@spaciv/sdk 0.1.15 → 0.1.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/apis/DashboardsApi.d.ts +12 -12
- package/dist/apis/DashboardsApi.js +6 -6
- package/dist/apis/ScenariosApi.d.ts +8 -8
- package/dist/apis/ScenariosApi.js +4 -4
- package/dist/apis/TopDownModelsApi.d.ts +4 -4
- package/dist/apis/TopDownModelsApi.js +2 -2
- package/dist/esm/apis/DashboardsApi.d.ts +12 -12
- package/dist/esm/apis/DashboardsApi.js +6 -6
- package/dist/esm/apis/ScenariosApi.d.ts +8 -8
- package/dist/esm/apis/ScenariosApi.js +4 -4
- package/dist/esm/apis/TopDownModelsApi.d.ts +4 -4
- package/dist/esm/apis/TopDownModelsApi.js +2 -2
- package/dist/esm/models/CalcListEntry.d.ts +6 -0
- package/dist/esm/models/CalcListEntry.js +2 -0
- package/dist/esm/models/CalcRes.d.ts +6 -0
- package/dist/esm/models/CalcRes.js +4 -0
- package/dist/esm/models/ScenarioChangelogBody.d.ts +6 -0
- package/dist/esm/models/ScenarioChangelogBody.js +2 -0
- package/dist/esm/models/ScenarioCreate.d.ts +6 -0
- package/dist/esm/models/ScenarioCreate.js +2 -0
- package/dist/esm/models/ScenarioPatch.d.ts +12 -0
- package/dist/esm/models/ScenarioPatch.js +4 -0
- package/dist/esm/models/TopDownModelEntryUpdate.d.ts +6 -0
- package/dist/esm/models/TopDownModelEntryUpdate.js +2 -0
- package/dist/models/CalcListEntry.d.ts +6 -0
- package/dist/models/CalcListEntry.js +2 -0
- package/dist/models/CalcRes.d.ts +6 -0
- package/dist/models/CalcRes.js +4 -0
- package/dist/models/ScenarioChangelogBody.d.ts +6 -0
- package/dist/models/ScenarioChangelogBody.js +2 -0
- package/dist/models/ScenarioCreate.d.ts +6 -0
- package/dist/models/ScenarioCreate.js +2 -0
- package/dist/models/ScenarioPatch.d.ts +12 -0
- package/dist/models/ScenarioPatch.js +4 -0
- package/dist/models/TopDownModelEntryUpdate.d.ts +6 -0
- package/dist/models/TopDownModelEntryUpdate.js +2 -0
- package/package.json +1 -1
- package/src/apis/DashboardsApi.ts +12 -12
- package/src/apis/ScenariosApi.ts +8 -8
- package/src/apis/TopDownModelsApi.ts +4 -4
- package/src/models/CalcListEntry.ts +8 -0
- package/src/models/CalcRes.ts +9 -0
- package/src/models/ScenarioChangelogBody.ts +8 -0
- package/src/models/ScenarioCreate.ts +8 -0
- package/src/models/ScenarioPatch.ts +16 -0
- package/src/models/TopDownModelEntryUpdate.ts +8 -0
|
@@ -39,7 +39,7 @@ export interface ScenariosApiUpdateRequest {
|
|
|
39
39
|
*/
|
|
40
40
|
export interface ScenariosApiInterface {
|
|
41
41
|
/**
|
|
42
|
-
* 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.
|
|
42
|
+
* 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.
|
|
43
43
|
* @summary Create a scenario
|
|
44
44
|
* @param {ScenarioCreate} [scenarioCreate]
|
|
45
45
|
* @param {*} [options] Override http request option.
|
|
@@ -48,7 +48,7 @@ export interface ScenariosApiInterface {
|
|
|
48
48
|
*/
|
|
49
49
|
createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
50
50
|
/**
|
|
51
|
-
* 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.
|
|
51
|
+
* 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.
|
|
52
52
|
* Create a scenario
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -123,7 +123,7 @@ export interface ScenariosApiInterface {
|
|
|
123
123
|
*/
|
|
124
124
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
125
125
|
/**
|
|
126
|
-
* 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.
|
|
126
|
+
* 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.
|
|
127
127
|
* @summary Update a scenario
|
|
128
128
|
* @param {string} id
|
|
129
129
|
* @param {ScenarioPatch} [scenarioPatch]
|
|
@@ -133,7 +133,7 @@ export interface ScenariosApiInterface {
|
|
|
133
133
|
*/
|
|
134
134
|
updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
135
135
|
/**
|
|
136
|
-
* 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.
|
|
136
|
+
* 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.
|
|
137
137
|
* Update a scenario
|
|
138
138
|
*/
|
|
139
139
|
update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -143,12 +143,12 @@ export interface ScenariosApiInterface {
|
|
|
143
143
|
*/
|
|
144
144
|
export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterface {
|
|
145
145
|
/**
|
|
146
|
-
* 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.
|
|
146
|
+
* 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.
|
|
147
147
|
* Create a scenario
|
|
148
148
|
*/
|
|
149
149
|
createRaw(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
150
150
|
/**
|
|
151
|
-
* 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.
|
|
151
|
+
* 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.
|
|
152
152
|
* Create a scenario
|
|
153
153
|
*/
|
|
154
154
|
create(requestParameters?: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
@@ -203,12 +203,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
203
203
|
*/
|
|
204
204
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
205
205
|
/**
|
|
206
|
-
* 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.
|
|
206
|
+
* 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.
|
|
207
207
|
* Update a scenario
|
|
208
208
|
*/
|
|
209
209
|
updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
210
210
|
/**
|
|
211
|
-
* 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.
|
|
211
|
+
* 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.
|
|
212
212
|
* Update a scenario
|
|
213
213
|
*/
|
|
214
214
|
update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -27,7 +27,7 @@ import { LayerVariablesResFromJSON, ScenarioChangelogBodyFromJSON, ScenarioCreat
|
|
|
27
27
|
*/
|
|
28
28
|
export class ScenariosApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* 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.
|
|
30
|
+
* 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.
|
|
31
31
|
* Create a scenario
|
|
32
32
|
*/
|
|
33
33
|
createRaw(requestParameters, initOverrides) {
|
|
@@ -59,7 +59,7 @@ export class ScenariosApi extends runtime.BaseAPI {
|
|
|
59
59
|
});
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
* 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.
|
|
62
|
+
* 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.
|
|
63
63
|
* Create a scenario
|
|
64
64
|
*/
|
|
65
65
|
create() {
|
|
@@ -267,7 +267,7 @@ export class ScenariosApi extends runtime.BaseAPI {
|
|
|
267
267
|
});
|
|
268
268
|
}
|
|
269
269
|
/**
|
|
270
|
-
* 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.
|
|
270
|
+
* 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.
|
|
271
271
|
* Update a scenario
|
|
272
272
|
*/
|
|
273
273
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -298,7 +298,7 @@ export class ScenariosApi extends runtime.BaseAPI {
|
|
|
298
298
|
});
|
|
299
299
|
}
|
|
300
300
|
/**
|
|
301
|
-
* 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.
|
|
301
|
+
* 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.
|
|
302
302
|
* Update a scenario
|
|
303
303
|
*/
|
|
304
304
|
update(requestParameters, initOverrides) {
|
|
@@ -169,7 +169,7 @@ export interface TopDownModelsApiInterface {
|
|
|
169
169
|
*/
|
|
170
170
|
update(requestParameters: TopDownModelsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
171
171
|
/**
|
|
172
|
-
* 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.
|
|
172
|
+
* 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.
|
|
173
173
|
* @summary Create or update a top-down model entry
|
|
174
174
|
* @param {string} id
|
|
175
175
|
* @param {TopDownModelEntryUpdate} [topDownModelEntryUpdate]
|
|
@@ -179,7 +179,7 @@ export interface TopDownModelsApiInterface {
|
|
|
179
179
|
*/
|
|
180
180
|
updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
181
|
/**
|
|
182
|
-
* 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.
|
|
182
|
+
* 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.
|
|
183
183
|
* Create or update a top-down model entry
|
|
184
184
|
*/
|
|
185
185
|
updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -269,12 +269,12 @@ export declare class TopDownModelsApi extends runtime.BaseAPI implements TopDown
|
|
|
269
269
|
*/
|
|
270
270
|
update(requestParameters: TopDownModelsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
271
271
|
/**
|
|
272
|
-
* 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.
|
|
272
|
+
* 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.
|
|
273
273
|
* Create or update a top-down model entry
|
|
274
274
|
*/
|
|
275
275
|
updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
276
276
|
/**
|
|
277
|
-
* 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.
|
|
277
|
+
* 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.
|
|
278
278
|
* Create or update a top-down model entry
|
|
279
279
|
*/
|
|
280
280
|
updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -359,7 +359,7 @@ export class TopDownModelsApi extends runtime.BaseAPI {
|
|
|
359
359
|
});
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
|
-
* 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.
|
|
362
|
+
* 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.
|
|
363
363
|
* Create or update a top-down model entry
|
|
364
364
|
*/
|
|
365
365
|
updateEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -390,7 +390,7 @@ export class TopDownModelsApi extends runtime.BaseAPI {
|
|
|
390
390
|
});
|
|
391
391
|
}
|
|
392
392
|
/**
|
|
393
|
-
* 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.
|
|
393
|
+
* 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.
|
|
394
394
|
* Create or update a top-down model entry
|
|
395
395
|
*/
|
|
396
396
|
updateEntries(requestParameters, initOverrides) {
|
|
@@ -38,6 +38,7 @@ export function CalcListEntryFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
38
|
}
|
|
39
39
|
return {
|
|
40
40
|
'_function': MaybeVarFuncFromJSON(json['function']),
|
|
41
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
41
42
|
'name': json['name'],
|
|
42
43
|
'params': (mapValues(json['params'], ParameterTypeFromJSON)),
|
|
43
44
|
'scenario': MaybeVarStrFromJSON(json['scenario']),
|
|
@@ -52,6 +53,7 @@ export function CalcListEntryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
52
53
|
}
|
|
53
54
|
return {
|
|
54
55
|
'function': MaybeVarFuncToJSON(value['_function']),
|
|
56
|
+
'hexCode': value['hexCode'],
|
|
55
57
|
'name': value['name'],
|
|
56
58
|
'params': (mapValues(value['params'], ParameterTypeToJSON)),
|
|
57
59
|
'scenario': MaybeVarStrToJSON(value['scenario']),
|
|
@@ -18,6 +18,8 @@ import { CalcAxisFromJSON, CalcAxisToJSON, } from './CalcAxis';
|
|
|
18
18
|
export function instanceOfCalcRes(value) {
|
|
19
19
|
if (!('axes' in value) || value['axes'] === undefined)
|
|
20
20
|
return false;
|
|
21
|
+
if (!('columnHexCodes' in value) || value['columnHexCodes'] === undefined)
|
|
22
|
+
return false;
|
|
21
23
|
if (!('values' in value) || value['values'] === undefined)
|
|
22
24
|
return false;
|
|
23
25
|
return true;
|
|
@@ -31,6 +33,7 @@ export function CalcResFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
31
33
|
}
|
|
32
34
|
return {
|
|
33
35
|
'axes': (json['axes'].map(CalcAxisFromJSON)),
|
|
36
|
+
'columnHexCodes': json['columnHexCodes'],
|
|
34
37
|
'values': json['values'],
|
|
35
38
|
};
|
|
36
39
|
}
|
|
@@ -43,6 +46,7 @@ export function CalcResToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
43
46
|
}
|
|
44
47
|
return {
|
|
45
48
|
'axes': (value['axes'].map(CalcAxisToJSON)),
|
|
49
|
+
'columnHexCodes': value['columnHexCodes'],
|
|
46
50
|
'values': value['values'],
|
|
47
51
|
};
|
|
48
52
|
}
|
|
@@ -38,6 +38,7 @@ export function ScenarioChangelogBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
38
|
return {
|
|
39
39
|
'createdAt': json['createdAt'],
|
|
40
40
|
'description': json['description'],
|
|
41
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
41
42
|
'layers': (json['layers'].map(LayerFromJSON)),
|
|
42
43
|
'modifiedAt': json['modifiedAt'],
|
|
43
44
|
'name': json['name'],
|
|
@@ -53,6 +54,7 @@ export function ScenarioChangelogBodyToJSONTyped(value, ignoreDiscriminator = fa
|
|
|
53
54
|
return {
|
|
54
55
|
'createdAt': value['createdAt'],
|
|
55
56
|
'description': value['description'],
|
|
57
|
+
'hexCode': value['hexCode'],
|
|
56
58
|
'layers': (value['layers'].map(LayerToJSON)),
|
|
57
59
|
'modifiedAt': value['modifiedAt'],
|
|
58
60
|
'name': value['name'],
|
|
@@ -33,6 +33,7 @@ export function ScenarioCreateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
35
|
'description': json['description'],
|
|
36
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
36
37
|
'layers': (json['layers'].map(LayerFromJSON)),
|
|
37
38
|
'name': json['name'],
|
|
38
39
|
};
|
|
@@ -46,6 +47,7 @@ export function ScenarioCreateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
46
47
|
}
|
|
47
48
|
return {
|
|
48
49
|
'description': value['description'],
|
|
50
|
+
'hexCode': value['hexCode'],
|
|
49
51
|
'layers': (value['layers'].map(LayerToJSON)),
|
|
50
52
|
'name': value['name'],
|
|
51
53
|
};
|
|
@@ -16,12 +16,24 @@ import type { Layer } from './Layer';
|
|
|
16
16
|
* @interface ScenarioPatch
|
|
17
17
|
*/
|
|
18
18
|
export interface ScenarioPatch {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof ScenarioPatch
|
|
23
|
+
*/
|
|
24
|
+
clearLayers?: boolean;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
22
28
|
* @memberof ScenarioPatch
|
|
23
29
|
*/
|
|
24
30
|
description?: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ScenarioPatch
|
|
35
|
+
*/
|
|
36
|
+
hexCode?: string;
|
|
25
37
|
/**
|
|
26
38
|
*
|
|
27
39
|
* @type {Array<Layer>}
|
|
@@ -28,7 +28,9 @@ export function ScenarioPatchFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
28
28
|
return json;
|
|
29
29
|
}
|
|
30
30
|
return {
|
|
31
|
+
'clearLayers': json['clearLayers'] == null ? undefined : json['clearLayers'],
|
|
31
32
|
'description': json['description'] == null ? undefined : json['description'],
|
|
33
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
32
34
|
'layers': (json['layers'].map(LayerFromJSON)),
|
|
33
35
|
'name': json['name'] == null ? undefined : json['name'],
|
|
34
36
|
};
|
|
@@ -41,7 +43,9 @@ export function ScenarioPatchToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
41
43
|
return value;
|
|
42
44
|
}
|
|
43
45
|
return {
|
|
46
|
+
'clearLayers': value['clearLayers'],
|
|
44
47
|
'description': value['description'],
|
|
48
|
+
'hexCode': value['hexCode'],
|
|
45
49
|
'layers': (value['layers'].map(LayerToJSON)),
|
|
46
50
|
'name': value['name'],
|
|
47
51
|
};
|
|
@@ -17,6 +17,12 @@ import type { FilterGroup } from './FilterGroup';
|
|
|
17
17
|
* @interface TopDownModelEntryUpdate
|
|
18
18
|
*/
|
|
19
19
|
export interface TopDownModelEntryUpdate {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {boolean}
|
|
23
|
+
* @memberof TopDownModelEntryUpdate
|
|
24
|
+
*/
|
|
25
|
+
clearObjects?: boolean;
|
|
20
26
|
/**
|
|
21
27
|
*
|
|
22
28
|
* @type {string}
|
|
@@ -31,6 +31,7 @@ export function TopDownModelEntryUpdateFromJSONTyped(json, ignoreDiscriminator)
|
|
|
31
31
|
return json;
|
|
32
32
|
}
|
|
33
33
|
return {
|
|
34
|
+
'clearObjects': json['clearObjects'] == null ? undefined : json['clearObjects'],
|
|
34
35
|
'id': json['id'],
|
|
35
36
|
'objects': (json['objects'].map(FilterGroupFromJSON)),
|
|
36
37
|
'properties': json['properties'] == null ? undefined : TopDownModelPropertiesFromJSON(json['properties']),
|
|
@@ -44,6 +45,7 @@ export function TopDownModelEntryUpdateToJSONTyped(value, ignoreDiscriminator =
|
|
|
44
45
|
return value;
|
|
45
46
|
}
|
|
46
47
|
return {
|
|
48
|
+
'clearObjects': value['clearObjects'],
|
|
47
49
|
'id': value['id'],
|
|
48
50
|
'objects': (value['objects'].map(FilterGroupToJSON)),
|
|
49
51
|
'properties': TopDownModelPropertiesToJSON(value['properties']),
|
|
@@ -45,6 +45,7 @@ function CalcListEntryFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
45
45
|
}
|
|
46
46
|
return {
|
|
47
47
|
'_function': (0, MaybeVarFunc_1.MaybeVarFuncFromJSON)(json['function']),
|
|
48
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
48
49
|
'name': json['name'],
|
|
49
50
|
'params': ((0, runtime_1.mapValues)(json['params'], ParameterType_1.ParameterTypeFromJSON)),
|
|
50
51
|
'scenario': (0, MaybeVarStr_1.MaybeVarStrFromJSON)(json['scenario']),
|
|
@@ -59,6 +60,7 @@ function CalcListEntryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
59
60
|
}
|
|
60
61
|
return {
|
|
61
62
|
'function': (0, MaybeVarFunc_1.MaybeVarFuncToJSON)(value['_function']),
|
|
63
|
+
'hexCode': value['hexCode'],
|
|
62
64
|
'name': value['name'],
|
|
63
65
|
'params': ((0, runtime_1.mapValues)(value['params'], ParameterType_1.ParameterTypeToJSON)),
|
|
64
66
|
'scenario': (0, MaybeVarStr_1.MaybeVarStrToJSON)(value['scenario']),
|
package/dist/models/CalcRes.d.ts
CHANGED
package/dist/models/CalcRes.js
CHANGED
|
@@ -25,6 +25,8 @@ const CalcAxis_1 = require("./CalcAxis");
|
|
|
25
25
|
function instanceOfCalcRes(value) {
|
|
26
26
|
if (!('axes' in value) || value['axes'] === undefined)
|
|
27
27
|
return false;
|
|
28
|
+
if (!('columnHexCodes' in value) || value['columnHexCodes'] === undefined)
|
|
29
|
+
return false;
|
|
28
30
|
if (!('values' in value) || value['values'] === undefined)
|
|
29
31
|
return false;
|
|
30
32
|
return true;
|
|
@@ -38,6 +40,7 @@ function CalcResFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
40
|
}
|
|
39
41
|
return {
|
|
40
42
|
'axes': (json['axes'].map(CalcAxis_1.CalcAxisFromJSON)),
|
|
43
|
+
'columnHexCodes': json['columnHexCodes'],
|
|
41
44
|
'values': json['values'],
|
|
42
45
|
};
|
|
43
46
|
}
|
|
@@ -50,6 +53,7 @@ function CalcResToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
50
53
|
}
|
|
51
54
|
return {
|
|
52
55
|
'axes': (value['axes'].map(CalcAxis_1.CalcAxisToJSON)),
|
|
56
|
+
'columnHexCodes': value['columnHexCodes'],
|
|
53
57
|
'values': value['values'],
|
|
54
58
|
};
|
|
55
59
|
}
|
|
@@ -45,6 +45,7 @@ function ScenarioChangelogBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
45
45
|
return {
|
|
46
46
|
'createdAt': json['createdAt'],
|
|
47
47
|
'description': json['description'],
|
|
48
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
48
49
|
'layers': (json['layers'].map(Layer_1.LayerFromJSON)),
|
|
49
50
|
'modifiedAt': json['modifiedAt'],
|
|
50
51
|
'name': json['name'],
|
|
@@ -60,6 +61,7 @@ function ScenarioChangelogBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
60
61
|
return {
|
|
61
62
|
'createdAt': value['createdAt'],
|
|
62
63
|
'description': value['description'],
|
|
64
|
+
'hexCode': value['hexCode'],
|
|
63
65
|
'layers': (value['layers'].map(Layer_1.LayerToJSON)),
|
|
64
66
|
'modifiedAt': value['modifiedAt'],
|
|
65
67
|
'name': value['name'],
|
|
@@ -40,6 +40,7 @@ function ScenarioCreateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
40
40
|
}
|
|
41
41
|
return {
|
|
42
42
|
'description': json['description'],
|
|
43
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
43
44
|
'layers': (json['layers'].map(Layer_1.LayerFromJSON)),
|
|
44
45
|
'name': json['name'],
|
|
45
46
|
};
|
|
@@ -53,6 +54,7 @@ function ScenarioCreateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
53
54
|
}
|
|
54
55
|
return {
|
|
55
56
|
'description': value['description'],
|
|
57
|
+
'hexCode': value['hexCode'],
|
|
56
58
|
'layers': (value['layers'].map(Layer_1.LayerToJSON)),
|
|
57
59
|
'name': value['name'],
|
|
58
60
|
};
|
|
@@ -16,12 +16,24 @@ import type { Layer } from './Layer';
|
|
|
16
16
|
* @interface ScenarioPatch
|
|
17
17
|
*/
|
|
18
18
|
export interface ScenarioPatch {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof ScenarioPatch
|
|
23
|
+
*/
|
|
24
|
+
clearLayers?: boolean;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {string}
|
|
22
28
|
* @memberof ScenarioPatch
|
|
23
29
|
*/
|
|
24
30
|
description?: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ScenarioPatch
|
|
35
|
+
*/
|
|
36
|
+
hexCode?: string;
|
|
25
37
|
/**
|
|
26
38
|
*
|
|
27
39
|
* @type {Array<Layer>}
|
|
@@ -35,7 +35,9 @@ function ScenarioPatchFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
35
|
return json;
|
|
36
36
|
}
|
|
37
37
|
return {
|
|
38
|
+
'clearLayers': json['clearLayers'] == null ? undefined : json['clearLayers'],
|
|
38
39
|
'description': json['description'] == null ? undefined : json['description'],
|
|
40
|
+
'hexCode': json['hexCode'] == null ? undefined : json['hexCode'],
|
|
39
41
|
'layers': (json['layers'].map(Layer_1.LayerFromJSON)),
|
|
40
42
|
'name': json['name'] == null ? undefined : json['name'],
|
|
41
43
|
};
|
|
@@ -48,7 +50,9 @@ function ScenarioPatchToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
48
50
|
return value;
|
|
49
51
|
}
|
|
50
52
|
return {
|
|
53
|
+
'clearLayers': value['clearLayers'],
|
|
51
54
|
'description': value['description'],
|
|
55
|
+
'hexCode': value['hexCode'],
|
|
52
56
|
'layers': (value['layers'].map(Layer_1.LayerToJSON)),
|
|
53
57
|
'name': value['name'],
|
|
54
58
|
};
|
|
@@ -17,6 +17,12 @@ import type { FilterGroup } from './FilterGroup';
|
|
|
17
17
|
* @interface TopDownModelEntryUpdate
|
|
18
18
|
*/
|
|
19
19
|
export interface TopDownModelEntryUpdate {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {boolean}
|
|
23
|
+
* @memberof TopDownModelEntryUpdate
|
|
24
|
+
*/
|
|
25
|
+
clearObjects?: boolean;
|
|
20
26
|
/**
|
|
21
27
|
*
|
|
22
28
|
* @type {string}
|
|
@@ -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']),
|