@spaciv/sdk 0.1.6 → 0.1.8

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 (88) 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 +13 -13
  6. package/dist/apis/FloorPlansApi.js +6 -6
  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 +13 -13
  10. package/dist/esm/apis/FloorPlansApi.js +6 -6
  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/FloorplanBrief.d.ts +12 -0
  22. package/dist/esm/models/FloorplanBrief.js +4 -0
  23. package/dist/esm/models/FloorplanGetBody.d.ts +12 -0
  24. package/dist/esm/models/FloorplanGetBody.js +4 -0
  25. package/dist/esm/models/FloorplanPatchParamsBody.d.ts +12 -0
  26. package/dist/esm/models/FloorplanPatchParamsBody.js +4 -0
  27. package/dist/esm/models/index.d.ts +2 -8
  28. package/dist/esm/models/index.js +2 -8
  29. package/dist/{esm/models/TwoDLegendEntry.d.ts → models/CalcAxis.d.ts} +27 -15
  30. package/dist/models/{TwoDLegendEntry.js → CalcAxis.js} +31 -19
  31. package/dist/models/{CalcNode.d.ts → CalcAxisMember.d.ts} +24 -18
  32. package/dist/models/{CalcNode.js → CalcAxisMember.js} +22 -20
  33. package/dist/models/CalcBody.d.ts +6 -0
  34. package/dist/models/CalcBody.js +2 -0
  35. package/dist/models/CalcErrorBody.d.ts +1 -0
  36. package/dist/models/CalcErrorBody.js +2 -1
  37. package/dist/models/CalcRes.d.ts +5 -6
  38. package/dist/models/CalcRes.js +7 -8
  39. package/dist/models/FloorplanBrief.d.ts +12 -0
  40. package/dist/models/FloorplanBrief.js +4 -0
  41. package/dist/models/FloorplanGetBody.d.ts +12 -0
  42. package/dist/models/FloorplanGetBody.js +4 -0
  43. package/dist/models/FloorplanPatchParamsBody.d.ts +12 -0
  44. package/dist/models/FloorplanPatchParamsBody.js +4 -0
  45. package/dist/models/index.d.ts +2 -8
  46. package/dist/models/index.js +2 -8
  47. package/package.json +1 -1
  48. package/src/apis/AnalysisApi.ts +4 -4
  49. package/src/apis/FloorPlansApi.ts +13 -13
  50. package/src/models/{NodeOffset.ts → CalcAxis.ts} +43 -29
  51. package/src/models/{CalcNode.ts → CalcAxisMember.ts} +34 -26
  52. package/src/models/CalcBody.ts +8 -0
  53. package/src/models/CalcErrorBody.ts +2 -1
  54. package/src/models/CalcRes.ts +16 -23
  55. package/src/models/FloorplanBrief.ts +16 -0
  56. package/src/models/FloorplanGetBody.ts +16 -0
  57. package/src/models/FloorplanPatchParamsBody.ts +16 -0
  58. package/src/models/index.ts +2 -8
  59. package/dist/esm/models/Legend.d.ts +0 -23
  60. package/dist/esm/models/Legend.js +0 -51
  61. package/dist/esm/models/LegendList.d.ts +0 -32
  62. package/dist/esm/models/LegendList.js +0 -43
  63. package/dist/esm/models/LegendOneOf.d.ts +0 -33
  64. package/dist/esm/models/LegendOneOf.js +0 -44
  65. package/dist/esm/models/LegendOneOf1.d.ts +0 -33
  66. package/dist/esm/models/LegendOneOf1.js +0 -44
  67. package/dist/esm/models/TwoDLegendEntry.js +0 -47
  68. package/dist/esm/models/TwoDLegendList.d.ts +0 -33
  69. package/dist/esm/models/TwoDLegendList.js +0 -44
  70. package/dist/models/Legend.d.ts +0 -23
  71. package/dist/models/Legend.js +0 -57
  72. package/dist/models/LegendList.d.ts +0 -32
  73. package/dist/models/LegendList.js +0 -50
  74. package/dist/models/LegendOneOf.d.ts +0 -33
  75. package/dist/models/LegendOneOf.js +0 -51
  76. package/dist/models/LegendOneOf1.d.ts +0 -33
  77. package/dist/models/LegendOneOf1.js +0 -51
  78. package/dist/models/NodeOffset.d.ts +0 -39
  79. package/dist/models/NodeOffset.js +0 -55
  80. package/dist/models/TwoDLegendEntry.d.ts +0 -38
  81. package/dist/models/TwoDLegendList.d.ts +0 -33
  82. package/dist/models/TwoDLegendList.js +0 -51
  83. package/src/models/Legend.ts +0 -76
  84. package/src/models/LegendList.ts +0 -66
  85. package/src/models/LegendOneOf.ts +0 -74
  86. package/src/models/LegendOneOf1.ts +0 -74
  87. package/src/models/TwoDLegendEntry.ts +0 -75
  88. package/src/models/TwoDLegendList.ts +0 -74
