@spaciv/sdk 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @spaciv/sdk@0.1.6
1
+ ## @spaciv/sdk@0.1.7
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @spaciv/sdk@0.1.6 --save
39
+ npm install @spaciv/sdk@0.1.7 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -85,18 +85,18 @@ export interface FloorPlansApiInterface {
85
85
  */
86
86
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
87
87
  /**
88
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
88
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
89
89
  * @summary Get a floor plan image
90
90
  * @param {string} id
91
91
  * @param {'image' | 'foreground'} imageType Which image layer to retrieve: the base drawing (image) or the foreground overlay (foreground).
92
- * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if no image has been uploaded.
92
+ * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if the layer has no image.
93
93
  * @param {*} [options] Override http request option.
94
94
  * @throws {RequiredError}
95
95
  * @memberof FloorPlansApiInterface
96
96
  */
97
97
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
98
98
  /**
99
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
99
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
100
100
  * Get a floor plan image
101
101
  */
102
102
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -114,7 +114,7 @@ export interface FloorPlansApiInterface {
114
114
  */
115
115
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
116
116
  /**
117
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
117
+ * 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}`.
118
118
  * @summary Update a floor plan
119
119
  * @param {string} id
120
120
  * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
@@ -124,12 +124,12 @@ export interface FloorPlansApiInterface {
124
124
  */
125
125
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
126
126
  /**
127
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
127
+ * 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}`.
128
128
  * Update a floor plan
129
129
  */
130
130
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
131
131
  /**
132
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
132
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
133
133
  * @summary Upload a floor plan image
134
134
  * @param {string} id
135
135
  * @param {'image' | 'foreground'} imageType Which image layer to upload: the base drawing (image) or the foreground overlay (foreground).
@@ -141,7 +141,7 @@ export interface FloorPlansApiInterface {
141
141
  */
142
142
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
143
143
  /**
144
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
144
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
145
145
  * Upload a floor plan image
146
146
  */
147
147
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -181,12 +181,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
181
181
  */
182
182
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
183
183
  /**
184
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
184
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
185
185
  * Get a floor plan image
186
186
  */
187
187
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
188
188
  /**
189
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
189
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
190
190
  * Get a floor plan image
191
191
  */
192
192
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -201,22 +201,22 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
201
201
  */
202
202
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
203
203
  /**
204
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
204
+ * 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}`.
205
205
  * Update a floor plan
206
206
  */
207
207
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
208
208
  /**
209
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
209
+ * 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}`.
210
210
  * Update a floor plan
211
211
  */
212
212
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
213
213
  /**
214
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
214
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
215
215
  * Upload a floor plan image
216
216
  */
217
217
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
218
218
  /**
219
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
219
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
220
220
  * Upload a floor plan image
221
221
  */
222
222
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -153,7 +153,7 @@ class FloorPlansApi extends runtime.BaseAPI {
153
153
  });
154
154
  }
155
155
  /**
156
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
156
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
157
157
  * Get a floor plan image
158
158
  */
159
159
  getImagesRaw(requestParameters, initOverrides) {
@@ -194,7 +194,7 @@ class FloorPlansApi extends runtime.BaseAPI {
194
194
  });
195
195
  }
196
196
  /**
197
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
197
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
198
198
  * Get a floor plan image
199
199
  */
200
200
  getImages(requestParameters, initOverrides) {
@@ -239,7 +239,7 @@ class FloorPlansApi extends runtime.BaseAPI {
239
239
  });
240
240
  }
241
241
  /**
242
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
242
+ * 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}`.
243
243
  * Update a floor plan
244
244
  */
245
245
  updateRaw(requestParameters, initOverrides) {
@@ -270,7 +270,7 @@ class FloorPlansApi extends runtime.BaseAPI {
270
270
  });
271
271
  }
272
272
  /**
273
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
273
+ * 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}`.
274
274
  * Update a floor plan
275
275
  */
