@spaciv/sdk 0.0.0 → 0.1.0

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

@@ -0,0 +1,224 @@
+/**
+ * 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 { LayerVariablesRes, ScenarioChangelogBody, ScenarioCreate, ScenarioListRes, ScenarioPatch } from '../models/index';
+export interface ScenariosApiCreateRequest {
+    scenarioCreate?: ScenarioCreate;
+}
+export interface ScenariosApiDeleteRequest {
+    id: string;
+    action?: ScenariosApiDeleteActionEnum;
+}
+export interface ScenariosApiDuplicateRequest {
+    id: string;
+}
+export interface ScenariosApiGetRequest {
+    id: string;
+}
+export interface ScenariosApiListRequest {
+    showArchived?: boolean;
+}
+export interface ScenariosApiUpdateRequest {
+    id: string;
+    scenarioPatch?: ScenarioPatch;
+}
+/**
+ * ScenariosApi - interface
+ *
+ * @export
+ * @interface ScenariosApiInterface
+ */
+export interface ScenariosApiInterface {
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * @summary Create a scenario
+     * @param {ScenarioCreate} [scenarioCreate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Create a scenario
+     */
+    create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * @summary Delete or archive a scenario
+     * @param {string} id
+     * @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \&quot;archive\&quot; moves the scenario to the archive, \&quot;restore\&quot; returns it to active, and \&quot;purge\&quot; permanently deletes it. Defaults to \&quot;purge\&quot; when omitted.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * Delete or archive a scenario
+     */
+    delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * @summary Duplicate a scenario
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    duplicateRaw(requestParameters: ScenariosApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * Duplicate a scenario
+     */
+    duplicate(requestParameters: ScenariosApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * @summary Get a scenario
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    getRaw(requestParameters: ScenariosApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScenarioChangelogBody>>;
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * Get a scenario
+     */
+    get(requestParameters: ScenariosApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioChangelogBody>;
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * @summary List scenarios
+     * @param {boolean} [showArchived]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    listRaw(requestParameters: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScenarioListRes>>;
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * List scenarios
+     */
+    list(requestParameters: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioListRes>;
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * @summary List account variables used by scenario layers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>>;
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * List account variables used by scenario layers
+     */
+    listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * @summary Update a scenario
+     * @param {string} id
+     * @param {ScenarioPatch} [scenarioPatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScenariosApiInterface
+     */
+    updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Update a scenario
+     */
+    update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ *
+ */
+export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterface {
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Create a scenario
+     */
+    createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Create a scenario
+     */
+    create(requestParameters?: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * Delete or archive a scenario
+     */
+    deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * Delete or archive a scenario
+     */
+    delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * Duplicate a scenario
+     */
+    duplicateRaw(requestParameters: ScenariosApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * Duplicate a scenario
+     */
+    duplicate(requestParameters: ScenariosApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * Get a scenario
+     */
+    getRaw(requestParameters: ScenariosApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScenarioChangelogBody>>;
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * Get a scenario
+     */
+    get(requestParameters: ScenariosApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioChangelogBody>;
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * List scenarios
+     */
+    listRaw(requestParameters: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScenarioListRes>>;
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * List scenarios
+     */
+    list(requestParameters?: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioListRes>;
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * List account variables used by scenario layers
+     */
+    listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>>;
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * List account variables used by scenario layers
+     */
+    listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Update a scenario
+     */
+    updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Update a scenario
+     */
+    update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ * @export
+ */
+export declare const ScenariosApiDeleteActionEnum: {
+    readonly Archive: "archive";
+    readonly Restore: "restore";
+    readonly Purge: "purge";
+};
+export type ScenariosApiDeleteActionEnum = typeof ScenariosApiDeleteActionEnum[keyof typeof ScenariosApiDeleteActionEnum];

package/dist/esm/apis/ScenariosApi.js

@@ -0,0 +1,318 @@
+/* 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 { LayerVariablesResFromJSON, ScenarioChangelogBodyFromJSON, ScenarioCreateToJSON, ScenarioListResFromJSON, ScenarioPatchToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ScenariosApi extends runtime.BaseAPI {
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Create a scenario
+     */
+    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/scenarios`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ScenarioCreateToJSON(requestParameters['scenarioCreate']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Create a scenario
+     */
+    create() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * Delete or archive a scenario
+     */
+    deleteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling delete().');
+            }
+            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/scenarios/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
+     * Delete or archive a scenario
+     */
+    delete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * Duplicate a scenario
+     */
+    duplicateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling duplicate().');
+            }
+            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/scenarios/{id}/duplicate`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a copy of the specified scenario named \"Copy of <original name>\". Returns the UUID of the new scenario. Requires the *Edit scenario planning* permission.
+     * Duplicate a scenario
+     */
+    duplicate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.duplicateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * Get a scenario
+     */
+    getRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling get().');
+            }
+            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/scenarios/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ScenarioChangelogBodyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the scenario identified by `id`. Returns `404` if the scenario does not exist. Requires the *View scenario planning* permission.
+     * Get a scenario
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * List scenarios
+     */
+    listRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            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/scenarios`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ScenarioListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns all scenarios for the account, sorted alphabetically by name. By default only active scenarios are returned; set `showArchived=true` to list archived scenarios instead. Requires the *View scenario planning* permission.
+     * List scenarios
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * List account variables used by scenario layers
+     */
+    listLayerVariablesRaw(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/layer-variables`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => LayerVariablesResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
+     * List account variables used by scenario layers
+     */
+    listLayerVariables(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listLayerVariablesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Update a scenario
+     */
+    updateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" 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/scenarios/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ScenarioPatchToJSON(requestParameters['scenarioPatch']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
+     * Update a scenario
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ScenariosApiDeleteActionEnum = {
+    Archive: 'archive',
+    Restore: 'restore',
+    Purge: 'purge'
+};

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

@@ -0,0 +1,72 @@
+/**
+ * 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 { MetaVersionResponse } from '../models/index';
+/**
+ * ServiceApi - interface
+ *
+ * @export
+ * @interface ServiceApiInterface
+ */
+export interface ServiceApiInterface {
+    /**
+     * Returns `ok` when the API is running and reachable. No authentication required. Use as a liveness probe.
+     * @summary Check service health
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServiceApiInterface
+     */
+    getRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns `ok` when the API is running and reachable. No authentication required. Use as a liveness probe.
+     * Check service health
+     */
+    get(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the release version of the Spaciv platform, which is independent of the `/v1` API version in the path, and the minimum frontend compatibility version. No authentication required.
+     * @summary Get release version
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServiceApiInterface
+     */
+    getVersionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetaVersionResponse>>;
+    /**
+     * Returns the release version of the Spaciv platform, which is independent of the `/v1` API version in the path, and the minimum frontend compatibility version. No authentication required.
+     * Get release version
+     */
+    getVersion(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetaVersionResponse>;
+}
+/**
+ *
+ */
+export declare class ServiceApi extends runtime.BaseAPI implements ServiceApiInterface {
+    /**
+     * Returns `ok` when the API is running and reachable. No authentication required. Use as a liveness probe.
+     * Check service health
+     */
+    getRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns `ok` when the API is running and reachable. No authentication required. Use as a liveness probe.
+     * Check service health
+     */
+    get(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the release version of the Spaciv platform, which is independent of the `/v1` API version in the path, and the minimum frontend compatibility version. No authentication required.
+     * Get release version
+     */
+    getVersionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetaVersionResponse>>;
+    /**
+     * Returns the release version of the Spaciv platform, which is independent of the `/v1` API version in the path, and the minimum frontend compatibility version. No authentication required.
+     * Get release version
+     */
+    getVersion(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetaVersionResponse>;
+}