@@ -120,11 +120,11 @@ export interface FloorPlansApiInterface {
120
120
  get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
121
121
 
122
122
  /**
123
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
123
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
124
124
  * @summary Get a floor plan image
125
125
  * @param {string} id
126
126
  * @param {'image' | 'foreground'} imageType Which image layer to retrieve: the base drawing (image) or the foreground overlay (foreground).
127
- * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if no image has been uploaded.
127
+ * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if the layer has no image.
128
128
  * @param {*} [options] Override http request option.
129
129
  * @throws {RequiredError}
130
130
  * @memberof FloorPlansApiInterface
@@ -132,7 +132,7 @@ export interface FloorPlansApiInterface {
132
132
  getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
133
133
 
134
134
  /**
135
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
135
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
136
136
  * Get a floor plan image
137
137
  */
138
138
  getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -153,7 +153,7 @@ export interface FloorPlansApiInterface {
153
153
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
154
154
 
155
155
  /**
156
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
156
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission. `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
157
157
  * @summary Update a floor plan
158
158
  * @param {string} id
159
159
  * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody]
@@ -164,13 +164,13 @@ export interface FloorPlansApiInterface {
164
164
  updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
165
165
 
166
166
  /**
167
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
167
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission. `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
168
168
  * Update a floor plan
169
169
  */
170
170
  update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
171
171
 
172
172
  /**
173
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
173
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
174
174
  * @summary Upload a floor plan image
175
175
  * @param {string} id
176
176
  * @param {'image' | 'foreground'} imageType Which image layer to upload: the base drawing (image) or the foreground overlay (foreground).
@@ -183,7 +183,7 @@ export interface FloorPlansApiInterface {
183
183
  updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
184
184
 
185
185
  /**
186
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
186
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
187
187
  * Upload a floor plan image
188
188
  */
189
189
  updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -343,7 +343,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
343
343
  }
344
344
 
345
345
  /**
346
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
346
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
347
347
  * Get a floor plan image
348
348
  */
349
349
  async getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -397,7 +397,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
397
397
  }
398
398
 
399
399
  /**
400
- * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
400
+ * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
401
401
  * Get a floor plan image
402
402
  */
403
403
  async getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -445,7 +445,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
445
445
  }
446
446
 
447
447
  /**
448
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
448
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission. `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
449
449
  * Update a floor plan
450
450
  */
451
451
  async updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -486,7 +486,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
486
486
  }
487
487
 
488
488
  /**
489
- * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
489
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission. `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
490
490
  * Update a floor plan
491
491
  */
492
492
  async update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -495,7 +495,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
495
495
  }
496
496
 
497
497
  /**
498
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
498
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
499
499
  * Upload a floor plan image
500
500
  */
501
501
  async updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -566,7 +566,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
566
566
  }
567
567
 
568
568
  /**
569
- * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
569
+ * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
570
570
  * Upload a floor plan image
571
571
  */
572
572
  async updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -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
 
@@ -19,12 +19,24 @@ import { mapValues } from '../runtime';
19
19
  * @interface FloorplanBrief
20
20
  */
