@spaciv/sdk 0.1.15 → 0.1.17

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 (72) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/DashboardsApi.d.ts +12 -12
  3. package/dist/apis/DashboardsApi.js +6 -6
  4. package/dist/apis/FloorPlansApi.d.ts +8 -8
  5. package/dist/apis/FloorPlansApi.js +4 -4
  6. package/dist/apis/ScenariosApi.d.ts +8 -8
  7. package/dist/apis/ScenariosApi.js +4 -4
  8. package/dist/apis/TopDownModelsApi.d.ts +4 -4
  9. package/dist/apis/TopDownModelsApi.js +2 -2
  10. package/dist/esm/apis/DashboardsApi.d.ts +12 -12
  11. package/dist/esm/apis/DashboardsApi.js +6 -6
  12. package/dist/esm/apis/FloorPlansApi.d.ts +8 -8
  13. package/dist/esm/apis/FloorPlansApi.js +4 -4
  14. package/dist/esm/apis/ScenariosApi.d.ts +8 -8
  15. package/dist/esm/apis/ScenariosApi.js +4 -4
  16. package/dist/esm/apis/TopDownModelsApi.d.ts +4 -4
  17. package/dist/esm/apis/TopDownModelsApi.js +2 -2
  18. package/dist/esm/models/CalcListEntry.d.ts +6 -0
  19. package/dist/esm/models/CalcListEntry.js +2 -0
  20. package/dist/esm/models/CalcRes.d.ts +6 -0
  21. package/dist/esm/models/CalcRes.js +4 -0
  22. package/dist/esm/models/FloorplanCreateSpace.d.ts +12 -0
  23. package/dist/esm/models/FloorplanCreateSpace.js +4 -0
  24. package/dist/esm/models/FloorplanGetBody.d.ts +6 -0
  25. package/dist/esm/models/FloorplanGetBody.js +2 -0
  26. package/dist/esm/models/FloorplanGetBodySpace.d.ts +14 -2
  27. package/dist/esm/models/FloorplanGetBodySpace.js +4 -0
  28. package/dist/esm/models/FloorplanPatchParamsBody.d.ts +6 -0
  29. package/dist/esm/models/FloorplanPatchParamsBody.js +2 -0
  30. package/dist/esm/models/ScenarioChangelogBody.d.ts +6 -0
  31. package/dist/esm/models/ScenarioChangelogBody.js +2 -0
  32. package/dist/esm/models/ScenarioCreate.d.ts +6 -0
  33. package/dist/esm/models/ScenarioCreate.js +2 -0
  34. package/dist/esm/models/ScenarioPatch.d.ts +12 -0
  35. package/dist/esm/models/ScenarioPatch.js +4 -0
  36. package/dist/esm/models/TopDownModelEntryUpdate.d.ts +6 -0
  37. package/dist/esm/models/TopDownModelEntryUpdate.js +2 -0
  38. package/dist/models/CalcListEntry.d.ts +6 -0
  39. package/dist/models/CalcListEntry.js +2 -0
  40. package/dist/models/CalcRes.d.ts +6 -0
  41. package/dist/models/CalcRes.js +4 -0
  42. package/dist/models/FloorplanCreateSpace.d.ts +12 -0
  43. package/dist/models/FloorplanCreateSpace.js +4 -0
  44. package/dist/models/FloorplanGetBody.d.ts +6 -0
  45. package/dist/models/FloorplanGetBody.js +2 -0
  46. package/dist/models/FloorplanGetBodySpace.d.ts +14 -2
  47. package/dist/models/FloorplanGetBodySpace.js +4 -0
  48. package/dist/models/FloorplanPatchParamsBody.d.ts +6 -0
  49. package/dist/models/FloorplanPatchParamsBody.js +2 -0
  50. package/dist/models/ScenarioChangelogBody.d.ts +6 -0
  51. package/dist/models/ScenarioChangelogBody.js +2 -0
  52. package/dist/models/ScenarioCreate.d.ts +6 -0
  53. package/dist/models/ScenarioCreate.js +2 -0
  54. package/dist/models/ScenarioPatch.d.ts +12 -0
  55. package/dist/models/ScenarioPatch.js +4 -0
  56. package/dist/models/TopDownModelEntryUpdate.d.ts +6 -0
  57. package/dist/models/TopDownModelEntryUpdate.js +2 -0
  58. package/package.json +1 -1
  59. package/src/apis/DashboardsApi.ts +12 -12
  60. package/src/apis/FloorPlansApi.ts +8 -8
  61. package/src/apis/ScenariosApi.ts +8 -8
  62. package/src/apis/TopDownModelsApi.ts +4 -4
  63. package/src/models/CalcListEntry.ts +8 -0
  64. package/src/models/CalcRes.ts +9 -0
  65. package/src/models/FloorplanCreateSpace.ts +16 -0
  66. package/src/models/FloorplanGetBody.ts +8 -0
  67. package/src/models/FloorplanGetBodySpace.ts +18 -2
  68. package/src/models/FloorplanPatchParamsBody.ts +8 -0
  69. package/src/models/ScenarioChangelogBody.ts +8 -0
  70. package/src/models/ScenarioCreate.ts +8 -0
  71. package/src/models/ScenarioPatch.ts +16 -0
  72. package/src/models/TopDownModelEntryUpdate.ts +8 -0
