@emilgroup/tenant-sdk 1.0.1 → 1.2.1

package/dist/api/data-report-api.d.ts

@@ -1,380 +0,0 @@
-/**
- * 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 { CreateDataReportRequestDto } from '../models';
-import { CreateDataReportResponseClass } from '../models';
-import { GetDataReportResponseClass } from '../models';
-import { ListDataReportsResponseClass } from '../models';
-import { UpdateDataReportRequestDto } from '../models';
-import { UpdateDataReportResponseClass } from '../models';
-/**
- * DataReportApi - axios parameter creator
- * @export
- */
-export declare const DataReportApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * This will create a data report for tenant in the database
-     * @summary Create the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {CreateDataReportRequestDto} createDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createCustomSchema: (authorization: string, createDataReportRequestDto: CreateDataReportRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteAlert: (authorization: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
-     * @summary Retrieve the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [expand] Fields to expand response by
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getDataReport: (authorization: string, code: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
-     * @summary List data-reports
-     * @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}
-     */
-    listDataReports: (authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
-     * @summary Update the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code
-     * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updateDataReport: (authorization: string, code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * DataReportApi - functional programming interface
- * @export
- */
-export declare const DataReportApiFp: (configuration?: Configuration) => {
-    /**
-     * This will create a data report for tenant in the database
-     * @summary Create the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {CreateDataReportRequestDto} createDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createCustomSchema(authorization: string, createDataReportRequestDto: CreateDataReportRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>>;
-    /**
-     *
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteAlert(authorization: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
-     * @summary Retrieve the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [expand] Fields to expand response by
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getDataReport(authorization: string, code: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDataReportResponseClass>>;
-    /**
-     * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
-     * @summary List data-reports
-     * @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}
-     */
-    listDataReports(authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDataReportsResponseClass>>;
-    /**
-     * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
-     * @summary Update the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code
-     * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updateDataReport(authorization: string, code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDataReportResponseClass>>;
-};
-/**
- * DataReportApi - factory interface
- * @export
- */
-export declare const DataReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * This will create a data report for tenant in the database
-     * @summary Create the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {CreateDataReportRequestDto} createDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createCustomSchema(authorization: string, createDataReportRequestDto: CreateDataReportRequestDto, options?: any): AxiosPromise<CreateDataReportResponseClass>;
-    /**
-     *
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    deleteAlert(authorization: string, id: string, options?: any): AxiosPromise<void>;
-    /**
-     * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
-     * @summary Retrieve the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [expand] Fields to expand response by
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getDataReport(authorization: string, code: string, expand?: string, options?: any): AxiosPromise<GetDataReportResponseClass>;
-    /**
-     * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
-     * @summary List data-reports
-     * @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}
-     */
-    listDataReports(authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDataReportsResponseClass>;
-    /**
-     * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
-     * @summary Update the data-report
-     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} code
-     * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updateDataReport(authorization: string, code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, options?: any): AxiosPromise<UpdateDataReportResponseClass>;
-};
-/**
- * Request parameters for createCustomSchema operation in DataReportApi.
- * @export
- * @interface DataReportApiCreateCustomSchemaRequest
- */
-export interface DataReportApiCreateCustomSchemaRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof DataReportApiCreateCustomSchema
-     */
-    readonly authorization: string;
-    /**
-     *
-     * @type {CreateDataReportRequestDto}
-     * @memberof DataReportApiCreateCustomSchema
-     */
-    readonly createDataReportRequestDto: CreateDataReportRequestDto;
-}
-/**
- * Request parameters for deleteAlert operation in DataReportApi.
- * @export
- * @interface DataReportApiDeleteAlertRequest
- */
-export interface DataReportApiDeleteAlertRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof DataReportApiDeleteAlert
-     */
-    readonly authorization: string;
-    /**
-     *
-     * @type {string}
-     * @memberof DataReportApiDeleteAlert
-     */
-    readonly id: string;
-}
-/**
- * Request parameters for getDataReport operation in DataReportApi.
- * @export
- * @interface DataReportApiGetDataReportRequest
- */
-export interface DataReportApiGetDataReportRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof DataReportApiGetDataReport
-     */
-    readonly authorization: string;
-    /**
-     * Unique identifier for the object.
-     * @type {string}
-     * @memberof DataReportApiGetDataReport
-     */
-    readonly code: string;
-    /**
-     * Fields to expand response by
-     * @type {string}
-     * @memberof DataReportApiGetDataReport
-     */
-    readonly expand?: string;
-}
-/**
- * Request parameters for listDataReports operation in DataReportApi.
- * @export
- * @interface DataReportApiListDataReportsRequest
- */
-export interface DataReportApiListDataReportsRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof DataReportApiListDataReports
-     */
-    readonly authorization: string;
-    /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
-     * @type {any}
-     * @memberof DataReportApiListDataReports
-     */
-    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 DataReportApiListDataReports
-     */
-    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 DataReportApiListDataReports
-     */
-    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 DataReportApiListDataReports
-     */
-    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 DataReportApiListDataReports
-     */
-    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 DataReportApiListDataReports
-     */
-    readonly expand?: any;
-}
-/**
- * Request parameters for updateDataReport operation in DataReportApi.
- * @export
- * @interface DataReportApiUpdateDataReportRequest
- */
-export interface DataReportApiUpdateDataReportRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof DataReportApiUpdateDataReport
-     */
-    readonly authorization: string;
-    /**
-     *
-     * @type {string}
-     * @memberof DataReportApiUpdateDataReport
-     */
-    readonly code: string;
-    /**
-     *
-     * @type {UpdateDataReportRequestDto}
-     * @memberof DataReportApiUpdateDataReport
-     */
-    readonly updateDataReportRequestDto: UpdateDataReportRequestDto;
-}
-/**
- * DataReportApi - object-oriented interface
- * @export
- * @class DataReportApi
- * @extends {BaseAPI}
- */
-export declare class DataReportApi extends BaseAPI {
-    /**
-     * This will create a data report for tenant in the database
-     * @summary Create the data-report
-     * @param {DataReportApiCreateCustomSchemaRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DataReportApi
-     */
-    createCustomSchema(requestParameters: DataReportApiCreateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDataReportResponseClass, any>>;
-    /**
-     *
-     * @param {DataReportApiDeleteAlertRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DataReportApi
-     */
-    deleteAlert(requestParameters: DataReportApiDeleteAlertRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
-    /**
-     * Retrieves the details of the data-report that was previously created. Supply the unique data-report code that was returned when you created it and Emil Api will return the corresponding data-report information.
-     * @summary Retrieve the data-report
-     * @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DataReportApi
-     */
-    getDataReport(requestParameters: DataReportApiGetDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDataReportResponseClass, any>>;
-    /**
-     * Returns a list of data-reports you have previously created. The data-reports are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
-     * @summary List data-reports
-     * @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DataReportApi
-     */
-    listDataReports(requestParameters: DataReportApiListDataReportsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDataReportsResponseClass, any>>;
-    /**
-     * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
-     * @summary Update the data-report
-     * @param {DataReportApiUpdateDataReportRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DataReportApi
-     */
-    updateDataReport(requestParameters: DataReportApiUpdateDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDataReportResponseClass, any>>;
-}