276
276
  update(requestParameters, initOverrides) {
@@ -280,7 +280,7 @@ class FloorPlansApi extends runtime.BaseAPI {
280
280
  });
281
281
  }
282
282
  /**
283
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
283
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
284
284
  * Upload a floor plan image
285
285
  */
286
286
  updateImagesRaw(requestParameters, initOverrides) {
@@ -335,7 +335,7 @@ class FloorPlansApi extends runtime.BaseAPI {
335
335
  });
336
336
  }
337
337
  /**
338
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
338
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
339
339
  * Upload a floor plan image
340
340
  */
341
341
  updateImages(requestParameters, initOverrides) {
@@ -85,18 +85,18 @@ export interface FloorPlansApiInterface {
85
85
  */
86
86
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
87
87
  /**
88
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
88
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
89
89
  * @summary Get a floor plan image
90
90
  * @param {string} id
91
91
  * @param {'image' | 'foreground'} imageType Which image layer to retrieve: the base drawing (image) or the foreground overlay (foreground).
92
- * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if no image has been uploaded.
92
+ * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if the layer has no image.
93
93
  * @param {*} [options] Override http request option.
94
94
  * @throws {RequiredError}
95
95
  * @memberof FloorPlansApiInterface
96
96
  */
97
97
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
98
98
  /**
99
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
99
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
100
100
  * Get a floor plan image
101
101
  */
102
102
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -114,7 +114,7 @@ export interface FloorPlansApiInterface {
114
114
  */
115
115
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
116
116
  /**
117
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
117
+ * 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}`.
118
118
  * @summary Update a floor plan
119
119
  * @param {string} id
120
120
  * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
@@ -124,12 +124,12 @@ export interface FloorPlansApiInterface {
124
124
  */
125
125
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
126
126
  /**
127
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
127
+ * 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}`.
128
128
  * Update a floor plan
129
129
  */
130
130
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
131
131
  /**
132
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
132
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
133
133
  * @summary Upload a floor plan image
134
134
  * @param {string} id
135
135
  * @param {'image' | 'foreground'} imageType Which image layer to upload: the base drawing (image) or the foreground overlay (foreground).
@@ -141,7 +141,7 @@ export interface FloorPlansApiInterface {
141
141
  */
142
142
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
143
143
  /**
144
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
144
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
145
145
  * Upload a floor plan image
146
146
  */
147
147
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -181,12 +181,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
181
181
  */
182
182
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
183
183
  /**
184
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
184
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
185
185
  * Get a floor plan image
186
186
  */
187
187
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
188
188
  /**
189
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
189
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
190
190
  * Get a floor plan image
191
191
  */
192
192
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -201,22 +201,22 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
201
201
  */
202
202
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
203
203
  /**
204
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
204
+ * 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}`.
205
205
  * Update a floor plan
206
206
  */
207
207
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
208
208
  /**
209
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
209
+ * 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}`.
210
210
  * Update a floor plan
211
211
  */
212
212
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
213
213
  /**
214
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
214
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
215
215
  * Upload a floor plan image
216
216
  */
217
217
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
218
218
  /**
219
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
219
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
220
220
  * Upload a floor plan image
221
221
  */
222
222
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -150,7 +150,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
150
150
  });
151
151
  }
152
152
  /**
153
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
153
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
154
154
  * Get a floor plan image
155
155
  */
156
156
  getImagesRaw(requestParameters, initOverrides) {
@@ -191,7 +191,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
191
191
  });
192
192
  }
193
193
  /**
194
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
194
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
195
195
  * Get a floor plan image
196
196
  */
197
197
  getImages(requestParameters, initOverrides) {
@@ -236,7 +236,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
236
236
  });
237
237
  }
238
238
  /**
239
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
239
+ * 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}`.
240
240
  * Update a floor plan
241
241
  */
242
242
  updateRaw(requestParameters, initOverrides) {
@@ -267,7 +267,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
267
267
  });
