@spaciv/sdk 0.0.0 → 0.1.0

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

@@ -0,0 +1,164 @@
+/**
+ * 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 { IDNameStringString } from '../models/index';
+/**
+ * LookupsApi - interface
+ *
+ * @export
+ * @interface LookupsApiInterface
+ */
+export interface LookupsApiInterface {
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * @summary List availabilities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listAvailabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * List availabilities
+     */
+    listAvailabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * @summary List company sizes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listCompanySizesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * List company sizes
+     */
+    listCompanySizes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * @summary List countries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * List countries
+     */
+    listCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * @summary List industries
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listIndustriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * List industries
+     */
+    listIndustries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * @summary List job functions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listJobFunctionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * List job functions
+     */
+    listJobFunctions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * @summary List products
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LookupsApiInterface
+     */
+    listProductsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * List products
+     */
+    listProducts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+}
+/**
+ *
+ */
+export declare class LookupsApi extends runtime.BaseAPI implements LookupsApiInterface {
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * List availabilities
+     */
+    listAvailabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * List availabilities
+     */
+    listAvailabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * List company sizes
+     */
+    listCompanySizesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * List company sizes
+     */
+    listCompanySizes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * List countries
+     */
+    listCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * List countries
+     */
+    listCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * List industries
+     */
+    listIndustriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * List industries
+     */
+    listIndustries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * List job functions
+     */
+    listJobFunctionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * List job functions
+     */
+    listJobFunctions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * List products
+     */
+    listProductsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * List products
+     */
+    listProducts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+}

package/dist/esm/apis/LookupsApi.js

