@spaciv/sdk 0.0.0 → 0.1.0

package/dist/apis/VariablesApi.js

@@ -0,0 +1,266 @@
+"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.VariablesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class VariablesApi extends runtime.BaseAPI {
+    /**
+     * 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, 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/variables`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.VariableCreateToJSON)(requestParameters['variableCreate']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * 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() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, 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 = {};
+            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/variables/{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.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * 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, 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/variables/{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) => (0, index_1.VariableResFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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) {
+        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/variables`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.VariableListResFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, 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 listReferences().');
+            }
+            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/variables/{id}/references`;
+            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) => (0, index_1.ReferencesResFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listReferencesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, 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/variables/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.VariablePatchToJSON)(requestParameters['variablePatch']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.VariablesApi = VariablesApi;

package/dist/apis/index.d.ts

@@ -0,0 +1,28 @@
+export * from './AccountsApi';
+export * from './AnalysisApi';
+export * from './AssistantApi';
+export * from './AuditLogApi';
+export * from './AuthenticationApi';
+export * from './BrandingApi';
+export * from './ContributionsApi';
+export * from './DashboardsApi';
+export * from './DataCollectionApi';
+export * from './DatasetsApi';
+export * from './FilesApi';
+export * from './FloorPlansApi';
+export * from './IntegrationsApi';
+export * from './InternalApi';
+export * from './LocalisationApi';
+export * from './LookupsApi';
+export * from './NeedsApi';
+export * from './ObjectGroupsApi';
+export * from './ProjectsApi';
+export * from './PropertiesApi';
+export * from './ReportsApi';
+export * from './ScenariosApi';
+export * from './ServiceApi';
+export * from './SpaceRulesetsApi';
+export * from './TemplateProjectsApi';
+export * from './TopDownModelsApi';
+export * from './UsersApi';
+export * from './VariablesApi';

package/dist/apis/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AccountsApi"), exports);
+__exportStar(require("./AnalysisApi"), exports);
+__exportStar(require("./AssistantApi"), exports);
+__exportStar(require("./AuditLogApi"), exports);
+__exportStar(require("./AuthenticationApi"), exports);
+__exportStar(require("./BrandingApi"), exports);
+__exportStar(require("./ContributionsApi"), exports);
+__exportStar(require("./DashboardsApi"), exports);
+__exportStar(require("./DataCollectionApi"), exports);
+__exportStar(require("./DatasetsApi"), exports);
+__exportStar(require("./FilesApi"), exports);
+__exportStar(require("./FloorPlansApi"), exports);
+__exportStar(require("./IntegrationsApi"), exports);
+__exportStar(require("./InternalApi"), exports);
+__exportStar(require("./LocalisationApi"), exports);
+__exportStar(require("./LookupsApi"), exports);
+__exportStar(require("./NeedsApi"), exports);
+__exportStar(require("./ObjectGroupsApi"), exports);
+__exportStar(require("./ProjectsApi"), exports);
+__exportStar(require("./PropertiesApi"), exports);
+__exportStar(require("./ReportsApi"), exports);
+__exportStar(require("./ScenariosApi"), exports);
+__exportStar(require("./ServiceApi"), exports);
+__exportStar(require("./SpaceRulesetsApi"), exports);
+__exportStar(require("./TemplateProjectsApi"), exports);
+__exportStar(require("./TopDownModelsApi"), exports);
+__exportStar(require("./UsersApi"), exports);
+__exportStar(require("./VariablesApi"), exports);

package/dist/esm/apiKeyAuth.d.ts

@@ -0,0 +1,24 @@
+import * as apis from './apis';
+import { AuthenticationApi } from './apis/AuthenticationApi';
+import { BaseAPI, Configuration, ConfigurationParameters } from './runtime';
+export declare const TOKEN_EXPIRY_SKEW_MS = 30000;
+export declare class ApiKeyTokenSource {
+    private readonly apiKey;
+    private readonly authApi;
+    private token?;
+    private expiresAt;
+    private pending?;
+    constructor(apiKey: string, authApi: AuthenticationApi);
+    getToken(rejected?: string): Promise<string>;
+    private exchange;
+}
+export declare function apiKeyConfiguration(apiKey: string, params?: ConfigurationParameters): Configuration;
+type ApiConstructor = new (configuration: Configuration) => BaseAPI;
+type ApiClasses = {
+    [K in keyof typeof apis as (typeof apis)[K] extends ApiConstructor ? K : never]: (typeof apis)[K];
+};
+export type SpacivClient = {
+    [K in keyof ApiClasses as K extends `${infer Name}Api` ? Uncapitalize<Name> : never]: InstanceType<ApiClasses[K]>;
+};
+export declare function apiKeyClient(apiKey: string, params?: ConfigurationParameters): SpacivClient;
+export {};

package/dist/esm/apiKeyAuth.js

@@ -0,0 +1,99 @@
+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());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import * as apis from './apis';
+import { AuthenticationApi } from './apis/AuthenticationApi';
+import { BaseAPI, Configuration } from './runtime';
+export const TOKEN_EXPIRY_SKEW_MS = 30000;
+export class ApiKeyTokenSource {
+    constructor(apiKey, authApi) {
+        this.apiKey = apiKey;
+        this.authApi = authApi;
+        this.expiresAt = 0;
+    }
+    getToken(rejected) {
+        if (this.pending) {
+            return this.pending;
+        }
+        if (this.token && this.token !== rejected && Date.now() + TOKEN_EXPIRY_SKEW_MS < this.expiresAt) {
+            return Promise.resolve(this.token);
+        }
+        this.pending = this.exchange();
+        return this.pending;
+    }
+    exchange() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { accessToken } = yield this.authApi.createAuthApiKeyToken({
+                    authAPIKeyTokenReqBody: { key: this.apiKey },
+                });
+                this.token = accessToken;
+                this.expiresAt = tokenExpiry(accessToken);
+                return accessToken;
+            }
+            finally {
+                this.pending = undefined;
+            }
+        });
+    }
+}
+export function apiKeyConfiguration(apiKey, params = {}) {
+    var _a, _b;
+    const { accessToken: _ignored } = params, rest = __rest(params, ["accessToken"]);
+    const tokens = new ApiKeyTokenSource(apiKey, new AuthenticationApi(new Configuration(rest)));
+    const fetchApi = (_a = params.fetchApi) !== null && _a !== void 0 ? _a : ((url, init) => fetch(url, init));
+    const retryUnauthorized = {
+        post(_a) {
+            return __awaiter(this, arguments, void 0, function* ({ url, init, response }) {
+                const headers = Object.assign({}, init.headers);
+                const sent = headers['Authorization'];
+                if (response.status !== 401 || !sent) {
+                    return response;
+                }
+                const rejected = sent.replace(/^Bearer /, '');
+                const token = yield tokens.getToken(rejected);
+                headers['Authorization'] = `Bearer ${token}`;
+                return fetchApi(url, Object.assign(Object.assign({}, init), { headers }));
+            });
+        },
+    };
+    return new Configuration(Object.assign(Object.assign({}, rest), { accessToken: () => tokens.getToken(), middleware: [retryUnauthorized, ...((_b = params.middleware) !== null && _b !== void 0 ? _b : [])] }));
+}
+export function apiKeyClient(apiKey, params = {}) {
+    const configuration = apiKeyConfiguration(apiKey, params);
+    const client = {};
+    for (const name of Object.keys(apis)) {
+        const Api = apis[name];
+        if (typeof Api === 'function' && Api.prototype instanceof BaseAPI && name.endsWith('Api')) {
+            client[name.charAt(0).toLowerCase() + name.slice(1, -'Api'.length)] = new Api(configuration);
+        }
+    }
+    return client;
+}
+function tokenExpiry(token) {
+    try {
+        const payload = token.split('.')[1].replace(/-/g, '+').replace(/_/g, '/');
+        const exp = JSON.parse(atob(payload + '='.repeat((4 - (payload.length % 4)) % 4))).exp;
+        return typeof exp === 'number' ? exp * 1000 : 0;
+    }
+    catch (_a) {
+        return 0;
+    }
+}