@spaciv/sdk 0.0.0 → 0.1.0

package/dist/esm/apis/DashboardsApi.js

@@ -0,0 +1,389 @@
+/* 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 { DashboardCardCreateToJSON, DashboardCardDeleteToJSON, DashboardCardPatchToJSON, DashboardChangelogBodyFromJSON, DashboardCopyToJSON, DashboardListResFromJSON, DashboardPostToJSON, DashboardUpdateToJSON, } from '../models/index';
+/**
+ *
+ */
+export class DashboardsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * Create a dashboard
+     */
+    createRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/dashboards`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardPostToJSON(requestParameters['dashboardPost']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a new dashboard for the current project and returns its UUID.  If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
+     * Create a dashboard
+     */
+    create() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * Add a card to a dashboard
+     */
+    createCardsRaw(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 createCards().');
+            }
+            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/dashboards/{id}/cards`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardCardCreateToJSON(requestParameters['dashboardCardCreate']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
+     * Add a card to a dashboard
+     */
+    createCards(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.createCardsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * Delete a dashboard
+     */
+    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/dashboards/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Permanently deletes a dashboard and removes it from the project\'s ordered index. Requires the *Edit org model* permission.
+     * Delete a dashboard
+     */
+    delete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Remove a card from a dashboard
+     */
+    deleteCardsRaw(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 deleteCards().');
+            }
+            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/dashboards/{id}/cards`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardCardDeleteToJSON(requestParameters['dashboardCardDelete']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the card at the given zero-based `index` from the dashboard\'s card list. Cards that follow it are shifted up. Out-of-range indices are silently ignored. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Remove a card from a dashboard
+     */
+    deleteCards(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCardsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * Copy a dashboard
+     */
+    duplicateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling duplicate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/dashboards/{id}/duplicate`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardCopyToJSON(requestParameters['dashboardCopy']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Copies a dashboard from the current project into a target project and returns the new dashboard\'s UUID. The target project is specified by `toProject` in the request body; it may be the same project or a different one within the same account. Requires the *Edit org model* permission, and the *Variable controls* permission when any of the dashboard\'s cards has controls.
+     * Copy a dashboard
+     */
+    duplicate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.duplicateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * Get a dashboard
+     */
+    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/dashboards/{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) => DashboardChangelogBodyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the full content of a single dashboard, including its card layout. Returns `404` if the dashboard does not exist or does not belong to the current project. Requires the *View org model* permission.
+     * Get a dashboard
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * List dashboards
+     */
+    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/dashboards`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DashboardListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the ordered list of dashboards belonging to the current project, with each entry containing the dashboard ID, name, and description. Requires the *View org model* permission.
+     * List dashboards
+     */
+    list(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Update a dashboard
+     */
+    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/dashboards/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardUpdateToJSON(requestParameters['dashboardUpdate']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates the name or description of a dashboard, or changes its position in the project\'s ordered list. Supply `move` with `\"Up\"` or `\"Down\"` to reorder; omit it to update metadata only. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission.
+     * Update a dashboard
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * Update a dashboard card
+     */
+    updateCardsRaw(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 updateCards().');
+            }
+            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/dashboards/{id}/cards`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DashboardCardPatchToJSON(requestParameters['dashboardCardPatch']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
+     * Update a dashboard card
+     */
+    updateCards(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateCardsRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -0,0 +1,236 @@
+/**
+ * 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 { DataCollectionAddResponseBody, DatacollectionBody, GetContributionListRes, GetDatacollectionListRes, GetDatacollectionRes } from '../models/index';
+export interface DataCollectionApiDeleteRequest {
+    id: string;
+}
+export interface DataCollectionApiGetRequest {
+    id: string;
+}
+export interface DataCollectionApiGetLinkRequest {
+    id: string;
+}
+export interface DataCollectionApiGetLinkQrCodeRequest {
+    id: string;
+}
+export interface DataCollectionApiListContributorsRequest {
+    id: string;
+}
+export interface DataCollectionApiUpdateRequest {
+    id: string;
+    datacollectionBody?: DatacollectionBody;
+}
+/**
+ * DataCollectionApi - interface
+ *
+ * @export
+ * @interface DataCollectionApiInterface
+ */
+export interface DataCollectionApiInterface {
+    /**
+     * 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.
+     * @summary Create a data collection survey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    createRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataCollectionAddResponseBody>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<DataCollectionAddResponseBody>;
+    /**
+     * Permanently deletes the survey and its associated contribution data. This action cannot be undone. Requires the *Configure crowd modelling* permission.
+     * @summary Delete a data collection survey
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    deleteRaw(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * 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.
+     * @summary Get a data collection survey
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
+    /**
+     * 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: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
+    /**
+     * 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.
+     * @summary Get a survey\'s invitation link
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    getLinkRaw(requestParameters: DataCollectionApiGetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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: DataCollectionApiGetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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.
+     * @summary Get a survey\'s QR code
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    getLinkQrCodeRaw(requestParameters: DataCollectionApiGetLinkQrCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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: DataCollectionApiGetLinkQrCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns all surveys for the account, sorted by name, each with contribution progress counts. Requires the *View crowd modelling* or *View scenario planning* permission.
+     * @summary List data collection surveys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionListRes>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
+    /**
+     * 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.
+     * @summary List contributors for a survey
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
+    /**
+     * 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: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
+    /**
+     * 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.
+     * @summary Update a data collection survey
+     * @param {string} id
+     * @param {DatacollectionBody} [datacollectionBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataCollectionApiInterface
+     */
+    updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ *
+ */
+export declare class DataCollectionApi extends runtime.BaseAPI implements DataCollectionApiInterface {
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataCollectionAddResponseBody>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<DataCollectionAddResponseBody>;
+    /**
+     * 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: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * 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: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
+    /**
+     * 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: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
+    /**
+     * 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: DataCollectionApiGetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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: DataCollectionApiGetLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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: DataCollectionApiGetLinkQrCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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: DataCollectionApiGetLinkQrCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionListRes>>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
+    /**
+     * 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: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
+    /**
+     * 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: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
+    /**
+     * 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: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}