@@ -38,6 +38,7 @@ function TopDownModelEntryUpdateFromJSONTyped(json, ignoreDiscriminator) {
38
38
  return json;
39
39
  }
40
40
  return {
41
+ 'clearObjects': json['clearObjects'] == null ? undefined : json['clearObjects'],
41
42
  'id': json['id'],
42
43
  'objects': (json['objects'].map(FilterGroup_1.FilterGroupFromJSON)),
43
44
  'properties': json['properties'] == null ? undefined : (0, TopDownModelProperties_1.TopDownModelPropertiesFromJSON)(json['properties']),
@@ -51,6 +52,7 @@ function TopDownModelEntryUpdateToJSONTyped(value, ignoreDiscriminator = false)
51
52
  return value;
52
53
  }
53
54
  return {
55
+ 'clearObjects': value['clearObjects'],
54
56
  'id': value['id'],
55
57
  'objects': (value['objects'].map(FilterGroup_1.FilterGroupToJSON)),
56
58
  'properties': (0, TopDownModelProperties_1.TopDownModelPropertiesToJSON)(value['properties']),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spaciv/sdk",
3
- "version": "0.1.15",
3
+ "version": "0.1.17",
4
4
  "description": "OpenAPI client for @spaciv/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -91,7 +91,7 @@ export interface DashboardsApiUpdateCardsRequest {
91
91
  */
92
92
  export interface DashboardsApiInterface {
93
93
  /**
94
- * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
94
+ * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
95
95
  * @summary Create a dashboard
96
96
  * @param {DashboardPost} [dashboardPost]
97
97
  * @param {*} [options] Override http request option.
@@ -101,13 +101,13 @@ export interface DashboardsApiInterface {
101
101
  createRaw(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
102
102
 
103
103
  /**
104
- * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
104
+ * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
105
105
  * Create a dashboard
106
106
  */
107
107
  create(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
108
108
 
109
109
  /**
110
- * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
110
+ * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
111
111
  * @summary Add a card to a dashboard
112
112
  * @param {string} id
113
113
  * @param {DashboardCardCreate} [dashboardCardCreate]
@@ -118,7 +118,7 @@ export interface DashboardsApiInterface {
118
118
  createCardsRaw(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
119
119
 
120
120
  /**
121
- * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
121
+ * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
122
122
  * Add a card to a dashboard
123
123
  */
124
124
  createCards(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -222,7 +222,7 @@ export interface DashboardsApiInterface {
222
222
  update(requestParameters: DashboardsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
223
223
 
224
224
  /**
225
- * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
225
+ * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
226
226
  * @summary Update a dashboard card
227
227
  * @param {string} id
228
228
  * @param {DashboardCardPatch} [dashboardCardPatch]
@@ -233,7 +233,7 @@ export interface DashboardsApiInterface {
233
233
  updateCardsRaw(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
234
234
 
235
235
  /**
236
- * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
236
+ * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
237
237
  * Update a dashboard card
238
238
  */
239
239
  updateCards(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -246,7 +246,7 @@ export interface DashboardsApiInterface {
246
246
  export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInterface {
247
247
 
248
248
  /**
249
- * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
249
+ * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
250
250
  * Create a dashboard
251
251
  */
252
252
  async createRaw(requestParameters: DashboardsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -283,7 +283,7 @@ export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInter
283
283
  }
284
284
 
285
285
  /**
286
- * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
286
+ * Creates a new dashboard for the current project and returns its UUID. If a dashboard with the supplied `id` already exists, the call is idempotent: it ensures the dashboard is indexed under the project and returns the existing ID without overwriting its content. The `account` ID is reserved for the account-level dashboard; project-scoped requests supplying it are rejected with 400. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Requires the *Edit org model* permission, and the *Variable controls* permission when any card has controls.
287
287
  * Create a dashboard
288
288
  */
289
289
  async create(requestParameters: DashboardsApiCreateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -292,7 +292,7 @@ export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInter
292
292
  }
293
293
 
294
294
  /**
295
- * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
295
+ * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
296
296
  * Add a card to a dashboard
297
297
  */
298
298
  async createCardsRaw(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -333,7 +333,7 @@ export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInter
333
333
  }
334
334
 
335
335
  /**
336
- * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
336
+ * Inserts a new card at the given zero-based `index` position in the dashboard\'s card list. Cards already at that position and beyond are shifted down. If `index` is out of range it is clamped to the nearest valid position. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the card has controls.
337
337
  * Add a card to a dashboard
338
338
  */
339
339
  async createCards(requestParameters: DashboardsApiCreateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -625,7 +625,7 @@ export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInter
625
625
  }
626
626
 
627
627
  /**
628
- * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
628
+ * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
629
629
  * Update a dashboard card
630
630
  */
631
631
  async updateCardsRaw(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -666,7 +666,7 @@ export class DashboardsApi extends runtime.BaseAPI implements DashboardsApiInter
666
666
  }
667
667
 
668
668
  /**
669
- * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items or a control is missing a variable or duplicates another control on the same card. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
669
+ * Applies a single action to a card on a dashboard. Use `moveCard` to swap two cards by their zero-based indices, `reorderCard` to move the card at `oldIndex` to `newIndex` (zero-based) while shifting the cards in between, or `updateCard` to replace the content of a card at a given index, including the order of its visualisation and control items. Out-of-range indices are silently ignored. Returns `400` when a row-break card has items, a control is missing a variable or duplicates another control on the same card, or a list entry\'s `hexCode` is not a colour such as `#1f77b4` or `#abc`. Returns `404` if the dashboard does not exist. Requires the *Edit org model* permission, and the *Variable controls* permission when the update adds, removes, reorders or changes a card\'s controls.
670
670
  * Update a dashboard card
671
671
  */
672
672
  async updateCards(requestParameters: DashboardsApiUpdateCardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -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, 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.
107
+ * Returns the floor plan\'s metadata, view mode, scale, space overlay geometry with each space\'s 3D heights in metres, 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, 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.
117
+ * Returns the floor plan\'s metadata, view mode, scale, space overlay geometry with each space\'s 3D heights in metres, 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, 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}`.
156
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, scale, 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`. `unitsPerMetre` is how many of the spaces\' path units make one metre; `0` clears the scale. A space\'s `startHeightMetres` and `endHeightMetres` must be set together and the end must be above the start; a space without them is drawn at a default height. `startHeight` and `endHeight` are the same in the spaces\' path units, from editors that predate metres, and follow the same rules. 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, 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}`.
167
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, scale, 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`. `unitsPerMetre` is how many of the spaces\' path units make one metre; `0` clears the scale. A space\'s `startHeightMetres` and `endHeightMetres` must be set together and the end must be above the start; a space without them is drawn at a default height. `startHeight` and `endHeight` are the same in the spaces\' path units, from editors that predate metres, and follow the same rules. 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, 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.
299
+ * Returns the floor plan\'s metadata, view mode, scale, space overlay geometry with each space\'s 3D heights in metres, 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, 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.
337
+ * Returns the floor plan\'s metadata, view mode, scale, space overlay geometry with each space\'s 3D heights in metres, 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, 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}`.
448
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, scale, 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`. `unitsPerMetre` is how many of the spaces\' path units make one metre; `0` clears the scale. A space\'s `startHeightMetres` and `endHeightMetres` must be set together and the end must be above the start; a space without them is drawn at a default height. `startHeight` and `endHeight` are the same in the spaces\' path units, from editors that predate metres, and follow the same rules. 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, 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}`.
489
+ * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, view mode, scale, 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`. `unitsPerMetre` is how many of the spaces\' path units make one metre; `0` clears the scale. A space\'s `startHeightMetres` and `endHeightMetres` must be set together and the end must be above the start; a space without them is drawn at a default height. `startHeight` and `endHeight` are the same in the spaces\' path units, from editors that predate metres, and follow the same rules. 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> {
@@ -71,7 +71,7 @@ export interface ScenariosApiUpdateRequest {
71
71
  */
72
72
  export interface ScenariosApiInterface {
73
73
  /**
74
- * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
74
+ * Creates a new scenario for the account and returns its UUID. The optional `hexCode` is a colour such as `#1f77b4` or `#abc`. Returns `400` if the colour is not a valid hex code or a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
75
75
  * @summary Create a scenario
76
76
  * @param {ScenarioCreate} [scenarioCreate]
77
77
  * @param {*} [options] Override http request option.
@@ -81,7 +81,7 @@ export interface ScenariosApiInterface {
81
81
  createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
82
82
 
83
83
  /**
84
- * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
84
+ * Creates a new scenario for the account and returns its UUID. The optional `hexCode` is a colour such as `#1f77b4` or `#abc`. Returns `400` if the colour is not a valid hex code or a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
85
85
  * Create a scenario
86
86
  */
87
87
  create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -167,7 +167,7 @@ export interface ScenariosApiInterface {
167
167
  listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
168
168
 
169
169
  /**
170
- * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
170
+ * Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
171
171
  * @summary Update a scenario
172
172
  * @param {string} id
173
173
  * @param {ScenarioPatch} [scenarioPatch]
@@ -178,7 +178,7 @@ export interface ScenariosApiInterface {
178
178
  updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
179
179
 
180
180
  /**
181
- * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
181
+ * Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
182
182
  * Update a scenario
183
183
  */
184
184
  update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -191,7 +191,7 @@ export interface ScenariosApiInterface {
191
191
  export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterface {
192
192
 
193
193
  /**
194
- * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
194
+ * Creates a new scenario for the account and returns its UUID. The optional `hexCode` is a colour such as `#1f77b4` or `#abc`. Returns `400` if the colour is not a valid hex code or a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
195
195
  * Create a scenario
196
196
  */
197
197
  async createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -228,7 +228,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
228
228
  }
229
229
 
230
230
  /**
231
- * Creates a new scenario for the account and returns its UUID. Returns `400` if a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
231
+ * Creates a new scenario for the account and returns its UUID. The optional `hexCode` is a colour such as `#1f77b4` or `#abc`. Returns `400` if the colour is not a valid hex code or a layer references an entity that does not exist. Requires the *Edit scenario planning* permission.
232
232
  * Create a scenario
233
233
  */
234
234
  async create(requestParameters: ScenariosApiCreateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -468,7 +468,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
468
468
  }
469
469
 
470
470
  /**
471
- * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
471
+ * Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
472
472
  * Update a scenario
473
473
  */
474
474
  async updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -509,7 +509,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
509
509
  }
510
510
 
511
511
  /**
512
- * Updates the name, description, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. Returns `400` if a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
512
+ * Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
513
513
  * Update a scenario
514
514
  */
515
515
  async update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -217,7 +217,7 @@ export interface TopDownModelsApiInterface {
217
217
  update(requestParameters: TopDownModelsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
218
218
 
219
219
  /**
220
- * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
220
+ * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
221
221
  * @summary Create or update a top-down model entry
222
222
  * @param {string} id
223
223
  * @param {TopDownModelEntryUpdate} [topDownModelEntryUpdate]
@@ -228,7 +228,7 @@ export interface TopDownModelsApiInterface {
228
228
  updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
229
229
 
230
230
  /**
231
- * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
231
+ * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
232
232
  * Create or update a top-down model entry
233
233
  */
234
234
  updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -638,7 +638,7 @@ export class TopDownModelsApi extends runtime.BaseAPI implements TopDownModelsAp
638
638
  }
639
639
 
640
640
  /**
641
- * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
641
+ * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
642
642
  * Create or update a top-down model entry
643
643
  */
644
644
  async updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -679,7 +679,7 @@ export class TopDownModelsApi extends runtime.BaseAPI implements TopDownModelsAp
679
679
  }
680
680
 
681
681
  /**
682
- * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
682
+ * Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references and the add, subtract, multiply and divide operators. With `variable_controls` enabled, formulas may also reference numeric account variables by `account:<id>`; other variable references are rejected. `sumOf`, `select`, unknown operators and references to unknown properties or nodes are rejected with `400` naming the offending field. Returns `404` if the model does not exist. Requires the *Edit modification* permission.
683
683
  * Create or update a top-down model entry
684
684
  */
685
685
  async updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -47,6 +47,12 @@ export interface CalcListEntry {
47
47
  * @memberof CalcListEntry
48
48
  */
49
49
  _function: MaybeVarFunc;
50
+ /**
51
+ *
52
+ * @type {string}
53
+ * @memberof CalcListEntry
54
+ */
55
+ hexCode?: string;
50
56
  /**
51
57
  *
52
58
  * @type {string}
@@ -89,6 +95,7 @@ export function CalcListEntryFromJSONTyped(json: any, ignoreDiscriminator: boole
89
95
  return {
90
96
 
91
97
  '_function': MaybeVarFuncFromJSON(json['function']),
98
+ 'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
92
99
  'name': json['name'],
93
100
  'params': (mapValues(json['params'], ParameterTypeFromJSON)),
94
101
  'scenario': MaybeVarStrFromJSON(json['scenario']),
@@ -107,6 +114,7 @@ export function CalcListEntryToJSONTyped(value?: CalcListEntry | null, ignoreDis
107
114
  return {
108
115
 
109
116
  'function': MaybeVarFuncToJSON(value['_function']),
117
+ 'hexCode': value['hexCode'],
110
118
  'name': value['name'],
111
119
  'params': (mapValues(value['params'], ParameterTypeToJSON)),
112
120
  'scenario': MaybeVarStrToJSON(value['scenario']),
@@ -33,6 +33,12 @@ export interface CalcRes {
33
33
  * @memberof CalcRes
34
34
  */
35
35
  axes: Array<CalcAxis>;
36
+ /**
37
+ *
38
+ * @type {Array<string>}
39
+ * @memberof CalcRes
40
+ */
41
+ columnHexCodes: Array<string>;
36
42
  /**
37
43
  *
38
44
  * @type {Array<number>}
@@ -46,6 +52,7 @@ export interface CalcRes {
46
52
  */
47
53
  export function instanceOfCalcRes(value: object): value is CalcRes {
48
54
  if (!('axes' in value) || value['axes'] === undefined) return false;
55
+ if (!('columnHexCodes' in value) || value['columnHexCodes'] === undefined) return false;
49
56
  if (!('values' in value) || value['values'] === undefined) return false;
50
57
  return true;
51
58
  }
@@ -61,6 +68,7 @@ export function CalcResFromJSONTyped(json: any, ignoreDiscriminator: boolean): C
61
68
  return {
62
69
 
63
70
  'axes': ((json['axes'] as Array<any>).map(CalcAxisFromJSON)),
71
+ 'columnHexCodes': json['columnHexCodes'],
64
72
  'values': json['values'],
65
73
  };
66
74
  }
@@ -77,6 +85,7 @@ export function CalcResToJSONTyped(value?: CalcRes | null, ignoreDiscriminator:
77
85
  return {
78
86
 
79
87
  'axes': ((value['axes'] as Array<any>).map(CalcAxisToJSON)),
88
+ 'columnHexCodes': value['columnHexCodes'],
80
89
  'values': value['values'],
81
90
  };
82
91
  }
@@ -33,6 +33,12 @@ export interface FloorplanCreateSpace {
33
33
  * @memberof FloorplanCreateSpace
34
34
  */
35
35
  endHeight?: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof FloorplanCreateSpace
40
+ */
41
+ endHeightMetres?: number;
36
42
  /**
37
43
  *
38
44
  * @type {string}
@@ -51,6 +57,12 @@ export interface FloorplanCreateSpace {
51
57
  * @memberof FloorplanCreateSpace
52
58
  */
53
59
  startHeight?: number;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof FloorplanCreateSpace
64
+ */
65
+ startHeightMetres?: number;
54
66
  }
55
67
 
56
68
  /**
@@ -73,9 +85,11 @@ export function FloorplanCreateSpaceFromJSONTyped(json: any, ignoreDiscriminator
73
85
  return {
74
86
 
75
87
  'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
88
+ 'endHeightMetres': json['endHeightMetres'] == null ? undefined : json['endHeightMetres'],
76
89
  'location': json['location'],
77
90
  'paths': ((json['paths'] as Array<any>).map(FloorplanSpaceChangelogPathFromJSON)),
78
91
  'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
92
+ 'startHeightMetres': json['startHeightMetres'] == null ? undefined : json['startHeightMetres'],
79
93
  };
80
94
  }
81
95
 
@@ -91,9 +105,11 @@ export function FloorplanCreateSpaceToJSONTyped(value?: FloorplanCreateSpace | n
91
105
  return {
92
106
 
93
107
  'endHeight': value['endHeight'],
108
+ 'endHeightMetres': value['endHeightMetres'],
94
109
  'location': value['location'],
95
110
  'paths': ((value['paths'] as Array<any>).map(FloorplanSpaceChangelogPathToJSON)),
96
111
  'startHeight': value['startHeight'],
112
+ 'startHeightMetres': value['startHeightMetres'],
97
113
  };
98
114
  }
99
115
 
@@ -82,6 +82,12 @@ export interface FloorplanGetBody {
82
82
  * @memberof FloorplanGetBody
83
83
  */
84
84
  spaces: Array<FloorplanGetBodySpace>;
85
+ /**
86
+ * How many of the spaces' path units make one metre, which scales space heights in 3D. Absent until the floor plan's scale has been set.
87
+ * @type {number}
88
+ * @memberof FloorplanGetBody
89
+ */
90
+ unitsPerMetre?: number;
85
91
  /**
86
92
  * Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
87
93
  * @type {string}
@@ -134,6 +140,7 @@ export function FloorplanGetBodyFromJSONTyped(json: any, ignoreDiscriminator: bo
134
140
  'property': json['property'],
135
141
  'propertyNode': json['propertyNode'],
136
142
  'spaces': ((json['spaces'] as Array<any>).map(FloorplanGetBodySpaceFromJSON)),
143
+ 'unitsPerMetre': json['unitsPerMetre'] == null ? undefined : json['unitsPerMetre'],
137
144
  'viewMode': json['viewMode'],
138
145
  };
139
146
  }
@@ -157,6 +164,7 @@ export function FloorplanGetBodyToJSONTyped(value?: FloorplanGetBody | null, ign
157
164
  'property': value['property'],
158
165
  'propertyNode': value['propertyNode'],
159
166
  'spaces': ((value['spaces'] as Array<any>).map(FloorplanGetBodySpaceToJSON)),
167
+ 'unitsPerMetre': value['unitsPerMetre'],
160
168
  'viewMode': value['viewMode'],
161
169
  };
162
170
  }
@@ -28,11 +28,17 @@ import {
28
28
  */
29
29
  export interface FloorplanGetBodySpace {
30
30
  /**
31
- * Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
31
+ * Height the space ends at in 3D, in the spaces' path units, as written by editors that predate metres. Absent once converted to metres.
32
32
  * @type {number}
33
33
  * @memberof FloorplanGetBodySpace
34
34
  */
35
35
  endHeight?: number;
36
+ /**
37
+ * Height the space ends at in 3D, in metres. Absent when the space uses the default heights.
38
+ * @type {number}
39
+ * @memberof FloorplanGetBodySpace
40
+ */
41
+ endHeightMetres?: number;
36
42
  /**
37
43
  *
38
44
  * @type {string}
@@ -46,11 +52,17 @@ export interface FloorplanGetBodySpace {
46
52
  */
47
53
  paths: Array<Array<FloorplanGetBodySpacePoint>>;
48
54
  /**
49
- * Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
55
+ * Height the space starts at in 3D, in the spaces' path units, as written by editors that predate metres. Absent once converted to metres.
50
56
  * @type {number}
51
57
  * @memberof FloorplanGetBodySpace
52
58
  */
53
59
  startHeight?: number;
60
+ /**
61
+ * Height the space starts at in 3D, in metres. Absent when the space uses the default heights.
62
+ * @type {number}
63
+ * @memberof FloorplanGetBodySpace
64
+ */
65
+ startHeightMetres?: number;
54
66
  }
55
67
 
56
68
  /**
@@ -73,9 +85,11 @@ export function FloorplanGetBodySpaceFromJSONTyped(json: any, ignoreDiscriminato
73
85
  return {
74
86
 
75
87
  'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
88
+ 'endHeightMetres': json['endHeightMetres'] == null ? undefined : json['endHeightMetres'],
76
89
  'location': json['location'],
77
90
  'paths': json['paths'],
78
91
  'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
92
+ 'startHeightMetres': json['startHeightMetres'] == null ? undefined : json['startHeightMetres'],
79
93
  };
80
94
  }
81
95
 
@@ -91,9 +105,11 @@ export function FloorplanGetBodySpaceToJSONTyped(value?: FloorplanGetBodySpace |
91
105
  return {
92
106
 
93
107
  'endHeight': value['endHeight'],
108
+ 'endHeightMetres': value['endHeightMetres'],
94
109
  'location': value['location'],
95
110
  'paths': value['paths'],
96
111
  'startHeight': value['startHeight'],
112
+ 'startHeightMetres': value['startHeightMetres'],
97
113
  };
98
114
  }
99
115
 
@@ -82,6 +82,12 @@ export interface FloorplanPatchParamsBody {
82
82
  * @memberof FloorplanPatchParamsBody
83
83
  */
84
84
  spaces?: FloorplanCreateSpaceRepeated;
85
+ /**
86
+ *
87
+ * @type {number}
88
+ * @memberof FloorplanPatchParamsBody
89
+ */
90
+ unitsPerMetre?: number;
85
91
  /**
86
92
  *
87
93
  * @type {string}
@@ -115,6 +121,7 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json: any, ignoreDiscrimin
115
121
  'property': json['property'] == null ? undefined : json['property'],
116
122
  'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
117
123
  'spaces': json['spaces'] == null ? undefined : FloorplanCreateSpaceRepeatedFromJSON(json['spaces']),
124
+ 'unitsPerMetre': json['unitsPerMetre'] == null ? undefined : json['unitsPerMetre'],
118
125
  'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
119
126
  };
120
127
  }
@@ -138,6 +145,7 @@ export function FloorplanPatchParamsBodyToJSONTyped(value?: FloorplanPatchParams
138
145
  'property': value['property'],
139
146
  'propertyNode': value['propertyNode'],
140
147
  'spaces': FloorplanCreateSpaceRepeatedToJSON(value['spaces']),
148
+ 'unitsPerMetre': value['unitsPerMetre'],
141
149
  'viewMode': value['viewMode'],
142
150
  };
143
151
  }