268
268
  }
269
269
  /**
270
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
270
+ * 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}`.
271
271
  * Update a floor plan
272
272
  */
273
273
  update(requestParameters, initOverrides) {
@@ -277,7 +277,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
277
277
  });
278
278
  }
279
279
  /**
280
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
280
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
281
281
  * Upload a floor plan image
282
282
  */
283
283
  updateImagesRaw(requestParameters, initOverrides) {
@@ -332,7 +332,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
332
332
  });
333
333
  }
334
334
  /**
335
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
335
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
336
336
  * Upload a floor plan image
337
337
  */
338
338
  updateImages(requestParameters, initOverrides) {
@@ -15,12 +15,24 @@
15
15
  * @interface FloorplanBrief
16
16
  */
17
17
  export interface FloorplanBrief {
18
+ /**
19
+ * ID of the account file used as the background image, if one is set.
20
+ * @type {string}
21
+ * @memberof FloorplanBrief
22
+ */
23
+ backgroundFile?: string;
18
24
  /**
19
25
  *
20
26
  * @type {number}
21
27
  * @memberof FloorplanBrief
22
28
  */
23
29
  createdAt: number;
30
+ /**
31
+ * ID of the account file used as the foreground image, if one is set.
32
+ * @type {string}
33
+ * @memberof FloorplanBrief
34
+ */
35
+ foregroundFile?: string;
24
36
  /**
25
37
  *
26
38
  * @type {string}
@@ -35,7 +35,9 @@ export function FloorplanBriefFromJSONTyped(json, ignoreDiscriminator) {
35
35
  return json;
36
36
  }
37
37
  return {
38
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
38
39
  'createdAt': json['createdAt'],
40
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
39
41
  'id': json['id'],
40
42
  'name': json['name'],
41
43
  'property': json['property'],
@@ -50,7 +52,9 @@ export function FloorplanBriefToJSONTyped(value, ignoreDiscriminator = false) {
50
52
  return value;
51
53
  }
52
54
  return {
55
+ 'backgroundFile': value['backgroundFile'],
53
56
  'createdAt': value['createdAt'],
57
+ 'foregroundFile': value['foregroundFile'],
54
58
  'id': value['id'],
55
59
  'name': value['name'],
56
60
  'property': value['property'],
@@ -17,12 +17,24 @@ import type { FloorplanGetBodySpace } from './FloorplanGetBodySpace';
17
17
  * @interface FloorplanGetBody
18
18
  */
19
19
  export interface FloorplanGetBody {
20
+ /**
21
+ * ID of the account file used as the background image, if one is set.
22
+ * @type {string}
23
+ * @memberof FloorplanGetBody
24
+ */
25
+ backgroundFile?: string;
20
26
  /**
21
27
  *
22
28
  * @type {number}
23
29
  * @memberof FloorplanGetBody
24
30
  */
25
31
  createdAt: number;
32
+ /**
33
+ * ID of the account file used as the foreground image, if one is set.
34
+ * @type {string}
35
+ * @memberof FloorplanGetBody
36
+ */
37
+ foregroundFile?: string;
26
38
  /**
27
39
  *
28
40
  * @type {string}
@@ -39,7 +39,9 @@ export function FloorplanGetBodyFromJSONTyped(json, ignoreDiscriminator) {
39
39
  return json;
40
40
  }
41
41
  return {
42
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
42
43
  'createdAt': json['createdAt'],
44
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
43
45
  'name': json['name'],
44
46
  'overlayOffset': FloorplanGetBodyOverlayOffsetFromJSON(json['overlayOffset']),
45
47
  'property': json['property'],
@@ -55,7 +57,9 @@ export function FloorplanGetBodyToJSONTyped(value, ignoreDiscriminator = false)
55
57
  return value;
56
58
  }
57
59
  return {
60
+ 'backgroundFile': value['backgroundFile'],
58
61
  'createdAt': value['createdAt'],
62
+ 'foregroundFile': value['foregroundFile'],
59
63
  'name': value['name'],
60
64
  'overlayOffset': FloorplanGetBodyOverlayOffsetToJSON(value['overlayOffset']),
61
65
  'property': value['property'],
@@ -17,12 +17,24 @@ import type { FloorplanCreateSpaceRepeated } from './FloorplanCreateSpaceRepeate
17
17
  * @interface FloorplanPatchParamsBody
18
18
  */
19
19
  export interface FloorplanPatchParamsBody {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof FloorplanPatchParamsBody
24
+ */
25
+ backgroundFile?: string;
20
26
  /**
21
27
  *
22
28
  * @type {number}
23
29
  * @memberof FloorplanPatchParamsBody
24
30
  */
25
31
  createdAt?: number;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof FloorplanPatchParamsBody
36
+ */
37
+ foregroundFile?: string;
26
38
  /**
27
39
  *
28
40
  * @type {string}
@@ -27,7 +27,9 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json, ignoreDiscriminator)
27
27
  return json;
28
28
  }
29
29
  return {
30
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
30
31
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
32
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
31
33
  'name': json['name'] == null ? undefined : json['name'],
32
34
  'overlayOffset': json['overlayOffset'] == null ? undefined : FloorplanChangelogOverlayOffsetFromJSON(json['overlayOffset']),
33
35
  'property': json['property'] == null ? undefined : json['property'],
@@ -43,7 +45,9 @@ export function FloorplanPatchParamsBodyToJSONTyped(value, ignoreDiscriminator =
43
45
  return value;
44
46
  }
45
47
  return {
48
+ 'backgroundFile': value['backgroundFile'],
46
49
  'createdAt': value['createdAt'],
50
+ 'foregroundFile': value['foregroundFile'],
47
51
  'name': value['name'],
48
52
  'overlayOffset': FloorplanChangelogOverlayOffsetToJSON(value['overlayOffset']),
49
53
  'property': value['property'],
@@ -15,12 +15,24 @@
15
15
  * @interface FloorplanBrief
16
16
  */
17
17
  export interface FloorplanBrief {
18
+ /**
19
+ * ID of the account file used as the background image, if one is set.
20
+ * @type {string}
21
+ * @memberof FloorplanBrief
22
+ */
23
+ backgroundFile?: string;
18
24
  /**
19
25
  *
20
26
  * @type {number}
21
27
  * @memberof FloorplanBrief
22
28
  */
23
29
  createdAt: number;
30
+ /**
31
+ * ID of the account file used as the foreground image, if one is set.
32
+ * @type {string}
33
+ * @memberof FloorplanBrief
34
+ */
35
+ foregroundFile?: string;
24
36
  /**
25
37
  *
26
38
  * @type {string}
@@ -42,7 +42,9 @@ function FloorplanBriefFromJSONTyped(json, ignoreDiscriminator) {
42
42
  return json;
43
43
  }
44
44
  return {
45
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
45
46
  'createdAt': json['createdAt'],
47
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
46
48
  'id': json['id'],
47
49
  'name': json['name'],
48
50
  'property': json['property'],
@@ -57,7 +59,9 @@ function FloorplanBriefToJSONTyped(value, ignoreDiscriminator = false) {
57
59
  return value;
58
60
  }
59
61
  return {
62
+ 'backgroundFile': value['backgroundFile'],
60
63
  'createdAt': value['createdAt'],
64
+ 'foregroundFile': value['foregroundFile'],
61
65
  'id': value['id'],
62
66
  'name': value['name'],
63
67
  'property': value['property'],
@@ -17,12 +17,24 @@ import type { FloorplanGetBodySpace } from './FloorplanGetBodySpace';
17
17
  * @interface FloorplanGetBody
18
18
  */
19
19
  export interface FloorplanGetBody {
20
+ /**
21
+ * ID of the account file used as the background image, if one is set.
22
+ * @type {string}
23
+ * @memberof FloorplanGetBody
24
+ */
25
+ backgroundFile?: string;
20
26
  /**
21
27
  *
22
28
  * @type {number}
23
29
  * @memberof FloorplanGetBody
24
30
  */
25
31
  createdAt: number;
32
+ /**
33
+ * ID of the account file used as the foreground image, if one is set.
34
+ * @type {string}
35
+ * @memberof FloorplanGetBody
36
+ */
37
+ foregroundFile?: string;
26
38
  /**
27
39
  *
28
40
  * @type {string}
@@ -46,7 +46,9 @@ function FloorplanGetBodyFromJSONTyped(json, ignoreDiscriminator) {
46
46
  return json;
47
47
  }
48
48
  return {
49
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
49
50
  'createdAt': json['createdAt'],
51
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
50
52
  'name': json['name'],
51
53
  'overlayOffset': (0, FloorplanGetBodyOverlayOffset_1.FloorplanGetBodyOverlayOffsetFromJSON)(json['overlayOffset']),
52
54
  'property': json['property'],
@@ -62,7 +64,9 @@ function FloorplanGetBodyToJSONTyped(value, ignoreDiscriminator = false) {
62
64
  return value;
63
65
  }
64
66
  return {
67
+ 'backgroundFile': value['backgroundFile'],
65
68
  'createdAt': value['createdAt'],
69
+ 'foregroundFile': value['foregroundFile'],
66
70
  'name': value['name'],
67
71
  'overlayOffset': (0, FloorplanGetBodyOverlayOffset_1.FloorplanGetBodyOverlayOffsetToJSON)(value['overlayOffset']),
68
72
  'property': value['property'],
@@ -17,12 +17,24 @@ import type { FloorplanCreateSpaceRepeated } from './FloorplanCreateSpaceRepeate
17
17
  * @interface FloorplanPatchParamsBody
18
18
  */
19
19
  export interface FloorplanPatchParamsBody {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof FloorplanPatchParamsBody
24
+ */
25
+ backgroundFile?: string;
20
26
  /**
21
27
  *
22
28
  * @type {number}
23
29
  * @memberof FloorplanPatchParamsBody
24
30
  */
25
31
  createdAt?: number;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof FloorplanPatchParamsBody
36
+ */
37
+ foregroundFile?: string;
26
38
  /**
27
39
  *
28
40
  * @type {string}
@@ -34,7 +34,9 @@ function FloorplanPatchParamsBodyFromJSONTyped(json, ignoreDiscriminator) {
34
34
  return json;
35
35
  }
36
36
  return {
37
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
37
38
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
39
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
38
40
  'name': json['name'] == null ? undefined : json['name'],
39
41
  'overlayOffset': json['overlayOffset'] == null ? undefined : (0, FloorplanChangelogOverlayOffset_1.FloorplanChangelogOverlayOffsetFromJSON)(json['overlayOffset']),
40
42
  'property': json['property'] == null ? undefined : json['property'],
@@ -50,7 +52,9 @@ function FloorplanPatchParamsBodyToJSONTyped(value, ignoreDiscriminator = false)
50
52
  return value;
51
53
  }
52
54
  return {
55
+ 'backgroundFile': value['backgroundFile'],
53
56
  'createdAt': value['createdAt'],
57
+ 'foregroundFile': value['foregroundFile'],
54
58
  'name': value['name'],
55
59
  'overlayOffset': (0, FloorplanChangelogOverlayOffset_1.FloorplanChangelogOverlayOffsetToJSON)(value['overlayOffset']),
56
60
  'property': value['property'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spaciv/sdk",
3
- "version": "0.1.6",
3
+ "version": "0.1.7",
4
4
  "description": "OpenAPI client for @spaciv/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -120,11 +120,11 @@ export interface FloorPlansApiInterface {
120
120
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
121
121
 
122
122
  /**
123
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
123
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
124
124
  * @summary Get a floor plan image
125
125
  * @param {string} id
126
126
  * @param {'image' | 'foreground'} imageType Which image layer to retrieve: the base drawing (image) or the foreground overlay (foreground).
127
- * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if no image has been uploaded.
127
+ * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if the layer has no image.
128
128
  * @param {*} [options] Override http request option.
129
129
  * @throws {RequiredError}
130
130
  * @memberof FloorPlansApiInterface
@@ -132,7 +132,7 @@ export interface FloorPlansApiInterface {
132
132
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
133
133
 
134
134
  /**
135
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
135
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
136
136
  * Get a floor plan image
137
137
  */
138
138
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -153,7 +153,7 @@ export interface FloorPlansApiInterface {
153
153
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
154
154
 
155
155
  /**
156
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
156
+ * 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}`.
157
157
  * @summary Update a floor plan
158
158
  * @param {string} id
159
159
  * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
@@ -164,13 +164,13 @@ export interface FloorPlansApiInterface {
164
164
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
165
165
 
166
166
  /**
167
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
167
+ * 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}`.
168
168
  * Update a floor plan
169
169
  */
170
170
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
171
171
 
172
172
  /**
173
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
173
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
174
174
  * @summary Upload a floor plan image
175
175
  * @param {string} id
176
176
  * @param {'image' | 'foreground'} imageType Which image layer to upload: the base drawing (image) or the foreground overlay (foreground).
@@ -183,7 +183,7 @@ export interface FloorPlansApiInterface {
183
183
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
184
184
 
185
185
  /**
186
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
186
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
187
187
  * Upload a floor plan image
188
188
  */
189
189
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -343,7 +343,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
343
343
  }
344
344
 
345
345
  /**
346
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
346
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
347
347
  * Get a floor plan image
348
348
  */
349
349
  async getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -397,7 +397,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
397
397
  }
398
398
 
399
399
  /**
400
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* 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.
400
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
401
401
  * Get a floor plan image
402
402
  */
403
403
  async getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -445,7 +445,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
445
445
  }
446
446
 
447
447
  /**
448
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
448
+ * 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}`.
449
449
  * Update a floor plan
450
450
  */
451
451
  async updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -486,7 +486,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
486
486
  }
487
487
 
488
488
  /**
489
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
489
+ * 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}`.
490
490
  * Update a floor plan
491
491
  */
492
492
  async update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -495,7 +495,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
495
495
  }
496
496
 
497
497
  /**
498
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
498
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
499
499
  * Upload a floor plan image
500
500
  */
501
501
  async updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -566,7 +566,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
566
566
  }
567
567
 
568
568
  /**
569
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
569
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
570
570
  * Upload a floor plan image
571
571
  */
572
572
  async updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -19,12 +19,24 @@ import { mapValues } from '../runtime';
19
19
  * @interface FloorplanBrief
20
20
  */
21
21
  export interface FloorplanBrief {
22
+ /**
23
+ * ID of the account file used as the background image, if one is set.
24
+ * @type {string}
25
+ * @memberof FloorplanBrief
26
+ */
27
+ backgroundFile?: string;
22
28
  /**
23
29
  *
24
30
  * @type {number}
25
31
  * @memberof FloorplanBrief
26
32
  */
27
33
  createdAt: number;
34
+ /**
35
+ * ID of the account file used as the foreground image, if one is set.
36
+ * @type {string}
37
+ * @memberof FloorplanBrief
38
+ */
39
+ foregroundFile?: string;
28
40
  /**
29
41
  *
30
42
  * @type {string}
@@ -73,7 +85,9 @@ export function FloorplanBriefFromJSONTyped(json: any, ignoreDiscriminator: bool
73
85
  }
74
86
  return {
75
87
 
88
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
76
89
  'createdAt': json['createdAt'],
90
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
77
91
  'id': json['id'],
78
92
  'name': json['name'],
79
93
  'property': json['property'],
@@ -92,7 +106,9 @@ export function FloorplanBriefToJSONTyped(value?: FloorplanBrief | null, ignoreD
92
106
 
93
107
  return {
94
108
 
109
+ 'backgroundFile': value['backgroundFile'],
95
110
  'createdAt': value['createdAt'],
111
+ 'foregroundFile': value['foregroundFile'],
96
112
  'id': value['id'],
97
113
  'name': value['name'],
98
114
  'property': value['property'],
@@ -34,12 +34,24 @@ import {
34
34
  * @interface FloorplanGetBody
35
35
  */
36
36
  export interface FloorplanGetBody {
37
+ /**
38
+ * ID of the account file used as the background image, if one is set.
39
+ * @type {string}
40
+ * @memberof FloorplanGetBody
41
+ */
42
+ backgroundFile?: string;
37
43
  /**
38
44
  *
39
45
  * @type {number}
40
46
  * @memberof FloorplanGetBody
41
47
  */
42
48
  createdAt: number;
49
+ /**
50
+ * ID of the account file used as the foreground image, if one is set.
51
+ * @type {string}
52
+ * @memberof FloorplanGetBody
53
+ */
54
+ foregroundFile?: string;
43
55
  /**
44
56
  *
45
57
  * @type {string}
@@ -95,7 +107,9 @@ export function FloorplanGetBodyFromJSONTyped(json: any, ignoreDiscriminator: bo
95
107
  }
96
108
  return {
97
109
 
110
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
98
111
  'createdAt': json['createdAt'],
112
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
99
113
  'name': json['name'],
100
114
  'overlayOffset': FloorplanGetBodyOverlayOffsetFromJSON(json['overlayOffset']),
101
115
  'property': json['property'],
@@ -115,7 +129,9 @@ export function FloorplanGetBodyToJSONTyped(value?: FloorplanGetBody | null, ign
115
129
 
116
130
  return {
117
131
 
132
+ 'backgroundFile': value['backgroundFile'],
118
133
  'createdAt': value['createdAt'],
134
+ 'foregroundFile': value['foregroundFile'],
119
135
  'name': value['name'],
120
136
  'overlayOffset': FloorplanGetBodyOverlayOffsetToJSON(value['overlayOffset']),
121
137
  'property': value['property'],
@@ -34,12 +34,24 @@ import {
34
34
  * @interface FloorplanPatchParamsBody
35
35
  */
36
36
  export interface FloorplanPatchParamsBody {
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof FloorplanPatchParamsBody
41
+ */
42
+ backgroundFile?: string;
37
43
  /**
38
44
  *
39
45
  * @type {number}
40
46
  * @memberof FloorplanPatchParamsBody
41
47
  */
42
48
  createdAt?: number;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof FloorplanPatchParamsBody
53
+ */
54
+ foregroundFile?: string;
43
55
  /**
44
56
  *
45
57
  * @type {string}
@@ -89,7 +101,9 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json: any, ignoreDiscrimin
89
101
  }
90
102
  return {
91
103
 
104
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
92
105
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
106
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
93
107
  'name': json['name'] == null ? undefined : json['name'],
94
108
  'overlayOffset': json['overlayOffset'] == null ? undefined : FloorplanChangelogOverlayOffsetFromJSON(json['overlayOffset']),
95
109
  'property': json['property'] == null ? undefined : json['property'],
@@ -109,7 +123,9 @@ export function FloorplanPatchParamsBodyToJSONTyped(value?: FloorplanPatchParams
109
123
 
110
124
  return {
111
125
 
126
+ 'backgroundFile': value['backgroundFile'],
112
127
  'createdAt': value['createdAt'],
128
+ 'foregroundFile': value['foregroundFile'],
113
129
  'name': value['name'],
114
130
  'overlayOffset': FloorplanChangelogOverlayOffsetToJSON(value['overlayOffset']),
115
131
  'property': value['property'],