21
21
  export interface FloorplanBrief {
22
+ /**
23
+ * ID of the account file used as the background image, if one is set.
24
+ * @type {string}
25
+ * @memberof FloorplanBrief
26
+ */
27
+ backgroundFile?: string;
22
28
  /**
23
29
  *
24
30
  * @type {number}
25
31
  * @memberof FloorplanBrief
26
32
  */
27
33
  createdAt: number;
34
+ /**
35
+ * ID of the account file used as the foreground image, if one is set.
36
+ * @type {string}
37
+ * @memberof FloorplanBrief
38
+ */
39
+ foregroundFile?: string;
28
40
  /**
29
41
  *
30
42
  * @type {string}
@@ -73,7 +85,9 @@ export function FloorplanBriefFromJSONTyped(json: any, ignoreDiscriminator: bool
73
85
  }
74
86
  return {
75
87
 
88
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
76
89
  'createdAt': json['createdAt'],
90
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
77
91
  'id': json['id'],
78
92
  'name': json['name'],
79
93
  'property': json['property'],
@@ -92,7 +106,9 @@ export function FloorplanBriefToJSONTyped(value?: FloorplanBrief | null, ignoreD
92
106
 
93
107
  return {
94
108
 
109
+ 'backgroundFile': value['backgroundFile'],
95
110
  'createdAt': value['createdAt'],
111
+ 'foregroundFile': value['foregroundFile'],
96
112
  'id': value['id'],
97
113
  'name': value['name'],
98
114
  'property': value['property'],
@@ -34,12 +34,24 @@ import {
34
34
  * @interface FloorplanGetBody
35
35
  */
36
36
  export interface FloorplanGetBody {
37
+ /**
38
+ * ID of the account file used as the background image, if one is set.
39
+ * @type {string}
40
+ * @memberof FloorplanGetBody
41
+ */
42
+ backgroundFile?: string;
37
43
  /**
38
44
  *
39
45
  * @type {number}
40
46
  * @memberof FloorplanGetBody
41
47
  */
42
48
  createdAt: number;
49
+ /**
50
+ * ID of the account file used as the foreground image, if one is set.
51
+ * @type {string}
52
+ * @memberof FloorplanGetBody
53
+ */
54
+ foregroundFile?: string;
43
55
  /**
44
56
  *
45
57
  * @type {string}
@@ -95,7 +107,9 @@ export function FloorplanGetBodyFromJSONTyped(json: any, ignoreDiscriminator: bo
95
107
  }
96
108
  return {
97
109
 
110
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
98
111
  'createdAt': json['createdAt'],
112
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
99
113
  'name': json['name'],
100
114
  'overlayOffset': FloorplanGetBodyOverlayOffsetFromJSON(json['overlayOffset']),
101
115
  'property': json['property'],
@@ -115,7 +129,9 @@ export function FloorplanGetBodyToJSONTyped(value?: FloorplanGetBody | null, ign
115
129
 
116
130
  return {
117
131
 
132
+ 'backgroundFile': value['backgroundFile'],
118
133
  'createdAt': value['createdAt'],
134
+ 'foregroundFile': value['foregroundFile'],
119
135
  'name': value['name'],
120
136
  'overlayOffset': FloorplanGetBodyOverlayOffsetToJSON(value['overlayOffset']),
121
137
  'property': value['property'],
@@ -34,12 +34,24 @@ import {
34
34
  * @interface FloorplanPatchParamsBody
35
35
  */
36
36
  export interface FloorplanPatchParamsBody {
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof FloorplanPatchParamsBody
41
+ */
42
+ backgroundFile?: string;
37
43
  /**
38
44
  *
39
45
  * @type {number}
40
46
  * @memberof FloorplanPatchParamsBody
41
47
  */
42
48
  createdAt?: number;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof FloorplanPatchParamsBody
53
+ */
54
+ foregroundFile?: string;
43
55
  /**
44
56
  *
45
57
  * @type {string}
@@ -89,7 +101,9 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json: any, ignoreDiscrimin
89
101
  }
90
102
  return {
91
103
 
104
+ 'backgroundFile': json['backgroundFile'] == null ? undefined : json['backgroundFile'],
92
105
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
106
+ 'foregroundFile': json['foregroundFile'] == null ? undefined : json['foregroundFile'],
93
107
  'name': json['name'] == null ? undefined : json['name'],
94
108
  'overlayOffset': json['overlayOffset'] == null ? undefined : FloorplanChangelogOverlayOffsetFromJSON(json['overlayOffset']),
95
109
  'property': json['property'] == null ? undefined : json['property'],
@@ -109,7 +123,9 @@ export function FloorplanPatchParamsBodyToJSONTyped(value?: FloorplanPatchParams
109
123
 
110
124
  return {
111
125
 
126
+ 'backgroundFile': value['backgroundFile'],
112
127
  'createdAt': value['createdAt'],
128
+ 'foregroundFile': value['foregroundFile'],
113
129
  'name': value['name'],
114
130
  'overlayOffset': FloorplanChangelogOverlayOffsetToJSON(value['overlayOffset']),
115
131
  'property': value['property'],
@@ -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';