@spaciv/sdk 0.0.0-stage → 0.1.0

package/dist/apis/UsersApi.js

@@ -0,0 +1,417 @@
+"use strict";
+/* 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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsersApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class UsersApi extends runtime.BaseAPI {
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * Register a new user
+     */
+    createRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['userV2PostReqBody'] == null) {
+                throw new runtime.RequiredError('userV2PostReqBody', 'Required parameter "userV2PostReqBody" was null or undefined when calling create().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/users`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UserV2PostReqBodyToJSON)(requestParameters['userV2PostReqBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * Register a new user
+     */
+    create(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * Bulk import users
+     */
+    createImportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['importBody'] == null) {
+                throw new runtime.RequiredError('importBody', 'Required parameter "importBody" was null or undefined when calling createImport().');
+            }
+            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/users/import`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['importBody'].map(index_1.ImportBodyToJSON),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * Bulk import users
+     */
+    createImport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createImportRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Delete the current user\'s account
+     */
+    deleteRaw(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/user`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Delete the current user\'s account
+     */
+    delete(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteRaw(initOverrides);
+        });
+    }
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * Delete the current user\'s profile 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/user/image`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * Delete the current user\'s profile image
+     */
+    deleteImage(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteImageRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * Get the current user\'s profile
+     */
+    getRaw(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/user`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserV2GetResBodyFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * Get the current user\'s profile
+     */
+    get(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular 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 a user\'s profile image
+     */
+    getImageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['id'] != null) {
+                queryParameters['id'] = requestParameters['id'];
+            }
+            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/user/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 raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular 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 a user\'s profile image
+     */
+    getImage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * List users in the current account
+     */
+    listRaw(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/users`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ListUserDetailsWithEmailRowFromJSON));
+        });
+    }
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * List users in the current account
+     */
+    list(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * List assignable roles
+     */
+    listUserRolesRaw(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/user-roles`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * List assignable roles
+     */
+    listUserRoles(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listUserRolesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * Update a user\'s profile or role
+     */
+    updateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['userV2PatchReqBody'] == null) {
+                throw new runtime.RequiredError('userV2PatchReqBody', 'Required parameter "userV2PatchReqBody" was null or undefined when calling update().');
+            }
+            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/user`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UserV2PatchReqBodyToJSON)(requestParameters['userV2PatchReqBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * Update a user\'s profile or role
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * Upload a profile 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/user/image`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * Upload a profile image
+     */
+    updateImage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.updateImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.UsersApi = UsersApi;

package/dist/apis/VariablesApi.d.ts

@@ -0,0 +1,186 @@
+/**
+ * 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 { ReferencesRes, VariableCreate, VariableListRes, VariablePatch, VariableRes } from '../models/index';
+export interface VariablesApiCreateRequest {
+    variableCreate?: VariableCreate;
+}
+export interface VariablesApiDeleteRequest {
+    id: string;
+}
+export interface VariablesApiGetRequest {
+    id: string;
+}
+export interface VariablesApiListReferencesRequest {
+    id: string;
+}
+export interface VariablesApiUpdateRequest {
+    id: string;
+    variablePatch?: VariablePatch;
+}
+/**
+ * VariablesApi - interface
+ *
+ * @export
+ * @interface VariablesApiInterface
+ */
+export interface VariablesApiInterface {
+    /**
+     * Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
+     * @summary Create an account variable
+     * @param {VariableCreate} [variableCreate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
+     * Create an account variable
+     */
+    create(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Deletes an account-level variable. Returns `409` while the variable is referenced by a project override, project filter, dashboard or other entity; each entry of `errors` carries the reference in `value`, or only the count is given when the caller lacks the *View projects* permission. Requires the *Manage my account* permission.
+     * @summary Delete an account variable
+     * @param {string} id Account variable ID, either qualified (account:&lt;id&gt;) or bare.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    deleteRaw(requestParameters: VariablesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an account-level variable. Returns `409` while the variable is referenced by a project override, project filter, dashboard or other entity; each entry of `errors` carries the reference in `value`, or only the count is given when the caller lacks the *View projects* permission. Requires the *Manage my account* permission.
+     * Delete an account variable
+     */
+    delete(requestParameters: VariablesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a single account-level variable with its qualified `account:<id>` ID. Returns `404` if it does not exist. Requires the *View projects* permission.
+     * @summary Get an account variable
+     * @param {string} id Account variable ID, either qualified (account:&lt;id&gt;) or bare.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    getRaw(requestParameters: VariablesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariableRes>>;
+    /**
+     * Returns a single account-level variable with its qualified `account:<id>` ID. Returns `404` if it does not exist. Requires the *View projects* permission.
+     * Get an account variable
+     */
+    get(requestParameters: VariablesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableRes>;
+    /**
+     * Returns the account-level variables shared by every project in the account, sorted by name. IDs are qualified as `account:<id>`; use that form when referencing the variable from a project, dashboard or URL override. Project variables are returned by `GET /v1/project`. Requires the *View projects* permission.
+     * @summary List account variables
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariableListRes>>;
+    /**
+     * Returns the account-level variables shared by every project in the account, sorted by name. IDs are qualified as `account:<id>`; use that form when referencing the variable from a project, dashboard or URL override. Project variables are returned by `GET /v1/project`. Requires the *View projects* permission.
+     * List account variables
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableListRes>;
+    /**
+     * Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations and the modifier formulas of layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
+     * @summary List account variable references
+     * @param {string} id Account variable ID, either qualified (account:&lt;id&gt;) or bare.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>>;
+    /**
+     * Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations and the modifier formulas of layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
+     * List account variable references
+     */
+    listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
+    /**
+     * Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
+     * @summary Update an account variable
+     * @param {string} id Account variable ID, either qualified (account:&lt;id&gt;) or bare.
+     * @param {VariablePatch} [variablePatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariablesApiInterface
+     */
+    updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
+     * Update an account variable
+     */
+    update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class VariablesApi extends runtime.BaseAPI implements VariablesApiInterface {
+    /**
+     * Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
+     * Create an account variable
+     */
+    createRaw(requestParameters: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates an account-level variable and returns its qualified `account:<id>` ID. `name` and `data` are required; number variables must satisfy their own range and step. Requires the *Manage my account* permission.
+     * Create an account variable
+     */
+    create(requestParameters?: VariablesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Deletes an account-level variable. Returns `409` while the variable is referenced by a project override, project filter, dashboard or other entity; each entry of `errors` carries the reference in `value`, or only the count is given when the caller lacks the *View projects* permission. Requires the *Manage my account* permission.
+     * Delete an account variable
+     */
+    deleteRaw(requestParameters: VariablesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an account-level variable. Returns `409` while the variable is referenced by a project override, project filter, dashboard or other entity; each entry of `errors` carries the reference in `value`, or only the count is given when the caller lacks the *View projects* permission. Requires the *Manage my account* permission.
+     * Delete an account variable
+     */
+    delete(requestParameters: VariablesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a single account-level variable with its qualified `account:<id>` ID. Returns `404` if it does not exist. Requires the *View projects* permission.
+     * Get an account variable
+     */
+    getRaw(requestParameters: VariablesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariableRes>>;
+    /**
+     * Returns a single account-level variable with its qualified `account:<id>` ID. Returns `404` if it does not exist. Requires the *View projects* permission.
+     * Get an account variable
+     */
+    get(requestParameters: VariablesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableRes>;
+    /**
+     * Returns the account-level variables shared by every project in the account, sorted by name. IDs are qualified as `account:<id>`; use that form when referencing the variable from a project, dashboard or URL override. Project variables are returned by `GET /v1/project`. Requires the *View projects* permission.
+     * List account variables
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariableListRes>>;
+    /**
+     * Returns the account-level variables shared by every project in the account, sorted by name. IDs are qualified as `account:<id>`; use that form when referencing the variable from a project, dashboard or URL override. Project variables are returned by `GET /v1/project`. Requires the *View projects* permission.
+     * List account variables
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableListRes>;
+    /**
+     * Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations and the modifier formulas of layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
+     * List account variable references
+     */
+    listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>>;
+    /**
+     * Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations and the modifier formulas of layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
+     * List account variable references
+     */
+    listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
+    /**
+     * Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
+     * Update an account variable
+     */
+    updateRaw(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates the name and/or default value of an account-level variable; the new default applies to every project that does not override it. Setting `delete` behaves like `DELETE /v1/variables/{id}`. Changing the variable\'s type, or deleting it, is rejected with `409` while it is referenced. Changing its data so that an existing project override no longer validates (for example, a narrower number `min`/`max` or a different `step`) is also rejected with `409`, listing the projects with invalid overrides. In both cases the error details list the references when the caller has the *View projects* permission, otherwise only their count. Requires the *Manage my account* permission.
+     * Update an account variable
+     */
+    update(requestParameters: VariablesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}