@spaciv/sdk 0.0.0 → 0.1.0

package/dist/apis/TopDownModelsApi.js

@@ -0,0 +1,413 @@
+"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.TopDownModelsApiDeleteActionEnum = exports.TopDownModelsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class TopDownModelsApi extends runtime.BaseAPI {
+    /**
+     * Creates a ratio-driven space model for the account. Returns the UUID of the new model.  When the `propertyId` matches a recognised needs property (such as `activity` or `location`), a default entry with industry-average values is automatically created. Requires the *Edit modification* permission.
+     * Create a top-down model
+     */
+    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/top-down-models`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.TopDownModelChangelogBodyToJSON)(requestParameters['topDownModelChangelogBody']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a ratio-driven space model for the account. Returns the UUID of the new model.  When the `propertyId` matches a recognised needs property (such as `activity` or `location`), a default entry with industry-average values is automatically created. Requires the *Edit modification* permission.
+     * Create a top-down model
+     */
+    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 top-down model. 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 model and all its entries. Requires the *Edit modification* permission.
+     * Delete or archive a top-down model
+     */
+    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/top-down-models/{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);
+        });
+    }
+    /**
+     * Controls the lifecycle of a top-down model. 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 model and all its entries. Requires the *Edit modification* permission.
+     * Delete or archive a top-down model
+     */
+    delete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Permanently removes one or more entries from the specified top-down model. The request body is an array of entry IDs to delete. Requires the *Edit modification* permission.
+     * Delete top-down model entries
+     */
+    deleteEntriesRaw(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 deleteEntries().');
+            }
+            if (requestParameters['requestBody'] == null) {
+                throw new runtime.RequiredError('requestBody', 'Required parameter "requestBody" was null or undefined when calling deleteEntries().');
+            }
+            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/top-down-models/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['requestBody'],
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Permanently removes one or more entries from the specified top-down model. The request body is an array of entry IDs to delete. Requires the *Edit modification* permission.
+     * Delete top-down model entries
+     */
+    deleteEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteEntriesRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates a full copy of the specified top-down model, including all its entries. The copy is named \"Copy of <original name>\". Returns the UUID of the new model. Requires the *Edit modification* permission.
+     * Duplicate a top-down model
+     */
+    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/top-down-models/{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 full copy of the specified top-down model, including all its entries. The copy is named \"Copy of <original name>\". Returns the UUID of the new model. Requires the *Edit modification* permission.
+     * Duplicate a top-down model
+     */
+    duplicate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.duplicateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the top-down model identified by `id`. Requires the *View modification* permission.  Returns `404` if the model does not exist or belongs to a different account.
+     * Get a top-down model
+     */
+    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/top-down-models/{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.TopDownModelChangelogBodyFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the top-down model identified by `id`. Requires the *View modification* permission.  Returns `404` if the model does not exist or belongs to a different account.
+     * Get a top-down model
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all top-down models for the account, sorted alphabetically by name. By default only active models are returned; set `showArchived=true` to list archived models instead. Requires the *View modification* permission.
+     * List top-down models
+     */
+    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/top-down-models`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.TopDownModelEntryFromJSON));
+        });
+    }
+    /**
+     * Returns all top-down models for the account, sorted alphabetically by name. By default only active models are returned; set `showArchived=true` to list archived models instead. Requires the *View modification* permission.
+     * List top-down models
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns entries belonging to the specified top-down model, along with the total entry count. Each entry describes a cohort of people and the property values assigned to them.  Paging is optional: omitting `limit`, or passing 0, returns every entry from `start`. Requires the *View modification* permission.
+     * List entries of a top-down model
+     */
+    listEntriesRaw(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 listEntries().');
+            }
+            const queryParameters = {};
+            if (requestParameters['start'] != null) {
+                queryParameters['start'] = requestParameters['start'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            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/top-down-models/{id}/entries`;
+            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.GetTopDownModelEntriesResFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns entries belonging to the specified top-down model, along with the total entry count. Each entry describes a cohort of people and the property values assigned to them.  Paging is optional: omitting `limit`, or passing 0, returns every entry from `start`. Requires the *View modification* permission.
+     * List entries of a top-down model
+     */
+    listEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listEntriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the name and/or description of the specified top-down model. Only non-empty fields in the request body are applied. Requires the *Edit modification* permission.
+     * Update a top-down model
+     */
+    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/top-down-models/{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.TopDownModelChangelogBodyToJSON)(requestParameters['topDownModelChangelogBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates the name and/or description of the specified top-down model. Only non-empty fields in the request body are applied. Requires the *Edit modification* permission.
+     * Update a top-down model
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
+     * Create or update a top-down model entry
+     */
+    updateEntriesRaw(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 updateEntries().');
+            }
+            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/top-down-models/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.TopDownModelEntryUpdateToJSON)(requestParameters['topDownModelEntryUpdate']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
+     * Create or update a top-down model entry
+     */
+    updateEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateEntriesRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.TopDownModelsApi = TopDownModelsApi;
+/**
+ * @export
+ */
+exports.TopDownModelsApiDeleteActionEnum = {
+    Archive: 'archive',
+    Restore: 'restore',
+    Purge: 'purge'
+};