@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
|
@@ -25,15 +25,15 @@ import { SpaceRuleSetFromJSON, SpaceRuleSetJSONFromJSON, SpaceRulesetCreateToJSO
|
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
|
-
export class
|
|
28
|
+
export class LogicLayersApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Creates a new
|
|
31
|
-
* Create a
|
|
30
|
+
* Creates a new logic layer for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with no rules. Requires the *Edit space rule sets* permission.
|
|
31
|
+
* Create a logic layer
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
createSpaceRulesetsRaw(requestParameters, initOverrides) {
|
|
34
34
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35
35
|
if (requestParameters['spaceRulesetCreate'] == null) {
|
|
36
|
-
throw new runtime.RequiredError('spaceRulesetCreate', 'Required parameter "spaceRulesetCreate" was null or undefined when calling
|
|
36
|
+
throw new runtime.RequiredError('spaceRulesetCreate', 'Required parameter "spaceRulesetCreate" was null or undefined when calling createSpaceRulesets().');
|
|
37
37
|
}
|
|
38
38
|
const queryParameters = {};
|
|
39
39
|
const headerParameters = {};
|
|
@@ -57,12 +57,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Creates a new
|
|
61
|
-
* Create a
|
|
60
|
+
* Creates a new logic layer for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with no rules. Requires the *Edit space rule sets* permission.
|
|
61
|
+
* Create a logic layer
|
|
62
62
|
*/
|
|
63
|
-
|
|
63
|
+
createSpaceRulesets(requestParameters, initOverrides) {
|
|
64
64
|
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
-
const response = yield this.
|
|
65
|
+
const response = yield this.createSpaceRulesetsRaw(requestParameters, initOverrides);
|
|
66
66
|
return yield response.value();
|
|
67
67
|
});
|
|
68
68
|
}
|
|
@@ -70,10 +70,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
70
70
|
* Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
|
|
71
71
|
* Upload a space ruleset image
|
|
72
72
|
*/
|
|
73
|
-
|
|
73
|
+
createSpaceRulesetsImageRaw(requestParameters, initOverrides) {
|
|
74
74
|
return __awaiter(this, void 0, void 0, function* () {
|
|
75
75
|
if (requestParameters['id'] == null) {
|
|
76
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
76
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling createSpaceRulesetsImage().');
|
|
77
77
|
}
|
|
78
78
|
const queryParameters = {};
|
|
79
79
|
const headerParameters = {};
|
|
@@ -121,20 +121,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
121
121
|
* Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
|
|
122
122
|
* Upload a space ruleset image
|
|
123
123
|
*/
|
|
124
|
-
|
|
124
|
+
createSpaceRulesetsImage(requestParameters, initOverrides) {
|
|
125
125
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
|
-
const response = yield this.
|
|
126
|
+
const response = yield this.createSpaceRulesetsImageRaw(requestParameters, initOverrides);
|
|
127
127
|
return yield response.value();
|
|
128
128
|
});
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
|
-
* Permanently deletes a
|
|
132
|
-
* Delete a
|
|
131
|
+
* Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
132
|
+
* Delete a logic layer
|
|
133
133
|
*/
|
|
134
|
-
|
|
134
|
+
deleteSpaceRulesetsRaw(requestParameters, initOverrides) {
|
|
135
135
|
return __awaiter(this, void 0, void 0, function* () {
|
|
136
136
|
if (requestParameters['id'] == null) {
|
|
137
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
137
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteSpaceRulesets().');
|
|
138
138
|
}
|
|
139
139
|
const queryParameters = {};
|
|
140
140
|
const headerParameters = {};
|
|
@@ -157,12 +157,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
157
157
|
});
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* Permanently deletes a
|
|
161
|
-
* Delete a
|
|
160
|
+
* Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
161
|
+
* Delete a logic layer
|
|
162
162
|
*/
|
|
163
|
-
|
|
163
|
+
deleteSpaceRulesets(requestParameters, initOverrides) {
|
|
164
164
|
return __awaiter(this, void 0, void 0, function* () {
|
|
165
|
-
const response = yield this.
|
|
165
|
+
const response = yield this.deleteSpaceRulesetsRaw(requestParameters, initOverrides);
|
|
166
166
|
return yield response.value();
|
|
167
167
|
});
|
|
168
168
|
}
|
|
@@ -170,10 +170,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
170
170
|
* Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
|
|
171
171
|
* Delete a space ruleset image
|
|
172
172
|
*/
|
|
173
|
-
|
|
173
|
+
deleteSpaceRulesetsImageRaw(requestParameters, initOverrides) {
|
|
174
174
|
return __awaiter(this, void 0, void 0, function* () {
|
|
175
175
|
if (requestParameters['id'] == null) {
|
|
176
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
176
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteSpaceRulesetsImage().');
|
|
177
177
|
}
|
|
178
178
|
const queryParameters = {};
|
|
179
179
|
const headerParameters = {};
|
|
@@ -199,22 +199,25 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
199
199
|
* Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
|
|
200
200
|
* Delete a space ruleset image
|
|
201
201
|
*/
|
|
202
|
-
|
|
202
|
+
deleteSpaceRulesetsImage(requestParameters, initOverrides) {
|
|
203
203
|
return __awaiter(this, void 0, void 0, function* () {
|
|
204
|
-
const response = yield this.
|
|
204
|
+
const response = yield this.deleteSpaceRulesetsImageRaw(requestParameters, initOverrides);
|
|
205
205
|
return yield response.value();
|
|
206
206
|
});
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
209
|
-
* Returns the full detail of a
|
|
210
|
-
* Get a
|
|
209
|
+
* Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
|
|
210
|
+
* Get a logic layer
|
|
211
211
|
*/
|
|
212
|
-
|
|
212
|
+
getSpaceRulesetsRaw(requestParameters, initOverrides) {
|
|
213
213
|
return __awaiter(this, void 0, void 0, function* () {
|
|
214
214
|
if (requestParameters['id'] == null) {
|
|
215
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
215
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getSpaceRulesets().');
|
|
216
216
|
}
|
|
217
217
|
const queryParameters = {};
|
|
218
|
+
if (requestParameters['format'] != null) {
|
|
219
|
+
queryParameters['format'] = requestParameters['format'];
|
|
220
|
+
}
|
|
218
221
|
const headerParameters = {};
|
|
219
222
|
if (this.configuration && this.configuration.accessToken) {
|
|
220
223
|
const token = this.configuration.accessToken;
|
|
@@ -235,12 +238,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
235
238
|
});
|
|
236
239
|
}
|
|
237
240
|
/**
|
|
238
|
-
* Returns the full detail of a
|
|
239
|
-
* Get a
|
|
241
|
+
* Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
|
|
242
|
+
* Get a logic layer
|
|
240
243
|
*/
|
|
241
|
-
|
|
244
|
+
getSpaceRulesets(requestParameters, initOverrides) {
|
|
242
245
|
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
-
const response = yield this.
|
|
246
|
+
const response = yield this.getSpaceRulesetsRaw(requestParameters, initOverrides);
|
|
244
247
|
return yield response.value();
|
|
245
248
|
});
|
|
246
249
|
}
|
|
@@ -248,10 +251,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
248
251
|
* Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
|
|
249
252
|
* Get a space ruleset image
|
|
250
253
|
*/
|
|
251
|
-
|
|
254
|
+
getSpaceRulesetsImageRaw(requestParameters, initOverrides) {
|
|
252
255
|
return __awaiter(this, void 0, void 0, function* () {
|
|
253
256
|
if (requestParameters['id'] == null) {
|
|
254
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
257
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getSpaceRulesetsImage().');
|
|
255
258
|
}
|
|
256
259
|
const queryParameters = {};
|
|
257
260
|
if (requestParameters['noFallback'] != null) {
|
|
@@ -285,17 +288,17 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
285
288
|
* Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
|
|
286
289
|
* Get a space ruleset image
|
|
287
290
|
*/
|
|
288
|
-
|
|
291
|
+
getSpaceRulesetsImage(requestParameters, initOverrides) {
|
|
289
292
|
return __awaiter(this, void 0, void 0, function* () {
|
|
290
|
-
const response = yield this.
|
|
293
|
+
const response = yield this.getSpaceRulesetsImageRaw(requestParameters, initOverrides);
|
|
291
294
|
return yield response.value();
|
|
292
295
|
});
|
|
293
296
|
}
|
|
294
297
|
/**
|
|
295
|
-
* Returns all
|
|
296
|
-
* List
|
|
298
|
+
* Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
|
|
299
|
+
* List logic layers
|
|
297
300
|
*/
|
|
298
|
-
|
|
301
|
+
listSpaceRulesetsRaw(initOverrides) {
|
|
299
302
|
return __awaiter(this, void 0, void 0, function* () {
|
|
300
303
|
const queryParameters = {};
|
|
301
304
|
const headerParameters = {};
|
|
@@ -317,20 +320,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
317
320
|
});
|
|
318
321
|
}
|
|
319
322
|
/**
|
|
320
|
-
* Returns all
|
|
321
|
-
* List
|
|
323
|
+
* Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
|
|
324
|
+
* List logic layers
|
|
322
325
|
*/
|
|
323
|
-
|
|
326
|
+
listSpaceRulesets(initOverrides) {
|
|
324
327
|
return __awaiter(this, void 0, void 0, function* () {
|
|
325
|
-
const response = yield this.
|
|
328
|
+
const response = yield this.listSpaceRulesetsRaw(initOverrides);
|
|
326
329
|
return yield response.value();
|
|
327
330
|
});
|
|
328
331
|
}
|
|
329
332
|
/**
|
|
330
|
-
* Returns the spaciv-supplied preset
|
|
331
|
-
* List preset
|
|
333
|
+
* Returns the spaciv-supplied preset logic layers available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
|
|
334
|
+
* List preset logic layers
|
|
332
335
|
*/
|
|
333
|
-
|
|
336
|
+
listSpaceRulesetsPresetsRaw(initOverrides) {
|
|
334
337
|
return __awaiter(this, void 0, void 0, function* () {
|
|
335
338
|
const queryParameters = {};
|
|
336
339
|
const headerParameters = {};
|
|
@@ -352,26 +355,26 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
352
355
|
});
|
|
353
356
|
}
|
|
354
357
|
/**
|
|
355
|
-
* Returns the spaciv-supplied preset
|
|
356
|
-
* List preset
|
|
358
|
+
* Returns the spaciv-supplied preset logic layers available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
|
|
359
|
+
* List preset logic layers
|
|
357
360
|
*/
|
|
358
|
-
|
|
361
|
+
listSpaceRulesetsPresets(initOverrides) {
|
|
359
362
|
return __awaiter(this, void 0, void 0, function* () {
|
|
360
|
-
const response = yield this.
|
|
363
|
+
const response = yield this.listSpaceRulesetsPresetsRaw(initOverrides);
|
|
361
364
|
return yield response.value();
|
|
362
365
|
});
|
|
363
366
|
}
|
|
364
367
|
/**
|
|
365
|
-
* Updates one or more fields of a
|
|
366
|
-
* Update a
|
|
368
|
+
* Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
|
|
369
|
+
* Update a logic layer
|
|
367
370
|
*/
|
|
368
|
-
|
|
371
|
+
updateSpaceRulesetsRaw(requestParameters, initOverrides) {
|
|
369
372
|
return __awaiter(this, void 0, void 0, function* () {
|
|
370
373
|
if (requestParameters['id'] == null) {
|
|
371
|
-
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling
|
|
374
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateSpaceRulesets().');
|
|
372
375
|
}
|
|
373
376
|
if (requestParameters['spaceRulesetUpdate'] == null) {
|
|
374
|
-
throw new runtime.RequiredError('spaceRulesetUpdate', 'Required parameter "spaceRulesetUpdate" was null or undefined when calling
|
|
377
|
+
throw new runtime.RequiredError('spaceRulesetUpdate', 'Required parameter "spaceRulesetUpdate" was null or undefined when calling updateSpaceRulesets().');
|
|
375
378
|
}
|
|
376
379
|
const queryParameters = {};
|
|
377
380
|
const headerParameters = {};
|
|
@@ -396,13 +399,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
396
399
|
});
|
|
397
400
|
}
|
|
398
401
|
/**
|
|
399
|
-
* Updates one or more fields of a
|
|
400
|
-
* Update a
|
|
402
|
+
* Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
|
|
403
|
+
* Update a logic layer
|
|
401
404
|
*/
|
|
402
|
-
|
|
405
|
+
updateSpaceRulesets(requestParameters, initOverrides) {
|
|
403
406
|
return __awaiter(this, void 0, void 0, function* () {
|
|
404
|
-
const response = yield this.
|
|
407
|
+
const response = yield this.updateSpaceRulesetsRaw(requestParameters, initOverrides);
|
|
405
408
|
return yield response.value();
|
|
406
409
|
});
|
|
407
410
|
}
|
|
408
411
|
}
|
|
412
|
+
/**
|
|
413
|
+
* @export
|
|
414
|
+
*/
|
|
415
|
+
export const LogicLayersApiGetSpaceRulesetsFormatEnum = {
|
|
416
|
+
Stored: 'stored',
|
|
417
|
+
Logic: 'logic'
|
|
418
|
+
};
|
|
@@ -10,10 +10,13 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { EntryPatch, ObjectGroupChangelogBody, ObjectGroupEntriesRes, ObjectGroupEntrySearchRes, ObjectGroupEntryUpdate, ObjectGroupListRes } from '../models/index';
|
|
13
|
+
import type { EntryPatch, ObjectGroupChangelogBody, ObjectGroupEntriesRes, ObjectGroupEntrySearchRes, ObjectGroupEntryUpdate, ObjectGroupListRes, SelectObjectsParamsWrapperBody, Selection } from '../models/index';
|
|
14
14
|
export interface ObjectGroupsApiCreateRequest {
|
|
15
15
|
objectGroupChangelogBody?: ObjectGroupChangelogBody;
|
|
16
16
|
}
|
|
17
|
+
export interface ObjectGroupsApiCreateSelectRequest {
|
|
18
|
+
selectObjectsParamsWrapperBody: SelectObjectsParamsWrapperBody;
|
|
19
|
+
}
|
|
17
20
|
export interface ObjectGroupsApiDeleteRequest {
|
|
18
21
|
id: string;
|
|
19
22
|
action?: ObjectGroupsApiDeleteActionEnum;
|
|
@@ -100,6 +103,20 @@ export interface ObjectGroupsApiInterface {
|
|
|
100
103
|
* Create an object group
|
|
101
104
|
*/
|
|
102
105
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
106
|
+
/**
|
|
107
|
+
* 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.
|
|
108
|
+
* @summary Select objects by filters
|
|
109
|
+
* @param {SelectObjectsParamsWrapperBody} selectObjectsParamsWrapperBody
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
* @memberof ObjectGroupsApiInterface
|
|
113
|
+
*/
|
|
114
|
+
createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>>;
|
|
115
|
+
/**
|
|
116
|
+
* 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.
|
|
117
|
+
* Select objects by filters
|
|
118
|
+
*/
|
|
119
|
+
createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection>;
|
|
103
120
|
/**
|
|
104
121
|
* 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.
|
|
105
122
|
* @summary Delete or archive an object group
|
|
@@ -345,6 +362,16 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
345
362
|
* Create an object group
|
|
346
363
|
*/
|
|
347
364
|
create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
365
|
+
/**
|
|
366
|
+
* 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.
|
|
367
|
+
* Select objects by filters
|
|
368
|
+
*/
|
|
369
|
+
createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>>;
|
|
370
|
+
/**
|
|
371
|
+
* 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.
|
|
372
|
+
* Select objects by filters
|
|
373
|
+
*/
|
|
374
|
+
createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection>;
|
|
348
375
|
/**
|
|
349
376
|
* 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.
|
|
350
377
|
* Delete or archive an object group
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { EntryPatchToJSON, ObjectGroupChangelogBodyFromJSON, ObjectGroupChangelogBodyToJSON, ObjectGroupEntriesResFromJSON, ObjectGroupEntrySearchResFromJSON, ObjectGroupEntryUpdateToJSON, ObjectGroupListResFromJSON, } from '../models/index';
|
|
24
|
+
import { EntryPatchToJSON, ObjectGroupChangelogBodyFromJSON, ObjectGroupChangelogBodyToJSON, ObjectGroupEntriesResFromJSON, ObjectGroupEntrySearchResFromJSON, ObjectGroupEntryUpdateToJSON, ObjectGroupListResFromJSON, SelectObjectsParamsWrapperBodyToJSON, SelectionFromJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -68,6 +68,46 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
68
68
|
return yield response.value();
|
|
69
69
|
});
|
|
70
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
* 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.
|
|
73
|
+
* Select objects by filters
|
|
74
|
+
*/
|
|
75
|
+
createSelectRaw(requestParameters, initOverrides) {
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
if (requestParameters['selectObjectsParamsWrapperBody'] == null) {
|
|
78
|
+
throw new runtime.RequiredError('selectObjectsParamsWrapperBody', 'Required parameter "selectObjectsParamsWrapperBody" was null or undefined when calling createSelect().');
|
|
79
|
+
}
|
|
80
|
+
const queryParameters = {};
|
|
81
|
+
const headerParameters = {};
|
|
82
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
83
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
84
|
+
const token = this.configuration.accessToken;
|
|
85
|
+
const tokenString = yield token("accessToken", []);
|
|
86
|
+
if (tokenString) {
|
|
87
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
let urlPath = `/v1/object-groups/select`;
|
|
91
|
+
const response = yield this.request({
|
|
92
|
+
path: urlPath,
|
|
93
|
+
method: 'POST',
|
|
94
|
+
headers: headerParameters,
|
|
95
|
+
query: queryParameters,
|
|
96
|
+
body: SelectObjectsParamsWrapperBodyToJSON(requestParameters['selectObjectsParamsWrapperBody']),
|
|
97
|
+
}, initOverrides);
|
|
98
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SelectionFromJSON(jsonValue));
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* 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.
|
|
103
|
+
* Select objects by filters
|
|
104
|
+
*/
|
|
105
|
+
createSelect(requestParameters, initOverrides) {
|
|
106
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107
|
+
const response = yield this.createSelectRaw(requestParameters, initOverrides);
|
|
108
|
+
return yield response.value();
|
|
109
|
+
});
|
|
110
|
+
}
|
|
71
111
|
/**
|
|
72
112
|
* 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.
|
|
73
113
|
* Delete or archive an object group
|
|
@@ -53,7 +53,7 @@ export interface PropertiesApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* 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.
|
|
56
|
+
* 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.
|
|
57
57
|
* @summary Delete a property
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
@@ -62,7 +62,7 @@ export interface PropertiesApiInterface {
|
|
|
62
62
|
*/
|
|
63
63
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
64
64
|
/**
|
|
65
|
-
* 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.
|
|
65
|
+
* 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.
|
|
66
66
|
* Delete a property
|
|
67
67
|
*/
|
|
68
68
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -81,7 +81,7 @@ export interface PropertiesApiInterface {
|
|
|
81
81
|
*/
|
|
82
82
|
duplicate(requestParameters: PropertiesApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
83
83
|
/**
|
|
84
|
-
* 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 (
|
|
84
|
+
* 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.
|
|
85
85
|
* @summary Get a property
|
|
86
86
|
* @param {string} id
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
@@ -90,12 +90,12 @@ export interface PropertiesApiInterface {
|
|
|
90
90
|
*/
|
|
91
91
|
getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>>;
|
|
92
92
|
/**
|
|
93
|
-
* 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 (
|
|
93
|
+
* 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.
|
|
94
94
|
* Get a property
|
|
95
95
|
*/
|
|
96
96
|
get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes>;
|
|
97
97
|
/**
|
|
98
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
98
|
+
* 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.
|
|
99
99
|
* @summary List properties
|
|
100
100
|
* @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.
|
|
101
101
|
* @param {Array<number>} [objectTypes]
|
|
@@ -105,12 +105,12 @@ export interface PropertiesApiInterface {
|
|
|
105
105
|
*/
|
|
106
106
|
listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>>;
|
|
107
107
|
/**
|
|
108
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
108
|
+
* 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.
|
|
109
109
|
* List properties
|
|
110
110
|
*/
|
|
111
111
|
list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
112
112
|
/**
|
|
113
|
-
* 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
|
|
113
|
+
* 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.
|
|
114
114
|
* @summary Update a property
|
|
115
115
|
* @param {string} id
|
|
116
116
|
* @param {PropertyBody} [propertyBody]
|
|
@@ -120,7 +120,7 @@ export interface PropertiesApiInterface {
|
|
|
120
120
|
*/
|
|
121
121
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
122
122
|
/**
|
|
123
|
-
* 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
|
|
123
|
+
* 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.
|
|
124
124
|
* Update a property
|
|
125
125
|
*/
|
|
126
126
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -140,12 +140,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
140
140
|
*/
|
|
141
141
|
create(requestParameters?: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
142
142
|
/**
|
|
143
|
-
* 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.
|
|
143
|
+
* 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.
|
|
144
144
|
* Delete a property
|
|
145
145
|
*/
|
|
146
146
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
147
147
|
/**
|
|
148
|
-
* 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.
|
|
148
|
+
* 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.
|
|
149
149
|
* Delete a property
|
|
150
150
|
*/
|
|
151
151
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -160,32 +160,32 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
160
160
|
*/
|
|
161
161
|
duplicate(requestParameters: PropertiesApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
162
162
|
/**
|
|
163
|
-
* 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 (
|
|
163
|
+
* 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.
|
|
164
164
|
* Get a property
|
|
165
165
|
*/
|
|
166
166
|
getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>>;
|
|
167
167
|
/**
|
|
168
|
-
* 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 (
|
|
168
|
+
* 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.
|
|
169
169
|
* Get a property
|
|
170
170
|
*/
|
|
171
171
|
get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes>;
|
|
172
172
|
/**
|
|
173
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
173
|
+
* 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.
|
|
174
174
|
* List properties
|
|
175
175
|
*/
|
|
176
176
|
listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>>;
|
|
177
177
|
/**
|
|
178
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
178
|
+
* 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.
|
|
179
179
|
* List properties
|
|
180
180
|
*/
|
|
181
181
|
list(requestParameters?: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
182
182
|
/**
|
|
183
|
-
* 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
|
|
183
|
+
* 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.
|
|
184
184
|
* Update a property
|
|
185
185
|
*/
|
|
186
186
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
187
187
|
/**
|
|
188
|
-
* 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
|
|
188
|
+
* 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.
|
|
189
189
|
* Update a property
|
|
190
190
|
*/
|
|
191
191
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|