@spaciv/sdk 0.0.0 → 0.1.0

package/dist/esm/apis/DataCollectionApi.js

@@ -0,0 +1,345 @@
+/* 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 { DataCollectionAddResponseBodyFromJSON, DatacollectionBodyToJSON, GetContributionListResFromJSON, GetDatacollectionListResFromJSON, GetDatacollectionResFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DataCollectionApi extends runtime.BaseAPI {
+    /**
+     * Creates a new survey in draft status with a placeholder name. Use `PATCH /v1/data-collections/{id}` to configure its name, steps, and authentication mode before distributing it. Requires the *Configure crowd modelling* permission.
+     * Create a data collection survey
+     */
+    createRaw(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/data-collections`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataCollectionAddResponseBodyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new survey in draft status with a placeholder name. Use `PATCH /v1/data-collections/{id}` to configure its name, steps, and authentication mode before distributing it. Requires the *Configure crowd modelling* permission.
+     * Create a data collection survey
+     */
+    create(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Permanently deletes the survey and its associated contribution data. This action cannot be undone. Requires the *Configure crowd modelling* permission.
+     * Delete a data collection survey
+     */
+    deleteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling delete().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-collections/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Permanently deletes the survey and its associated contribution data. This action cannot be undone. Requires the *Configure crowd modelling* permission.
+     * Delete a data collection survey
+     */
+    delete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling* permission.
+     * Get a data collection survey
+     */
+    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/data-collections/{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) => GetDatacollectionResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling* permission.
+     * Get a data collection survey
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the URL contributors follow to open the survey. The link format depends on the survey\'s authentication mode: email-authenticated surveys redirect through activation, anonymous surveys go to sign-in, and public surveys go to a public activation page. Returns an empty string if the authentication mode is not yet configured. Requires the *View crowd modelling* permission.
+     * Get a survey\'s invitation link
+     */
+    getLinkRaw(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 getLink().');
+            }
+            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/data-collections/{id}/link`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Returns the URL contributors follow to open the survey. The link format depends on the survey\'s authentication mode: email-authenticated surveys redirect through activation, anonymous surveys go to sign-in, and public surveys go to a public activation page. Returns an empty string if the authentication mode is not yet configured. Requires the *View crowd modelling* permission.
+     * Get a survey\'s invitation link
+     */
+    getLink(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLinkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns a 256×256 PNG QR code encoding the survey\'s invitation link. The response is sent as a file download (`Content-Disposition: attachment`). The encoded URL follows the same authentication-mode rules as `GET /v1/data-collections/{id}/link`. Requires the *View crowd modelling* permission.
+     * Get a survey\'s QR code
+     */
+    getLinkQrCodeRaw(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 getLinkQrCode().');
+            }
+            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/data-collections/{id}/link-qr-code`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Returns a 256×256 PNG QR code encoding the survey\'s invitation link. The response is sent as a file download (`Content-Disposition: attachment`). The encoded URL follows the same authentication-mode rules as `GET /v1/data-collections/{id}/link`. Requires the *View crowd modelling* permission.
+     * Get a survey\'s QR code
+     */
+    getLinkQrCode(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLinkQrCodeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all surveys for the account, sorted by name, each with contribution progress counts. Requires the *View crowd modelling* or *View scenario planning* permission.
+     * List data collection surveys
+     */
+    listRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-collections`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetDatacollectionListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns all surveys for the account, sorted by name, each with contribution progress counts. Requires the *View crowd modelling* or *View scenario planning* permission.
+     * List data collection surveys
+     */
+    list(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * List contributors for a survey
+     */
+    listContributorsRaw(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 listContributors().');
+            }
+            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/data-collections/{id}/contributors`;
+            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) => GetContributionListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * List contributors for a survey
+     */
+    listContributors(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listContributorsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set.
+     * Update a data collection survey
+     */
+    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/data-collections/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DatacollectionBodyToJSON(requestParameters['datacollectionBody']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Partially updates the survey\'s name, steps, authentication mode, status, and other configurable fields. Only fields present in the request body are changed. Requires the *Configure crowd modelling* permission. Returns 400 if `anonymisationProperty` names a property that does not exist, or that is not a tree property for email or preferred-channel authentication. Also returns 400 if an already-set anonymisation property or authentication mode is changed, or status is moved back to draft, once the survey has left draft; an empty property or mode may still be set.
+     * Update a data collection survey
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,159 @@
+/**
+ * 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 { DatasetAddResponseBody, DatasetChangelogBody, DatasetCreate, DatasetModify, GetDatasetListRes } from '../models/index';
+export interface DatasetsApiCreateRequest {
+    datasetCreate?: DatasetCreate;
+}
+export interface DatasetsApiDeleteRequest {
+    id: string;
+}
+export interface DatasetsApiGetRequest {
+    id: string;
+}
+export interface DatasetsApiUpdateRequest {
+    id: string;
+    datasetModify?: DatasetModify;
+}
+/**
+ * DatasetsApi - interface
+ *
+ * @export
+ * @interface DatasetsApiInterface
+ */
+export interface DatasetsApiInterface {
+    /**
+     * Creates a custom dataset for the account and returns its UUID. Also provisions a matching property so the dataset can be used in space rulesets. Requires the *Edit datasets* permission.
+     * @summary Create a dataset
+     * @param {DatasetCreate} [datasetCreate]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    createRaw(requestParameters: DatasetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetAddResponseBody>>;
+    /**
+     * Creates a custom dataset for the account and returns its UUID. Also provisions a matching property so the dataset can be used in space rulesets. Requires the *Edit datasets* permission.
+     * Create a dataset
+     */
+    create(requestParameters: DatasetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetAddResponseBody>;
+    /**
+     * Permanently removes the specified custom dataset and its associated property. Returns `400` if the dataset is a standard (preset) dataset, which cannot be deleted, and `409` if its property is the anonymisation property of a live data collection. Requires the *Edit datasets* permission.
+     * @summary Delete a dataset
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    deleteRaw(requestParameters: DatasetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently removes the specified custom dataset and its associated property. Returns `400` if the dataset is a standard (preset) dataset, which cannot be deleted, and `409` if its property is the anonymisation property of a live data collection. Requires the *Edit datasets* permission.
+     * Delete a dataset
+     */
+    delete(requestParameters: DatasetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the dataset identified by `id`. Standard (preset) datasets are visible to any authenticated caller; custom datasets require the *View datasets* permission. Returns `403` if the dataset is private and the caller only holds the *View public datasets* permission.
+     * @summary Get a dataset
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    getRaw(requestParameters: DatasetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetChangelogBody>>;
+    /**
+     * Returns the dataset identified by `id`. Standard (preset) datasets are visible to any authenticated caller; custom datasets require the *View datasets* permission. Returns `403` if the dataset is private and the caller only holds the *View public datasets* permission.
+     * Get a dataset
+     */
+    get(requestParameters: DatasetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetChangelogBody>;
+    /**
+     * Returns all datasets available to the account, sorted alphabetically by name. Standard (preset) datasets are always included. Custom datasets are returned only to callers with the *View datasets* permission; callers with only *View public datasets* see solely datasets marked as public.
+     * @summary List datasets
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatasetListRes>>;
+    /**
+     * Returns all datasets available to the account, sorted alphabetically by name. Standard (preset) datasets are always included. Custom datasets are returned only to callers with the *View datasets* permission; callers with only *View public datasets* see solely datasets marked as public.
+     * List datasets
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatasetListRes>;
+    /**
+     * Updates the metadata and/or configuration of the specified dataset. Only fields supplied in the request body are changed. For select-type datasets, updating the options also re-syncs the associated property. Returns `409` if that property is the anonymisation property of a live data collection and the update would change its tree structure. Requires the *Edit datasets* permission.
+     * @summary Update a dataset
+     * @param {string} id
+     * @param {DatasetModify} [datasetModify]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatasetsApiInterface
+     */
+    updateRaw(requestParameters: DatasetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates the metadata and/or configuration of the specified dataset. Only fields supplied in the request body are changed. For select-type datasets, updating the options also re-syncs the associated property. Returns `409` if that property is the anonymisation property of a live data collection and the update would change its tree structure. Requires the *Edit datasets* permission.
+     * Update a dataset
+     */
+    update(requestParameters: DatasetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ *
+ */
+export declare class DatasetsApi extends runtime.BaseAPI implements DatasetsApiInterface {
+    /**
+     * Creates a custom dataset for the account and returns its UUID. Also provisions a matching property so the dataset can be used in space rulesets. Requires the *Edit datasets* permission.
+     * Create a dataset
+     */
+    createRaw(requestParameters: DatasetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetAddResponseBody>>;
+    /**
+     * Creates a custom dataset for the account and returns its UUID. Also provisions a matching property so the dataset can be used in space rulesets. Requires the *Edit datasets* permission.
+     * Create a dataset
+     */
+    create(requestParameters?: DatasetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetAddResponseBody>;
+    /**
+     * Permanently removes the specified custom dataset and its associated property. Returns `400` if the dataset is a standard (preset) dataset, which cannot be deleted, and `409` if its property is the anonymisation property of a live data collection. Requires the *Edit datasets* permission.
+     * Delete a dataset
+     */
+    deleteRaw(requestParameters: DatasetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently removes the specified custom dataset and its associated property. Returns `400` if the dataset is a standard (preset) dataset, which cannot be deleted, and `409` if its property is the anonymisation property of a live data collection. Requires the *Edit datasets* permission.
+     * Delete a dataset
+     */
+    delete(requestParameters: DatasetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the dataset identified by `id`. Standard (preset) datasets are visible to any authenticated caller; custom datasets require the *View datasets* permission. Returns `403` if the dataset is private and the caller only holds the *View public datasets* permission.
+     * Get a dataset
+     */
+    getRaw(requestParameters: DatasetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetChangelogBody>>;
+    /**
+     * Returns the dataset identified by `id`. Standard (preset) datasets are visible to any authenticated caller; custom datasets require the *View datasets* permission. Returns `403` if the dataset is private and the caller only holds the *View public datasets* permission.
+     * Get a dataset
+     */
+    get(requestParameters: DatasetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetChangelogBody>;
+    /**
+     * Returns all datasets available to the account, sorted alphabetically by name. Standard (preset) datasets are always included. Custom datasets are returned only to callers with the *View datasets* permission; callers with only *View public datasets* see solely datasets marked as public.
+     * List datasets
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatasetListRes>>;
+    /**
+     * Returns all datasets available to the account, sorted alphabetically by name. Standard (preset) datasets are always included. Custom datasets are returned only to callers with the *View datasets* permission; callers with only *View public datasets* see solely datasets marked as public.
+     * List datasets
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatasetListRes>;
+    /**
+     * Updates the metadata and/or configuration of the specified dataset. Only fields supplied in the request body are changed. For select-type datasets, updating the options also re-syncs the associated property. Returns `409` if that property is the anonymisation property of a live data collection and the update would change its tree structure. Requires the *Edit datasets* permission.
+     * Update a dataset
+     */
+    updateRaw(requestParameters: DatasetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates the metadata and/or configuration of the specified dataset. Only fields supplied in the request body are changed. For select-type datasets, updating the options also re-syncs the associated property. Returns `409` if that property is the anonymisation property of a live data collection and the update would change its tree structure. Requires the *Edit datasets* permission.
+     * Update a dataset
+     */
+    update(requestParameters: DatasetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}