@emilgroup/tenant-sdk-node 1.34.1-beta.48 → 1.34.1-beta.49

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

@@ -0,0 +1,394 @@
+/**
+ * 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 { CreateReportScheduleRequestDto } from '../models';
+import { CreateReportScheduleResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetReportScheduleResponseClass } from '../models';
+import { ListReportSchedulesResponseClass } from '../models';
+import { UpdateReportScheduleRequestDto } from '../models';
+import { UpdateReportScheduleResponseClass } from '../models';
+/**
+ * ReportScheduleApi - axios parameter creator
+ * @export
+ */
+export declare const ReportScheduleApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a scheduled report configuration for the tenant  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Create the report-schedule
+     * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createReportSchedule: (createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Delete the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteReportSchedule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code      that was returned when you created it and Emil Api will return the corresponding report-schedule information.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Retrieve the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportSchedule: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of report-schedules you have previously created.        The report-schedules are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary List report-schedules
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {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}
+     */
+    listReportSchedules: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Update the report-schedule
+     * @param {string} code
+     * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReportSchedule: (code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReportScheduleApi - functional programming interface
+ * @export
+ */
+export declare const ReportScheduleApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a scheduled report configuration for the tenant  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Create the report-schedule
+     * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReportScheduleResponseClass>>;
+    /**
+     * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Delete the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteReportSchedule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code      that was returned when you created it and Emil Api will return the corresponding report-schedule information.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Retrieve the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportSchedule(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportScheduleResponseClass>>;
+    /**
+     * Returns a list of report-schedules you have previously created.        The report-schedules are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary List report-schedules
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {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}
+     */
+    listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListReportSchedulesResponseClass>>;
+    /**
+     * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Update the report-schedule
+     * @param {string} code
+     * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateReportScheduleResponseClass>>;
+};
+/**
+ * ReportScheduleApi - factory interface
+ * @export
+ */
+export declare const ReportScheduleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a scheduled report configuration for the tenant  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Create the report-schedule
+     * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReportScheduleResponseClass>;
+    /**
+     * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Delete the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteReportSchedule(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code      that was returned when you created it and Emil Api will return the corresponding report-schedule information.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Retrieve the report-schedule
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportSchedule(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetReportScheduleResponseClass>;
+    /**
+     * Returns a list of report-schedules you have previously created.        The report-schedules are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary List report-schedules
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {string} [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 {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [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 {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}
+     */
+    listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListReportSchedulesResponseClass>;
+    /**
+     * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Update the report-schedule
+     * @param {string} code
+     * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateReportScheduleResponseClass>;
+};
+/**
+ * Request parameters for createReportSchedule operation in ReportScheduleApi.
+ * @export
+ * @interface ReportScheduleApiCreateReportScheduleRequest
+ */
+export interface ReportScheduleApiCreateReportScheduleRequest {
+    /**
+     *
+     * @type {CreateReportScheduleRequestDto}
+     * @memberof ReportScheduleApiCreateReportSchedule
+     */
+    readonly createReportScheduleRequestDto: CreateReportScheduleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ReportScheduleApiCreateReportSchedule
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteReportSchedule operation in ReportScheduleApi.
+ * @export
+ * @interface ReportScheduleApiDeleteReportScheduleRequest
+ */
+export interface ReportScheduleApiDeleteReportScheduleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ReportScheduleApiDeleteReportSchedule
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ReportScheduleApiDeleteReportSchedule
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getReportSchedule operation in ReportScheduleApi.
+ * @export
+ * @interface ReportScheduleApiGetReportScheduleRequest
+ */
+export interface ReportScheduleApiGetReportScheduleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ReportScheduleApiGetReportSchedule
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ReportScheduleApiGetReportSchedule
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof ReportScheduleApiGetReportSchedule
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listReportSchedules operation in ReportScheduleApi.
+ * @export
+ * @interface ReportScheduleApiListReportSchedulesRequest
+ */
+export interface ReportScheduleApiListReportSchedulesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 {string}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    readonly search?: string;
+    /**
+     * 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 {string}
+     * @memberof ReportScheduleApiListReportSchedules
+     */
+    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 ReportScheduleApiListReportSchedules
+     */
+    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 ReportScheduleApiListReportSchedules
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateReportSchedule operation in ReportScheduleApi.
+ * @export
+ * @interface ReportScheduleApiUpdateReportScheduleRequest
+ */
+export interface ReportScheduleApiUpdateReportScheduleRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportScheduleApiUpdateReportSchedule
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateReportScheduleRequestDto}
+     * @memberof ReportScheduleApiUpdateReportSchedule
+     */
+    readonly updateReportScheduleRequestDto: UpdateReportScheduleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ReportScheduleApiUpdateReportSchedule
+     */
+    readonly authorization?: string;
+}
+/**
+ * ReportScheduleApi - object-oriented interface
+ * @export
+ * @class ReportScheduleApi
+ * @extends {BaseAPI}
+ */
+export declare class ReportScheduleApi extends BaseAPI {
+    /**
+     * Creates a scheduled report configuration for the tenant  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Create the report-schedule
+     * @param {ReportScheduleApiCreateReportScheduleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportScheduleApi
+     */
+    createReportSchedule(requestParameters: ReportScheduleApiCreateReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReportScheduleResponseClass, any, {}>>;
+    /**
+     * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Delete the report-schedule
+     * @param {ReportScheduleApiDeleteReportScheduleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportScheduleApi
+     */
+    deleteReportSchedule(requestParameters: ReportScheduleApiDeleteReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
+    /**
+     * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code      that was returned when you created it and Emil Api will return the corresponding report-schedule information.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Retrieve the report-schedule
+     * @param {ReportScheduleApiGetReportScheduleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportScheduleApi
+     */
+    getReportSchedule(requestParameters: ReportScheduleApiGetReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReportScheduleResponseClass, any, {}>>;
+    /**
+     * Returns a list of report-schedules you have previously created.        The report-schedules are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary List report-schedules
+     * @param {ReportScheduleApiListReportSchedulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportScheduleApi
+     */
+    listReportSchedules(requestParameters?: ReportScheduleApiListReportSchedulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListReportSchedulesResponseClass, any, {}>>;
+    /**
+     * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"reporting.dashboards.view\"
+     * @summary Update the report-schedule
+     * @param {ReportScheduleApiUpdateReportScheduleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportScheduleApi
+     */
+    updateReportSchedule(requestParameters: ReportScheduleApiUpdateReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateReportScheduleResponseClass, any, {}>>;
+}