@spaciv/sdk 0.1.21 → 0.1.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +23 -1
- package/README.md +2 -2
- package/dist/apis/LogicLayersApi.d.ts +279 -0
- package/dist/apis/{SpaceRulesetsApi.js → LogicLayersApi.js} +72 -62
- package/dist/apis/ObjectGroupsApi.d.ts +28 -1
- package/dist/apis/ObjectGroupsApi.js +40 -0
- package/dist/apis/PropertiesApi.d.ts +16 -16
- package/dist/apis/PropertiesApi.js +8 -8
- package/dist/apis/ScenariosApi.d.ts +4 -4
- package/dist/apis/ScenariosApi.js +2 -2
- package/dist/apis/TopDownModelsApi.d.ts +4 -4
- package/dist/apis/TopDownModelsApi.js +2 -2
- package/dist/apis/VariablesApi.d.ts +4 -4
- package/dist/apis/VariablesApi.js +2 -2
- package/dist/apis/index.d.ts +1 -1
- package/dist/apis/index.js +1 -1
- package/dist/esm/apis/LogicLayersApi.d.ts +279 -0
- package/dist/esm/apis/{SpaceRulesetsApi.js → LogicLayersApi.js} +70 -60
- package/dist/esm/apis/ObjectGroupsApi.d.ts +28 -1
- package/dist/esm/apis/ObjectGroupsApi.js +41 -1
- package/dist/esm/apis/PropertiesApi.d.ts +16 -16
- package/dist/esm/apis/PropertiesApi.js +8 -8
- package/dist/esm/apis/ScenariosApi.d.ts +4 -4
- package/dist/esm/apis/ScenariosApi.js +2 -2
- package/dist/esm/apis/TopDownModelsApi.d.ts +4 -4
- package/dist/esm/apis/TopDownModelsApi.js +2 -2
- package/dist/esm/apis/VariablesApi.d.ts +4 -4
- package/dist/esm/apis/VariablesApi.js +2 -2
- package/dist/esm/apis/index.d.ts +1 -1
- package/dist/esm/apis/index.js +1 -1
- package/dist/esm/models/CalcCompare.d.ts +45 -0
- package/dist/esm/models/CalcCompare.js +52 -0
- package/dist/esm/models/CalcCondition.d.ts +46 -0
- package/dist/esm/models/CalcCondition.js +53 -0
- package/dist/esm/models/CalcHasNode.d.ts +44 -0
- package/dist/esm/models/CalcHasNode.js +51 -0
- package/dist/esm/models/CalcIsObject.d.ts +32 -0
- package/dist/esm/models/CalcIsObject.js +43 -0
- package/dist/esm/models/CalcRuleRef.d.ts +2 -1
- package/dist/esm/models/CalcRuleRef.js +7 -0
- package/dist/esm/models/CalcRuleRefOneOf2.d.ts +3 -2
- package/dist/esm/models/CalcRuleRefOneOf2.js +4 -3
- package/dist/esm/models/CalcRuleRefOneOf3.d.ts +2 -3
- package/dist/esm/models/CalcRuleRefOneOf3.js +3 -4
- package/dist/esm/models/CalcRuleRefOneOf4.d.ts +3 -3
- package/dist/esm/models/CalcRuleRefOneOf4.js +4 -4
- package/dist/esm/models/CalcRuleRefOneOf5.d.ts +3 -2
- package/dist/esm/models/CalcRuleRefOneOf5.js +4 -3
- package/dist/esm/models/CalcRuleRefOneOf6.d.ts +32 -0
- package/dist/esm/models/CalcRuleRefOneOf6.js +43 -0
- package/dist/esm/models/CalcTest.d.ts +24 -0
- package/dist/esm/models/CalcTest.js +58 -0
- package/dist/esm/models/CalcTestOneOf.d.ts +33 -0
- package/dist/esm/models/CalcTestOneOf.js +44 -0
- package/dist/esm/models/CalcTestOneOf1.d.ts +33 -0
- package/dist/esm/models/CalcTestOneOf1.js +44 -0
- package/dist/esm/models/CalcTestOneOf2.d.ts +33 -0
- package/dist/esm/models/CalcTestOneOf2.js +44 -0
- package/dist/esm/models/Group.d.ts +45 -0
- package/dist/esm/models/Group.js +52 -0
- package/dist/esm/models/LayerVariablesRes.d.ts +1 -1
- package/dist/esm/models/LogicAssignment.d.ts +23 -0
- package/dist/esm/models/LogicAssignment.js +51 -0
- package/dist/esm/models/LogicAssignmentOneOf.d.ts +32 -0
- package/dist/esm/models/LogicAssignmentOneOf.js +43 -0
- package/dist/esm/models/LogicAssignmentOneOf1.d.ts +32 -0
- package/dist/esm/models/LogicAssignmentOneOf1.js +43 -0
- package/dist/esm/models/LogicDemand.d.ts +40 -0
- package/dist/esm/models/LogicDemand.js +49 -0
- package/dist/esm/models/LogicLayerConfig.d.ts +39 -0
- package/dist/esm/models/LogicLayerConfig.js +48 -0
- package/dist/esm/models/LogicPer.d.ts +45 -0
- package/dist/esm/models/LogicPer.js +52 -0
- package/dist/esm/models/LogicRule.d.ts +66 -0
- package/dist/esm/models/LogicRule.js +67 -0
- package/dist/esm/models/LogicSupply.d.ts +48 -0
- package/dist/esm/models/LogicSupply.js +54 -0
- package/dist/esm/models/LogicSupplyWeight.d.ts +32 -0
- package/dist/esm/models/LogicSupplyWeight.js +43 -0
- package/dist/esm/models/MaybeVarInt.d.ts +2 -2
- package/dist/esm/models/MaybeVarInt.js +5 -5
- package/dist/esm/models/MaybeVarProp.d.ts +2 -2
- package/dist/esm/models/MaybeVarProp.js +5 -5
- package/dist/esm/models/MaybeVarStr.d.ts +2 -2
- package/dist/esm/models/MaybeVarStr.js +5 -5
- package/dist/esm/models/ModelObject.d.ts +38 -0
- package/dist/esm/models/ModelObject.js +47 -0
- package/dist/esm/models/ObjectGroupListEntry.d.ts +0 -6
- package/dist/esm/models/ObjectGroupListEntry.js +0 -4
- package/dist/esm/models/SelectObjectsParamsWrapperBody.d.ts +33 -0
- package/dist/esm/models/SelectObjectsParamsWrapperBody.js +44 -0
- package/dist/esm/models/Selection.d.ts +39 -0
- package/dist/esm/models/Selection.js +48 -0
- package/dist/esm/models/SpaceRuleSetJSON.d.ts +3 -2
- package/dist/esm/models/SpaceRuleSetJSON.js +3 -2
- package/dist/esm/models/SpaceRulesetCreate.d.ts +1 -1
- package/dist/esm/models/index.d.ts +22 -0
- package/dist/esm/models/index.js +22 -0
- package/dist/models/CalcCompare.d.ts +45 -0
- package/dist/models/CalcCompare.js +59 -0
- package/dist/models/CalcCondition.d.ts +46 -0
- package/dist/models/CalcCondition.js +60 -0
- package/dist/models/CalcHasNode.d.ts +44 -0
- package/dist/models/CalcHasNode.js +58 -0
- package/dist/models/CalcIsObject.d.ts +32 -0
- package/dist/models/CalcIsObject.js +50 -0
- package/dist/models/CalcRuleRef.d.ts +2 -1
- package/dist/models/CalcRuleRef.js +7 -0
- package/dist/models/CalcRuleRefOneOf2.d.ts +3 -2
- package/dist/models/CalcRuleRefOneOf2.js +4 -3
- package/dist/models/CalcRuleRefOneOf3.d.ts +2 -3
- package/dist/models/CalcRuleRefOneOf3.js +3 -4
- package/dist/models/CalcRuleRefOneOf4.d.ts +3 -3
- package/dist/models/CalcRuleRefOneOf4.js +4 -4
- package/dist/models/CalcRuleRefOneOf5.d.ts +3 -2
- package/dist/models/CalcRuleRefOneOf5.js +4 -3
- package/dist/models/CalcRuleRefOneOf6.d.ts +32 -0
- package/dist/models/CalcRuleRefOneOf6.js +50 -0
- package/dist/models/CalcTest.d.ts +24 -0
- package/dist/models/CalcTest.js +64 -0
- package/dist/models/CalcTestOneOf.d.ts +33 -0
- package/dist/models/CalcTestOneOf.js +51 -0
- package/dist/models/CalcTestOneOf1.d.ts +33 -0
- package/dist/models/CalcTestOneOf1.js +51 -0
- package/dist/models/CalcTestOneOf2.d.ts +33 -0
- package/dist/models/CalcTestOneOf2.js +51 -0
- package/dist/models/Group.d.ts +45 -0
- package/dist/models/Group.js +59 -0
- package/dist/models/LayerVariablesRes.d.ts +1 -1
- package/dist/models/LogicAssignment.d.ts +23 -0
- package/dist/models/LogicAssignment.js +57 -0
- package/dist/models/LogicAssignmentOneOf.d.ts +32 -0
- package/dist/models/LogicAssignmentOneOf.js +50 -0
- package/dist/models/LogicAssignmentOneOf1.d.ts +32 -0
- package/dist/models/LogicAssignmentOneOf1.js +50 -0
- package/dist/models/LogicDemand.d.ts +40 -0
- package/dist/models/LogicDemand.js +56 -0
- package/dist/models/LogicLayerConfig.d.ts +39 -0
- package/dist/models/LogicLayerConfig.js +55 -0
- package/dist/models/LogicPer.d.ts +45 -0
- package/dist/models/LogicPer.js +59 -0
- package/dist/models/LogicRule.d.ts +66 -0
- package/dist/models/LogicRule.js +74 -0
- package/dist/models/LogicSupply.d.ts +48 -0
- package/dist/models/LogicSupply.js +61 -0
- package/dist/models/LogicSupplyWeight.d.ts +32 -0
- package/dist/models/LogicSupplyWeight.js +50 -0
- package/dist/models/MaybeVarInt.d.ts +2 -2
- package/dist/models/MaybeVarInt.js +5 -5
- package/dist/models/MaybeVarProp.d.ts +2 -2
- package/dist/models/MaybeVarProp.js +5 -5
- package/dist/models/MaybeVarStr.d.ts +2 -2
- package/dist/models/MaybeVarStr.js +5 -5
- package/dist/models/ModelObject.d.ts +38 -0
- package/dist/models/ModelObject.js +54 -0
- package/dist/models/ObjectGroupListEntry.d.ts +0 -6
- package/dist/models/ObjectGroupListEntry.js +0 -4
- package/dist/models/SelectObjectsParamsWrapperBody.d.ts +33 -0
- package/dist/models/SelectObjectsParamsWrapperBody.js +51 -0
- package/dist/models/Selection.d.ts +39 -0
- package/dist/models/Selection.js +55 -0
- package/dist/models/SpaceRuleSetJSON.d.ts +3 -2
- package/dist/models/SpaceRuleSetJSON.js +3 -2
- package/dist/models/SpaceRulesetCreate.d.ts +1 -1
- package/dist/models/index.d.ts +22 -0
- package/dist/models/index.js +22 -0
- package/package.json +1 -1
- package/src/apis/{SpaceRulesetsApi.ts → LogicLayersApi.ts} +136 -121
- package/src/apis/ObjectGroupsApi.ts +75 -0
- package/src/apis/PropertiesApi.ts +16 -16
- package/src/apis/ScenariosApi.ts +4 -4
- package/src/apis/TopDownModelsApi.ts +4 -4
- package/src/apis/VariablesApi.ts +4 -4
- package/src/apis/index.ts +1 -1
- package/src/models/CalcCompare.ts +92 -0
- package/src/models/CalcCondition.ts +99 -0
- package/src/models/CalcHasNode.ts +84 -0
- package/src/models/CalcIsObject.ts +66 -0
- package/src/models/CalcRuleRef.ts +14 -1
- package/src/models/CalcRuleRefOneOf2.ts +13 -5
- package/src/models/CalcRuleRefOneOf3.ts +5 -13
- package/src/models/CalcRuleRefOneOf4.ts +11 -11
- package/src/models/CalcRuleRefOneOf5.ts +13 -5
- package/src/models/CalcRuleRefOneOf6.ts +66 -0
- package/src/models/CalcTest.ts +89 -0
- package/src/models/CalcTestOneOf.ts +74 -0
- package/src/models/CalcTestOneOf1.ts +74 -0
- package/src/models/CalcTestOneOf2.ts +74 -0
- package/src/models/Group.ts +92 -0
- package/src/models/LayerVariablesRes.ts +1 -1
- package/src/models/LogicAssignment.ts +76 -0
- package/src/models/LogicAssignmentOneOf.ts +66 -0
- package/src/models/LogicAssignmentOneOf1.ts +66 -0
- package/src/models/LogicDemand.ts +90 -0
- package/src/models/LogicLayerConfig.ts +83 -0
- package/src/models/LogicPer.ts +92 -0
- package/src/models/LogicRule.ts +140 -0
- package/src/models/LogicSupply.ts +99 -0
- package/src/models/LogicSupplyWeight.ts +66 -0
- package/src/models/MaybeVarInt.ts +11 -11
- package/src/models/MaybeVarProp.ts +11 -11
- package/src/models/MaybeVarStr.ts +11 -11
- package/src/models/ModelObject.ts +75 -0
- package/src/models/ObjectGroupListEntry.ts +0 -9
- package/src/models/SelectObjectsParamsWrapperBody.ts +74 -0
- package/src/models/Selection.ts +83 -0
- package/src/models/SpaceRuleSetJSON.ts +12 -4
- package/src/models/SpaceRulesetCreate.ts +1 -1
- package/src/models/index.ts +22 -0
- package/dist/apis/SpaceRulesetsApi.d.ts +0 -269
- package/dist/esm/apis/SpaceRulesetsApi.d.ts +0 -269
|
@@ -22,6 +22,8 @@ import type {
|
|
|
22
22
|
ObjectGroupEntrySearchRes,
|
|
23
23
|
ObjectGroupEntryUpdate,
|
|
24
24
|
ObjectGroupListRes,
|
|
25
|
+
SelectObjectsParamsWrapperBody,
|
|
26
|
+
Selection,
|
|
25
27
|
} from '../models/index';
|
|
26
28
|
import {
|
|
27
29
|
EntryPatchFromJSON,
|
|
@@ -38,12 +40,20 @@ import {
|
|
|
38
40
|
ObjectGroupEntryUpdateToJSON,
|
|
39
41
|
ObjectGroupListResFromJSON,
|
|
40
42
|
ObjectGroupListResToJSON,
|
|
43
|
+
SelectObjectsParamsWrapperBodyFromJSON,
|
|
44
|
+
SelectObjectsParamsWrapperBodyToJSON,
|
|
45
|
+
SelectionFromJSON,
|
|
46
|
+
SelectionToJSON,
|
|
41
47
|
} from '../models/index';
|
|
42
48
|
|
|
43
49
|
export interface ObjectGroupsApiCreateRequest {
|
|
44
50
|
objectGroupChangelogBody?: ObjectGroupChangelogBody;
|
|
45
51
|
}
|
|
46
52
|
|
|
53
|
+
export interface ObjectGroupsApiCreateSelectRequest {
|
|
54
|
+
selectObjectsParamsWrapperBody: SelectObjectsParamsWrapperBody;
|
|
55
|
+
}
|
|
56
|
+
|
|
47
57
|
export interface ObjectGroupsApiDeleteRequest {
|
|
48
58
|
id: string;
|
|
49
59
|
action?: ObjectGroupsApiDeleteActionEnum;
|
|
@@ -147,6 +157,22 @@ export interface ObjectGroupsApiInterface {
|
|
|
147
157
|
*/
|
|
148
158
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
149
159
|
|
|
160
|
+
/**
|
|
161
|
+
* Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
|
|
162
|
+
* @summary Select objects by filters
|
|
163
|
+
* @param {SelectObjectsParamsWrapperBody} selectObjectsParamsWrapperBody
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
* @memberof ObjectGroupsApiInterface
|
|
167
|
+
*/
|
|
168
|
+
createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>>;
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
|
|
172
|
+
* Select objects by filters
|
|
173
|
+
*/
|
|
174
|
+
createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection>;
|
|
175
|
+
|
|
150
176
|
/**
|
|
151
177
|
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
152
178
|
* @summary Delete or archive an object group
|
|
@@ -460,6 +486,55 @@ export class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGroupsApiI
|
|
|
460
486
|
return await response.value();
|
|
461
487
|
}
|
|
462
488
|
|
|
489
|
+
/**
|
|
490
|
+
* Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
|
|
491
|
+
* Select objects by filters
|
|
492
|
+
*/
|
|
493
|
+
async createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>> {
|
|
494
|
+
if (requestParameters['selectObjectsParamsWrapperBody'] == null) {
|
|
495
|
+
throw new runtime.RequiredError(
|
|
496
|
+
'selectObjectsParamsWrapperBody',
|
|
497
|
+
'Required parameter "selectObjectsParamsWrapperBody" was null or undefined when calling createSelect().'
|
|
498
|
+
);
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
const queryParameters: any = {};
|
|
502
|
+
|
|
503
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
504
|
+
|
|
505
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
506
|
+
|
|
507
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
508
|
+
const token = this.configuration.accessToken;
|
|
509
|
+
const tokenString = await token("accessToken", []);
|
|
510
|
+
|
|
511
|
+
if (tokenString) {
|
|
512
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
513
|
+
}
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
let urlPath = `/v1/object-groups/select`;
|
|
517
|
+
|
|
518
|
+
const response = await this.request({
|
|
519
|
+
path: urlPath,
|
|
520
|
+
method: 'POST',
|
|
521
|
+
headers: headerParameters,
|
|
522
|
+
query: queryParameters,
|
|
523
|
+
body: SelectObjectsParamsWrapperBodyToJSON(requestParameters['selectObjectsParamsWrapperBody']),
|
|
524
|
+
}, initOverrides);
|
|
525
|
+
|
|
526
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SelectionFromJSON(jsonValue));
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
|
|
531
|
+
* Select objects by filters
|
|
532
|
+
*/
|
|
533
|
+
async createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection> {
|
|
534
|
+
const response = await this.createSelectRaw(requestParameters, initOverrides);
|
|
535
|
+
return await response.value();
|
|
536
|
+
}
|
|
537
|
+
|
|
463
538
|
/**
|
|
464
539
|
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
465
540
|
* Delete or archive an object group
|
|
@@ -81,7 +81,7 @@ export interface PropertiesApiInterface {
|
|
|
81
81
|
create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
84
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
85
85
|
* @summary Delete a property
|
|
86
86
|
* @param {string} id
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
@@ -91,7 +91,7 @@ export interface PropertiesApiInterface {
|
|
|
91
91
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
94
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
95
95
|
* Delete a property
|
|
96
96
|
*/
|
|
97
97
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -113,7 +113,7 @@ export interface PropertiesApiInterface {
|
|
|
113
113
|
duplicate(requestParameters: PropertiesApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
|
-
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (
|
|
116
|
+
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
|
|
117
117
|
* @summary Get a property
|
|
118
118
|
* @param {string} id
|
|
119
119
|
* @param {*} [options] Override http request option.
|
|
@@ -123,13 +123,13 @@ export interface PropertiesApiInterface {
|
|
|
123
123
|
getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>>;
|
|
124
124
|
|
|
125
125
|
/**
|
|
126
|
-
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (
|
|
126
|
+
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
|
|
127
127
|
* Get a property
|
|
128
128
|
*/
|
|
129
129
|
get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes>;
|
|
130
130
|
|
|
131
131
|
/**
|
|
132
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
132
|
+
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is. Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
|
|
133
133
|
* @summary List properties
|
|
134
134
|
* @param {Array<number>} [types] Filter by property type. Pass one or more numeric type values (e.g. the integer values of the PropertyType enum). When omitted, all types are returned.
|
|
135
135
|
* @param {Array<number>} [objectTypes]
|
|
@@ -140,13 +140,13 @@ export interface PropertiesApiInterface {
|
|
|
140
140
|
listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>>;
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
143
|
+
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is. Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
|
|
144
144
|
* List properties
|
|
145
145
|
*/
|
|
146
146
|
list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
147
147
|
|
|
148
148
|
/**
|
|
149
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids
|
|
149
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
150
150
|
* @summary Update a property
|
|
151
151
|
* @param {string} id
|
|
152
152
|
* @param {PropertyBody} [propertyBody]
|
|
@@ -157,7 +157,7 @@ export interface PropertiesApiInterface {
|
|
|
157
157
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
158
158
|
|
|
159
159
|
/**
|
|
160
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids
|
|
160
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
161
161
|
* Update a property
|
|
162
162
|
*/
|
|
163
163
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -216,7 +216,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
216
216
|
}
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
219
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
220
220
|
* Delete a property
|
|
221
221
|
*/
|
|
222
222
|
async deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -254,7 +254,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
254
254
|
}
|
|
255
255
|
|
|
256
256
|
/**
|
|
257
|
-
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
257
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
258
258
|
* Delete a property
|
|
259
259
|
*/
|
|
260
260
|
async delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -313,7 +313,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
313
313
|
}
|
|
314
314
|
|
|
315
315
|
/**
|
|
316
|
-
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (
|
|
316
|
+
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
|
|
317
317
|
* Get a property
|
|
318
318
|
*/
|
|
319
319
|
async getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>> {
|
|
@@ -351,7 +351,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
351
351
|
}
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
|
-
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (
|
|
354
|
+
* Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy. Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
|
|
355
355
|
* Get a property
|
|
356
356
|
*/
|
|
357
357
|
async get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes> {
|
|
@@ -360,7 +360,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
360
360
|
}
|
|
361
361
|
|
|
362
362
|
/**
|
|
363
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
363
|
+
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is. Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
|
|
364
364
|
* List properties
|
|
365
365
|
*/
|
|
366
366
|
async listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>> {
|
|
@@ -398,7 +398,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
398
398
|
}
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
401
|
+
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is. Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
|
|
402
402
|
* List properties
|
|
403
403
|
*/
|
|
404
404
|
async list(requestParameters: PropertiesApiListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes> {
|
|
@@ -407,7 +407,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
407
407
|
}
|
|
408
408
|
|
|
409
409
|
/**
|
|
410
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids
|
|
410
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
411
411
|
* Update a property
|
|
412
412
|
*/
|
|
413
413
|
async updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -448,7 +448,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
448
448
|
}
|
|
449
449
|
|
|
450
450
|
/**
|
|
451
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids
|
|
451
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
452
452
|
* Update a property
|
|
453
453
|
*/
|
|
454
454
|
async update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
package/src/apis/ScenariosApi.ts
CHANGED
|
@@ -152,7 +152,7 @@ export interface ScenariosApiInterface {
|
|
|
152
152
|
list(requestParameters: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioListRes>;
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
|
-
* Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
155
|
+
* Returns, per active scenario, the account variables that the modifier formulas and logic layer functions of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
156
156
|
* @summary List account variables used by scenario layers
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
@@ -161,7 +161,7 @@ export interface ScenariosApiInterface {
|
|
|
161
161
|
listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>>;
|
|
162
162
|
|
|
163
163
|
/**
|
|
164
|
-
* Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
164
|
+
* Returns, per active scenario, the account variables that the modifier formulas and logic layer functions of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
165
165
|
* List account variables used by scenario layers
|
|
166
166
|
*/
|
|
167
167
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
@@ -429,7 +429,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
429
429
|
}
|
|
430
430
|
|
|
431
431
|
/**
|
|
432
|
-
* Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
432
|
+
* Returns, per active scenario, the account variables that the modifier formulas and logic layer functions of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
433
433
|
* List account variables used by scenario layers
|
|
434
434
|
*/
|
|
435
435
|
async listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>> {
|
|
@@ -459,7 +459,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
459
459
|
}
|
|
460
460
|
|
|
461
461
|
/**
|
|
462
|
-
* Returns, per active scenario, the account variables that the modifier formulas of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
462
|
+
* Returns, per active scenario, the account variables that the modifier formulas and logic layer functions of its layers reference, following stacked scenarios. Changing one of these variables recalculates every visualisation of that scenario. Scenarios whose layers use no account variables are omitted. Requires the *View projects* permission and the *Variable controls* feature.
|
|
463
463
|
* List account variables used by scenario layers
|
|
464
464
|
*/
|
|
465
465
|
async listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes> {
|
|
@@ -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). 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
|
|
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, the add, subtract, multiply and divide operators, and `condition` (if a comparison or a `has` test, then one expression, else another). 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). 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
|
|
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, the add, subtract, multiply and divide operators, and `condition` (if a comparison or a `has` test, then one expression, else another). 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). 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
|
|
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, the add, subtract, multiply and divide operators, and `condition` (if a comparison or a `has` test, then one expression, else another). 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). 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
|
|
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, the add, subtract, multiply and divide operators, and `condition` (if a comparison or a `has` test, then one expression, else another). 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> {
|
package/src/apis/VariablesApi.ts
CHANGED
|
@@ -129,7 +129,7 @@ export interface VariablesApiInterface {
|
|
|
129
129
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableListRes>;
|
|
130
130
|
|
|
131
131
|
/**
|
|
132
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
132
|
+
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations, the modifier formulas of layers and the functions of logic layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
|
|
133
133
|
* @summary List account variable references
|
|
134
134
|
* @param {string} id Account variable ID, either qualified (account:<id>) or bare.
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
@@ -139,7 +139,7 @@ export interface VariablesApiInterface {
|
|
|
139
139
|
listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>>;
|
|
140
140
|
|
|
141
141
|
/**
|
|
142
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
142
|
+
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations, the modifier formulas of layers and the functions of logic layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
|
|
143
143
|
* List account variable references
|
|
144
144
|
*/
|
|
145
145
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
@@ -347,7 +347,7 @@ export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterfa
|
|
|
347
347
|
}
|
|
348
348
|
|
|
349
349
|
/**
|
|
350
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
350
|
+
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations, the modifier formulas of layers and the functions of logic layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
|
|
351
351
|
* List account variable references
|
|
352
352
|
*/
|
|
353
353
|
async listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>> {
|
|
@@ -385,7 +385,7 @@ export class VariablesApi extends runtime.BaseAPI implements VariablesApiInterfa
|
|
|
385
385
|
}
|
|
386
386
|
|
|
387
387
|
/**
|
|
388
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
388
|
+
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations, the modifier formulas of layers and the functions of logic layers, across all projects including archived ones. A variable can only be deleted, or have its type changed, when this list is empty. Requires the *View projects* permission.
|
|
389
389
|
* List account variable references
|
|
390
390
|
*/
|
|
391
391
|
async listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes> {
|
package/src/apis/index.ts
CHANGED
|
@@ -15,6 +15,7 @@ export * from './FloorPlansApi';
|
|
|
15
15
|
export * from './IntegrationsApi';
|
|
16
16
|
export * from './InternalApi';
|
|
17
17
|
export * from './LocalisationApi';
|
|
18
|
+
export * from './LogicLayersApi';
|
|
18
19
|
export * from './LookupsApi';
|
|
19
20
|
export * from './NeedsApi';
|
|
20
21
|
export * from './ObjectGroupsApi';
|
|
@@ -24,7 +25,6 @@ export * from './ReportsApi';
|
|
|
24
25
|
export * from './ScenariosApi';
|
|
25
26
|
export * from './ScriptsApi';
|
|
26
27
|
export * from './ServiceApi';
|
|
27
|
-
export * from './SpaceRulesetsApi';
|
|
28
28
|
export * from './TemplateProjectsApi';
|
|
29
29
|
export * from './TopDownModelsApi';
|
|
30
30
|
export * from './UsersApi';
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { CalcRuleRef } from './CalcRuleRef';
|
|
17
|
+
import {
|
|
18
|
+
CalcRuleRefFromJSON,
|
|
19
|
+
CalcRuleRefFromJSONTyped,
|
|
20
|
+
CalcRuleRefToJSON,
|
|
21
|
+
CalcRuleRefToJSONTyped,
|
|
22
|
+
} from './CalcRuleRef';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface CalcCompare
|
|
28
|
+
*/
|
|
29
|
+
export interface CalcCompare {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {CalcRuleRef}
|
|
33
|
+
* @memberof CalcCompare
|
|
34
|
+
*/
|
|
35
|
+
left: CalcRuleRef;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof CalcCompare
|
|
40
|
+
*/
|
|
41
|
+
op: number;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {CalcRuleRef}
|
|
45
|
+
* @memberof CalcCompare
|
|
46
|
+
*/
|
|
47
|
+
right: CalcRuleRef;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Check if a given object implements the CalcCompare interface.
|
|
52
|
+
*/
|
|
53
|
+
export function instanceOfCalcCompare(value: object): value is CalcCompare {
|
|
54
|
+
if (!('left' in value) || value['left'] === undefined) return false;
|
|
55
|
+
if (!('op' in value) || value['op'] === undefined) return false;
|
|
56
|
+
if (!('right' in value) || value['right'] === undefined) return false;
|
|
57
|
+
return true;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function CalcCompareFromJSON(json: any): CalcCompare {
|
|
61
|
+
return CalcCompareFromJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function CalcCompareFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcCompare {
|
|
65
|
+
if (json == null) {
|
|
66
|
+
return json;
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'left': CalcRuleRefFromJSON(json['left']),
|
|
71
|
+
'op': json['op'],
|
|
72
|
+
'right': CalcRuleRefFromJSON(json['right']),
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function CalcCompareToJSON(json: any): CalcCompare {
|
|
77
|
+
return CalcCompareToJSONTyped(json, false);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function CalcCompareToJSONTyped(value?: CalcCompare | null, ignoreDiscriminator: boolean = false): any {
|
|
81
|
+
if (value == null) {
|
|
82
|
+
return value;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
|
|
87
|
+
'left': CalcRuleRefToJSON(value['left']),
|
|
88
|
+
'op': value['op'],
|
|
89
|
+
'right': CalcRuleRefToJSON(value['right']),
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { CalcTest } from './CalcTest';
|
|
17
|
+
import {
|
|
18
|
+
CalcTestFromJSON,
|
|
19
|
+
CalcTestFromJSONTyped,
|
|
20
|
+
CalcTestToJSON,
|
|
21
|
+
CalcTestToJSONTyped,
|
|
22
|
+
} from './CalcTest';
|
|
23
|
+
import type { CalcRuleRef } from './CalcRuleRef';
|
|
24
|
+
import {
|
|
25
|
+
CalcRuleRefFromJSON,
|
|
26
|
+
CalcRuleRefFromJSONTyped,
|
|
27
|
+
CalcRuleRefToJSON,
|
|
28
|
+
CalcRuleRefToJSONTyped,
|
|
29
|
+
} from './CalcRuleRef';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface CalcCondition
|
|
35
|
+
*/
|
|
36
|
+
export interface CalcCondition {
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {CalcRuleRef}
|
|
40
|
+
* @memberof CalcCondition
|
|
41
|
+
*/
|
|
42
|
+
_else: CalcRuleRef;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {CalcTest}
|
|
46
|
+
* @memberof CalcCondition
|
|
47
|
+
*/
|
|
48
|
+
_if: CalcTest;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {CalcRuleRef}
|
|
52
|
+
* @memberof CalcCondition
|
|
53
|
+
*/
|
|
54
|
+
then: CalcRuleRef;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Check if a given object implements the CalcCondition interface.
|
|
59
|
+
*/
|
|
60
|
+
export function instanceOfCalcCondition(value: object): value is CalcCondition {
|
|
61
|
+
if (!('_else' in value) || value['_else'] === undefined) return false;
|
|
62
|
+
if (!('_if' in value) || value['_if'] === undefined) return false;
|
|
63
|
+
if (!('then' in value) || value['then'] === undefined) return false;
|
|
64
|
+
return true;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function CalcConditionFromJSON(json: any): CalcCondition {
|
|
68
|
+
return CalcConditionFromJSONTyped(json, false);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function CalcConditionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CalcCondition {
|
|
72
|
+
if (json == null) {
|
|
73
|
+
return json;
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
|
|
77
|
+
'_else': CalcRuleRefFromJSON(json['else']),
|
|
78
|
+
'_if': CalcTestFromJSON(json['if']),
|
|
79
|
+
'then': CalcRuleRefFromJSON(json['then']),
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function CalcConditionToJSON(json: any): CalcCondition {
|
|
84
|
+
return CalcConditionToJSONTyped(json, false);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function CalcConditionToJSONTyped(value?: CalcCondition | null, ignoreDiscriminator: boolean = false): any {
|
|
88
|
+
if (value == null) {
|
|
89
|
+
return value;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return {
|
|
93
|
+
|
|
94
|
+
'else': CalcRuleRefToJSON(value['_else']),
|
|
95
|
+
'if': CalcTestToJSON(value['_if']),
|
|
96
|
+
'then': CalcRuleRefToJSON(value['then']),
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
|