@emilgroup/tenant-sdk-node 1.4.0 → 1.5.0

package/api/data-report-executor-api.ts

@@ -0,0 +1,165 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { RunDataReportRequestDto } from '../models';
+// @ts-ignore
+import { RunDataReportResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * DataReportExecutorApi - axios parameter creator
+ * @export
+ */
+export const DataReportExecutorApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @param {RunDataReportRequestDto} runDataReportRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        runDataReport: async (runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'runDataReportRequestDto' is not null or undefined
+            assertParamExists('runDataReport', 'runDataReportRequestDto', runDataReportRequestDto)
+            const localVarPath = `/tenantservice/v1/data-report-executor`;
+            // 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: 'POST', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(runDataReportRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DataReportExecutorApi - functional programming interface
+ * @export
+ */
+export const DataReportExecutorApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DataReportExecutorApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @param {RunDataReportRequestDto} runDataReportRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunDataReportResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.runDataReport(runDataReportRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * DataReportExecutorApi - factory interface
+ * @export
+ */
+export const DataReportExecutorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DataReportExecutorApiFp(configuration)
+    return {
+        /**
+         * 
+         * @param {RunDataReportRequestDto} runDataReportRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<RunDataReportResponseClass> {
+            return localVarFp.runDataReport(runDataReportRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for runDataReport operation in DataReportExecutorApi.
+ * @export
+ * @interface DataReportExecutorApiRunDataReportRequest
+ */
+export interface DataReportExecutorApiRunDataReportRequest {
+    /**
+     * 
+     * @type {RunDataReportRequestDto}
+     * @memberof DataReportExecutorApiRunDataReport
+     */
+    readonly runDataReportRequestDto: RunDataReportRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof DataReportExecutorApiRunDataReport
+     */
+    readonly authorization?: string
+}
+
+/**
+ * DataReportExecutorApi - object-oriented interface
+ * @export
+ * @class DataReportExecutorApi
+ * @extends {BaseAPI}
+ */
+export class DataReportExecutorApi extends BaseAPI {
+    /**
+     * 
+     * @param {DataReportExecutorApiRunDataReportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataReportExecutorApi
+     */
+    public runDataReport(requestParameters: DataReportExecutorApiRunDataReportRequest, options?: AxiosRequestConfig) {
+        return DataReportExecutorApiFp(this.configuration).runDataReport(requestParameters.runDataReportRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api/roles-api.ts

@@ -33,17 +33,19 @@ const FormData = require('form-data');
 export const RolesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List roles
+         * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will     conserve bandwidth and reduce response time.
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
-         * @param {string} [expand] Extra fields to fetch
+         * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
+         * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listRoles: async (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listRoles: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/tenantservice/v1/roles`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -86,6 +88,10 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
                 localVarQueryParameter['expand'] = expand;
             }
 
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -108,18 +114,20 @@ export const RolesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = RolesApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List roles
+         * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will     conserve bandwidth and reduce response time.
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
-         * @param {string} [expand] Extra fields to fetch
+         * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
+         * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listRoles(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(pageSize, pageToken, filter, search, order, expand, options);
+        async listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -133,18 +141,20 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
     const localVarFp = RolesApiFp(configuration)
     return {
         /**
-         * 
+         * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List roles
+         * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
-         * @param {string} [filter] List filter
+         * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will     conserve bandwidth and reduce response time.
          * @param {string} [search] Search query
-         * @param {string} [order] Ordering criteria
-         * @param {string} [expand] Extra fields to fetch
+         * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
+         * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listRoles(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRolesResponseClass> {
-            return localVarFp.listRoles(pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: any): AxiosPromise<ListRolesResponseClass> {
+            return localVarFp.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -155,6 +165,13 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
  * @interface RolesApiListRolesRequest
  */
 export interface RolesApiListRolesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof RolesApiListRoles
+     */
+    readonly authorization?: string
+
     /**
      * Page size
      * @type {number}
@@ -170,11 +187,11 @@ export interface RolesApiListRolesRequest {
     readonly pageToken?: string
 
     /**
-     * List filter
-     * @type {string}
+     * Filter the response by one or multiple fields. In general, fetching filtered responses will     conserve bandwidth and reduce response time.
+     * @type {'id' | 'code' | 'label'}
      * @memberof RolesApiListRoles
      */
-    readonly filter?: string
+    readonly filter?: 'id' | 'code' | 'label'
 
     /**
      * Search query
@@ -184,18 +201,18 @@ export interface RolesApiListRolesRequest {
     readonly search?: string
 
     /**
-     * Ordering criteria
-     * @type {string}
+     * Order allowing you to specify the desired order of entities retrieved from the server.
+     * @type {'label'}
      * @memberof RolesApiListRoles
      */
-    readonly order?: string
+    readonly order?: 'label'
 
     /**
-     * Extra fields to fetch
-     * @type {string}
+     * You can expand roles in this endpoint. By default, permissions will be an empty array.
+     * @type {'permissions'}
      * @memberof RolesApiListRoles
      */
-    readonly expand?: string
+    readonly expand?: 'permissions'
 }
 
 /**
@@ -206,13 +223,14 @@ export interface RolesApiListRolesRequest {
  */
 export class RolesApi extends BaseAPI {
     /**
-     * 
+     * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List roles
      * @param {RolesApiListRolesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof RolesApi
      */
     public listRoles(requestParameters: RolesApiListRolesRequest = {}, options?: AxiosRequestConfig) {
-        return RolesApiFp(this.configuration).listRoles(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return RolesApiFp(this.configuration).listRoles(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/api/settings-api.ts

@@ -33,7 +33,8 @@ const FormData = require('form-data');
 export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
+         * @summary Retrieve the settings
          * @param {string} keys 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -90,7 +91,8 @@ export const SettingsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
+         * @summary Retrieve the settings
          * @param {string} keys 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -111,7 +113,8 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = SettingsApiFp(configuration)
     return {
         /**
-         * 
+         * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
+         * @summary Retrieve the settings
          * @param {string} keys 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -152,7 +155,8 @@ export interface SettingsApiGetTenantSettingsRequest {
  */
 export class SettingsApi extends BaseAPI {
     /**
-     * 
+     * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
+     * @summary Retrieve the settings
      * @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/api.ts

@@ -25,6 +25,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
 import { CustomSchemaApi } from './api';
+import { DataReportApi } from './api';
+import { DataReportExecutorApi } from './api';
 import { InviteOrganizationsApi } from './api';
 import { InviteUsersApi } from './api';
 import { ListOrganizationInvitationsApi } from './api';
@@ -36,6 +38,8 @@ import { UsersApi } from './api';
 
 
 export * from './api/custom-schema-api';
+export * from './api/data-report-api';
+export * from './api/data-report-executor-api';
 export * from './api/invite-organizations-api';
 export * from './api/invite-users-api';
 export * from './api/list-organization-invitations-api';