@itwin/insights-client/lib/cjs/reporting/clients/IReportsClient.d.ts

Insights client for the iTwin platform

import type { AccessToken } from "@itwin/core-bentley";
import type { Report, ReportAggregation, ReportAggregationCreate, ReportCreate, ReportMapping, ReportMappingCreate, ReportUpdate } from "../interfaces/Reports";
import type { EntityListIterator } from "../../common/iterators/EntityListIterator";
export interface IReportsClient {
    /**
     * Gets all Reports within the context of a Project. This method returns the full list of reports.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} projectId The project Id.
     * @param {number} top The number of entities to load per page.
     * @param {boolean} deleted Parameter to specify whether to include deleted reports.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-project-reports/
     */
    getReports(accessToken: AccessToken, projectId: string, top?: number, deleted?: boolean): Promise<Report[]>;
    /**
     * Gets an async paged iterator for Reports within the context of a Project.
     * This method returns an iterator which loads pages of reports as it is being iterated over.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} projectId The project Id.
     * @param {number} top The number of entities to load per page.
     * @param {boolean} deleted Parameter to specify whether to include deleted reports.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-project-reports/
     */
    getReportsIterator(accessToken: AccessToken, projectId: string, top?: number, deleted?: boolean): EntityListIterator<Report>;
    /**
     * Gets a single Report.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @memberof ReportsClient
     * @link https://developer.bentley.com/apis/insights/operations/get-report/
     */
    getReport(accessToken: AccessToken, reportId: string): Promise<Report>;
    /**
     * Creates a Report within the context of a Project.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {ReportCreate} report Request body.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/create-report/
     */
    createReport(accessToken: AccessToken, report: ReportCreate): Promise<Report>;
    /**
     * Updates a Report.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {ReportUpdate} report Request body.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/update-report/
     */
    updateReport(accessToken: AccessToken, reportId: string, report: ReportUpdate): Promise<Report>;
    /**
     * Marks a Report for deletion.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/delete-report/
     */
    deleteReport(accessToken: AccessToken, reportId: string): Promise<Response>;
    /**
     * Gets all Report Mappings for a Report. This method returns the full list of report mappings.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {number} top The number of entities to load per page.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-report-mappings/
     */
    getReportMappings(accessToken: AccessToken, reportId: string, top?: number): Promise<ReportMapping[]>;
    /**
     * Gets an async paged iterator of Report Mappings for a Report.
     * This method returns an iterator which loads pages of report mappings as it is being iterated over.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {number} top The number of entities to load per page.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-report-mappings/
     */
    getReportMappingsIterator(accessToken: AccessToken, reportId: string, top?: number): EntityListIterator<ReportMapping>;
    /**
     * Creates a Report Mapping.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {ReportMappingCreate} reportMapping Request body.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/create-report-mapping/
     */
    createReportMapping(accessToken: AccessToken, reportId: string, reportMapping: ReportMappingCreate): Promise<ReportMapping>;
    /**
     * Deletes a Report Mapping from a Report.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {string} reportMappingId The Report Mapping Id
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/delete-report-mapping/
     */
    deleteReportMapping(accessToken: AccessToken, reportId: string, reportMappingId: string): Promise<Response>;
    /**
     * Gets all Report Aggregations for a Report. This method returns the full list of aggregations.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {number} top Optional max items to be sent in response.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-report-aggregations/
     */
    getReportAggregations(accessToken: AccessToken, reportId: string, top?: number): Promise<ReportAggregation[]>;
    /**
     * Gets an async paged iterator of Report Aggregations for a Report.
     * This method returns an iterator which loads pages of report aggregations as it is being iterated over.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {number} top Optional max items to be sent in response.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/get-report-aggregations/
     */
    getReportAggregationsIterator(accessToken: AccessToken, reportId: string, top?: number): EntityListIterator<ReportAggregation>;
    /**
     * Creates a Report Aggregation.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {ReportAggregationCreate} aggregation Request body.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/create-report-aggregation/
     */
    createReportAggregation(accessToken: AccessToken, reportId: string, aggregation: ReportAggregationCreate): Promise<ReportAggregation>;
    /**
     * Deletes a Report Aggregation from a Report.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} reportId The Report Id.
     * @param {string} aggregationTableSetId The Aggregation Table Set Id.
     * @memberof ReportingClient
     * @link https://developer.bentley.com/apis/insights/operations/delete-report-aggregation/
     */
    deleteReportAggregation(accessToken: AccessToken, reportId: string, aggregationTableSetId: string): Promise<Response>;
}
//# sourceMappingURL=IReportsClient.d.ts.map