@emilgroup/tenant-sdk 1.18.0 → 1.19.0

package/dist/api/dashboard-api.d.ts

@@ -0,0 +1,365 @@
+/**
+ * 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 { CreateDashboardRequestDto } from '../models';
+import { CreateDashboardResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetDashboardResponseClass } from '../models';
+import { ListDashboardsResponseClass } from '../models';
+import { UpdateDashboardRequestDto } from '../models';
+import { UpdateDashboardResponseClass } from '../models';
+/**
+ * DashboardApi - axios parameter creator
+ * @export
+ */
+export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDashboardRequestDto} createDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboard: (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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] To search the list by any field, pass search&#x3D;xxx 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 {any} [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}
+     */
+    listDashboards: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboard: (code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DashboardApi - functional programming interface
+ * @export
+ */
+export declare const DashboardApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDashboardRequestDto} createDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboard(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponseClass>>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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] To search the list by any field, pass search&#x3D;xxx 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 {any} [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}
+     */
+    listDashboards(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDashboardsResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboard(code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDashboardResponseClass>>;
+};
+/**
+ * DashboardApi - factory interface
+ * @export
+ */
+export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateDashboardRequestDto} createDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboard(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboard(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardResponseClass>;
+    /**
+     *
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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] To search the list by any field, pass search&#x3D;xxx 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 {any} [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}
+     */
+    listDashboards(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListDashboardsResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboard(code: string, updateDashboardRequestDto: UpdateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDashboardResponseClass>;
+};
+/**
+ * Request parameters for createDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiCreateDashboardRequest
+ */
+export interface DashboardApiCreateDashboardRequest {
+    /**
+     *
+     * @type {CreateDashboardRequestDto}
+     * @memberof DashboardApiCreateDashboard
+     */
+    readonly createDashboardRequestDto: CreateDashboardRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardApiCreateDashboard
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiDeleteDashboardRequest
+ */
+export interface DashboardApiDeleteDashboardRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiDeleteDashboard
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardApiDeleteDashboard
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiGetDashboardRequest
+ */
+export interface DashboardApiGetDashboardRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiGetDashboard
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardApiGetDashboard
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listDashboards operation in DashboardApi.
+ * @export
+ * @interface DashboardApiListDashboardsRequest
+ */
+export interface DashboardApiListDashboardsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardApiListDashboards
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof DashboardApiListDashboards
+     */
+    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 DashboardApiListDashboards
+     */
+    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 DashboardApiListDashboards
+     */
+    readonly filter?: any;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof DashboardApiListDashboards
+     */
+    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 DashboardApiListDashboards
+     */
+    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 DashboardApiListDashboards
+     */
+    readonly expand?: any;
+    /**
+     * 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 {any}
+     * @memberof DashboardApiListDashboards
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updateDashboard operation in DashboardApi.
+ * @export
+ * @interface DashboardApiUpdateDashboardRequest
+ */
+export interface DashboardApiUpdateDashboardRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardApiUpdateDashboard
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateDashboardRequestDto}
+     * @memberof DashboardApiUpdateDashboard
+     */
+    readonly updateDashboardRequestDto: UpdateDashboardRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardApiUpdateDashboard
+     */
+    readonly authorization?: string;
+}
+/**
+ * DashboardApi - object-oriented interface
+ * @export
+ * @class DashboardApi
+ * @extends {BaseAPI}
+ */
+export declare class DashboardApi extends BaseAPI {
+    /**
+     *
+     * @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    deleteDashboard(requestParameters: DashboardApiDeleteDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    listDashboards(requestParameters?: DashboardApiListDashboardsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDashboardsResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardApi
+     */
+    updateDashboard(requestParameters: DashboardApiUpdateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDashboardResponseClass, any>>;
+}