@spaciv/sdk 0.0.0 → 0.1.0

package/src/apis/DashboardsApi.ts

@@ -0,0 +1,676 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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';
+import type {
+  DashboardCardCreate,
+  DashboardCardDelete,
+  DashboardCardPatch,
+  DashboardChangelogBody,
+  DashboardCopy,
+  DashboardListRes,
+  DashboardPost,
+  DashboardUpdate,
+  ErrorModel,
+} from '../models/index';
+import {
+    DashboardCardCreateFromJSON,
+    DashboardCardCreateToJSON,
+    DashboardCardDeleteFromJSON,
+    DashboardCardDeleteToJSON,
+    DashboardCardPatchFromJSON,
+    DashboardCardPatchToJSON,
+    DashboardChangelogBodyFromJSON,
+    DashboardChangelogBodyToJSON,
+    DashboardCopyFromJSON,
+    DashboardCopyToJSON,
+    DashboardListResFromJSON,
+    DashboardListResToJSON,
+    DashboardPostFromJSON,
+    DashboardPostToJSON,
+    DashboardUpdateFromJSON,
+    DashboardUpdateToJSON,
+    ErrorModelFromJSON,
+    ErrorModelToJSON,
+} from '../models/index';
+
+export interface DashboardsApiCreateRequest {
+    dashboardPost?: DashboardPost;
+}
+
+export interface DashboardsApiCreateCardsRequest {
+    id: string;
+    dashboardCardCreate?: DashboardCardCreate;
+}
+
+export interface DashboardsApiDeleteRequest {
+    id: string;
+}
+
+export interface DashboardsApiDeleteCardsRequest {
+    id: string;
+    dashboardCardDelete?: DashboardCardDelete;
+}
+
+export interface DashboardsApiDuplicateRequest {
+    id: string;
+    dashboardCopy?: DashboardCopy;
+}
+
+export interface DashboardsApiGetRequest {
+    id: string;
+}
+
+export interface DashboardsApiUpdateRequest {
+    id: string;
+    dashboardUpdate?: DashboardUpdate;
+}
+
+export interface DashboardsApiUpdateCardsRequest {
+    id: string;
+    dashboardCardPatch?: DashboardCardPatch;
+}
+
+/**
+ * DashboardsApi - interface
+ * 
+ * @export
+ * @interface DashboardsApiInterface
+ */
+export interface DashboardsApiInterface {
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * @summary Create a dashboard
+     * @param {DashboardPost} [dashboardPost] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    createRaw(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * Create a dashboard
+     */
+    create(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * @summary Add a card to a dashboard
+     * @param {string} id 
+     * @param {DashboardCardCreate} [dashboardCardCreate] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    createCardsRaw(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * Add a card to a dashboard
+     */
+    createCards(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * @summary Delete a dashboard
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    deleteRaw(requestParameters: DashboardsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * Delete a dashboard
+     */
+    delete(requestParameters: DashboardsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * @summary Remove a card from a dashboard
+     * @param {string} id 
+     * @param {DashboardCardDelete} [dashboardCardDelete] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    deleteCardsRaw(requestParameters: DashboardsApiDeleteCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Remove a card from a dashboard
+     */
+    deleteCards(requestParameters: DashboardsApiDeleteCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * @summary Copy a dashboard
+     * @param {string} id 
+     * @param {DashboardCopy} [dashboardCopy] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    duplicateRaw(requestParameters: DashboardsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * Copy a dashboard
+     */
+    duplicate(requestParameters: DashboardsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * @summary Get a dashboard
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    getRaw(requestParameters: DashboardsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DashboardChangelogBody>>;
+
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * Get a dashboard
+     */
+    get(requestParameters: DashboardsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DashboardChangelogBody>;
+
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * @summary List dashboards
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DashboardListRes>>;
+
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * List dashboards
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DashboardListRes>;
+
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * @summary Update a dashboard
+     * @param {string} id 
+     * @param {DashboardUpdate} [dashboardUpdate] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    updateRaw(requestParameters: DashboardsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Update a dashboard
+     */
+    update(requestParameters: DashboardsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * @summary Update a dashboard card
+     * @param {string} id 
+     * @param {DashboardCardPatch} [dashboardCardPatch] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DashboardsApiInterface
+     */
+    updateCardsRaw(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * Update a dashboard card
+     */
+    updateCards(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInterface {
+
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * Create a dashboard
+     */
+    async createRaw(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardPostToJSON(requestParameters['dashboardPost']),
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * Create a dashboard
+     */
+    async create(requestParameters: DashboardsApiCreateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.createRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * Add a card to a dashboard
+     */
+    async createCardsRaw(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling createCards().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}/cards`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardCardCreateToJSON(requestParameters['dashboardCardCreate']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * Add a card to a dashboard
+     */
+    async createCards(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.createCardsRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * Delete a dashboard
+     */
+    async deleteRaw(requestParameters: DashboardsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling delete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * Delete a dashboard
+     */
+    async delete(requestParameters: DashboardsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Remove a card from a dashboard
+     */
+    async deleteCardsRaw(requestParameters: DashboardsApiDeleteCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteCards().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}/cards`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardCardDeleteToJSON(requestParameters['dashboardCardDelete']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Remove a card from a dashboard
+     */
+    async deleteCards(requestParameters: DashboardsApiDeleteCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCardsRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * Copy a dashboard
+     */
+    async duplicateRaw(requestParameters: DashboardsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling duplicate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}/duplicate`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardCopyToJSON(requestParameters['dashboardCopy']),
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * Copy a dashboard
+     */
+    async duplicate(requestParameters: DashboardsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.duplicateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * Get a dashboard
+     */
+    async getRaw(requestParameters: DashboardsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DashboardChangelogBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling get().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DashboardChangelogBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * Get a dashboard
+     */
+    async get(requestParameters: DashboardsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DashboardChangelogBody> {
+        const response = await this.getRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * List dashboards
+     */
+    async listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DashboardListRes>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DashboardListResFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * List dashboards
+     */
+    async list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DashboardListRes> {
+        const response = await this.listRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Update a dashboard
+     */
+    async updateRaw(requestParameters: DashboardsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling update().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardUpdateToJSON(requestParameters['dashboardUpdate']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Update a dashboard
+     */
+    async update(requestParameters: DashboardsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * Update a dashboard card
+     */
+    async updateCardsRaw(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateCards().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/dashboards/{id}/cards`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DashboardCardPatchToJSON(requestParameters['dashboardCardPatch']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * Update a dashboard card
+     */
+    async updateCards(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateCardsRaw(requestParameters, initOverrides);
+    }
+
+}