@coval/sdk 0.2.1 → 0.4.0

package/src/generated/apis/ReportsApi.ts

@@ -0,0 +1,596 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime.js';
+import {
+    type CovalReportsAPICreateReportRequest,
+    CovalReportsAPICreateReportRequestFromJSON,
+    CovalReportsAPICreateReportRequestToJSON,
+} from '../models/CovalReportsAPICreateReportRequest.js';
+import {
+    type CovalReportsAPICreateReportResponse,
+    CovalReportsAPICreateReportResponseFromJSON,
+    CovalReportsAPICreateReportResponseToJSON,
+} from '../models/CovalReportsAPICreateReportResponse.js';
+import {
+    type CovalReportsAPIDeleteReportResponse,
+    CovalReportsAPIDeleteReportResponseFromJSON,
+    CovalReportsAPIDeleteReportResponseToJSON,
+} from '../models/CovalReportsAPIDeleteReportResponse.js';
+import {
+    type CovalReportsAPIErrorResponse,
+    CovalReportsAPIErrorResponseFromJSON,
+    CovalReportsAPIErrorResponseToJSON,
+} from '../models/CovalReportsAPIErrorResponse.js';
+import {
+    type CovalReportsAPIGetReportResponse,
+    CovalReportsAPIGetReportResponseFromJSON,
+    CovalReportsAPIGetReportResponseToJSON,
+} from '../models/CovalReportsAPIGetReportResponse.js';
+import {
+    type CovalReportsAPIListReportRowsResponse,
+    CovalReportsAPIListReportRowsResponseFromJSON,
+    CovalReportsAPIListReportRowsResponseToJSON,
+} from '../models/CovalReportsAPIListReportRowsResponse.js';
+import {
+    type CovalReportsAPIListReportsResponse,
+    CovalReportsAPIListReportsResponseFromJSON,
+    CovalReportsAPIListReportsResponseToJSON,
+} from '../models/CovalReportsAPIListReportsResponse.js';
+import {
+    type CovalReportsAPIUpdateReportRequest,
+    CovalReportsAPIUpdateReportRequestFromJSON,
+    CovalReportsAPIUpdateReportRequestToJSON,
+} from '../models/CovalReportsAPIUpdateReportRequest.js';
+import {
+    type CovalReportsAPIUpdateReportResponse,
+    CovalReportsAPIUpdateReportResponseFromJSON,
+    CovalReportsAPIUpdateReportResponseToJSON,
+} from '../models/CovalReportsAPIUpdateReportResponse.js';
+
+export interface CreateReportRequest {
+    covalReportsAPICreateReportRequest: CovalReportsAPICreateReportRequest;
+}
+
+export interface DeleteReportRequest {
+    reportId: string;
+}
+
+export interface GetReportRequest {
+    reportId: string;
+}
+
+export interface ListReportRowsRequest {
+    reportId: string;
+    cursor?: string;
+    limit?: number;
+    metricIds?: string;
+    simulationOutputIds?: string;
+}
+
+export interface ListReportsRequest {
+    cursor?: string;
+    limit?: number;
+}
+
+export interface UpdateReportRequest {
+    reportId: string;
+    covalReportsAPIUpdateReportRequest: CovalReportsAPIUpdateReportRequest;
+}
+
+/**
+ * ReportsApi - interface
+ * 
+ * @export
+ * @interface ReportsApiInterface
+ */
+export interface ReportsApiInterface {
+    /**
+     * Creates request options for createReport without sending the request
+     * @param {CovalReportsAPICreateReportRequest} covalReportsAPICreateReportRequest 
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    createReportRequestOpts(requestParameters: CreateReportRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Create a saved report from existing run IDs. All runs must belong to the authenticated organization. Public reports are shareable without login and mark their included runs public. 
+     * @summary Create report
+     * @param {CovalReportsAPICreateReportRequest} covalReportsAPICreateReportRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    createReportRaw(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPICreateReportResponse>>;
+
+    /**
+     * Create a saved report from existing run IDs. All runs must belong to the authenticated organization. Public reports are shareable without login and mark their included runs public. 
+     * Create report
+     */
+    createReport(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPICreateReportResponse>;
+
+    /**
+     * Creates request options for deleteReport without sending the request
+     * @param {string} reportId Saved report ULID.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    deleteReportRequestOpts(requestParameters: DeleteReportRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Soft-delete a saved report. If the report is public, its run visibility is revoked unless another public report still references the same runs. 
+     * @summary Delete report
+     * @param {string} reportId Saved report ULID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    deleteReportRaw(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIDeleteReportResponse>>;
+
+    /**
+     * Soft-delete a saved report. If the report is public, its run visibility is revoked unless another public report still references the same runs. 
+     * Delete report
+     */
+    deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIDeleteReportResponse>;
+
+    /**
+     * Creates request options for getReport without sending the request
+     * @param {string} reportId Saved report ULID.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    getReportRequestOpts(requestParameters: GetReportRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Retrieve a saved report by ID.
+     * @summary Get report
+     * @param {string} reportId Saved report ULID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    getReportRaw(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIGetReportResponse>>;
+
+    /**
+     * Retrieve a saved report by ID.
+     * Get report
+     */
+    getReport(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIGetReportResponse>;
+
+    /**
+     * Creates request options for listReportRows without sending the request
+     * @param {string} reportId Saved report ULID.
+     * @param {string} [cursor] Pagination cursor from a prior response\&#39;s next_page_token.
+     * @param {number} [limit] Max rows per page (1-2000).
+     * @param {string} [metricIds] Comma-separated metric ids to include.
+     * @param {string} [simulationOutputIds] Comma-separated simulation output ids to restrict to.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    listReportRowsRequestOpts(requestParameters: ListReportRowsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * List a report\'s per-simulation rows, each with its metric outputs inline. Cursor-paginated. Optionally narrow with `metric_ids` and `simulation_output_ids` (comma-separated). 
+     * @summary List report rows
+     * @param {string} reportId Saved report ULID.
+     * @param {string} [cursor] Pagination cursor from a prior response\&#39;s next_page_token.
+     * @param {number} [limit] Max rows per page (1-2000).
+     * @param {string} [metricIds] Comma-separated metric ids to include.
+     * @param {string} [simulationOutputIds] Comma-separated simulation output ids to restrict to.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    listReportRowsRaw(requestParameters: ListReportRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIListReportRowsResponse>>;
+
+    /**
+     * List a report\'s per-simulation rows, each with its metric outputs inline. Cursor-paginated. Optionally narrow with `metric_ids` and `simulation_output_ids` (comma-separated). 
+     * List report rows
+     */
+    listReportRows(requestParameters: ListReportRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIListReportRowsResponse>;
+
+    /**
+     * Creates request options for listReports without sending the request
+     * @param {string} [cursor] Cursor from the previous page.
+     * @param {number} [limit] Maximum number of reports to return.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    listReportsRequestOpts(requestParameters: ListReportsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Retrieve a paginated list of saved reports for the authenticated organization.
+     * @summary List reports
+     * @param {string} [cursor] Cursor from the previous page.
+     * @param {number} [limit] Maximum number of reports to return.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    listReportsRaw(requestParameters: ListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIListReportsResponse>>;
+
+    /**
+     * Retrieve a paginated list of saved reports for the authenticated organization.
+     * List reports
+     */
+    listReports(requestParameters: ListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIListReportsResponse>;
+
+    /**
+     * Creates request options for updateReport without sending the request
+     * @param {string} reportId Saved report ULID.
+     * @param {CovalReportsAPIUpdateReportRequest} covalReportsAPIUpdateReportRequest 
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    updateReportRequestOpts(requestParameters: UpdateReportRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Partially update a saved report. To group by metadata, provide both `compare_by: metadata` and `metadata_key`. 
+     * @summary Update report
+     * @param {string} reportId Saved report ULID.
+     * @param {CovalReportsAPIUpdateReportRequest} covalReportsAPIUpdateReportRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    updateReportRaw(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIUpdateReportResponse>>;
+
+    /**
+     * Partially update a saved report. To group by metadata, provide both `compare_by: metadata` and `metadata_key`. 
+     * Update report
+     */
+    updateReport(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIUpdateReportResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
+
+    /**
+     * Creates request options for createReport without sending the request
+     */
+    async createReportRequestOpts(requestParameters: CreateReportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['covalReportsAPICreateReportRequest'] == null) {
+            throw new runtime.RequiredError(
+                'covalReportsAPICreateReportRequest',
+                'Required parameter "covalReportsAPICreateReportRequest" was null or undefined when calling createReport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CovalReportsAPICreateReportRequestToJSON(requestParameters['covalReportsAPICreateReportRequest']),
+        };
+    }
+
+    /**
+     * Create a saved report from existing run IDs. All runs must belong to the authenticated organization. Public reports are shareable without login and mark their included runs public. 
+     * Create report
+     */
+    async createReportRaw(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPICreateReportResponse>> {
+        const requestOptions = await this.createReportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPICreateReportResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a saved report from existing run IDs. All runs must belong to the authenticated organization. Public reports are shareable without login and mark their included runs public. 
+     * Create report
+     */
+    async createReport(requestParameters: CreateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPICreateReportResponse> {
+        const response = await this.createReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteReport without sending the request
+     */
+    async deleteReportRequestOpts(requestParameters: DeleteReportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reportId'] == null) {
+            throw new runtime.RequiredError(
+                'reportId',
+                'Required parameter "reportId" was null or undefined when calling deleteReport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports/{report_id}`;
+        urlPath = urlPath.replace('{report_id}', encodeURIComponent(String(requestParameters['reportId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-delete a saved report. If the report is public, its run visibility is revoked unless another public report still references the same runs. 
+     * Delete report
+     */
+    async deleteReportRaw(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIDeleteReportResponse>> {
+        const requestOptions = await this.deleteReportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPIDeleteReportResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Soft-delete a saved report. If the report is public, its run visibility is revoked unless another public report still references the same runs. 
+     * Delete report
+     */
+    async deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIDeleteReportResponse> {
+        const response = await this.deleteReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getReport without sending the request
+     */
+    async getReportRequestOpts(requestParameters: GetReportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reportId'] == null) {
+            throw new runtime.RequiredError(
+                'reportId',
+                'Required parameter "reportId" was null or undefined when calling getReport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports/{report_id}`;
+        urlPath = urlPath.replace('{report_id}', encodeURIComponent(String(requestParameters['reportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieve a saved report by ID.
+     * Get report
+     */
+    async getReportRaw(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIGetReportResponse>> {
+        const requestOptions = await this.getReportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPIGetReportResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a saved report by ID.
+     * Get report
+     */
+    async getReport(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIGetReportResponse> {
+        const response = await this.getReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listReportRows without sending the request
+     */
+    async listReportRowsRequestOpts(requestParameters: ListReportRowsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reportId'] == null) {
+            throw new runtime.RequiredError(
+                'reportId',
+                'Required parameter "reportId" was null or undefined when calling listReportRows().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['metricIds'] != null) {
+            queryParameters['metric_ids'] = requestParameters['metricIds'];
+        }
+
+        if (requestParameters['simulationOutputIds'] != null) {
+            queryParameters['simulation_output_ids'] = requestParameters['simulationOutputIds'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports/{report_id}/rows`;
+        urlPath = urlPath.replace('{report_id}', encodeURIComponent(String(requestParameters['reportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List a report\'s per-simulation rows, each with its metric outputs inline. Cursor-paginated. Optionally narrow with `metric_ids` and `simulation_output_ids` (comma-separated). 
+     * List report rows
+     */
+    async listReportRowsRaw(requestParameters: ListReportRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIListReportRowsResponse>> {
+        const requestOptions = await this.listReportRowsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPIListReportRowsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List a report\'s per-simulation rows, each with its metric outputs inline. Cursor-paginated. Optionally narrow with `metric_ids` and `simulation_output_ids` (comma-separated). 
+     * List report rows
+     */
+    async listReportRows(requestParameters: ListReportRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIListReportRowsResponse> {
+        const response = await this.listReportRowsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listReports without sending the request
+     */
+    async listReportsRequestOpts(requestParameters: ListReportsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieve a paginated list of saved reports for the authenticated organization.
+     * List reports
+     */
+    async listReportsRaw(requestParameters: ListReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIListReportsResponse>> {
+        const requestOptions = await this.listReportsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPIListReportsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a paginated list of saved reports for the authenticated organization.
+     * List reports
+     */
+    async listReports(requestParameters: ListReportsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIListReportsResponse> {
+        const response = await this.listReportsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateReport without sending the request
+     */
+    async updateReportRequestOpts(requestParameters: UpdateReportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['reportId'] == null) {
+            throw new runtime.RequiredError(
+                'reportId',
+                'Required parameter "reportId" was null or undefined when calling updateReport().'
+            );
+        }
+
+        if (requestParameters['covalReportsAPIUpdateReportRequest'] == null) {
+            throw new runtime.RequiredError(
+                'covalReportsAPIUpdateReportRequest',
+                'Required parameter "covalReportsAPIUpdateReportRequest" was null or undefined when calling updateReport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // Coval_Reports_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/reports/{report_id}`;
+        urlPath = urlPath.replace('{report_id}', encodeURIComponent(String(requestParameters['reportId'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CovalReportsAPIUpdateReportRequestToJSON(requestParameters['covalReportsAPIUpdateReportRequest']),
+        };
+    }
+
+    /**
+     * Partially update a saved report. To group by metadata, provide both `compare_by: metadata` and `metadata_key`. 
+     * Update report
+     */
+    async updateReportRaw(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalReportsAPIUpdateReportResponse>> {
+        const requestOptions = await this.updateReportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalReportsAPIUpdateReportResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Partially update a saved report. To group by metadata, provide both `compare_by: metadata` and `metadata_key`. 
+     * Update report
+     */
+    async updateReport(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalReportsAPIUpdateReportResponse> {
+        const response = await this.updateReportRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}