@spaciv/sdk 0.0.0 → 0.1.0

package/dist/esm/apis/ProjectsApi.d.ts

@@ -0,0 +1,251 @@
+/**
+ * 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 { ProjectChangelogBody, ProjectCreateBody, ProjectListRes, ProjectPatchBody } from '../models/index';
+export interface ProjectsApiCreateRequest {
+    projectCreateBody?: ProjectCreateBody;
+}
+export interface ProjectsApiDeleteRequest {
+    action?: ProjectsApiDeleteActionEnum;
+}
+export interface ProjectsApiGetRequest {
+    templateId?: number;
+}
+export interface ProjectsApiGetImageRequest {
+    noFallback?: boolean;
+}
+export interface ProjectsApiListRequest {
+    showTemplate?: boolean;
+    showArchived?: boolean;
+}
+export interface ProjectsApiUpdateRequest {
+    projectPatchBody?: ProjectPatchBody;
+}
+export interface ProjectsApiUpdateImageRequest {
+    filename?: Blob;
+    name?: string;
+}
+/**
+ * ProjectsApi - interface
+ *
+ * @export
+ * @interface ProjectsApiInterface
+ */
+export interface ProjectsApiInterface {
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * @summary Create a project
+     * @param {ProjectCreateBody} [projectCreateBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    createRaw(requestParameters: ProjectsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * Create a project
+     */
+    create(requestParameters: ProjectsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * @summary Delete or archive a project
+     * @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \&quot;archive\&quot; moves the project to the archive, \&quot;restore\&quot; makes it active again. Omit (or pass \&quot;purge\&quot;) to permanently delete the project and all its dashboards.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    deleteRaw(requestParameters: ProjectsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * Delete or archive a project
+     */
+    delete(requestParameters: ProjectsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * @summary Delete the project image
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    deleteImageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * Delete the project image
+     */
+    deleteImage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * @summary Get a project
+     * @param {number} [templateId] When non-zero, fetches this built-in template project instead of the caller\&#39;s current project.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    getRaw(requestParameters: ProjectsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectChangelogBody>>;
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * Get a project
+     */
+    get(requestParameters: ProjectsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectChangelogBody>;
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * @summary Get the project image
+     * @param {boolean} [noFallback] When true, returns 404 if no custom image has been uploaded rather than generating a default image from the project name.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    getImageRaw(requestParameters: ProjectsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the project image
+     */
+    getImage(requestParameters: ProjectsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * @summary List projects
+     * @param {boolean} [showTemplate] When true, lists the built-in template projects shared across all accounts instead of the caller\&#39;s own projects.
+     * @param {boolean} [showArchived] When true, returns only archived projects; omit or set false to return only active projects.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    listRaw(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectListRes>>;
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * List projects
+     */
+    list(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * @summary Update a project
+     * @param {ProjectPatchBody} [projectPatchBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * Update a project
+     */
+    update(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * @summary Upload a project image
+     * @param {Blob} [filename] filename of the file being uploaded
+     * @param {string} [name] general purpose name for multipart form value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApiInterface
+     */
+    updateImageRaw(requestParameters: ProjectsApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * Upload a project image
+     */
+    updateImage(requestParameters: ProjectsApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ *
+ */
+export declare class ProjectsApi extends runtime.BaseAPI implements ProjectsApiInterface {
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * Create a project
+     */
+    createRaw(requestParameters: ProjectsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * Create a project
+     */
+    create(requestParameters?: ProjectsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * Delete or archive a project
+     */
+    deleteRaw(requestParameters: ProjectsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * Delete or archive a project
+     */
+    delete(requestParameters?: ProjectsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * Delete the project image
+     */
+    deleteImageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * Delete the project image
+     */
+    deleteImage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * Get a project
+     */
+    getRaw(requestParameters: ProjectsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectChangelogBody>>;
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * Get a project
+     */
+    get(requestParameters?: ProjectsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectChangelogBody>;
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the project image
+     */
+    getImageRaw(requestParameters: ProjectsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the project image
+     */
+    getImage(requestParameters?: ProjectsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * List projects
+     */
+    listRaw(requestParameters: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectListRes>>;
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * List projects
+     */
+    list(requestParameters?: ProjectsApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectListRes>;
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * Update a project
+     */
+    updateRaw(requestParameters: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * Update a project
+     */
+    update(requestParameters?: ProjectsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * Upload a project image
+     */
+    updateImageRaw(requestParameters: ProjectsApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * Upload a project image
+     */
+    updateImage(requestParameters?: ProjectsApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ * @export
+ */
+export declare const ProjectsApiDeleteActionEnum: {
+    readonly Archive: "archive";
+    readonly Restore: "restore";
+    readonly Purge: "purge";
+};
+export type ProjectsApiDeleteActionEnum = typeof ProjectsApiDeleteActionEnum[keyof typeof ProjectsApiDeleteActionEnum];

package/dist/esm/apis/ProjectsApi.js

@@ -0,0 +1,366 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { ProjectChangelogBodyFromJSON, ProjectCreateBodyToJSON, ProjectListResFromJSON, ProjectPatchBodyToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ProjectsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * Create a project
+     */
+    createRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/projects`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ProjectCreateBodyToJSON(requestParameters['projectCreateBody']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a new project for the current account and returns its numeric ID. The project can be blank, duplicated from an existing project within the same account, or initialised from a template project (built-in starting points). When copying from a template or duplicate, dashboards are copied across and their scenario and property references are remapped according to the supplied mapping. Returns `400` if the template project\'s own filters reference a property or object group that the mapping leaves unmapped. Unless the account has the *Variable controls* permission, controls cards are omitted from copied dashboards and inline controls are removed from their visualisation cards. Requires the *Manage projects* permission.
+     * Create a project
+     */
+    create() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * Delete or archive a project
+     */
+    deleteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['action'] != null) {
+                queryParameters['action'] = requestParameters['action'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/project`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Archives, restores, or permanently deletes the current project depending on the `action` query parameter. Permanent deletion also removes all dashboards belonging to the project. Returns `404` if the project does not exist. Requires the *Manage projects* permission.
+     * Delete or archive a project
+     */
+    delete() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            yield this.deleteRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * Delete the project image
+     */
+    deleteImageRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/project/image`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Removes the custom cover image for the current project. After deletion, `GET /v1/project/image` returns a generated default image unless `noFallback` is set. Requires the *Manage projects* permission.
+     * Delete the project image
+     */
+    deleteImage(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteImageRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * Get a project
+     */
+    getRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['templateId'] != null) {
+                queryParameters['templateId'] = requestParameters['templateId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/project`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ProjectChangelogBodyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the projection for the current project. Pass `templateId` to retrieve a built-in template project instead. Returns `404` if the project does not exist. Requires the *View projects* permission.
+     * Get a project
+     */
+    get() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the project image
+     */
+    getImageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['noFallback'] != null) {
+                queryParameters['noFallback'] = requestParameters['noFallback'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/project/image`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Returns the project\'s custom cover image. If no image has been uploaded and `noFallback` is not set, a default image is generated from the project name and returned instead. The response `Content-Type` header reflects the actual image format. Requires the *View projects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the project image
+     */
+    getImage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * List projects
+     */
+    listRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['showTemplate'] != null) {
+                queryParameters['showTemplate'] = requestParameters['showTemplate'];
+            }
+            if (requestParameters['showArchived'] != null) {
+                queryParameters['showArchived'] = requestParameters['showArchived'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/projects`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ProjectListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns all active projects for the current account, sorted alphabetically by name. Pass `showTemplate=true` to list the built-in template projects instead. Pass `showArchived=true` to list only archived projects. Requires the *View projects* permission.
+     * List projects
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * Update a project
+     */
+    updateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/project`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ProjectPatchBodyToJSON(requestParameters['projectPatchBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates the name, description, default filters, or variables of the current project. Only fields present in the request body are changed; set `keepFilters` to preserve filters when `filters` is sent only for schema compatibility. Returns `404` if the project does not exist, and `409` if it keeps changing concurrently; retry the request. Variables keyed `account:<id>` override the value of that account variable for this project; their type and range come from the account definition. Other variable IDs must not contain `:`. Requires the *Manage projects* permission.
+     * Update a project
+     */
+    update() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * Upload a project image
+     */
+    updateImageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['filename'] != null) {
+                formParams.append('filename', requestParameters['filename']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            let urlPath = `/v1/project/image`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Uploads a custom cover image for the current project. Send the file as `multipart/form-data` with the field key `img`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Manage projects* permission.
+     * Upload a project image
+     */
+    updateImage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.updateImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ProjectsApiDeleteActionEnum = {
+    Archive: 'archive',
+    Restore: 'restore',
+    Purge: 'purge'
+};