@spaciv/sdk 0.0.0-stage → 0.1.0

package/dist/esm/apis/BrandingApi.js

@@ -0,0 +1,443 @@
+/* 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 { BrandingFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class BrandingApi extends runtime.BaseAPI {
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * Delete the sign-in page background
+     */
+    deleteAccountLoginBackgroundRaw(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/account/login-background`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * Delete the sign-in page background
+     */
+    deleteAccountLoginBackground(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteAccountLoginBackgroundRaw(initOverrides);
+        });
+    }
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * Delete the account logo
+     */
+    deleteAccountLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            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/account/logo`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * Delete the account logo
+     */
+    deleteAccountLogo() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            yield this.deleteAccountLogoRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * Get sign-in page branding for a hostname
+     */
+    getRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['hostname'] == null) {
+                throw new runtime.RequiredError('hostname', 'Required parameter "hostname" was null or undefined when calling get().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/branding/{hostname}`;
+            urlPath = urlPath.replace(`{${"hostname"}}`, encodeURIComponent(String(requestParameters['hostname'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => BrandingFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * Get sign-in page branding for a hostname
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background
+     */
+    getAccountLoginBackgroundRaw(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/account/login-background`;
+            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 raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background
+     */
+    getAccountLoginBackground(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getAccountLoginBackgroundRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo
+     */
+    getAccountLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            if (requestParameters['id'] != null) {
+                queryParameters['id'] = requestParameters['id'];
+            }
+            if (requestParameters['noFallback'] != null) {
+                queryParameters['noFallback'] = requestParameters['noFallback'];
+            }
+            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/account/logo`;
+            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 raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo
+     */
+    getAccountLogo() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAccountLogoRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background for a hostname
+     */
+    getLoginBackgroundRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['hostname'] == null) {
+                throw new runtime.RequiredError('hostname', 'Required parameter "hostname" was null or undefined when calling getLoginBackground().');
+            }
+            const queryParameters = {};
+            if (requestParameters['v'] != null) {
+                queryParameters['v'] = requestParameters['v'];
+            }
+            const headerParameters = {};
+            if (requestParameters['ifNoneMatch'] != null) {
+                headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+            }
+            let urlPath = `/v1/branding/{hostname}/login-background`;
+            urlPath = urlPath.replace(`{${"hostname"}}`, encodeURIComponent(String(requestParameters['hostname'])));
+            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 raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background for a hostname
+     */
+    getLoginBackground(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLoginBackgroundRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo for a hostname
+     */
+    getLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['hostname'] == null) {
+                throw new runtime.RequiredError('hostname', 'Required parameter "hostname" was null or undefined when calling getLogo().');
+            }
+            const queryParameters = {};
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            if (requestParameters['v'] != null) {
+                queryParameters['v'] = requestParameters['v'];
+            }
+            const headerParameters = {};
+            if (requestParameters['ifNoneMatch'] != null) {
+                headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+            }
+            let urlPath = `/v1/branding/{hostname}/logo`;
+            urlPath = urlPath.replace(`{${"hostname"}}`, encodeURIComponent(String(requestParameters['hostname'])));
+            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 raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo for a hostname
+     */
+    getLogo(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLogoRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * Upload the sign-in page background
+     */
+    updateAccountLoginBackgroundRaw(requestParameters, 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}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['filename'] != null) {
+                formParams.append('filename', requestParameters['filename']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            let urlPath = `/v1/account/login-background`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * Upload the sign-in page background
+     */
+    updateAccountLoginBackground() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            yield this.updateAccountLoginBackgroundRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * Upload the account logo
+     */
+    updateAccountLogoRaw(requestParameters, 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}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['filename'] != null) {
+                formParams.append('filename', requestParameters['filename']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            let urlPath = `/v1/account/logo`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * Upload the account logo
+     */
+    updateAccountLogo() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            yield this.updateAccountLogoRaw(requestParameters, initOverrides);
+        });
+    }
+}
+/**
+ * @export
+ */
+export const BrandingApiDeleteAccountLogoTypeEnum = {
+    Light: 'light',
+    Dark: 'dark'
+};
+/**
+ * @export
+ */
+export const BrandingApiGetAccountLogoTypeEnum = {
+    Light: 'light',
+    Dark: 'dark'
+};
+/**
+ * @export
+ */
+export const BrandingApiGetLogoTypeEnum = {
+    Light: 'light',
+    Dark: 'dark'
+};

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

@@ -0,0 +1,113 @@
+/**
+ * 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 { ContributionPost, GetContributionRes } from '../models/index';
+export interface ContributionsApiCreateDataCollectionsContributionRequest {
+    id: string;
+    datacollectionId?: string;
+    contributionPost?: ContributionPost;
+}
+export interface ContributionsApiCreateDataCollectionsUsersContributionRequest {
+    userId: number;
+    id: string;
+}
+export interface ContributionsApiGetDataCollectionsContributionRequest {
+    id: string;
+}
+/**
+ * ContributionsApi - interface
+ *
+ * @export
+ * @interface ContributionsApiInterface
+ */
+export interface ContributionsApiInterface {
+    /**
+     * Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * @summary Save a contribution
+     * @param {string} id
+     * @param {string} [datacollectionId] The survey the contribution belongs to. Required when submitting on behalf of an anonymous or public contributor whose contribution ID differs from the survey ID.
+     * @param {ContributionPost} [contributionPost]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ContributionsApiInterface
+     */
+    createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * Save a contribution
+     */
+    createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Initialises a blank contribution record for the specified user on the given survey, deleting any answers they have already saved. This is used by administrators to pre-populate the contributors list; contributors normally receive their record via `GET /v1/data-collections/{id}/contribution`. Requires the *Configure crowd modelling* permission.
+     * @summary Create a contribution for a user
+     * @param {number} userId
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ContributionsApiInterface
+     */
+    createDataCollectionsUsersContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsUsersContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Initialises a blank contribution record for the specified user on the given survey, deleting any answers they have already saved. This is used by administrators to pre-populate the contributors list; contributors normally receive their record via `GET /v1/data-collections/{id}/contribution`. Requires the *Configure crowd modelling* permission.
+     * Create a contribution for a user
+     */
+    createDataCollectionsUsersContribution(requestParameters: ContributionsApiCreateDataCollectionsUsersContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the authenticated contributor\'s current contribution for the survey, creating an empty one if none exists yet. For anonymous and public surveys the contribution is keyed to the caller\'s session rather than their user account. Requires the *View contribution* or *Contribute to public data collection* permission.
+     * @summary Get the caller\'s contribution for a survey
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ContributionsApiInterface
+     */
+    getDataCollectionsContributionRaw(requestParameters: ContributionsApiGetDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionRes>>;
+    /**
+     * Returns the authenticated contributor\'s current contribution for the survey, creating an empty one if none exists yet. For anonymous and public surveys the contribution is keyed to the caller\'s session rather than their user account. Requires the *View contribution* or *Contribute to public data collection* permission.
+     * Get the caller\'s contribution for a survey
+     */
+    getDataCollectionsContribution(requestParameters: ContributionsApiGetDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionRes>;
+}
+/**
+ *
+ */
+export declare class ContributionsApi extends runtime.BaseAPI implements ContributionsApiInterface {
+    /**
+     * Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * Save a contribution
+     */
+    createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * Save a contribution
+     */
+    createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Initialises a blank contribution record for the specified user on the given survey, deleting any answers they have already saved. This is used by administrators to pre-populate the contributors list; contributors normally receive their record via `GET /v1/data-collections/{id}/contribution`. Requires the *Configure crowd modelling* permission.
+     * Create a contribution for a user
+     */
+    createDataCollectionsUsersContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsUsersContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Initialises a blank contribution record for the specified user on the given survey, deleting any answers they have already saved. This is used by administrators to pre-populate the contributors list; contributors normally receive their record via `GET /v1/data-collections/{id}/contribution`. Requires the *Configure crowd modelling* permission.
+     * Create a contribution for a user
+     */
+    createDataCollectionsUsersContribution(requestParameters: ContributionsApiCreateDataCollectionsUsersContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the authenticated contributor\'s current contribution for the survey, creating an empty one if none exists yet. For anonymous and public surveys the contribution is keyed to the caller\'s session rather than their user account. Requires the *View contribution* or *Contribute to public data collection* permission.
+     * Get the caller\'s contribution for a survey
+     */
+    getDataCollectionsContributionRaw(requestParameters: ContributionsApiGetDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionRes>>;
+    /**
+     * Returns the authenticated contributor\'s current contribution for the survey, creating an empty one if none exists yet. For anonymous and public surveys the contribution is keyed to the caller\'s session rather than their user account. Requires the *View contribution* or *Contribute to public data collection* permission.
+     * Get the caller\'s contribution for a survey
+     */
+    getDataCollectionsContribution(requestParameters: ContributionsApiGetDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionRes>;
+}