@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.
Files changed (93) hide show
  1. package/.openapi-generator/FILES +2 -8
  2. package/README.md +2 -2
  3. package/dist/apis/AnalysisApi.d.ts +4 -4
  4. package/dist/apis/AnalysisApi.js +2 -2
  5. package/dist/apis/FloorPlansApi.d.ts +8 -8
  6. package/dist/apis/FloorPlansApi.js +4 -4
  7. package/dist/esm/apis/AnalysisApi.d.ts +4 -4
  8. package/dist/esm/apis/AnalysisApi.js +2 -2
  9. package/dist/esm/apis/FloorPlansApi.d.ts +8 -8
  10. package/dist/esm/apis/FloorPlansApi.js +4 -4
  11. package/dist/esm/models/{NodeOffset.d.ts → CalcAxis.d.ts} +27 -16
  12. package/dist/esm/models/{NodeOffset.js → CalcAxis.js} +25 -15
  13. package/dist/esm/models/{CalcNode.d.ts → CalcAxisMember.d.ts} +24 -18
  14. package/dist/esm/models/{CalcNode.js → CalcAxisMember.js} +17 -15
  15. package/dist/esm/models/CalcBody.d.ts +6 -0
  16. package/dist/esm/models/CalcBody.js +2 -0
  17. package/dist/esm/models/CalcErrorBody.d.ts +1 -0
  18. package/dist/esm/models/CalcErrorBody.js +2 -1
  19. package/dist/esm/models/CalcRes.d.ts +5 -6
  20. package/dist/esm/models/CalcRes.js +7 -8
  21. package/dist/esm/models/FloorplanCreateSpace.d.ts +12 -0
  22. package/dist/esm/models/FloorplanCreateSpace.js +4 -0
  23. package/dist/esm/models/FloorplanGetBody.d.ts +15 -0
  24. package/dist/esm/models/FloorplanGetBody.js +12 -0
  25. package/dist/esm/models/FloorplanGetBodySpace.d.ts +12 -0
  26. package/dist/esm/models/FloorplanGetBodySpace.js +4 -0
  27. package/dist/esm/models/FloorplanPatchParamsBody.d.ts +6 -0
  28. package/dist/esm/models/FloorplanPatchParamsBody.js +2 -0
  29. package/dist/esm/models/index.d.ts +2 -8
  30. package/dist/esm/models/index.js +2 -8
  31. package/dist/{esm/models/TwoDLegendEntry.d.ts → models/CalcAxis.d.ts} +27 -15
  32. package/dist/models/{TwoDLegendEntry.js → CalcAxis.js} +31 -19
  33. package/dist/models/{CalcNode.d.ts → CalcAxisMember.d.ts} +24 -18
  34. package/dist/models/{CalcNode.js → CalcAxisMember.js} +22 -20
  35. package/dist/models/CalcBody.d.ts +6 -0
  36. package/dist/models/CalcBody.js +2 -0
  37. package/dist/models/CalcErrorBody.d.ts +1 -0
  38. package/dist/models/CalcErrorBody.js +2 -1
  39. package/dist/models/CalcRes.d.ts +5 -6
  40. package/dist/models/CalcRes.js +7 -8
  41. package/dist/models/FloorplanCreateSpace.d.ts +12 -0
  42. package/dist/models/FloorplanCreateSpace.js +4 -0
  43. package/dist/models/FloorplanGetBody.d.ts +15 -0
  44. package/dist/models/FloorplanGetBody.js +13 -0
  45. package/dist/models/FloorplanGetBodySpace.d.ts +12 -0
  46. package/dist/models/FloorplanGetBodySpace.js +4 -0
  47. package/dist/models/FloorplanPatchParamsBody.d.ts +6 -0
  48. package/dist/models/FloorplanPatchParamsBody.js +2 -0
  49. package/dist/models/index.d.ts +2 -8
  50. package/dist/models/index.js +2 -8
  51. package/package.json +1 -1
  52. package/src/apis/AnalysisApi.ts +4 -4
  53. package/src/apis/FloorPlansApi.ts +8 -8
  54. package/src/models/{NodeOffset.ts → CalcAxis.ts} +43 -29
  55. package/src/models/{CalcNode.ts → CalcAxisMember.ts} +34 -26
  56. package/src/models/CalcBody.ts +8 -0
  57. package/src/models/CalcErrorBody.ts +2 -1
  58. package/src/models/CalcRes.ts +16 -23
  59. package/src/models/FloorplanCreateSpace.ts +16 -0
  60. package/src/models/FloorplanGetBody.ts +21 -0
  61. package/src/models/FloorplanGetBodySpace.ts +16 -0
  62. package/src/models/FloorplanPatchParamsBody.ts +8 -0
  63. package/src/models/index.ts +2 -8
  64. package/dist/esm/models/Legend.d.ts +0 -23
  65. package/dist/esm/models/Legend.js +0 -51
  66. package/dist/esm/models/LegendList.d.ts +0 -32
  67. package/dist/esm/models/LegendList.js +0 -43
  68. package/dist/esm/models/LegendOneOf.d.ts +0 -33
  69. package/dist/esm/models/LegendOneOf.js +0 -44
  70. package/dist/esm/models/LegendOneOf1.d.ts +0 -33
  71. package/dist/esm/models/LegendOneOf1.js +0 -44
  72. package/dist/esm/models/TwoDLegendEntry.js +0 -47
  73. package/dist/esm/models/TwoDLegendList.d.ts +0 -33
  74. package/dist/esm/models/TwoDLegendList.js +0 -44
  75. package/dist/models/Legend.d.ts +0 -23
  76. package/dist/models/Legend.js +0 -57
  77. package/dist/models/LegendList.d.ts +0 -32
  78. package/dist/models/LegendList.js +0 -50
  79. package/dist/models/LegendOneOf.d.ts +0 -33
  80. package/dist/models/LegendOneOf.js +0 -51
  81. package/dist/models/LegendOneOf1.d.ts +0 -33
  82. package/dist/models/LegendOneOf1.js +0 -51
  83. package/dist/models/NodeOffset.d.ts +0 -39
  84. package/dist/models/NodeOffset.js +0 -55
  85. package/dist/models/TwoDLegendEntry.d.ts +0 -38
  86. package/dist/models/TwoDLegendList.d.ts +0 -33
  87. package/dist/models/TwoDLegendList.js +0 -51
  88. package/src/models/Legend.ts +0 -76
  89. package/src/models/LegendList.ts +0 -66
  90. package/src/models/LegendOneOf.ts +0 -74
  91. package/src/models/LegendOneOf1.ts +0 -74
  92. package/src/models/TwoDLegendEntry.ts +0 -75
  93. package/src/models/TwoDLegendList.ts +0 -74
