@emilgroup/tenant-sdk 1.18.0 → 1.19.0

package/dist/api/dashboard-group-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 { CreateDashboardGroupRequestDto } from '../models';
+import { CreateDashboardGroupResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetDashboardGroupResponseClass } from '../models';
+import { ListDashboardGroupsResponseClass } from '../models';
+import { UpdateDashboardGroupRequestDto } from '../models';
+import { UpdateDashboardGroupResponseClass } from '../models';
+/**
+ * DashboardGroupApi - axios parameter creator
+ * @export
+ */
+export declare const DashboardGroupApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDashboardGroupRequestDto} createDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboardGroup: (createDashboardGroupRequestDto: CreateDashboardGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboardGroup: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboardGroup: (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}
+     */
+    listDashboardGroups: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardGroupRequestDto} updateDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboardGroup: (code: string, updateDashboardGroupRequestDto: UpdateDashboardGroupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DashboardGroupApi - functional programming interface
+ * @export
+ */
+export declare const DashboardGroupApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateDashboardGroupRequestDto} createDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboardGroup(createDashboardGroupRequestDto: CreateDashboardGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardGroupResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboardGroup(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}
+     */
+    getDashboardGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardGroupResponseClass>>;
+    /**
+     *
+     * @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}
+     */
+    listDashboardGroups(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDashboardGroupsResponseClass>>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardGroupRequestDto} updateDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboardGroup(code: string, updateDashboardGroupRequestDto: UpdateDashboardGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDashboardGroupResponseClass>>;
+};
+/**
+ * DashboardGroupApi - factory interface
+ * @export
+ */
+export declare const DashboardGroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateDashboardGroupRequestDto} createDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDashboardGroup(createDashboardGroupRequestDto: CreateDashboardGroupRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardGroupResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDashboardGroup(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDashboardGroup(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardGroupResponseClass>;
+    /**
+     *
+     * @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}
+     */
+    listDashboardGroups(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListDashboardGroupsResponseClass>;
+    /**
+     *
+     * @param {string} code
+     * @param {UpdateDashboardGroupRequestDto} updateDashboardGroupRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDashboardGroup(code: string, updateDashboardGroupRequestDto: UpdateDashboardGroupRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDashboardGroupResponseClass>;
+};
+/**
+ * Request parameters for createDashboardGroup operation in DashboardGroupApi.
+ * @export
+ * @interface DashboardGroupApiCreateDashboardGroupRequest
+ */
+export interface DashboardGroupApiCreateDashboardGroupRequest {
+    /**
+     *
+     * @type {CreateDashboardGroupRequestDto}
+     * @memberof DashboardGroupApiCreateDashboardGroup
+     */
+    readonly createDashboardGroupRequestDto: CreateDashboardGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardGroupApiCreateDashboardGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteDashboardGroup operation in DashboardGroupApi.
+ * @export
+ * @interface DashboardGroupApiDeleteDashboardGroupRequest
+ */
+export interface DashboardGroupApiDeleteDashboardGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardGroupApiDeleteDashboardGroup
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardGroupApiDeleteDashboardGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getDashboardGroup operation in DashboardGroupApi.
+ * @export
+ * @interface DashboardGroupApiGetDashboardGroupRequest
+ */
+export interface DashboardGroupApiGetDashboardGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardGroupApiGetDashboardGroup
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardGroupApiGetDashboardGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listDashboardGroups operation in DashboardGroupApi.
+ * @export
+ * @interface DashboardGroupApiListDashboardGroupsRequest
+ */
+export interface DashboardGroupApiListDashboardGroupsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardGroupApiListDashboardGroups
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof DashboardGroupApiListDashboardGroups
+     */
+    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 DashboardGroupApiListDashboardGroups
+     */
+    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 DashboardGroupApiListDashboardGroups
+     */
+    readonly filter?: any;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof DashboardGroupApiListDashboardGroups
+     */
+    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 DashboardGroupApiListDashboardGroups
+     */
+    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 DashboardGroupApiListDashboardGroups
+     */
+    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 DashboardGroupApiListDashboardGroups
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updateDashboardGroup operation in DashboardGroupApi.
+ * @export
+ * @interface DashboardGroupApiUpdateDashboardGroupRequest
+ */
+export interface DashboardGroupApiUpdateDashboardGroupRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DashboardGroupApiUpdateDashboardGroup
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateDashboardGroupRequestDto}
+     * @memberof DashboardGroupApiUpdateDashboardGroup
+     */
+    readonly updateDashboardGroupRequestDto: UpdateDashboardGroupRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof DashboardGroupApiUpdateDashboardGroup
+     */
+    readonly authorization?: string;
+}
+/**
+ * DashboardGroupApi - object-oriented interface
+ * @export
+ * @class DashboardGroupApi
+ * @extends {BaseAPI}
+ */
+export declare class DashboardGroupApi extends BaseAPI {
+    /**
+     *
+     * @param {DashboardGroupApiCreateDashboardGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardGroupApi
+     */
+    createDashboardGroup(requestParameters: DashboardGroupApiCreateDashboardGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardGroupResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardGroupApiDeleteDashboardGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardGroupApi
+     */
+    deleteDashboardGroup(requestParameters: DashboardGroupApiDeleteDashboardGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardGroupApiGetDashboardGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardGroupApi
+     */
+    getDashboardGroup(requestParameters: DashboardGroupApiGetDashboardGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardGroupResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardGroupApiListDashboardGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardGroupApi
+     */
+    listDashboardGroups(requestParameters?: DashboardGroupApiListDashboardGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDashboardGroupsResponseClass, any>>;
+    /**
+     *
+     * @param {DashboardGroupApiUpdateDashboardGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardGroupApi
+     */
+    updateDashboardGroup(requestParameters: DashboardGroupApiUpdateDashboardGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDashboardGroupResponseClass, any>>;
+}