@spaciv/sdk 0.1.8 → 0.1.10

package/dist/esm/apis/DataCollectionApi.js

@@ -101,7 +101,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
      * Get a data collection survey
      */
     getRaw(requestParameters, initOverrides) {
@@ -130,7 +130,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Returns the survey and a summary of contribution progress: how many contributors have started, completed, and the total invited. Requires the *View crowd modelling*, *View data collection preview* or *View public data collection* permission; drafts need one of the first two. Callers without *View crowd modelling* receive the survey without its `contributors` list or progress counts. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
      * Get a data collection survey
      */
     get(requestParameters, initOverrides) {
@@ -263,7 +263,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
      * List contributors for a survey
      */
     listContributorsRaw(requestParameters, initOverrides) {
@@ -292,7 +292,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
      * List contributors for a survey
      */
     listContributors(requestParameters, initOverrides) {
@@ -302,7 +302,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending either requires the *Upload data collection contributors* permission as well, and sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
      * Update a data collection survey
      */
     updateRaw(requestParameters, initOverrides) {
@@ -333,7 +333,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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. The object group ID in an email or preferred-channel authentication mode is only locked until contributors have been uploaded. For email or preferred-channel authentication, `contributors` lists each contributor\'s user ID and their nodes on the anonymisation property; a non-empty list replaces the stored one and `clearContributors` empties it. Sending either requires the *Upload data collection contributors* permission as well, and sending both returns 400. Switching a draft to anonymous or public authentication clears its contributors. Returns 400 if contributors are uploaded for anonymous or public authentication, if a contributor is listed twice, is not a user of the account, or names a node that is not on the anonymisation property, if the contributors change or are cleared once the survey has left draft, or if the survey leaves draft without contributors. Also returns 400 if the stored survey, contributors included, would exceed 300 KiB; at one node ID per contributor that is roughly 5,000 contributors. A survey that leaves draft without ever having had contributors uploaded takes them from the object group named by its authentication mode, if any.
      * Update a data collection survey
      */
     update(requestParameters, initOverrides) {

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

@@ -71,7 +71,7 @@ export interface FloorPlansApiInterface {
      */
     delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * @summary Get a floor plan
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -80,7 +80,7 @@ export interface FloorPlansApiInterface {
      */
     getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * Get a floor plan
      */
     get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
@@ -114,7 +114,7 @@ export interface FloorPlansApiInterface {
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * @summary Update a floor plan
      * @param {string} id
      * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
@@ -124,7 +124,7 @@ export interface FloorPlansApiInterface {
      */
     updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -171,12 +171,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
      */
     delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * Get a floor plan
      */
     getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * Get a floor plan
      */
     get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
@@ -201,12 +201,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;

package/dist/esm/apis/FloorPlansApi.js

@@ -111,7 +111,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * Get a floor plan
      */
     getRaw(requestParameters, initOverrides) {
@@ -140,7 +140,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the floor plan\'s metadata, space overlay geometry, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
+     * Returns the floor plan\'s metadata, view mode, space overlay geometry with each space\'s 3D heights, and image offset. Returns an empty body (not 404) when the floor plan does not exist. Use `GET /v1/floorplans/{id}/images/{imageType}` to retrieve the drawing image. Requires the *View floorplans* permission.
      * Get a floor plan
      */
     get(requestParameters, initOverrides) {
@@ -236,7 +236,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     updateRaw(requestParameters, initOverrides) {
@@ -267,7 +267,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. `viewMode` is one of `2d-and-3d`, `3d-only` or `2d-only`. A space\'s `startHeight` and `endHeight` are in the same units as its paths, must be set together and the end must be above the start; a space without them is drawn at a default height scaled to the floor plan. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     update(requestParameters, initOverrides) {

package/dist/esm/models/DatacollectionBody.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
+import type { DatacollectionContributor } from './DatacollectionContributor';
 import type { Step } from './Step';
 /**
  *
@@ -29,6 +30,12 @@ export interface DatacollectionBody {
      * @memberof DatacollectionBody
      */
     authenticationMode?: DatacollectionAuthentication;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DatacollectionBody
+     */
+    clearContributors?: boolean;
     /**
      *
      * @type {boolean}
@@ -41,6 +48,12 @@ export interface DatacollectionBody {
      * @memberof DatacollectionBody
      */
     completeMessage?: string;
+    /**
+     *
+     * @type {Array<DatacollectionContributor>}
+     * @memberof DatacollectionBody
+     */
+    contributors?: Array<DatacollectionContributor>;
     /**
      *
      * @type {boolean}

package/dist/esm/models/DatacollectionBody.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { DatacollectionAuthenticationFromJSON, DatacollectionAuthenticationToJSON, } from './DatacollectionAuthentication';
+import { DatacollectionContributorFromJSON, DatacollectionContributorToJSON, } from './DatacollectionContributor';
 import { StepFromJSON, StepToJSON, } from './Step';
 /**
  * Check if a given object implements the DatacollectionBody interface.
@@ -37,8 +38,10 @@ export function DatacollectionBodyFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'anonymisationProperty': json['anonymisationProperty'] == null ? undefined : json['anonymisationProperty'],
         'authenticationMode': json['authenticationMode'] == null ? undefined : DatacollectionAuthenticationFromJSON(json['authenticationMode']),
+        'clearContributors': json['clearContributors'] == null ? undefined : json['clearContributors'],
         'clearSteps': json['clearSteps'],
         'completeMessage': json['completeMessage'] == null ? undefined : json['completeMessage'],
+        'contributors': json['contributors'] == null ? undefined : (json['contributors'].map(DatacollectionContributorFromJSON)),
         'delete': json['delete'],
         'description': json['description'] == null ? undefined : json['description'],
         'end': json['end'] == null ? undefined : json['end'],
@@ -63,8 +66,10 @@ export function DatacollectionBodyToJSONTyped(value, ignoreDiscriminator = false
     return {
         'anonymisationProperty': value['anonymisationProperty'],
         'authenticationMode': DatacollectionAuthenticationToJSON(value['authenticationMode']),
+        'clearContributors': value['clearContributors'],
         'clearSteps': value['clearSteps'],
         'completeMessage': value['completeMessage'],
+        'contributors': value['contributors'] == null ? undefined : (value['contributors'].map(DatacollectionContributorToJSON)),
         'delete': value['delete'],
         'description': value['description'],
         'end': value['end'],

package/dist/esm/models/DatacollectionChangelogBody.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
+import type { DatacollectionContributor } from './DatacollectionContributor';
 import type { Step } from './Step';
 /**
  *
@@ -35,6 +36,18 @@ export interface DatacollectionChangelogBody {
      * @memberof DatacollectionChangelogBody
      */
     completeMessage: string;
+    /**
+     *
+     * @type {Array<DatacollectionContributor>}
+     * @memberof DatacollectionChangelogBody
+     */
+    contributors: Array<DatacollectionContributor>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DatacollectionChangelogBody
+     */
+    contributorsUploaded: boolean;
     /**
      *
      * @type {string}

package/dist/esm/models/DatacollectionChangelogBody.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { DatacollectionAuthenticationFromJSON, DatacollectionAuthenticationToJSON, } from './DatacollectionAuthentication';
+import { DatacollectionContributorFromJSON, DatacollectionContributorToJSON, } from './DatacollectionContributor';
 import { StepFromJSON, StepToJSON, } from './Step';
 /**
  * Check if a given object implements the DatacollectionChangelogBody interface.
@@ -23,6 +24,10 @@ export function instanceOfDatacollectionChangelogBody(value) {
         return false;
     if (!('completeMessage' in value) || value['completeMessage'] === undefined)
         return false;
+    if (!('contributors' in value) || value['contributors'] === undefined)
+        return false;
+    if (!('contributorsUploaded' in value) || value['contributorsUploaded'] === undefined)
+        return false;
     if (!('description' in value) || value['description'] === undefined)
         return false;
     if (!('end' in value) || value['end'] === undefined)
@@ -56,6 +61,8 @@ export function DatacollectionChangelogBodyFromJSONTyped(json, ignoreDiscriminat
         'anonymisationProperty': json['anonymisationProperty'],
         'authenticationMode': DatacollectionAuthenticationFromJSON(json['authenticationMode']),
         'completeMessage': json['completeMessage'],
+        'contributors': (json['contributors'].map(DatacollectionContributorFromJSON)),
+        'contributorsUploaded': json['contributorsUploaded'],
         'description': json['description'],
         'end': json['end'],
         'inviteMessage': json['inviteMessage'],
@@ -79,6 +86,8 @@ export function DatacollectionChangelogBodyToJSONTyped(value, ignoreDiscriminato
         'anonymisationProperty': value['anonymisationProperty'],
         'authenticationMode': DatacollectionAuthenticationToJSON(value['authenticationMode']),
         'completeMessage': value['completeMessage'],
+        'contributors': (value['contributors'].map(DatacollectionContributorToJSON)),
+        'contributorsUploaded': value['contributorsUploaded'],
         'description': value['description'],
         'end': value['end'],
         'inviteMessage': value['inviteMessage'],

package/dist/esm/models/DatacollectionContributor.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DatacollectionContributor
+ */
+export interface DatacollectionContributor {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DatacollectionContributor
+     */
+    nodes: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof DatacollectionContributor
+     */
+    user: string;
+}
+/**
+ * Check if a given object implements the DatacollectionContributor interface.
+ */
+export declare function instanceOfDatacollectionContributor(value: object): value is DatacollectionContributor;
+export declare function DatacollectionContributorFromJSON(json: any): DatacollectionContributor;
+export declare function DatacollectionContributorFromJSONTyped(json: any, ignoreDiscriminator: boolean): DatacollectionContributor;
+export declare function DatacollectionContributorToJSON(json: any): DatacollectionContributor;
+export declare function DatacollectionContributorToJSONTyped(value?: DatacollectionContributor | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DatacollectionContributor.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DatacollectionContributor interface.
+ */
+export function instanceOfDatacollectionContributor(value) {
+    if (!('nodes' in value) || value['nodes'] === undefined)
+        return false;
+    if (!('user' in value) || value['user'] === undefined)
+        return false;
+    return true;
+}
+export function DatacollectionContributorFromJSON(json) {
+    return DatacollectionContributorFromJSONTyped(json, false);
+}
+export function DatacollectionContributorFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'nodes': json['nodes'],
+        'user': json['user'],
+    };
+}
+export function DatacollectionContributorToJSON(json) {
+    return DatacollectionContributorToJSONTyped(json, false);
+}
+export function DatacollectionContributorToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'nodes': value['nodes'],
+        'user': value['user'],
+    };
+}

package/dist/esm/models/FloorplanCreateSpace.d.ts

@@ -16,6 +16,12 @@ import type { FloorplanSpaceChangelogPath } from './FloorplanSpaceChangelogPath'
  * @interface FloorplanCreateSpace
  */
 export interface FloorplanCreateSpace {
+    /**
+     *
+     * @type {number}
+     * @memberof FloorplanCreateSpace
+     */
+    endHeight?: number;
     /**
      *
      * @type {string}
@@ -28,6 +34,12 @@ export interface FloorplanCreateSpace {
      * @memberof FloorplanCreateSpace
      */
     paths: Array<FloorplanSpaceChangelogPath>;
+    /**
+     *
+     * @type {number}
+     * @memberof FloorplanCreateSpace
+     */
+    startHeight?: number;
 }
 /**
  * Check if a given object implements the FloorplanCreateSpace interface.

package/dist/esm/models/FloorplanCreateSpace.js

@@ -30,8 +30,10 @@ export function FloorplanCreateSpaceFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
         'location': json['location'],
         'paths': (json['paths'].map(FloorplanSpaceChangelogPathFromJSON)),
+        'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
     };
 }
 export function FloorplanCreateSpaceToJSON(json) {
@@ -42,7 +44,9 @@ export function FloorplanCreateSpaceToJSONTyped(value, ignoreDiscriminator = fal
         return value;
     }
     return {
+        'endHeight': value['endHeight'],
         'location': value['location'],
         'paths': (value['paths'].map(FloorplanSpaceChangelogPathToJSON)),
+        'startHeight': value['startHeight'],
     };
 }

package/dist/esm/models/FloorplanGetBody.d.ts

@@ -65,7 +65,22 @@ export interface FloorplanGetBody {
      * @memberof FloorplanGetBody
      */
     spaces: Array<FloorplanGetBodySpace>;
+    /**
+     * Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
+     * @type {string}
+     * @memberof FloorplanGetBody
+     */
+    viewMode: FloorplanGetBodyViewModeEnum;
 }
+/**
+ * @export
+ */
+export declare const FloorplanGetBodyViewModeEnum: {
+    readonly _2dAnd3d: "2d-and-3d";
+    readonly _3dOnly: "3d-only";
+    readonly _2dOnly: "2d-only";
+};
+export type FloorplanGetBodyViewModeEnum = typeof FloorplanGetBodyViewModeEnum[keyof typeof FloorplanGetBodyViewModeEnum];
 /**
  * Check if a given object implements the FloorplanGetBody interface.
  */

package/dist/esm/models/FloorplanGetBody.js

@@ -13,6 +13,14 @@
  */
 import { FloorplanGetBodyOverlayOffsetFromJSON, FloorplanGetBodyOverlayOffsetToJSON, } from './FloorplanGetBodyOverlayOffset';
 import { FloorplanGetBodySpaceFromJSON, FloorplanGetBodySpaceToJSON, } from './FloorplanGetBodySpace';
+/**
+ * @export
+ */
+export const FloorplanGetBodyViewModeEnum = {
+    _2dAnd3d: '2d-and-3d',
+    _3dOnly: '3d-only',
+    _2dOnly: '2d-only'
+};
 /**
  * Check if a given object implements the FloorplanGetBody interface.
  */
@@ -29,6 +37,8 @@ export function instanceOfFloorplanGetBody(value) {
         return false;
     if (!('spaces' in value) || value['spaces'] === undefined)
         return false;
+    if (!('viewMode' in value) || value['viewMode'] === undefined)
+        return false;
     return true;
 }
 export function FloorplanGetBodyFromJSON(json) {
@@ -47,6 +57,7 @@ export function FloorplanGetBodyFromJSONTyped(json, ignoreDiscriminator) {
         'property': json['property'],
         'propertyNode': json['propertyNode'],
         'spaces': (json['spaces'].map(FloorplanGetBodySpaceFromJSON)),
+        'viewMode': json['viewMode'],
     };
 }
 export function FloorplanGetBodyToJSON(json) {
@@ -65,5 +76,6 @@ export function FloorplanGetBodyToJSONTyped(value, ignoreDiscriminator = false)
         'property': value['property'],
         'propertyNode': value['propertyNode'],
         'spaces': (value['spaces'].map(FloorplanGetBodySpaceToJSON)),
+        'viewMode': value['viewMode'],
     };
 }

package/dist/esm/models/FloorplanGetBodySpace.d.ts

@@ -16,6 +16,12 @@ import type { FloorplanGetBodySpacePoint } from './FloorplanGetBodySpacePoint';
  * @interface FloorplanGetBodySpace
  */
 export interface FloorplanGetBodySpace {
+    /**
+     * Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
+     * @type {number}
+     * @memberof FloorplanGetBodySpace
+     */
+    endHeight?: number;
     /**
      *
      * @type {string}
@@ -28,6 +34,12 @@ export interface FloorplanGetBodySpace {
      * @memberof FloorplanGetBodySpace
      */
     paths: Array<Array<FloorplanGetBodySpacePoint>>;
+    /**
+     * Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
+     * @type {number}
+     * @memberof FloorplanGetBodySpace
+     */
+    startHeight?: number;
 }
 /**
  * Check if a given object implements the FloorplanGetBodySpace interface.

package/dist/esm/models/FloorplanGetBodySpace.js

@@ -29,8 +29,10 @@ export function FloorplanGetBodySpaceFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
         'location': json['location'],
         'paths': json['paths'],
+        'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
     };
 }
 export function FloorplanGetBodySpaceToJSON(json) {
@@ -41,7 +43,9 @@ export function FloorplanGetBodySpaceToJSONTyped(value, ignoreDiscriminator = fa
         return value;
     }
     return {
+        'endHeight': value['endHeight'],
         'location': value['location'],
         'paths': value['paths'],
+        'startHeight': value['startHeight'],
     };
 }

package/dist/esm/models/FloorplanPatchParamsBody.d.ts

@@ -65,6 +65,12 @@ export interface FloorplanPatchParamsBody {
      * @memberof FloorplanPatchParamsBody
      */
     spaces?: FloorplanCreateSpaceRepeated;
+    /**
+     *
+     * @type {string}
+     * @memberof FloorplanPatchParamsBody
+     */
+    viewMode?: string;
 }
 /**
  * Check if a given object implements the FloorplanPatchParamsBody interface.

package/dist/esm/models/FloorplanPatchParamsBody.js

@@ -35,6 +35,7 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json, ignoreDiscriminator)
         'property': json['property'] == null ? undefined : json['property'],
         'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
         'spaces': json['spaces'] == null ? undefined : FloorplanCreateSpaceRepeatedFromJSON(json['spaces']),
+        'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
     };
 }
 export function FloorplanPatchParamsBodyToJSON(json) {
@@ -53,5 +54,6 @@ export function FloorplanPatchParamsBodyToJSONTyped(value, ignoreDiscriminator =
         'property': value['property'],
         'propertyNode': value['propertyNode'],
         'spaces': FloorplanCreateSpaceRepeatedToJSON(value['spaces']),
+        'viewMode': value['viewMode'],
     };
 }

package/dist/esm/models/GetDatacollectionRes.d.ts

@@ -34,6 +34,12 @@ export interface GetDatacollectionRes {
      * @memberof GetDatacollectionRes
      */
     id: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetDatacollectionRes
+     */
+    legacyContributors?: number;
     /**
      *
      * @type {number}

package/dist/esm/models/GetDatacollectionRes.js

@@ -39,6 +39,7 @@ export function GetDatacollectionResFromJSONTyped(json, ignoreDiscriminator) {
         'completed': json['completed'],
         'datacollection': DatacollectionChangelogBodyFromJSON(json['datacollection']),
         'id': json['id'],
+        'legacyContributors': json['legacyContributors'] == null ? undefined : json['legacyContributors'],
         'started': json['started'],
         'total': json['total'],
     };
@@ -54,6 +55,7 @@ export function GetDatacollectionResToJSONTyped(value, ignoreDiscriminator = fal
         'completed': value['completed'],
         'datacollection': DatacollectionChangelogBodyToJSON(value['datacollection']),
         'id': value['id'],
+        'legacyContributors': value['legacyContributors'],
         'started': value['started'],
         'total': value['total'],
     };

package/dist/esm/models/index.d.ts

@@ -146,6 +146,7 @@ export * from './DatacollectionAuthenticationOneOf2';
 export * from './DatacollectionAuthenticationOneOf3';
 export * from './DatacollectionBody';
 export * from './DatacollectionChangelogBody';
+export * from './DatacollectionContributor';
 export * from './DatasetAddResponseBody';
 export * from './DatasetChangelogBody';
 export * from './DatasetChangelogData';