@spaciv/sdk 0.1.7 → 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/.openapi-generator/FILES +2 -8
- package/README.md +2 -2
- package/dist/apis/AnalysisApi.d.ts +4 -4
- package/dist/apis/AnalysisApi.js +2 -2
- package/dist/apis/FloorPlansApi.d.ts +8 -8
- package/dist/apis/FloorPlansApi.js +4 -4
- package/dist/esm/apis/AnalysisApi.d.ts +4 -4
- package/dist/esm/apis/AnalysisApi.js +2 -2
- package/dist/esm/apis/FloorPlansApi.d.ts +8 -8
- package/dist/esm/apis/FloorPlansApi.js +4 -4
- package/dist/esm/models/{NodeOffset.d.ts → CalcAxis.d.ts} +27 -16
- package/dist/esm/models/{NodeOffset.js → CalcAxis.js} +25 -15
- package/dist/esm/models/{CalcNode.d.ts → CalcAxisMember.d.ts} +24 -18
- package/dist/esm/models/{CalcNode.js → CalcAxisMember.js} +17 -15
- package/dist/esm/models/CalcBody.d.ts +6 -0
- package/dist/esm/models/CalcBody.js +2 -0
- package/dist/esm/models/CalcErrorBody.d.ts +1 -0
- package/dist/esm/models/CalcErrorBody.js +2 -1
- package/dist/esm/models/CalcRes.d.ts +5 -6
- package/dist/esm/models/CalcRes.js +7 -8
- 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/esm/models/index.d.ts +2 -8
- package/dist/esm/models/index.js +2 -8
- package/dist/{esm/models/TwoDLegendEntry.d.ts → models/CalcAxis.d.ts} +27 -15
- package/dist/models/{TwoDLegendEntry.js → CalcAxis.js} +31 -19
- package/dist/models/{CalcNode.d.ts → CalcAxisMember.d.ts} +24 -18
- package/dist/models/{CalcNode.js → CalcAxisMember.js} +22 -20
- package/dist/models/CalcBody.d.ts +6 -0
- package/dist/models/CalcBody.js +2 -0
- package/dist/models/CalcErrorBody.d.ts +1 -0
- package/dist/models/CalcErrorBody.js +2 -1
- package/dist/models/CalcRes.d.ts +5 -6
- package/dist/models/CalcRes.js +7 -8
- 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/dist/models/index.d.ts +2 -8
- package/dist/models/index.js +2 -8
- package/package.json +1 -1
- package/src/apis/AnalysisApi.ts +4 -4
- package/src/apis/FloorPlansApi.ts +8 -8
- package/src/models/{NodeOffset.ts → CalcAxis.ts} +43 -29
- package/src/models/{CalcNode.ts → CalcAxisMember.ts} +34 -26
- package/src/models/CalcBody.ts +8 -0
- package/src/models/CalcErrorBody.ts +2 -1
- package/src/models/CalcRes.ts +16 -23
- 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/src/models/index.ts +2 -8
- package/dist/esm/models/Legend.d.ts +0 -23
- package/dist/esm/models/Legend.js +0 -51
- package/dist/esm/models/LegendList.d.ts +0 -32
- package/dist/esm/models/LegendList.js +0 -43
- package/dist/esm/models/LegendOneOf.d.ts +0 -33
- package/dist/esm/models/LegendOneOf.js +0 -44
- package/dist/esm/models/LegendOneOf1.d.ts +0 -33
- package/dist/esm/models/LegendOneOf1.js +0 -44
- package/dist/esm/models/TwoDLegendEntry.js +0 -47
- package/dist/esm/models/TwoDLegendList.d.ts +0 -33
- package/dist/esm/models/TwoDLegendList.js +0 -44
- package/dist/models/Legend.d.ts +0 -23
- package/dist/models/Legend.js +0 -57
- package/dist/models/LegendList.d.ts +0 -32
- package/dist/models/LegendList.js +0 -50
- package/dist/models/LegendOneOf.d.ts +0 -33
- package/dist/models/LegendOneOf.js +0 -51
- package/dist/models/LegendOneOf1.d.ts +0 -33
- package/dist/models/LegendOneOf1.js +0 -51
- package/dist/models/NodeOffset.d.ts +0 -39
- package/dist/models/NodeOffset.js +0 -55
- package/dist/models/TwoDLegendEntry.d.ts +0 -38
- package/dist/models/TwoDLegendList.d.ts +0 -33
- package/dist/models/TwoDLegendList.js +0 -51
- package/src/models/Legend.ts +0 -76
- package/src/models/LegendList.ts +0 -66
- package/src/models/LegendOneOf.ts +0 -74
- package/src/models/LegendOneOf1.ts +0 -74
- package/src/models/TwoDLegendEntry.ts +0 -75
- package/src/models/TwoDLegendList.ts +0 -74
package/.openapi-generator/FILES
CHANGED
|
@@ -90,13 +90,14 @@ src/models/AuthenticationEmail.ts
|
|
|
90
90
|
src/models/AuthenticationPreferredChanel.ts
|
|
91
91
|
src/models/AuthenticationPublic.ts
|
|
92
92
|
src/models/Branding.ts
|
|
93
|
+
src/models/CalcAxis.ts
|
|
94
|
+
src/models/CalcAxisMember.ts
|
|
93
95
|
src/models/CalcBody.ts
|
|
94
96
|
src/models/CalcChildren.ts
|
|
95
97
|
src/models/CalcErrorBody.ts
|
|
96
98
|
src/models/CalcList.ts
|
|
97
99
|
src/models/CalcListEntry.ts
|
|
98
100
|
src/models/CalcListTwoD.ts
|
|
99
|
-
src/models/CalcNode.ts
|
|
100
101
|
src/models/CalcRes.ts
|
|
101
102
|
src/models/CalcRuleFloat.ts
|
|
102
103
|
src/models/CalcRuleRef.ts
|
|
@@ -250,10 +251,6 @@ src/models/LayerOneOf3.ts
|
|
|
250
251
|
src/models/LayerOneOf4.ts
|
|
251
252
|
src/models/LayerTypeNeed.ts
|
|
252
253
|
src/models/LayerVariablesRes.ts
|
|
253
|
-
src/models/Legend.ts
|
|
254
|
-
src/models/LegendList.ts
|
|
255
|
-
src/models/LegendOneOf.ts
|
|
256
|
-
src/models/LegendOneOf1.ts
|
|
257
254
|
src/models/ListAccountsForUserRow.ts
|
|
258
255
|
src/models/ListPage.ts
|
|
259
256
|
src/models/ListUserDetailsWithEmailRow.ts
|
|
@@ -276,7 +273,6 @@ src/models/ModelRecord.ts
|
|
|
276
273
|
src/models/MultiSelectChangelogData.ts
|
|
277
274
|
src/models/MultiSelectContributionData.ts
|
|
278
275
|
src/models/MultiSelectData.ts
|
|
279
|
-
src/models/NodeOffset.ts
|
|
280
276
|
src/models/ObjectGroupChangelogBody.ts
|
|
281
277
|
src/models/ObjectGroupEntriesRes.ts
|
|
282
278
|
src/models/ObjectGroupEntry.ts
|
|
@@ -378,8 +374,6 @@ src/models/TopDownModelEntryList.ts
|
|
|
378
374
|
src/models/TopDownModelEntryPropertyNodes.ts
|
|
379
375
|
src/models/TopDownModelEntryUpdate.ts
|
|
380
376
|
src/models/TopDownModelProperties.ts
|
|
381
|
-
src/models/TwoDLegendEntry.ts
|
|
382
|
-
src/models/TwoDLegendList.ts
|
|
383
377
|
src/models/UnmappedParameterDetail.ts
|
|
384
378
|
src/models/UserV2GetResBody.ts
|
|
385
379
|
src/models/UserV2PatchReqBody.ts
|
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):_
|
|
@@ -22,7 +22,7 @@ export interface AnalysisApiCreateAnalyseRequest {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AnalysisApiInterface {
|
|
24
24
|
/**
|
|
25
|
-
* Runs the scenario through the calculation engine and returns the
|
|
25
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
26
26
|
* @summary Run analysis
|
|
27
27
|
* @param {CalcBody} [calcBody]
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -31,7 +31,7 @@ export interface AnalysisApiInterface {
|
|
|
31
31
|
*/
|
|
32
32
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
33
33
|
/**
|
|
34
|
-
* Runs the scenario through the calculation engine and returns the
|
|
34
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
35
35
|
* Run analysis
|
|
36
36
|
*/
|
|
37
37
|
createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -41,12 +41,12 @@ export interface AnalysisApiInterface {
|
|
|
41
41
|
*/
|
|
42
42
|
export declare class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface {
|
|
43
43
|
/**
|
|
44
|
-
* Runs the scenario through the calculation engine and returns the
|
|
44
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
45
45
|
* Run analysis
|
|
46
46
|
*/
|
|
47
47
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
48
48
|
/**
|
|
49
|
-
* Runs the scenario through the calculation engine and returns the
|
|
49
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
50
50
|
* Run analysis
|
|
51
51
|
*/
|
|
52
52
|
createAnalyse(requestParameters?: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
package/dist/apis/AnalysisApi.js
CHANGED
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class AnalysisApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Runs the scenario through the calculation engine and returns the
|
|
33
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
34
34
|
* Run analysis
|
|
35
35
|
*/
|
|
36
36
|
createAnalyseRaw(requestParameters, initOverrides) {
|
|
@@ -57,7 +57,7 @@ class AnalysisApi extends runtime.BaseAPI {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Runs the scenario through the calculation engine and returns the
|
|
60
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
61
61
|
* Run analysis
|
|
62
62
|
*/
|
|
63
63
|
createAnalyse() {
|
|
@@ -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) {
|
|
@@ -22,7 +22,7 @@ export interface AnalysisApiCreateAnalyseRequest {
|
|
|
22
22
|
*/
|
|
23
23
|
export interface AnalysisApiInterface {
|
|
24
24
|
/**
|
|
25
|
-
* Runs the scenario through the calculation engine and returns the
|
|
25
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
26
26
|
* @summary Run analysis
|
|
27
27
|
* @param {CalcBody} [calcBody]
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -31,7 +31,7 @@ export interface AnalysisApiInterface {
|
|
|
31
31
|
*/
|
|
32
32
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
33
33
|
/**
|
|
34
|
-
* Runs the scenario through the calculation engine and returns the
|
|
34
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
35
35
|
* Run analysis
|
|
36
36
|
*/
|
|
37
37
|
createAnalyse(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -41,12 +41,12 @@ export interface AnalysisApiInterface {
|
|
|
41
41
|
*/
|
|
42
42
|
export declare class AnalysisApi extends runtime.BaseAPI implements AnalysisApiInterface {
|
|
43
43
|
/**
|
|
44
|
-
* Runs the scenario through the calculation engine and returns the
|
|
44
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
45
45
|
* Run analysis
|
|
46
46
|
*/
|
|
47
47
|
createAnalyseRaw(requestParameters: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CalcRes>>;
|
|
48
48
|
/**
|
|
49
|
-
* Runs the scenario through the calculation engine and returns the
|
|
49
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
50
50
|
* Run analysis
|
|
51
51
|
*/
|
|
52
52
|
createAnalyse(requestParameters?: AnalysisApiCreateAnalyseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CalcRes>;
|
|
@@ -27,7 +27,7 @@ import { CalcBodyToJSON, CalcResFromJSON, } from '../models/index';
|
|
|
27
27
|
*/
|
|
28
28
|
export class AnalysisApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Runs the scenario through the calculation engine and returns the
|
|
30
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
31
31
|
* Run analysis
|
|
32
32
|
*/
|
|
33
33
|
createAnalyseRaw(requestParameters, initOverrides) {
|
|
@@ -54,7 +54,7 @@ export class AnalysisApi extends runtime.BaseAPI {
|
|
|
54
54
|
});
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Runs the scenario through the calculation engine and returns the
|
|
57
|
+
* Runs the scenario through the calculation engine and returns the result as labelled `axes` and a flat `values` array. The axes come in the order given by `dimensions`, and `values` runs fastest along the last axis. A `400` response with a structured `kind` field indicates a configuration problem such as a missing scenario, property, or unmapped parameter — inspect the `kind` and the accompanying detail object to identify what needs fixing. A `variableOverrides` value outside the variable\'s range, step or `options` is rejected with `400` and `kind` `variable_type_mismatch`; `options` sent inside an override are ignored. Requires the *View ideal space* permission.
|
|
58
58
|
* Run analysis
|
|
59
59
|
*/
|
|
60
60
|
createAnalyse() {
|
|
@@ -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) {
|
|
@@ -9,31 +9,42 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { CalcAxisMember } from './CalcAxisMember';
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface CalcAxis
|
|
17
17
|
*/
|
|
18
|
-
export interface
|
|
18
|
+
export interface CalcAxis {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {
|
|
22
|
-
* @memberof
|
|
20
|
+
* `1` is day, `2` tree node, `3` series, `4` scenario and `5` group.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof CalcAxis
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
dimension: CalcAxisDimensionEnum;
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
|
-
* @type {
|
|
28
|
-
* @memberof
|
|
27
|
+
* @type {Array<CalcAxisMember>}
|
|
28
|
+
* @memberof CalcAxis
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
members: Array<CalcAxisMember>;
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const CalcAxisDimensionEnum: {
|
|
36
|
+
readonly NUMBER_1: 1;
|
|
37
|
+
readonly NUMBER_2: 2;
|
|
38
|
+
readonly NUMBER_3: 3;
|
|
39
|
+
readonly NUMBER_4: 4;
|
|
40
|
+
readonly NUMBER_5: 5;
|
|
41
|
+
};
|
|
42
|
+
export type CalcAxisDimensionEnum = typeof CalcAxisDimensionEnum[keyof typeof CalcAxisDimensionEnum];
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the CalcAxis interface.
|
|
34
45
|
*/
|
|
35
|
-
export declare function
|
|
36
|
-
export declare function
|
|
37
|
-
export declare function
|
|
38
|
-
export declare function
|
|
39
|
-
export declare function
|
|
46
|
+
export declare function instanceOfCalcAxis(value: object): value is CalcAxis;
|
|
47
|
+
export declare function CalcAxisFromJSON(json: any): CalcAxis;
|
|
48
|
+
export declare function CalcAxisFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcAxis;
|
|
49
|
+
export declare function CalcAxisToJSON(json: any): CalcAxis;
|
|
50
|
+
export declare function CalcAxisToJSONTyped(value?: CalcAxis | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -11,38 +11,48 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import {
|
|
14
|
+
import { CalcAxisMemberFromJSON, CalcAxisMemberToJSON, } from './CalcAxisMember';
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* @export
|
|
17
17
|
*/
|
|
18
|
-
export
|
|
19
|
-
|
|
18
|
+
export const CalcAxisDimensionEnum = {
|
|
19
|
+
NUMBER_1: 1,
|
|
20
|
+
NUMBER_2: 2,
|
|
21
|
+
NUMBER_3: 3,
|
|
22
|
+
NUMBER_4: 4,
|
|
23
|
+
NUMBER_5: 5
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the CalcAxis interface.
|
|
27
|
+
*/
|
|
28
|
+
export function instanceOfCalcAxis(value) {
|
|
29
|
+
if (!('dimension' in value) || value['dimension'] === undefined)
|
|
20
30
|
return false;
|
|
21
|
-
if (!('
|
|
31
|
+
if (!('members' in value) || value['members'] === undefined)
|
|
22
32
|
return false;
|
|
23
33
|
return true;
|
|
24
34
|
}
|
|
25
|
-
export function
|
|
26
|
-
return
|
|
35
|
+
export function CalcAxisFromJSON(json) {
|
|
36
|
+
return CalcAxisFromJSONTyped(json, false);
|
|
27
37
|
}
|
|
28
|
-
export function
|
|
38
|
+
export function CalcAxisFromJSONTyped(json, ignoreDiscriminator) {
|
|
29
39
|
if (json == null) {
|
|
30
40
|
return json;
|
|
31
41
|
}
|
|
32
42
|
return {
|
|
33
|
-
'
|
|
34
|
-
'
|
|
43
|
+
'dimension': json['dimension'],
|
|
44
|
+
'members': (json['members'].map(CalcAxisMemberFromJSON)),
|
|
35
45
|
};
|
|
36
46
|
}
|
|
37
|
-
export function
|
|
38
|
-
return
|
|
47
|
+
export function CalcAxisToJSON(json) {
|
|
48
|
+
return CalcAxisToJSONTyped(json, false);
|
|
39
49
|
}
|
|
40
|
-
export function
|
|
50
|
+
export function CalcAxisToJSONTyped(value, ignoreDiscriminator = false) {
|
|
41
51
|
if (value == null) {
|
|
42
52
|
return value;
|
|
43
53
|
}
|
|
44
54
|
return {
|
|
45
|
-
'
|
|
46
|
-
'
|
|
55
|
+
'dimension': value['dimension'],
|
|
56
|
+
'members': (value['members'].map(CalcAxisMemberToJSON)),
|
|
47
57
|
};
|
|
48
58
|
}
|