@spaciv/sdk 0.0.0 → 0.1.0

package/dist/apis/InternalApi.js

@@ -0,0 +1,450 @@
+"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.InternalApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class InternalApi extends runtime.BaseAPI {
+    /**
+     * Returns all feature flags grouped by availability tier, product, and role, together with a mapping from feature index to feature name. Used by the spaciv admin tooling to manage which features are enabled per group. Requires the *Feature management* and *Sys admin* permissions.
+     * List feature groups
+     */
+    createAdminFeatureGroupsRaw(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/admin/feature-groups`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FeatureGroupsResBodyFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns all feature flags grouped by availability tier, product, and role, together with a mapping from feature index to feature name. Used by the spaciv admin tooling to manage which features are enabled per group. Requires the *Feature management* and *Sys admin* permissions.
+     * List feature groups
+     */
+    createAdminFeatureGroups(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAdminFeatureGroupsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Triggers the event processor to re-attempt all events currently in the dead-letter queue. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Flush dead-letter events
+     */
+    createAdminFlushDeadLettersRaw(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/admin/flush-dead-letters`;
+            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);
+            }
+        });
+    }
+    /**
+     * Triggers the event processor to re-attempt all events currently in the dead-letter queue. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Flush dead-letter events
+     */
+    createAdminFlushDeadLetters(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAdminFlushDeadLettersRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Populate account from template
+     */
+    createAdminPopulateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['body'] == null) {
+                throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling createAdminPopulate().');
+            }
+            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/admin/populate`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Populate account from template
+     */
+    createAdminPopulate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createAdminPopulateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Compares the account file storage bucket with the file records, in both directions, and reports every difference. Requires the *Project admin controls* and *Sys admin* permissions.  An **orphan** is a stored object with no record. With `apply`, an orphan older than 24 hours is deleted after a system audit entry is written to its account\'s file audit trail; younger orphans may be uploads still in flight and are always kept. Orphans under an account that no longer exists, and keys that are not `account/{accountId}/{fileId}`, are reported and never deleted. Deleting an orphan never changes an account\'s storage usage, which counts records only.  A **dangling record** is a record whose object is missing. It is reported, and logged as an error, but never changed: it still counts towards the account\'s usage until it is deleted through the file delete operation.  Without `apply` nothing is changed. A run over every account may take minutes; pass `account` to limit it.  `apply` is refused with 403 unless the environment sets `SPACIV_FILE_STORAGE_RECONCILE_APPLY` to `true`. Production sets it to `false`.
+     * Reconcile account file storage
+     */
+    createAdminReconcileFileStorageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['apply'] != null) {
+                queryParameters['apply'] = requestParameters['apply'];
+            }
+            if (requestParameters['account'] != null) {
+                queryParameters['account'] = requestParameters['account'];
+            }
+            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/admin/reconcile-file-storage`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReconcileReportFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Compares the account file storage bucket with the file records, in both directions, and reports every difference. Requires the *Project admin controls* and *Sys admin* permissions.  An **orphan** is a stored object with no record. With `apply`, an orphan older than 24 hours is deleted after a system audit entry is written to its account\'s file audit trail; younger orphans may be uploads still in flight and are always kept. Orphans under an account that no longer exists, and keys that are not `account/{accountId}/{fileId}`, are reported and never deleted. Deleting an orphan never changes an account\'s storage usage, which counts records only.  A **dangling record** is a record whose object is missing. It is reported, and logged as an error, but never changed: it still counts towards the account\'s usage until it is deleted through the file delete operation.  Without `apply` nothing is changed. A run over every account may take minutes; pass `account` to limit it.  `apply` is refused with 403 unless the environment sets `SPACIV_FILE_STORAGE_RECONCILE_APPLY` to `true`. Production sets it to `false`.
+     * Reconcile account file storage
+     */
+    createAdminReconcileFileStorage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createAdminReconcileFileStorageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes all existing properties for the account and rebuilds them from the account\'s datasets and the defaults template. Also recreates any top-down-model predictions derived from those datasets. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Recreate properties from datasets
+     */
+    createAdminRecreatePropertiesRaw(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/admin/recreate-properties`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes all existing properties for the account and rebuilds them from the account\'s datasets and the defaults template. Also recreates any top-down-model predictions derived from those datasets. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Recreate properties from datasets
+     */
+    createAdminRecreateProperties(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createAdminRecreatePropertiesRaw(initOverrides);
+        });
+    }
+    /**
+     * Rewrites dashboard visualisations and project variables in the caller\'s account that still point at floor plans belonging to the template account they were copied from, and reports how many were repaired. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Repair floorplan references
+     */
+    createAdminRepairFloorplanReferencesRaw(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/admin/repair-floorplan-references`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RepairFloorplansResBodyFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Rewrites dashboard visualisations and project variables in the caller\'s account that still point at floor plans belonging to the template account they were copied from, and reports how many were repaired. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Repair floorplan references
+     */
+    createAdminRepairFloorplanReferences(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAdminRepairFloorplanReferencesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the events currently queued for retry in the event processor, including the original timestamp, the scheduled retry timestamp, and the last error. Requires the *Project admin controls* and *Sys admin* permissions.
+     * List pending retries
+     */
+    createAdminRetriesRaw(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/admin/retries`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RetriesResBodyFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the events currently queued for retry in the event processor, including the original timestamp, the scheduled retry timestamp, and the last error. Requires the *Project admin controls* and *Sys admin* permissions.
+     * List pending retries
+     */
+    createAdminRetries(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAdminRetriesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Toggles a single feature flag on or off for the specified role, availability tier, or product tier. Supply exactly one of `role`, `availability`, or `product`. Requires the *Feature management* and *Sys admin* permissions.
+     * Update a feature flag group assignment
+     */
+    createAdminUpdateFeatureGroupsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sysAdminUpdateFeatureGroupsParamsWrapperBody'] == null) {
+                throw new runtime.RequiredError('sysAdminUpdateFeatureGroupsParamsWrapperBody', 'Required parameter "sysAdminUpdateFeatureGroupsParamsWrapperBody" was null or undefined when calling createAdminUpdateFeatureGroups().');
+            }
+            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/admin/update-feature-groups`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.SysAdminUpdateFeatureGroupsParamsWrapperBodyToJSON)(requestParameters['sysAdminUpdateFeatureGroupsParamsWrapperBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Toggles a single feature flag on or off for the specified role, availability tier, or product tier. Supply exactly one of `role`, `availability`, or `product`. Requires the *Feature management* and *Sys admin* permissions.
+     * Update a feature flag group assignment
+     */
+    createAdminUpdateFeatureGroups(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createAdminUpdateFeatureGroupsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Downloads all translation key/value pairs for the given locale as a UTF-8 CSV file. Requires the *Sys admin* permission.
+     * Export translations as CSV
+     */
+    createTranslationsExportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['i18nTranslationsExportParamsWrapperBody'] == null) {
+                throw new runtime.RequiredError('i18nTranslationsExportParamsWrapperBody', 'Required parameter "i18nTranslationsExportParamsWrapperBody" was null or undefined when calling createTranslationsExport().');
+            }
+            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/translations/export`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.I18nTranslationsExportParamsWrapperBodyToJSON)(requestParameters['i18nTranslationsExportParamsWrapperBody']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Downloads all translation key/value pairs for the given locale as a UTF-8 CSV file. Requires the *Sys admin* permission.
+     * Export translations as CSV
+     */
+    createTranslationsExport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createTranslationsExportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Replaces the stored translations for the given locale with the rows supplied in `translations`. The first row is treated as a header and skipped. Requires the *Sys admin* permission.
+     * Import translations from CSV
+     */
+    createTranslationsImportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['i18nTranslationsImportParamsWrapperBody'] == null) {
+                throw new runtime.RequiredError('i18nTranslationsImportParamsWrapperBody', 'Required parameter "i18nTranslationsImportParamsWrapperBody" was null or undefined when calling createTranslationsImport().');
+            }
+            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/translations/import`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.I18nTranslationsImportParamsWrapperBodyToJSON)(requestParameters['i18nTranslationsImportParamsWrapperBody']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Replaces the stored translations for the given locale with the rows supplied in `translations`. The first row is treated as a header and skipped. Requires the *Sys admin* permission.
+     * Import translations from CSV
+     */
+    createTranslationsImport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createTranslationsImportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Dispatches events to regenerate any preset images and derived assets for the caller\'s account. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Regenerate customer preset assets
+     */
+    listAdminRegeneratePresetsRaw(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/admin/regenerate-presets`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Dispatches events to regenerate any preset images and derived assets for the caller\'s account. Requires the *Project admin controls* and *Sys admin* permissions.
+     * Regenerate customer preset assets
+     */
+    listAdminRegeneratePresets(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.listAdminRegeneratePresetsRaw(initOverrides);
+        });
+    }
+}
+exports.InternalApi = InternalApi;

package/dist/apis/LocalisationApi.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { I18nTranslationsParamsWrapperBody, IDNameStringString } from '../models/index';
+export interface LocalisationApiCreateTranslationsRequest {
+    i18nTranslationsParamsWrapperBody: I18nTranslationsParamsWrapperBody;
+}
+/**
+ * LocalisationApi - interface
+ *
+ * @export
+ * @interface LocalisationApiInterface
+ */
+export interface LocalisationApiInterface {
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * @summary Get translations
+     * @param {I18nTranslationsParamsWrapperBody} i18nTranslationsParamsWrapperBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LocalisationApiInterface
+     */
+    createTranslationsRaw(requestParameters: LocalisationApiCreateTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: string;
+    }>>;
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * Get translations
+     */
+    createTranslations(requestParameters: LocalisationApiCreateTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * @summary List available locales
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LocalisationApiInterface
+     */
+    listLocalesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * List available locales
+     */
+    listLocales(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+}
+/**
+ *
+ */
+export declare class LocalisationApi extends runtime.BaseAPI implements LocalisationApiInterface {
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * Get translations
+     */
+    createTranslationsRaw(requestParameters: LocalisationApiCreateTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: string;
+    }>>;
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * Get translations
+     */
+    createTranslations(requestParameters: LocalisationApiCreateTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * List available locales
+     */
+    listLocalesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IDNameStringString>>>;
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * List available locales
+     */
+    listLocales(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IDNameStringString>>;
+}

package/dist/apis/LocalisationApi.js

@@ -0,0 +1,101 @@
+"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.LocalisationApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class LocalisationApi extends runtime.BaseAPI {
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * Get translations
+     */
+    createTranslationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['i18nTranslationsParamsWrapperBody'] == null) {
+                throw new runtime.RequiredError('i18nTranslationsParamsWrapperBody', 'Required parameter "i18nTranslationsParamsWrapperBody" was null or undefined when calling createTranslations().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/translations`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.I18nTranslationsParamsWrapperBodyToJSON)(requestParameters['i18nTranslationsParamsWrapperBody']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Returns the full map of translation keys to localised strings for the requested locale. Clients should call this once on start-up and cache the result. No authentication required.
+     * Get translations
+     */
+    createTranslations(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createTranslationsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * List available locales
+     */
+    listLocalesRaw(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/locales`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.IDNameStringStringFromJSON));
+        });
+    }
+    /**
+     * Returns the locale identifiers and display names that the product has translations for. Falls back to `en-gb` if no locales have been configured. No authentication required.
+     * List available locales
+     */
+    listLocales(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listLocalesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.LocalisationApi = LocalisationApi;