@@ -0,0 +1,239 @@
+/* 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 { IDNameStringStringFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class LookupsApi extends runtime.BaseAPI {
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * List availabilities
+     */
+    listAvailabilitiesRaw(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/lookups/availabilities`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns the configured availability tiers used to classify how often employees are in the office. The list is account-independent and driven by platform configuration. No authentication required.
+     * List availabilities
+     */
+    listAvailabilities(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listAvailabilitiesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * List company sizes
+     */
+    listCompanySizesRaw(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/lookups/company-sizes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IDNameStringStringFromJSON));
+        });
+    }
+    /**
+     * Returns the fixed set of headcount-band options (e.g. `1-10`, `51-200`) used to classify an organisation\'s size during onboarding. No authentication required.
+     * List company sizes
+     */
+    listCompanySizes(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCompanySizesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * List countries
+     */
+    listCountriesRaw(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/lookups/countries`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IDNameStringStringFromJSON));
+        });
+    }
+    /**
+     * Returns the full list of countries as ISO 3166-1 alpha-3 code / display-name pairs, used to populate country selection fields. No authentication required.
+     * List countries
+     */
+    listCountries(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCountriesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * List industries
+     */
+    listIndustriesRaw(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/lookups/industries`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IDNameStringStringFromJSON));
+        });
+    }
+    /**
+     * Returns the fixed list of industry classifications used to categorise an account during onboarding. No authentication required.
+     * List industries
+     */
+    listIndustries(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listIndustriesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * List job functions
+     */
+    listJobFunctionsRaw(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/lookups/job-functions`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IDNameStringStringFromJSON));
+        });
+    }
+    /**
+     * Returns the fixed set of workplace job-function options (e.g. `Corporate real estate`, `Facility management`) used during user onboarding. No authentication required.
+     * List job functions
+     */
+    listJobFunctions(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listJobFunctionsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * List products
+     */
+    listProductsRaw(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/lookups/products`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns the product tier identifiers (e.g. `starter`, `pro`) that determine which features are available to an account. No authentication required.
+     * List products
+     */
+    listProducts(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listProductsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { Contribution, EstimationPatch } from '../models/index';
+export interface NeedsApiGetEstimationsRequest {
+    id: string;
+    dataset: string;
+    group: string;
+    node: string;
+}
+export interface NeedsApiUpdateRequest {
+    id: string;
+    node?: string;
+    estimationPatch?: EstimationPatch;
+}
+/**
+ * NeedsApi - interface
+ *
+ * @export
+ * @interface NeedsApiInterface
+ */
+export interface NeedsApiInterface {
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * @summary Get a need estimation
+     * @param {string} id
+     * @param {string} dataset Dataset identifier; must match the top-down model\&#39;s propertyId.
+     * @param {string} group Aggregation scope; currently only \&quot;all\&quot; is supported.
+     * @param {string} node Entry ID within the top-down model whose contribution values are returned.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NeedsApiInterface
+     */
+    getEstimationsRaw(requestParameters: NeedsApiGetEstimationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Contribution>>;
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * Get a need estimation
+     */
+    getEstimations(requestParameters: NeedsApiGetEstimationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Contribution>;
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * @summary Update a need estimation
+     * @param {string} id
+     * @param {string} [node] Entry ID within the top-down model to apply the estimation to.
+     * @param {EstimationPatch} [estimationPatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NeedsApiInterface
+     */
+    updateRaw(requestParameters: NeedsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * Update a need estimation
+     */
+    update(requestParameters: NeedsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class NeedsApi extends runtime.BaseAPI implements NeedsApiInterface {
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * Get a need estimation
+     */
+    getEstimationsRaw(requestParameters: NeedsApiGetEstimationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Contribution>>;
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * Get a need estimation
+     */
+    getEstimations(requestParameters: NeedsApiGetEstimationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Contribution>;
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * Update a need estimation
+     */
+    updateRaw(requestParameters: NeedsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * Update a need estimation
+     */
+    update(requestParameters: NeedsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/esm/apis/NeedsApi.js

@@ -0,0 +1,123 @@
+/* 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 { ContributionFromJSON, EstimationPatchToJSON, } from '../models/index';
+/**
+ *
+ */
+export class NeedsApi extends runtime.BaseAPI {
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * Get a need estimation
+     */
+    getEstimationsRaw(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 getEstimations().');
+            }
+            if (requestParameters['dataset'] == null) {
+                throw new runtime.RequiredError('dataset', 'Required parameter "dataset" was null or undefined when calling getEstimations().');
+            }
+            if (requestParameters['group'] == null) {
+                throw new runtime.RequiredError('group', 'Required parameter "group" was null or undefined when calling getEstimations().');
+            }
+            if (requestParameters['node'] == null) {
+                throw new runtime.RequiredError('node', 'Required parameter "node" was null or undefined when calling getEstimations().');
+            }
+            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/needs/{id}/estimations/{dataset}/{group}/{node}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            urlPath = urlPath.replace(`{${"dataset"}}`, encodeURIComponent(String(requestParameters['dataset'])));
+            urlPath = urlPath.replace(`{${"group"}}`, encodeURIComponent(String(requestParameters['group'])));
+            urlPath = urlPath.replace(`{${"node"}}`, encodeURIComponent(String(requestParameters['node'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ContributionFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the current contribution data for a single entry of a top-down model, expressed in the format expected by the contribution UI. The `dataset` path segment must match the model\'s `propertyId` and `group` must be `all`. Returns `400` naming the layer, entry and node if the entry holds a modifier whose formula is not a plain number, since estimations can only be expressed as constants. Requires the *View user needs scenarios* permission.
+     * Get a need estimation
+     */
+    getEstimations(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEstimationsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * Update a need estimation
+     */
+    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 = {};
+            if (requestParameters['node'] != null) {
+                queryParameters['node'] = requestParameters['node'];
+            }
+            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/needs/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: EstimationPatchToJSON(requestParameters['estimationPatch']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Applies an estimation update to a single entry (node) of a top-down model. Pass `setDefault=true` in the body to restore industry-average values for the relevant dataset, or `delete=true` to remove the entry entirely. Unless deleting, returns `400` naming the layer, entry and node if the existing entry holds a modifier whose formula is not a plain number. Requires the *Edit user needs scenarios* permission.
+     * Update a need estimation
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+}