@spaciv/sdk 0.1.8 → 0.1.9
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 +2 -2
- package/dist/apis/FloorPlansApi.d.ts +8 -8
- package/dist/apis/FloorPlansApi.js +4 -4
- package/dist/esm/apis/FloorPlansApi.d.ts +8 -8
- package/dist/esm/apis/FloorPlansApi.js +4 -4
- package/dist/esm/models/FloorplanCreateSpace.d.ts +12 -0
- package/dist/esm/models/FloorplanCreateSpace.js +4 -0
- package/dist/esm/models/FloorplanGetBody.d.ts +15 -0
- package/dist/esm/models/FloorplanGetBody.js +12 -0
- package/dist/esm/models/FloorplanGetBodySpace.d.ts +12 -0
- package/dist/esm/models/FloorplanGetBodySpace.js +4 -0
- package/dist/esm/models/FloorplanPatchParamsBody.d.ts +6 -0
- package/dist/esm/models/FloorplanPatchParamsBody.js +2 -0
- package/dist/models/FloorplanCreateSpace.d.ts +12 -0
- package/dist/models/FloorplanCreateSpace.js +4 -0
- package/dist/models/FloorplanGetBody.d.ts +15 -0
- package/dist/models/FloorplanGetBody.js +13 -0
- package/dist/models/FloorplanGetBodySpace.d.ts +12 -0
- package/dist/models/FloorplanGetBodySpace.js +4 -0
- package/dist/models/FloorplanPatchParamsBody.d.ts +6 -0
- package/dist/models/FloorplanPatchParamsBody.js +2 -0
- package/package.json +1 -1
- package/src/apis/FloorPlansApi.ts +8 -8
- package/src/models/FloorplanCreateSpace.ts +16 -0
- package/src/models/FloorplanGetBody.ts +21 -0
- package/src/models/FloorplanGetBodySpace.ts +16 -0
- package/src/models/FloorplanPatchParamsBody.ts +8 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.9
|
|
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.
|
|
39
|
+
npm install @spaciv/sdk@0.1.9 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -71,7 +71,7 @@ export interface FloorPlansApiInterface {
|
|
|
71
71
|
*/
|
|
72
72
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
73
73
|
/**
|
|
74
|
-
* 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.
|
|
74
|
+
* 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.
|
|
75
75
|
* @summary Get a floor plan
|
|
76
76
|
* @param {string} id
|
|
77
77
|
* @param {*} [options] Override http request option.
|
|
@@ -80,7 +80,7 @@ export interface FloorPlansApiInterface {
|
|
|
80
80
|
*/
|
|
81
81
|
getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
|
|
82
82
|
/**
|
|
83
|
-
* 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.
|
|
83
|
+
* 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.
|
|
84
84
|
* Get a floor plan
|
|
85
85
|
*/
|
|
86
86
|
get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
|
|
@@ -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, 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}`.
|
|
117
|
+
* 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}`.
|
|
118
118
|
* @summary Update a floor plan
|
|
119
119
|
* @param {string} id
|
|
120
120
|
* @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
|
|
@@ -124,7 +124,7 @@ 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, 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}`.
|
|
127
|
+
* 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}`.
|
|
128
128
|
* Update a floor plan
|
|
129
129
|
*/
|
|
130
130
|
update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -171,12 +171,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
|
|
|
171
171
|
*/
|
|
172
172
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
173
173
|
/**
|
|
174
|
-
* 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.
|
|
174
|
+
* 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.
|
|
175
175
|
* Get a floor plan
|
|
176
176
|
*/
|
|
177
177
|
getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
|
|
178
178
|
/**
|
|
179
|
-
* 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.
|
|
179
|
+
* 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.
|
|
180
180
|
* Get a floor plan
|
|
181
181
|
*/
|
|
182
182
|
get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
|
|
@@ -201,12 +201,12 @@ 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, 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}`.
|
|
204
|
+
* 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}`.
|
|
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, 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}`.
|
|
209
|
+
* 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}`.
|
|
210
210
|
* Update a floor plan
|
|
211
211
|
*/
|
|
212
212
|
update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -114,7 +114,7 @@ class FloorPlansApi extends runtime.BaseAPI {
|
|
|
114
114
|
});
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
|
-
* 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.
|
|
117
|
+
* 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.
|
|
118
118
|
* Get a floor plan
|
|
119
119
|
*/
|
|
120
120
|
getRaw(requestParameters, initOverrides) {
|
|
@@ -143,7 +143,7 @@ class FloorPlansApi extends runtime.BaseAPI {
|
|
|
143
143
|
});
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
|
-
* 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.
|
|
146
|
+
* 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.
|
|
147
147
|
* Get a floor plan
|
|
148
148
|
*/
|
|
149
149
|
get(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, 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}`.
|
|
242
|
+
* 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}`.
|
|
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, 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}`.
|
|
273
|
+
* 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}`.
|
|
274
274
|
* Update a floor plan
|
|
275
275
|
*/
|
|
276
276
|
update(requestParameters, initOverrides) {
|
|
@@ -71,7 +71,7 @@ export interface FloorPlansApiInterface {
|
|
|
71
71
|
*/
|
|
72
72
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
73
73
|
/**
|
|
74
|
-
* 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.
|
|
74
|
+
* 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.
|
|
75
75
|
* @summary Get a floor plan
|
|
76
76
|
* @param {string} id
|
|
77
77
|
* @param {*} [options] Override http request option.
|
|
@@ -80,7 +80,7 @@ export interface FloorPlansApiInterface {
|
|
|
80
80
|
*/
|
|
81
81
|
getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
|
|
82
82
|
/**
|
|
83
|
-
* 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.
|
|
83
|
+
* 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.
|
|
84
84
|
* Get a floor plan
|
|
85
85
|
*/
|
|
86
86
|
get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
|
|
@@ -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, 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}`.
|
|
117
|
+
* 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}`.
|
|
118
118
|
* @summary Update a floor plan
|
|
119
119
|
* @param {string} id
|
|
120
120
|
* @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
|
|
@@ -124,7 +124,7 @@ 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, 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}`.
|
|
127
|
+
* 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}`.
|
|
128
128
|
* Update a floor plan
|
|
129
129
|
*/
|
|
130
130
|
update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -171,12 +171,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
|
|
|
171
171
|
*/
|
|
172
172
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
173
173
|
/**
|
|
174
|
-
* 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.
|
|
174
|
+
* 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.
|
|
175
175
|
* Get a floor plan
|
|
176
176
|
*/
|
|
177
177
|
getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
|
|
178
178
|
/**
|
|
179
|
-
* 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.
|
|
179
|
+
* 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.
|
|
180
180
|
* Get a floor plan
|
|
181
181
|
*/
|
|
182
182
|
get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
|
|
@@ -201,12 +201,12 @@ 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, 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}`.
|
|
204
|
+
* 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}`.
|
|
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, 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}`.
|
|
209
|
+
* 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}`.
|
|
210
210
|
* Update a floor plan
|
|
211
211
|
*/
|
|
212
212
|
update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -111,7 +111,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
111
111
|
});
|
|
112
112
|
}
|
|
113
113
|
/**
|
|
114
|
-
* 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.
|
|
114
|
+
* 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.
|
|
115
115
|
* Get a floor plan
|
|
116
116
|
*/
|
|
117
117
|
getRaw(requestParameters, initOverrides) {
|
|
@@ -140,7 +140,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
140
140
|
});
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
|
-
* 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.
|
|
143
|
+
* 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.
|
|
144
144
|
* Get a floor plan
|
|
145
145
|
*/
|
|
146
146
|
get(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, 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}`.
|
|
239
|
+
* 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}`.
|
|
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, 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}`.
|
|
270
|
+
* 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}`.
|
|
271
271
|
* Update a floor plan
|
|
272
272
|
*/
|
|
273
273
|
update(requestParameters, initOverrides) {
|
|
@@ -16,6 +16,12 @@ import type { FloorplanSpaceChangelogPath } from './FloorplanSpaceChangelogPath'
|
|
|
16
16
|
* @interface FloorplanCreateSpace
|
|
17
17
|
*/
|
|
18
18
|
export interface FloorplanCreateSpace {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof FloorplanCreateSpace
|
|
23
|
+
*/
|
|
24
|
+
endHeight?: number;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
@@ -28,6 +34,12 @@ export interface FloorplanCreateSpace {
|
|
|
28
34
|
* @memberof FloorplanCreateSpace
|
|
29
35
|
*/
|
|
30
36
|
paths: Array<FloorplanSpaceChangelogPath>;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof FloorplanCreateSpace
|
|
41
|
+
*/
|
|
42
|
+
startHeight?: number;
|
|
31
43
|
}
|
|
32
44
|
/**
|
|
33
45
|
* Check if a given object implements the FloorplanCreateSpace interface.
|
|
@@ -30,8 +30,10 @@ export function FloorplanCreateSpaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
30
30
|
return json;
|
|
31
31
|
}
|
|
32
32
|
return {
|
|
33
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
33
34
|
'location': json['location'],
|
|
34
35
|
'paths': (json['paths'].map(FloorplanSpaceChangelogPathFromJSON)),
|
|
36
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
35
37
|
};
|
|
36
38
|
}
|
|
37
39
|
export function FloorplanCreateSpaceToJSON(json) {
|
|
@@ -42,7 +44,9 @@ export function FloorplanCreateSpaceToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
42
44
|
return value;
|
|
43
45
|
}
|
|
44
46
|
return {
|
|
47
|
+
'endHeight': value['endHeight'],
|
|
45
48
|
'location': value['location'],
|
|
46
49
|
'paths': (value['paths'].map(FloorplanSpaceChangelogPathToJSON)),
|
|
50
|
+
'startHeight': value['startHeight'],
|
|
47
51
|
};
|
|
48
52
|
}
|
|
@@ -65,7 +65,22 @@ export interface FloorplanGetBody {
|
|
|
65
65
|
* @memberof FloorplanGetBody
|
|
66
66
|
*/
|
|
67
67
|
spaces: Array<FloorplanGetBodySpace>;
|
|
68
|
+
/**
|
|
69
|
+
* Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof FloorplanGetBody
|
|
72
|
+
*/
|
|
73
|
+
viewMode: FloorplanGetBodyViewModeEnum;
|
|
68
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* @export
|
|
77
|
+
*/
|
|
78
|
+
export declare const FloorplanGetBodyViewModeEnum: {
|
|
79
|
+
readonly _2dAnd3d: "2d-and-3d";
|
|
80
|
+
readonly _3dOnly: "3d-only";
|
|
81
|
+
readonly _2dOnly: "2d-only";
|
|
82
|
+
};
|
|
83
|
+
export type FloorplanGetBodyViewModeEnum = typeof FloorplanGetBodyViewModeEnum[keyof typeof FloorplanGetBodyViewModeEnum];
|
|
69
84
|
/**
|
|
70
85
|
* Check if a given object implements the FloorplanGetBody interface.
|
|
71
86
|
*/
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { FloorplanGetBodyOverlayOffsetFromJSON, FloorplanGetBodyOverlayOffsetToJSON, } from './FloorplanGetBodyOverlayOffset';
|
|
15
15
|
import { FloorplanGetBodySpaceFromJSON, FloorplanGetBodySpaceToJSON, } from './FloorplanGetBodySpace';
|
|
16
|
+
/**
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const FloorplanGetBodyViewModeEnum = {
|
|
20
|
+
_2dAnd3d: '2d-and-3d',
|
|
21
|
+
_3dOnly: '3d-only',
|
|
22
|
+
_2dOnly: '2d-only'
|
|
23
|
+
};
|
|
16
24
|
/**
|
|
17
25
|
* Check if a given object implements the FloorplanGetBody interface.
|
|
18
26
|
*/
|
|
@@ -29,6 +37,8 @@ export function instanceOfFloorplanGetBody(value) {
|
|
|
29
37
|
return false;
|
|
30
38
|
if (!('spaces' in value) || value['spaces'] === undefined)
|
|
31
39
|
return false;
|
|
40
|
+
if (!('viewMode' in value) || value['viewMode'] === undefined)
|
|
41
|
+
return false;
|
|
32
42
|
return true;
|
|
33
43
|
}
|
|
34
44
|
export function FloorplanGetBodyFromJSON(json) {
|
|
@@ -47,6 +57,7 @@ export function FloorplanGetBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
57
|
'property': json['property'],
|
|
48
58
|
'propertyNode': json['propertyNode'],
|
|
49
59
|
'spaces': (json['spaces'].map(FloorplanGetBodySpaceFromJSON)),
|
|
60
|
+
'viewMode': json['viewMode'],
|
|
50
61
|
};
|
|
51
62
|
}
|
|
52
63
|
export function FloorplanGetBodyToJSON(json) {
|
|
@@ -65,5 +76,6 @@ export function FloorplanGetBodyToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
65
76
|
'property': value['property'],
|
|
66
77
|
'propertyNode': value['propertyNode'],
|
|
67
78
|
'spaces': (value['spaces'].map(FloorplanGetBodySpaceToJSON)),
|
|
79
|
+
'viewMode': value['viewMode'],
|
|
68
80
|
};
|
|
69
81
|
}
|
|
@@ -16,6 +16,12 @@ import type { FloorplanGetBodySpacePoint } from './FloorplanGetBodySpacePoint';
|
|
|
16
16
|
* @interface FloorplanGetBodySpace
|
|
17
17
|
*/
|
|
18
18
|
export interface FloorplanGetBodySpace {
|
|
19
|
+
/**
|
|
20
|
+
* Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof FloorplanGetBodySpace
|
|
23
|
+
*/
|
|
24
|
+
endHeight?: number;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
@@ -28,6 +34,12 @@ export interface FloorplanGetBodySpace {
|
|
|
28
34
|
* @memberof FloorplanGetBodySpace
|
|
29
35
|
*/
|
|
30
36
|
paths: Array<Array<FloorplanGetBodySpacePoint>>;
|
|
37
|
+
/**
|
|
38
|
+
* Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof FloorplanGetBodySpace
|
|
41
|
+
*/
|
|
42
|
+
startHeight?: number;
|
|
31
43
|
}
|
|
32
44
|
/**
|
|
33
45
|
* Check if a given object implements the FloorplanGetBodySpace interface.
|
|
@@ -29,8 +29,10 @@ export function FloorplanGetBodySpaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
29
29
|
return json;
|
|
30
30
|
}
|
|
31
31
|
return {
|
|
32
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
32
33
|
'location': json['location'],
|
|
33
34
|
'paths': json['paths'],
|
|
35
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
34
36
|
};
|
|
35
37
|
}
|
|
36
38
|
export function FloorplanGetBodySpaceToJSON(json) {
|
|
@@ -41,7 +43,9 @@ export function FloorplanGetBodySpaceToJSONTyped(value, ignoreDiscriminator = fa
|
|
|
41
43
|
return value;
|
|
42
44
|
}
|
|
43
45
|
return {
|
|
46
|
+
'endHeight': value['endHeight'],
|
|
44
47
|
'location': value['location'],
|
|
45
48
|
'paths': value['paths'],
|
|
49
|
+
'startHeight': value['startHeight'],
|
|
46
50
|
};
|
|
47
51
|
}
|
|
@@ -65,6 +65,12 @@ export interface FloorplanPatchParamsBody {
|
|
|
65
65
|
* @memberof FloorplanPatchParamsBody
|
|
66
66
|
*/
|
|
67
67
|
spaces?: FloorplanCreateSpaceRepeated;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof FloorplanPatchParamsBody
|
|
72
|
+
*/
|
|
73
|
+
viewMode?: string;
|
|
68
74
|
}
|
|
69
75
|
/**
|
|
70
76
|
* Check if a given object implements the FloorplanPatchParamsBody interface.
|
|
@@ -35,6 +35,7 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json, ignoreDiscriminator)
|
|
|
35
35
|
'property': json['property'] == null ? undefined : json['property'],
|
|
36
36
|
'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
|
|
37
37
|
'spaces': json['spaces'] == null ? undefined : FloorplanCreateSpaceRepeatedFromJSON(json['spaces']),
|
|
38
|
+
'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
|
|
38
39
|
};
|
|
39
40
|
}
|
|
40
41
|
export function FloorplanPatchParamsBodyToJSON(json) {
|
|
@@ -53,5 +54,6 @@ export function FloorplanPatchParamsBodyToJSONTyped(value, ignoreDiscriminator =
|
|
|
53
54
|
'property': value['property'],
|
|
54
55
|
'propertyNode': value['propertyNode'],
|
|
55
56
|
'spaces': FloorplanCreateSpaceRepeatedToJSON(value['spaces']),
|
|
57
|
+
'viewMode': value['viewMode'],
|
|
56
58
|
};
|
|
57
59
|
}
|
|
@@ -16,6 +16,12 @@ import type { FloorplanSpaceChangelogPath } from './FloorplanSpaceChangelogPath'
|
|
|
16
16
|
* @interface FloorplanCreateSpace
|
|
17
17
|
*/
|
|
18
18
|
export interface FloorplanCreateSpace {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof FloorplanCreateSpace
|
|
23
|
+
*/
|
|
24
|
+
endHeight?: number;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
@@ -28,6 +34,12 @@ export interface FloorplanCreateSpace {
|
|
|
28
34
|
* @memberof FloorplanCreateSpace
|
|
29
35
|
*/
|
|
30
36
|
paths: Array<FloorplanSpaceChangelogPath>;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof FloorplanCreateSpace
|
|
41
|
+
*/
|
|
42
|
+
startHeight?: number;
|
|
31
43
|
}
|
|
32
44
|
/**
|
|
33
45
|
* Check if a given object implements the FloorplanCreateSpace interface.
|
|
@@ -37,8 +37,10 @@ function FloorplanCreateSpaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
37
|
return json;
|
|
38
38
|
}
|
|
39
39
|
return {
|
|
40
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
40
41
|
'location': json['location'],
|
|
41
42
|
'paths': (json['paths'].map(FloorplanSpaceChangelogPath_1.FloorplanSpaceChangelogPathFromJSON)),
|
|
43
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
42
44
|
};
|
|
43
45
|
}
|
|
44
46
|
function FloorplanCreateSpaceToJSON(json) {
|
|
@@ -49,7 +51,9 @@ function FloorplanCreateSpaceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
49
51
|
return value;
|
|
50
52
|
}
|
|
51
53
|
return {
|
|
54
|
+
'endHeight': value['endHeight'],
|
|
52
55
|
'location': value['location'],
|
|
53
56
|
'paths': (value['paths'].map(FloorplanSpaceChangelogPath_1.FloorplanSpaceChangelogPathToJSON)),
|
|
57
|
+
'startHeight': value['startHeight'],
|
|
54
58
|
};
|
|
55
59
|
}
|
|
@@ -65,7 +65,22 @@ export interface FloorplanGetBody {
|
|
|
65
65
|
* @memberof FloorplanGetBody
|
|
66
66
|
*/
|
|
67
67
|
spaces: Array<FloorplanGetBodySpace>;
|
|
68
|
+
/**
|
|
69
|
+
* Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof FloorplanGetBody
|
|
72
|
+
*/
|
|
73
|
+
viewMode: FloorplanGetBodyViewModeEnum;
|
|
68
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* @export
|
|
77
|
+
*/
|
|
78
|
+
export declare const FloorplanGetBodyViewModeEnum: {
|
|
79
|
+
readonly _2dAnd3d: "2d-and-3d";
|
|
80
|
+
readonly _3dOnly: "3d-only";
|
|
81
|
+
readonly _2dOnly: "2d-only";
|
|
82
|
+
};
|
|
83
|
+
export type FloorplanGetBodyViewModeEnum = typeof FloorplanGetBodyViewModeEnum[keyof typeof FloorplanGetBodyViewModeEnum];
|
|
69
84
|
/**
|
|
70
85
|
* Check if a given object implements the FloorplanGetBody interface.
|
|
71
86
|
*/
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.FloorplanGetBodyViewModeEnum = void 0;
|
|
16
17
|
exports.instanceOfFloorplanGetBody = instanceOfFloorplanGetBody;
|
|
17
18
|
exports.FloorplanGetBodyFromJSON = FloorplanGetBodyFromJSON;
|
|
18
19
|
exports.FloorplanGetBodyFromJSONTyped = FloorplanGetBodyFromJSONTyped;
|
|
@@ -20,6 +21,14 @@ exports.FloorplanGetBodyToJSON = FloorplanGetBodyToJSON;
|
|
|
20
21
|
exports.FloorplanGetBodyToJSONTyped = FloorplanGetBodyToJSONTyped;
|
|
21
22
|
const FloorplanGetBodyOverlayOffset_1 = require("./FloorplanGetBodyOverlayOffset");
|
|
22
23
|
const FloorplanGetBodySpace_1 = require("./FloorplanGetBodySpace");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.FloorplanGetBodyViewModeEnum = {
|
|
28
|
+
_2dAnd3d: '2d-and-3d',
|
|
29
|
+
_3dOnly: '3d-only',
|
|
30
|
+
_2dOnly: '2d-only'
|
|
31
|
+
};
|
|
23
32
|
/**
|
|
24
33
|
* Check if a given object implements the FloorplanGetBody interface.
|
|
25
34
|
*/
|
|
@@ -36,6 +45,8 @@ function instanceOfFloorplanGetBody(value) {
|
|
|
36
45
|
return false;
|
|
37
46
|
if (!('spaces' in value) || value['spaces'] === undefined)
|
|
38
47
|
return false;
|
|
48
|
+
if (!('viewMode' in value) || value['viewMode'] === undefined)
|
|
49
|
+
return false;
|
|
39
50
|
return true;
|
|
40
51
|
}
|
|
41
52
|
function FloorplanGetBodyFromJSON(json) {
|
|
@@ -54,6 +65,7 @@ function FloorplanGetBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
54
65
|
'property': json['property'],
|
|
55
66
|
'propertyNode': json['propertyNode'],
|
|
56
67
|
'spaces': (json['spaces'].map(FloorplanGetBodySpace_1.FloorplanGetBodySpaceFromJSON)),
|
|
68
|
+
'viewMode': json['viewMode'],
|
|
57
69
|
};
|
|
58
70
|
}
|
|
59
71
|
function FloorplanGetBodyToJSON(json) {
|
|
@@ -72,5 +84,6 @@ function FloorplanGetBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
72
84
|
'property': value['property'],
|
|
73
85
|
'propertyNode': value['propertyNode'],
|
|
74
86
|
'spaces': (value['spaces'].map(FloorplanGetBodySpace_1.FloorplanGetBodySpaceToJSON)),
|
|
87
|
+
'viewMode': value['viewMode'],
|
|
75
88
|
};
|
|
76
89
|
}
|
|
@@ -16,6 +16,12 @@ import type { FloorplanGetBodySpacePoint } from './FloorplanGetBodySpacePoint';
|
|
|
16
16
|
* @interface FloorplanGetBodySpace
|
|
17
17
|
*/
|
|
18
18
|
export interface FloorplanGetBodySpace {
|
|
19
|
+
/**
|
|
20
|
+
* Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof FloorplanGetBodySpace
|
|
23
|
+
*/
|
|
24
|
+
endHeight?: number;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
@@ -28,6 +34,12 @@ export interface FloorplanGetBodySpace {
|
|
|
28
34
|
* @memberof FloorplanGetBodySpace
|
|
29
35
|
*/
|
|
30
36
|
paths: Array<Array<FloorplanGetBodySpacePoint>>;
|
|
37
|
+
/**
|
|
38
|
+
* Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof FloorplanGetBodySpace
|
|
41
|
+
*/
|
|
42
|
+
startHeight?: number;
|
|
31
43
|
}
|
|
32
44
|
/**
|
|
33
45
|
* Check if a given object implements the FloorplanGetBodySpace interface.
|
|
@@ -36,8 +36,10 @@ function FloorplanGetBodySpaceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
36
36
|
return json;
|
|
37
37
|
}
|
|
38
38
|
return {
|
|
39
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
39
40
|
'location': json['location'],
|
|
40
41
|
'paths': json['paths'],
|
|
42
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
41
43
|
};
|
|
42
44
|
}
|
|
43
45
|
function FloorplanGetBodySpaceToJSON(json) {
|
|
@@ -48,7 +50,9 @@ function FloorplanGetBodySpaceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
48
50
|
return value;
|
|
49
51
|
}
|
|
50
52
|
return {
|
|
53
|
+
'endHeight': value['endHeight'],
|
|
51
54
|
'location': value['location'],
|
|
52
55
|
'paths': value['paths'],
|
|
56
|
+
'startHeight': value['startHeight'],
|
|
53
57
|
};
|
|
54
58
|
}
|
|
@@ -65,6 +65,12 @@ export interface FloorplanPatchParamsBody {
|
|
|
65
65
|
* @memberof FloorplanPatchParamsBody
|
|
66
66
|
*/
|
|
67
67
|
spaces?: FloorplanCreateSpaceRepeated;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof FloorplanPatchParamsBody
|
|
72
|
+
*/
|
|
73
|
+
viewMode?: string;
|
|
68
74
|
}
|
|
69
75
|
/**
|
|
70
76
|
* Check if a given object implements the FloorplanPatchParamsBody interface.
|
|
@@ -42,6 +42,7 @@ function FloorplanPatchParamsBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
42
42
|
'property': json['property'] == null ? undefined : json['property'],
|
|
43
43
|
'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
|
|
44
44
|
'spaces': json['spaces'] == null ? undefined : (0, FloorplanCreateSpaceRepeated_1.FloorplanCreateSpaceRepeatedFromJSON)(json['spaces']),
|
|
45
|
+
'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
|
|
45
46
|
};
|
|
46
47
|
}
|
|
47
48
|
function FloorplanPatchParamsBodyToJSON(json) {
|
|
@@ -60,5 +61,6 @@ function FloorplanPatchParamsBodyToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
60
61
|
'property': value['property'],
|
|
61
62
|
'propertyNode': value['propertyNode'],
|
|
62
63
|
'spaces': (0, FloorplanCreateSpaceRepeated_1.FloorplanCreateSpaceRepeatedToJSON)(value['spaces']),
|
|
64
|
+
'viewMode': value['viewMode'],
|
|
63
65
|
};
|
|
64
66
|
}
|
package/package.json
CHANGED
|
@@ -104,7 +104,7 @@ export interface FloorPlansApiInterface {
|
|
|
104
104
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
-
* 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.
|
|
107
|
+
* 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.
|
|
108
108
|
* @summary Get a floor plan
|
|
109
109
|
* @param {string} id
|
|
110
110
|
* @param {*} [options] Override http request option.
|
|
@@ -114,7 +114,7 @@ export interface FloorPlansApiInterface {
|
|
|
114
114
|
getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>>;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* 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.
|
|
117
|
+
* 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.
|
|
118
118
|
* Get a floor plan
|
|
119
119
|
*/
|
|
120
120
|
get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
|
|
@@ -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, 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}`.
|
|
156
|
+
* 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}`.
|
|
157
157
|
* @summary Update a floor plan
|
|
158
158
|
* @param {string} id
|
|
159
159
|
* @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
|
|
@@ -164,7 +164,7 @@ 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, 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}`.
|
|
167
|
+
* 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}`.
|
|
168
168
|
* Update a floor plan
|
|
169
169
|
*/
|
|
170
170
|
update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -296,7 +296,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
|
|
|
296
296
|
}
|
|
297
297
|
|
|
298
298
|
/**
|
|
299
|
-
* 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.
|
|
299
|
+
* 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.
|
|
300
300
|
* Get a floor plan
|
|
301
301
|
*/
|
|
302
302
|
async getRaw(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FloorplanGetBody>> {
|
|
@@ -334,7 +334,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
|
|
|
334
334
|
}
|
|
335
335
|
|
|
336
336
|
/**
|
|
337
|
-
* 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.
|
|
337
|
+
* 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.
|
|
338
338
|
* Get a floor plan
|
|
339
339
|
*/
|
|
340
340
|
async get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody> {
|
|
@@ -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, 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}`.
|
|
448
|
+
* 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}`.
|
|
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, 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}`.
|
|
489
|
+
* 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}`.
|
|
490
490
|
* Update a floor plan
|
|
491
491
|
*/
|
|
492
492
|
async update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|
|
@@ -27,6 +27,12 @@ import {
|
|
|
27
27
|
* @interface FloorplanCreateSpace
|
|
28
28
|
*/
|
|
29
29
|
export interface FloorplanCreateSpace {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof FloorplanCreateSpace
|
|
34
|
+
*/
|
|
35
|
+
endHeight?: number;
|
|
30
36
|
/**
|
|
31
37
|
*
|
|
32
38
|
* @type {string}
|
|
@@ -39,6 +45,12 @@ export interface FloorplanCreateSpace {
|
|
|
39
45
|
* @memberof FloorplanCreateSpace
|
|
40
46
|
*/
|
|
41
47
|
paths: Array<FloorplanSpaceChangelogPath>;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof FloorplanCreateSpace
|
|
52
|
+
*/
|
|
53
|
+
startHeight?: number;
|
|
42
54
|
}
|
|
43
55
|
|
|
44
56
|
/**
|
|
@@ -60,8 +72,10 @@ export function FloorplanCreateSpaceFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
60
72
|
}
|
|
61
73
|
return {
|
|
62
74
|
|
|
75
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
63
76
|
'location': json['location'],
|
|
64
77
|
'paths': ((json['paths'] as Array<any>).map(FloorplanSpaceChangelogPathFromJSON)),
|
|
78
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
65
79
|
};
|
|
66
80
|
}
|
|
67
81
|
|
|
@@ -76,8 +90,10 @@ export function FloorplanCreateSpaceToJSONTyped(value?: FloorplanCreateSpace | n
|
|
|
76
90
|
|
|
77
91
|
return {
|
|
78
92
|
|
|
93
|
+
'endHeight': value['endHeight'],
|
|
79
94
|
'location': value['location'],
|
|
80
95
|
'paths': ((value['paths'] as Array<any>).map(FloorplanSpaceChangelogPathToJSON)),
|
|
96
|
+
'startHeight': value['startHeight'],
|
|
81
97
|
};
|
|
82
98
|
}
|
|
83
99
|
|
|
@@ -82,8 +82,26 @@ export interface FloorplanGetBody {
|
|
|
82
82
|
* @memberof FloorplanGetBody
|
|
83
83
|
*/
|
|
84
84
|
spaces: Array<FloorplanGetBodySpace>;
|
|
85
|
+
/**
|
|
86
|
+
* Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof FloorplanGetBody
|
|
89
|
+
*/
|
|
90
|
+
viewMode: FloorplanGetBodyViewModeEnum;
|
|
85
91
|
}
|
|
86
92
|
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @export
|
|
96
|
+
*/
|
|
97
|
+
export const FloorplanGetBodyViewModeEnum = {
|
|
98
|
+
_2dAnd3d: '2d-and-3d',
|
|
99
|
+
_3dOnly: '3d-only',
|
|
100
|
+
_2dOnly: '2d-only'
|
|
101
|
+
} as const;
|
|
102
|
+
export type FloorplanGetBodyViewModeEnum = typeof FloorplanGetBodyViewModeEnum[keyof typeof FloorplanGetBodyViewModeEnum];
|
|
103
|
+
|
|
104
|
+
|
|
87
105
|
/**
|
|
88
106
|
* Check if a given object implements the FloorplanGetBody interface.
|
|
89
107
|
*/
|
|
@@ -94,6 +112,7 @@ export function instanceOfFloorplanGetBody(value: object): value is FloorplanGet
|
|
|
94
112
|
if (!('property' in value) || value['property'] === undefined) return false;
|
|
95
113
|
if (!('propertyNode' in value) || value['propertyNode'] === undefined) return false;
|
|
96
114
|
if (!('spaces' in value) || value['spaces'] === undefined) return false;
|
|
115
|
+
if (!('viewMode' in value) || value['viewMode'] === undefined) return false;
|
|
97
116
|
return true;
|
|
98
117
|
}
|
|
99
118
|
|
|
@@ -115,6 +134,7 @@ export function FloorplanGetBodyFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
115
134
|
'property': json['property'],
|
|
116
135
|
'propertyNode': json['propertyNode'],
|
|
117
136
|
'spaces': ((json['spaces'] as Array<any>).map(FloorplanGetBodySpaceFromJSON)),
|
|
137
|
+
'viewMode': json['viewMode'],
|
|
118
138
|
};
|
|
119
139
|
}
|
|
120
140
|
|
|
@@ -137,6 +157,7 @@ export function FloorplanGetBodyToJSONTyped(value?: FloorplanGetBody | null, ign
|
|
|
137
157
|
'property': value['property'],
|
|
138
158
|
'propertyNode': value['propertyNode'],
|
|
139
159
|
'spaces': ((value['spaces'] as Array<any>).map(FloorplanGetBodySpaceToJSON)),
|
|
160
|
+
'viewMode': value['viewMode'],
|
|
140
161
|
};
|
|
141
162
|
}
|
|
142
163
|
|
|
@@ -27,6 +27,12 @@ import {
|
|
|
27
27
|
* @interface FloorplanGetBodySpace
|
|
28
28
|
*/
|
|
29
29
|
export interface FloorplanGetBodySpace {
|
|
30
|
+
/**
|
|
31
|
+
* Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof FloorplanGetBodySpace
|
|
34
|
+
*/
|
|
35
|
+
endHeight?: number;
|
|
30
36
|
/**
|
|
31
37
|
*
|
|
32
38
|
* @type {string}
|
|
@@ -39,6 +45,12 @@ export interface FloorplanGetBodySpace {
|
|
|
39
45
|
* @memberof FloorplanGetBodySpace
|
|
40
46
|
*/
|
|
41
47
|
paths: Array<Array<FloorplanGetBodySpacePoint>>;
|
|
48
|
+
/**
|
|
49
|
+
* Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof FloorplanGetBodySpace
|
|
52
|
+
*/
|
|
53
|
+
startHeight?: number;
|
|
42
54
|
}
|
|
43
55
|
|
|
44
56
|
/**
|
|
@@ -60,8 +72,10 @@ export function FloorplanGetBodySpaceFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
60
72
|
}
|
|
61
73
|
return {
|
|
62
74
|
|
|
75
|
+
'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
|
|
63
76
|
'location': json['location'],
|
|
64
77
|
'paths': json['paths'],
|
|
78
|
+
'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
|
|
65
79
|
};
|
|
66
80
|
}
|
|
67
81
|
|
|
@@ -76,8 +90,10 @@ export function FloorplanGetBodySpaceToJSONTyped(value?: FloorplanGetBodySpace |
|
|
|
76
90
|
|
|
77
91
|
return {
|
|
78
92
|
|
|
93
|
+
'endHeight': value['endHeight'],
|
|
79
94
|
'location': value['location'],
|
|
80
95
|
'paths': value['paths'],
|
|
96
|
+
'startHeight': value['startHeight'],
|
|
81
97
|
};
|
|
82
98
|
}
|
|
83
99
|
|
|
@@ -82,6 +82,12 @@ export interface FloorplanPatchParamsBody {
|
|
|
82
82
|
* @memberof FloorplanPatchParamsBody
|
|
83
83
|
*/
|
|
84
84
|
spaces?: FloorplanCreateSpaceRepeated;
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @type {string}
|
|
88
|
+
* @memberof FloorplanPatchParamsBody
|
|
89
|
+
*/
|
|
90
|
+
viewMode?: string;
|
|
85
91
|
}
|
|
86
92
|
|
|
87
93
|
/**
|
|
@@ -109,6 +115,7 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
109
115
|
'property': json['property'] == null ? undefined : json['property'],
|
|
110
116
|
'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
|
|
111
117
|
'spaces': json['spaces'] == null ? undefined : FloorplanCreateSpaceRepeatedFromJSON(json['spaces']),
|
|
118
|
+
'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
|
|
112
119
|
};
|
|
113
120
|
}
|
|
114
121
|
|
|
@@ -131,6 +138,7 @@ export function FloorplanPatchParamsBodyToJSONTyped(value?: FloorplanPatchParams
|
|
|
131
138
|
'property': value['property'],
|
|
132
139
|
'propertyNode': value['propertyNode'],
|
|
133
140
|
'spaces': FloorplanCreateSpaceRepeatedToJSON(value['spaces']),
|
|
141
|
+
'viewMode': value['viewMode'],
|
|
134
142
|
};
|
|
135
143
|
}
|
|
136
144
|
|