@@ -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> {
@@ -13,71 +13,85 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { CalcNode } from './CalcNode';
16
+ import type { CalcAxisMember } from './CalcAxisMember';
17
17
  import {
18
- CalcNodeFromJSON,
19
- CalcNodeFromJSONTyped,
20
- CalcNodeToJSON,
21
- CalcNodeToJSONTyped,
22
- } from './CalcNode';
18
+ CalcAxisMemberFromJSON,
19
+ CalcAxisMemberFromJSONTyped,
20
+ CalcAxisMemberToJSON,
21
+ CalcAxisMemberToJSONTyped,
22
+ } from './CalcAxisMember';
23
23
 
24
24
  /**
25
25
  *
26
26
  * @export
27
- * @interface NodeOffset
27
+ * @interface CalcAxis
28
28
  */
29
- export interface NodeOffset {
29
+ export interface CalcAxis {
30
30
  /**
31
- *
32
- * @type {string}
33
- * @memberof NodeOffset
31
+ * `1` is day, `2` tree node, `3` series, `4` scenario and `5` group.
32
+ * @type {number}
33
+ * @memberof CalcAxis
34
34
  */
35
- day: string;
35
+ dimension: CalcAxisDimensionEnum;
36
36
  /**
37
37
  *
38
- * @type {CalcNode}
39
- * @memberof NodeOffset
38
+ * @type {Array<CalcAxisMember>}
39
+ * @memberof CalcAxis
40
40
  */
41
- root: CalcNode;
41
+ members: Array<CalcAxisMember>;
42
42
  }
43
43
 
44
+
45
+ /**
46
+ * @export
47
+ */
48
+ export const CalcAxisDimensionEnum = {
49
+ NUMBER_1: 1,
50
+ NUMBER_2: 2,
51
+ NUMBER_3: 3,
52
+ NUMBER_4: 4,
53
+ NUMBER_5: 5
54
+ } as const;
55
+ export type CalcAxisDimensionEnum = typeof CalcAxisDimensionEnum[keyof typeof CalcAxisDimensionEnum];
56
+
57
+
44
58
  /**
45
- * Check if a given object implements the NodeOffset interface.
59
+ * Check if a given object implements the CalcAxis interface.
46
60
  */
47
- export function instanceOfNodeOffset(value: object): value is NodeOffset {
48
- if (!('day' in value) || value['day'] === undefined) return false;
49
- if (!('root' in value) || value['root'] === undefined) return false;
61
+ export function instanceOfCalcAxis(value: object): value is CalcAxis {
62
+ if (!('dimension' in value) || value['dimension'] === undefined) return false;
63
+ if (!('members' in value) || value['members'] === undefined) return false;
50
64
  return true;
51
65
  }
52
66
 
53
- export function NodeOffsetFromJSON(json: any): NodeOffset {
54
- return NodeOffsetFromJSONTyped(json, false);
67
+ export function CalcAxisFromJSON(json: any): CalcAxis {
68
+ return CalcAxisFromJSONTyped(json, false);
55
69
  }
56
70
 
57
- export function NodeOffsetFromJSONTyped(json: any, ignoreDiscriminator: boolean): NodeOffset {
71
+ export function CalcAxisFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcAxis {
58
72
  if (json == null) {
59
73
  return json;
60
74
  }
61
75
  return {
62
76
 
63
- 'day': json['day'],
64
- 'root': CalcNodeFromJSON(json['root']),
77
+ 'dimension': json['dimension'],
78
+ 'members': ((json['members'] as Array<any>).map(CalcAxisMemberFromJSON)),
65
79
  };
66
80
  }
67
81
 
68
- export function NodeOffsetToJSON(json: any): NodeOffset {
69
- return NodeOffsetToJSONTyped(json, false);
82
+ export function CalcAxisToJSON(json: any): CalcAxis {
83
+ return CalcAxisToJSONTyped(json, false);
70
84
  }
71
85
 
72
- export function NodeOffsetToJSONTyped(value?: NodeOffset | null, ignoreDiscriminator: boolean = false): any {
86
+ export function CalcAxisToJSONTyped(value?: CalcAxis | null, ignoreDiscriminator: boolean = false): any {
73
87
  if (value == null) {
74
88
  return value;
75
89
  }
76
90
 
77
91
  return {
78
92
 
79
- 'day': value['day'],
80
- 'root': CalcNodeToJSON(value['root']),
93
+ 'dimension': value['dimension'],
94
+ 'members': ((value['members'] as Array<any>).map(CalcAxisMemberToJSON)),
81
95
  };
82
96
  }
83
97
 
@@ -16,78 +16,86 @@ import { mapValues } from '../runtime';
16
16
  /**
17
17
  *
18
18
  * @export
19
- * @interface CalcNode
19
+ * @interface CalcAxisMember
20
20
  */
21
- export interface CalcNode {
21
+ export interface CalcAxisMember {
22
22
  /**
23
23
  *
24
- * @type {Array<CalcNode>}
25
- * @memberof CalcNode
24
+ * @type {string}
25
+ * @memberof CalcAxisMember
26
26
  */
27
- children: Array<CalcNode>;
27
+ day: string;
28
28
  /**
29
29
  *
30
- * @type {Array<number>}
31
- * @memberof CalcNode
30
+ * @type {string}
31
+ * @memberof CalcAxisMember
32
32
  */
33
- data: Array<number>;
33
+ id: string;
34
34
  /**
35
35
  *
36
36
  * @type {string}
37
- * @memberof CalcNode
37
+ * @memberof CalcAxisMember
38
38
  */
39
- id: string;
39
+ name: string;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof CalcAxisMember
44
+ */
45
+ parent?: number;
40
46
  /**
41
47
  *
42
48
  * @type {string}
43
- * @memberof CalcNode
49
+ * @memberof CalcAxisMember
44
50
  */
45
- name: string;
51
+ scenario: string;
46
52
  }
47
53
 
48
54
  /**
49
- * Check if a given object implements the CalcNode interface.
55
+ * Check if a given object implements the CalcAxisMember interface.
50
56
  */
51
- export function instanceOfCalcNode(value: object): value is CalcNode {
52
- if (!('children' in value) || value['children'] === undefined) return false;
53
- if (!('data' in value) || value['data'] === undefined) return false;
57
+ export function instanceOfCalcAxisMember(value: object): value is CalcAxisMember {
58
+ if (!('day' in value) || value['day'] === undefined) return false;
54
59
  if (!('id' in value) || value['id'] === undefined) return false;
55
60
  if (!('name' in value) || value['name'] === undefined) return false;
61
+ if (!('scenario' in value) || value['scenario'] === undefined) return false;
56
62
  return true;
57
63
  }
58
64
 
59
- export function CalcNodeFromJSON(json: any): CalcNode {
60
- return CalcNodeFromJSONTyped(json, false);
65
+ export function CalcAxisMemberFromJSON(json: any): CalcAxisMember {
66
+ return CalcAxisMemberFromJSONTyped(json, false);
61
67
  }
62
68
 
63
- export function CalcNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcNode {
69
+ export function CalcAxisMemberFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcAxisMember {
64
70
  if (json == null) {
65
71
  return json;
66
72
  }
67
73
  return {
68
74
 
69
- 'children': ((json['children'] as Array<any>).map(CalcNodeFromJSON)),
70
- 'data': json['data'],
75
+ 'day': json['day'],
71
76
  'id': json['id'],
72
77
  'name': json['name'],
78
+ 'parent': json['parent'] == null ? undefined : json['parent'],
79
+ 'scenario': json['scenario'],
73
80
  };
74
81
  }
75
82
 
76
- export function CalcNodeToJSON(json: any): CalcNode {
77
- return CalcNodeToJSONTyped(json, false);
83
+ export function CalcAxisMemberToJSON(json: any): CalcAxisMember {
84
+ return CalcAxisMemberToJSONTyped(json, false);
78
85
  }
79
86
 
80
- export function CalcNodeToJSONTyped(value?: CalcNode | null, ignoreDiscriminator: boolean = false): any {
87
+ export function CalcAxisMemberToJSONTyped(value?: CalcAxisMember | null, ignoreDiscriminator: boolean = false): any {
81
88
  if (value == null) {
82
89
  return value;
83
90
  }
84
91
 
85
92
  return {
86
93
 
87
- 'children': ((value['children'] as Array<any>).map(CalcNodeToJSON)),
88
- 'data': value['data'],
94
+ 'day': value['day'],
89
95
  'id': value['id'],
90
96
  'name': value['name'],
97
+ 'parent': value['parent'],
98
+ 'scenario': value['scenario'],
91
99
  };
92
100
  }
93
101
 
@@ -47,6 +47,12 @@ export interface CalcBody {
47
47
  * @memberof CalcBody
48
48
  */
49
49
  data: DataShapes;
50
+ /**
51
+ * The order to lay the result's values out in, outermost first. `1` is day, `2` tree node, `3` series, `4` scenario and `5` group. Every result has day and tree node; a card adds series (single values, categorisation mixes, lists and tree lists), scenario (scenario comparisons and tree lists over scenarios) or, for a 2D list, group for its rows and series or scenario for its columns. List each of the card's dimensions exactly once, in any order; leave this out for day, tree node, then the card's own dimensions. Any other list is rejected with `400` and `kind` `invalid_dimensions`.
52
+ * @type {Array<number>}
53
+ * @memberof CalcBody
54
+ */
55
+ dimensions?: Array<number>;
50
56
  /**
51
57
  *
52
58
  * @type {Array<FilterGroup>}
@@ -93,6 +99,7 @@ export function CalcBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean):
93
99
  return {
94
100
 
95
101
  'data': DataShapesFromJSON(json['data']),
102
+ 'dimensions': json['dimensions'] == null ? undefined : json['dimensions'],
96
103
  'filters': ((json['filters'] as Array<any>).map(FilterGroupFromJSON)),
97
104
  'includeObjects': json['includeObjects'] == null ? undefined : json['includeObjects'],
98
105
  'limit': json['limit'] == null ? undefined : json['limit'],
@@ -112,6 +119,7 @@ export function CalcBodyToJSONTyped(value?: CalcBody | null, ignoreDiscriminator
112
119
  return {
113
120
 
114
121
  'data': DataShapesToJSON(value['data']),
122
+ 'dimensions': value['dimensions'],
115
123
  'filters': ((value['filters'] as Array<any>).map(FilterGroupToJSON)),
116
124
  'includeObjects': value['includeObjects'],
117
125
  'limit': value['limit'],
@@ -181,7 +181,8 @@ export const CalcErrorBodyKindEnum = {
181
181
  MissingAttribute: 'missing_attribute',
182
182
  MissingSpaceRule: 'missing_space_rule',
183
183
  MissingTopDownModel: 'missing_top_down_model',
184
- InvalidModifierFormula: 'invalid_modifier_formula'
184
+ InvalidModifierFormula: 'invalid_modifier_formula',
185
+ InvalidDimensions: 'invalid_dimensions'
185
186
  } as const;
186
187
  export type CalcErrorBodyKindEnum = typeof CalcErrorBodyKindEnum[keyof typeof CalcErrorBodyKindEnum];
187
188
 
@@ -13,20 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { Legend } from './Legend';
16
+ import type { CalcAxis } from './CalcAxis';
17
17
  import {
18
- LegendFromJSON,
19
- LegendFromJSONTyped,
20
- LegendToJSON,
21
- LegendToJSONTyped,
22
- } from './Legend';
23
- import type { NodeOffset } from './NodeOffset';
24
- import {
25
- NodeOffsetFromJSON,
26
- NodeOffsetFromJSONTyped,
27
- NodeOffsetToJSON,
28
- NodeOffsetToJSONTyped,
29
- } from './NodeOffset';
18
+ CalcAxisFromJSON,
19
+ CalcAxisFromJSONTyped,
20
+ CalcAxisToJSON,
21
+ CalcAxisToJSONTyped,
22
+ } from './CalcAxis';
30
23
 
31
24
  /**
32
25
  *
@@ -36,24 +29,24 @@ import {
36
29
  export interface CalcRes {
37
30
  /**
38
31
  *
39
- * @type {Legend}
32
+ * @type {Array<CalcAxis>}
40
33
  * @memberof CalcRes
41
34
  */
42
- legend: Legend;
35
+ axes: Array<CalcAxis>;
43
36
  /**
44
37
  *
45
- * @type {Array<NodeOffset>}
38
+ * @type {Array<number>}
46
39
  * @memberof CalcRes
47
40
  */
48
- timeline: Array<NodeOffset>;
41
+ values: Array<number>;
49
42
  }
50
43
 
51
44
  /**
52
45
  * Check if a given object implements the CalcRes interface.
53
46
  */
54
47
  export function instanceOfCalcRes(value: object): value is CalcRes {
55
- if (!('legend' in value) || value['legend'] === undefined) return false;
56
- if (!('timeline' in value) || value['timeline'] === undefined) return false;
48
+ if (!('axes' in value) || value['axes'] === undefined) return false;
49
+ if (!('values' in value) || value['values'] === undefined) return false;
57
50
  return true;
58
51
  }
59
52
 
@@ -67,8 +60,8 @@ export function CalcResFromJSONTyped(json: any, ignoreDiscriminator: boolean): C
67
60
  }
68
61
  return {
69
62
 
70
- 'legend': LegendFromJSON(json['legend']),
71
- 'timeline': ((json['timeline'] as Array<any>).map(NodeOffsetFromJSON)),
63
+ 'axes': ((json['axes'] as Array<any>).map(CalcAxisFromJSON)),
64
+ 'values': json['values'],
72
65
  };
73
66
  }
74
67
 
@@ -83,8 +76,8 @@ export function CalcResToJSONTyped(value?: CalcRes | null, ignoreDiscriminator:
83
76
 
84
77
  return {
85
78
 
86
- 'legend': LegendToJSON(value['legend']),
87
- 'timeline': ((value['timeline'] as Array<any>).map(NodeOffsetToJSON)),
79
+ 'axes': ((value['axes'] as Array<any>).map(CalcAxisToJSON)),
80
+ 'values': value['values'],
88
81
  };
89
82
  }
90
83
 
@@ -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
 
@@ -56,13 +56,14 @@ export * from './AuthenticationEmail';
56
56
  export * from './AuthenticationPreferredChanel';
57
57
  export * from './AuthenticationPublic';
58
58
  export * from './Branding';
59
+ export * from './CalcAxis';
60
+ export * from './CalcAxisMember';
59
61
  export * from './CalcBody';
60
62
  export * from './CalcChildren';
61
63
  export * from './CalcErrorBody';
62
64
  export * from './CalcList';
63
65
  export * from './CalcListEntry';
64
66
  export * from './CalcListTwoD';
65
- export * from './CalcNode';
66
67
  export * from './CalcRes';
67
68
  export * from './CalcRuleFloat';
68
69
  export * from './CalcRuleRef';
@@ -216,10 +217,6 @@ export * from './LayerOneOf3';
216
217
  export * from './LayerOneOf4';
217
218
  export * from './LayerTypeNeed';
218
219
  export * from './LayerVariablesRes';
219
- export * from './Legend';
220
- export * from './LegendList';
221
- export * from './LegendOneOf';
222
- export * from './LegendOneOf1';
223
220
  export * from './ListAccountsForUserRow';
224
221
  export * from './ListPage';
225
222
  export * from './ListUserDetailsWithEmailRow';
@@ -242,7 +239,6 @@ export * from './ModelRecord';
242
239
  export * from './MultiSelectChangelogData';
243
240
  export * from './MultiSelectContributionData';
244
241
  export * from './MultiSelectData';
245
- export * from './NodeOffset';
246
242
  export * from './ObjectGroupChangelogBody';
247
243
  export * from './ObjectGroupEntriesRes';
248
244
  export * from './ObjectGroupEntry';
@@ -344,8 +340,6 @@ export * from './TopDownModelEntryList';
344
340
  export * from './TopDownModelEntryPropertyNodes';
345
341
  export * from './TopDownModelEntryUpdate';
346
342
  export * from './TopDownModelProperties';
347
- export * from './TwoDLegendEntry';
348
- export * from './TwoDLegendList';
349
343
  export * from './UnmappedParameterDetail';
350
344
  export * from './UserV2GetResBody';
351
345
  export * from './UserV2PatchReqBody';