@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
|
@@ -72,7 +72,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* 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.
|
|
75
|
+
* 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.
|
|
76
76
|
* Delete a property
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* 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.
|
|
104
|
+
* 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.
|
|
105
105
|
* Delete a property
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -154,7 +154,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
154
154
|
});
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* 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 (
|
|
157
|
+
* 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.
|
|
158
158
|
* Get a property
|
|
159
159
|
*/
|
|
160
160
|
getRaw(requestParameters, initOverrides) {
|
|
@@ -183,7 +183,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
183
183
|
});
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
|
-
* 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 (
|
|
186
|
+
* 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.
|
|
187
187
|
* Get a property
|
|
188
188
|
*/
|
|
189
189
|
get(requestParameters, initOverrides) {
|
|
@@ -193,7 +193,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
193
193
|
});
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
196
|
+
* 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.
|
|
197
197
|
* List properties
|
|
198
198
|
*/
|
|
199
199
|
listRaw(requestParameters, initOverrides) {
|
|
@@ -224,7 +224,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
224
224
|
});
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
|
-
* Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are
|
|
227
|
+
* 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.
|
|
228
228
|
* List properties
|
|
229
229
|
*/
|
|
230
230
|
list() {
|
|
@@ -234,7 +234,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
234
234
|
});
|
|
235
235
|
}
|
|
236
236
|
/**
|
|
237
|
-
* 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
|
|
237
|
+
* 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.
|
|
238
238
|
* Update a property
|
|
239
239
|
*/
|
|
240
240
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -265,7 +265,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
265
265
|
});
|
|
266
266
|
}
|
|
267
267
|
/**
|
|
268
|
-
* 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
|
|
268
|
+
* 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.
|
|
269
269
|
* Update a property
|
|
270
270
|
*/
|
|
271
271
|
update(requestParameters, initOverrides) {
|
|
@@ -110,7 +110,7 @@ export interface ScenariosApiInterface {
|
|
|
110
110
|
*/
|
|
111
111
|
list(requestParameters: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioListRes>;
|
|
112
112
|
/**
|
|
113
|
-
* 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.
|
|
113
|
+
* 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.
|
|
114
114
|
* @summary List account variables used by scenario layers
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
@@ -118,7 +118,7 @@ export interface ScenariosApiInterface {
|
|
|
118
118
|
*/
|
|
119
119
|
listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>>;
|
|
120
120
|
/**
|
|
121
|
-
* 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.
|
|
121
|
+
* 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.
|
|
122
122
|
* List account variables used by scenario layers
|
|
123
123
|
*/
|
|
124
124
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
@@ -193,12 +193,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
193
193
|
*/
|
|
194
194
|
list(requestParameters?: ScenariosApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScenarioListRes>;
|
|
195
195
|
/**
|
|
196
|
-
* 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.
|
|
196
|
+
* 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.
|
|
197
197
|
* List account variables used by scenario layers
|
|
198
198
|
*/
|
|
199
199
|
listLayerVariablesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LayerVariablesRes>>;
|
|
200
200
|
/**
|
|
201
|
-
* 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.
|
|
201
|
+
* 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.
|
|
202
202
|
* List account variables used by scenario layers
|
|
203
203
|
*/
|
|
204
204
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
@@ -235,7 +235,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
235
235
|
});
|
|
236
236
|
}
|
|
237
237
|
/**
|
|
238
|
-
* 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.
|
|
238
|
+
* 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.
|
|
239
239
|
* List account variables used by scenario layers
|
|
240
240
|
*/
|
|
241
241
|
listLayerVariablesRaw(initOverrides) {
|
|
@@ -260,7 +260,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
260
260
|
});
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
|
-
* 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.
|
|
263
|
+
* 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.
|
|
264
264
|
* List account variables used by scenario layers
|
|
265
265
|
*/
|
|
266
266
|
listLayerVariables(initOverrides) {
|
|
@@ -169,7 +169,7 @@ export interface TopDownModelsApiInterface {
|
|
|
169
169
|
*/
|
|
170
170
|
update(requestParameters: TopDownModelsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
171
171
|
/**
|
|
172
|
-
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). 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
|
|
172
|
+
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references, 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.
|
|
173
173
|
* @summary Create or update a top-down model entry
|
|
174
174
|
* @param {string} id
|
|
175
175
|
* @param {TopDownModelEntryUpdate} [topDownModelEntryUpdate]
|
|
@@ -179,7 +179,7 @@ export interface TopDownModelsApiInterface {
|
|
|
179
179
|
*/
|
|
180
180
|
updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
181
|
/**
|
|
182
|
-
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). 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
|
|
182
|
+
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references, 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.
|
|
183
183
|
* Create or update a top-down model entry
|
|
184
184
|
*/
|
|
185
185
|
updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -269,12 +269,12 @@ export declare class TopDownModelsApi extends runtime.BaseAPI implements TopDown
|
|
|
269
269
|
*/
|
|
270
270
|
update(requestParameters: TopDownModelsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
271
271
|
/**
|
|
272
|
-
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). 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
|
|
272
|
+
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references, 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.
|
|
273
273
|
* Create or update a top-down model entry
|
|
274
274
|
*/
|
|
275
275
|
updateEntriesRaw(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
276
276
|
/**
|
|
277
|
-
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). 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
|
|
277
|
+
* Upserts an entry on the specified top-down model. If an entry with the given ID already exists it is updated; otherwise a new entry is created. Supply the entry\'s ID in the request body (`id` field). A non-empty `objects` replaces the entry\'s stored objects and `clearObjects` removes them all; sending both returns `400`. Each `properties.map[].formula` must be a per-object expression: numbers, static property references, 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.
|
|
278
278
|
* Create or update a top-down model entry
|
|
279
279
|
*/
|
|
280
280
|
updateEntries(requestParameters: TopDownModelsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -362,7 +362,7 @@ class TopDownModelsApi extends runtime.BaseAPI {
|
|
|
362
362
|
});
|
|
363
363
|
}
|
|
364
364
|
/**
|
|
365
|
-
* 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
|
|
365
|
+
* 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.
|
|
366
366
|
* Create or update a top-down model entry
|
|
367
367
|
*/
|
|
368
368
|
updateEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -393,7 +393,7 @@ class TopDownModelsApi extends runtime.BaseAPI {
|
|
|
393
393
|
});
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
|
-
* 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
|
|
396
|
+
* 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.
|
|
397
397
|
* Create or update a top-down model entry
|
|
398
398
|
*/
|
|
399
399
|
updateEntries(requestParameters, initOverrides) {
|
|
@@ -90,7 +90,7 @@ export interface VariablesApiInterface {
|
|
|
90
90
|
*/
|
|
91
91
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableListRes>;
|
|
92
92
|
/**
|
|
93
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
93
|
+
* 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.
|
|
94
94
|
* @summary List account variable references
|
|
95
95
|
* @param {string} id Account variable ID, either qualified (account:<id>) or bare.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
@@ -99,7 +99,7 @@ export interface VariablesApiInterface {
|
|
|
99
99
|
*/
|
|
100
100
|
listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>>;
|
|
101
101
|
/**
|
|
102
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
102
|
+
* 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.
|
|
103
103
|
* List account variable references
|
|
104
104
|
*/
|
|
105
105
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
@@ -164,12 +164,12 @@ export declare class VariablesApi extends runtime.BaseAPI implements VariablesAp
|
|
|
164
164
|
*/
|
|
165
165
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariableListRes>;
|
|
166
166
|
/**
|
|
167
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
167
|
+
* 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.
|
|
168
168
|
* List account variable references
|
|
169
169
|
*/
|
|
170
170
|
listReferencesRaw(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferencesRes>>;
|
|
171
171
|
/**
|
|
172
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
172
|
+
* 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.
|
|
173
173
|
* List account variable references
|
|
174
174
|
*/
|
|
175
175
|
listReferences(requestParameters: VariablesApiListReferencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferencesRes>;
|
|
@@ -184,7 +184,7 @@ class VariablesApi extends runtime.BaseAPI {
|
|
|
184
184
|
});
|
|
185
185
|
}
|
|
186
186
|
/**
|
|
187
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
187
|
+
* 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.
|
|
188
188
|
* List account variable references
|
|
189
189
|
*/
|
|
190
190
|
listReferencesRaw(requestParameters, initOverrides) {
|
|
@@ -213,7 +213,7 @@ class VariablesApi extends runtime.BaseAPI {
|
|
|
213
213
|
});
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
|
-
* Returns every place in the account that uses the account-level variable: project value overrides, project filters, dashboard visualisations
|
|
216
|
+
* 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.
|
|
217
217
|
* List account variable references
|
|
218
218
|
*/
|
|
219
219
|
listReferences(requestParameters, initOverrides) {
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export * from './FloorPlansApi';
|
|
|
13
13
|
export * from './IntegrationsApi';
|
|
14
14
|
export * from './InternalApi';
|
|
15
15
|
export * from './LocalisationApi';
|
|
16
|
+
export * from './LogicLayersApi';
|
|
16
17
|
export * from './LookupsApi';
|
|
17
18
|
export * from './NeedsApi';
|
|
18
19
|
export * from './ObjectGroupsApi';
|
|
@@ -22,7 +23,6 @@ export * from './ReportsApi';
|
|
|
22
23
|
export * from './ScenariosApi';
|
|
23
24
|
export * from './ScriptsApi';
|
|
24
25
|
export * from './ServiceApi';
|
|
25
|
-
export * from './SpaceRulesetsApi';
|
|
26
26
|
export * from './TemplateProjectsApi';
|
|
27
27
|
export * from './TopDownModelsApi';
|
|
28
28
|
export * from './UsersApi';
|
package/dist/apis/index.js
CHANGED
|
@@ -31,6 +31,7 @@ __exportStar(require("./FloorPlansApi"), exports);
|
|
|
31
31
|
__exportStar(require("./IntegrationsApi"), exports);
|
|
32
32
|
__exportStar(require("./InternalApi"), exports);
|
|
33
33
|
__exportStar(require("./LocalisationApi"), exports);
|
|
34
|
+
__exportStar(require("./LogicLayersApi"), exports);
|
|
34
35
|
__exportStar(require("./LookupsApi"), exports);
|
|
35
36
|
__exportStar(require("./NeedsApi"), exports);
|
|
36
37
|
__exportStar(require("./ObjectGroupsApi"), exports);
|
|
@@ -40,7 +41,6 @@ __exportStar(require("./ReportsApi"), exports);
|
|
|
40
41
|
__exportStar(require("./ScenariosApi"), exports);
|
|
41
42
|
__exportStar(require("./ScriptsApi"), exports);
|
|
42
43
|
__exportStar(require("./ServiceApi"), exports);
|
|
43
|
-
__exportStar(require("./SpaceRulesetsApi"), exports);
|
|
44
44
|
__exportStar(require("./TemplateProjectsApi"), exports);
|
|
45
45
|
__exportStar(require("./TopDownModelsApi"), exports);
|
|
46
46
|
__exportStar(require("./UsersApi"), exports);
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* spaciv API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: support@spaciv.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { SpaceRuleSet, SpaceRuleSetJSON, SpaceRulesetCreate, SpaceRulesetListEntry, SpaceRulesetUpdate } from '../models/index';
|
|
14
|
+
export interface LogicLayersApiCreateSpaceRulesetsRequest {
|
|
15
|
+
spaceRulesetCreate: SpaceRulesetCreate;
|
|
16
|
+
}
|
|
17
|
+
export interface LogicLayersApiCreateSpaceRulesetsImageRequest {
|
|
18
|
+
id: string;
|
|
19
|
+
filename?: Blob;
|
|
20
|
+
name?: string;
|
|
21
|
+
}
|
|
22
|
+
export interface LogicLayersApiDeleteSpaceRulesetsRequest {
|
|
23
|
+
id: string;
|
|
24
|
+
}
|
|
25
|
+
export interface LogicLayersApiDeleteSpaceRulesetsImageRequest {
|
|
26
|
+
id: string;
|
|
27
|
+
}
|
|
28
|
+
export interface LogicLayersApiGetSpaceRulesetsRequest {
|
|
29
|
+
id: string;
|
|
30
|
+
format?: LogicLayersApiGetSpaceRulesetsFormatEnum;
|
|
31
|
+
}
|
|
32
|
+
export interface LogicLayersApiGetSpaceRulesetsImageRequest {
|
|
33
|
+
id: string;
|
|
34
|
+
noFallback?: boolean;
|
|
35
|
+
}
|
|
36
|
+
export interface LogicLayersApiUpdateSpaceRulesetsRequest {
|
|
37
|
+
id: string;
|
|
38
|
+
spaceRulesetUpdate: SpaceRulesetUpdate;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* LogicLayersApi - interface
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface LogicLayersApiInterface
|
|
45
|
+
*/
|
|
46
|
+
export interface LogicLayersApiInterface {
|
|
47
|
+
/**
|
|
48
|
+
* 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.
|
|
49
|
+
* @summary Create a logic layer
|
|
50
|
+
* @param {SpaceRulesetCreate} spaceRulesetCreate
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
* @memberof LogicLayersApiInterface
|
|
54
|
+
*/
|
|
55
|
+
createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
56
|
+
/**
|
|
57
|
+
* 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.
|
|
58
|
+
* Create a logic layer
|
|
59
|
+
*/
|
|
60
|
+
createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
61
|
+
/**
|
|
62
|
+
* 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.
|
|
63
|
+
* @summary Upload a space ruleset image
|
|
64
|
+
* @param {string} id
|
|
65
|
+
* @param {Blob} [filename] filename of the file being uploaded
|
|
66
|
+
* @param {string} [name] general purpose name for multipart form value
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
* @memberof LogicLayersApiInterface
|
|
70
|
+
*/
|
|
71
|
+
createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
* Upload a space ruleset image
|
|
75
|
+
*/
|
|
76
|
+
createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
77
|
+
/**
|
|
78
|
+
* 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.
|
|
79
|
+
* @summary Delete a logic layer
|
|
80
|
+
* @param {string} id
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
* @memberof LogicLayersApiInterface
|
|
84
|
+
*/
|
|
85
|
+
deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
86
|
+
/**
|
|
87
|
+
* 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.
|
|
88
|
+
* Delete a logic layer
|
|
89
|
+
*/
|
|
90
|
+
deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
91
|
+
/**
|
|
92
|
+
* 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.
|
|
93
|
+
* @summary Delete a space ruleset image
|
|
94
|
+
* @param {string} id
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
* @memberof LogicLayersApiInterface
|
|
98
|
+
*/
|
|
99
|
+
deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
100
|
+
/**
|
|
101
|
+
* 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.
|
|
102
|
+
* Delete a space ruleset image
|
|
103
|
+
*/
|
|
104
|
+
deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
105
|
+
/**
|
|
106
|
+
* 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.
|
|
107
|
+
* @summary Get a logic layer
|
|
108
|
+
* @param {string} id
|
|
109
|
+
* @param {'stored' | 'logic'} [format] stored returns the config as it was saved; logic converts a config saved by an app from before logic layers into a LogicLayerConfig.
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
* @memberof LogicLayersApiInterface
|
|
113
|
+
*/
|
|
114
|
+
getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
|
|
115
|
+
/**
|
|
116
|
+
* 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.
|
|
117
|
+
* Get a logic layer
|
|
118
|
+
*/
|
|
119
|
+
getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
|
|
120
|
+
/**
|
|
121
|
+
* 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.
|
|
122
|
+
* @summary Get a space ruleset image
|
|
123
|
+
* @param {string} id
|
|
124
|
+
* @param {boolean} [noFallback] When true, returns 404 if no custom image has been uploaded rather than generating a default image from the ruleset name.
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
* @memberof LogicLayersApiInterface
|
|
128
|
+
*/
|
|
129
|
+
getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
130
|
+
/**
|
|
131
|
+
* 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.
|
|
132
|
+
* Get a space ruleset image
|
|
133
|
+
*/
|
|
134
|
+
getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
135
|
+
/**
|
|
136
|
+
* 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.
|
|
137
|
+
* @summary List logic layers
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
* @memberof LogicLayersApiInterface
|
|
141
|
+
*/
|
|
142
|
+
listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
|
|
143
|
+
/**
|
|
144
|
+
* 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.
|
|
145
|
+
* List logic layers
|
|
146
|
+
*/
|
|
147
|
+
listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
|
|
148
|
+
/**
|
|
149
|
+
* 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.
|
|
150
|
+
* @summary List preset logic layers
|
|
151
|
+
* @param {*} [options] Override http request option.
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
* @memberof LogicLayersApiInterface
|
|
154
|
+
*/
|
|
155
|
+
listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
|
|
156
|
+
/**
|
|
157
|
+
* 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.
|
|
158
|
+
* List preset logic layers
|
|
159
|
+
*/
|
|
160
|
+
listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
|
|
161
|
+
/**
|
|
162
|
+
* 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.
|
|
163
|
+
* @summary Update a logic layer
|
|
164
|
+
* @param {string} id
|
|
165
|
+
* @param {SpaceRulesetUpdate} spaceRulesetUpdate
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
* @memberof LogicLayersApiInterface
|
|
169
|
+
*/
|
|
170
|
+
updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
171
|
+
/**
|
|
172
|
+
* 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.
|
|
173
|
+
* Update a logic layer
|
|
174
|
+
*/
|
|
175
|
+
updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
*
|
|
179
|
+
*/
|
|
180
|
+
export declare class LogicLayersApi extends runtime.BaseAPI implements LogicLayersApiInterface {
|
|
181
|
+
/**
|
|
182
|
+
* 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.
|
|
183
|
+
* Create a logic layer
|
|
184
|
+
*/
|
|
185
|
+
createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
186
|
+
/**
|
|
187
|
+
* 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.
|
|
188
|
+
* Create a logic layer
|
|
189
|
+
*/
|
|
190
|
+
createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
191
|
+
/**
|
|
192
|
+
* 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.
|
|
193
|
+
* Upload a space ruleset image
|
|
194
|
+
*/
|
|
195
|
+
createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
196
|
+
/**
|
|
197
|
+
* 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.
|
|
198
|
+
* Upload a space ruleset image
|
|
199
|
+
*/
|
|
200
|
+
createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
201
|
+
/**
|
|
202
|
+
* 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.
|
|
203
|
+
* Delete a logic layer
|
|
204
|
+
*/
|
|
205
|
+
deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
206
|
+
/**
|
|
207
|
+
* 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.
|
|
208
|
+
* Delete a logic layer
|
|
209
|
+
*/
|
|
210
|
+
deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
211
|
+
/**
|
|
212
|
+
* 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.
|
|
213
|
+
* Delete a space ruleset image
|
|
214
|
+
*/
|
|
215
|
+
deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
216
|
+
/**
|
|
217
|
+
* 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.
|
|
218
|
+
* Delete a space ruleset image
|
|
219
|
+
*/
|
|
220
|
+
deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
221
|
+
/**
|
|
222
|
+
* 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.
|
|
223
|
+
* Get a logic layer
|
|
224
|
+
*/
|
|
225
|
+
getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
|
|
226
|
+
/**
|
|
227
|
+
* 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.
|
|
228
|
+
* Get a logic layer
|
|
229
|
+
*/
|
|
230
|
+
getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
|
|
231
|
+
/**
|
|
232
|
+
* 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.
|
|
233
|
+
* Get a space ruleset image
|
|
234
|
+
*/
|
|
235
|
+
getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
236
|
+
/**
|
|
237
|
+
* 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.
|
|
238
|
+
* Get a space ruleset image
|
|
239
|
+
*/
|
|
240
|
+
getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
241
|
+
/**
|
|
242
|
+
* 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.
|
|
243
|
+
* List logic layers
|
|
244
|
+
*/
|
|
245
|
+
listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
|
|
246
|
+
/**
|
|
247
|
+
* 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.
|
|
248
|
+
* List logic layers
|
|
249
|
+
*/
|
|
250
|
+
listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
|
|
251
|
+
/**
|
|
252
|
+
* 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.
|
|
253
|
+
* List preset logic layers
|
|
254
|
+
*/
|
|
255
|
+
listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
|
|
256
|
+
/**
|
|
257
|
+
* 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.
|
|
258
|
+
* List preset logic layers
|
|
259
|
+
*/
|
|
260
|
+
listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
|
|
261
|
+
/**
|
|
262
|
+
* 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.
|
|
263
|
+
* Update a logic layer
|
|
264
|
+
*/
|
|
265
|
+
updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
266
|
+
/**
|
|
267
|
+
* 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.
|
|
268
|
+
* Update a logic layer
|
|
269
|
+
*/
|
|
270
|
+
updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* @export
|
|
274
|
+
*/
|
|
275
|
+
export declare const LogicLayersApiGetSpaceRulesetsFormatEnum: {
|
|
276
|
+
readonly Stored: "stored";
|
|
277
|
+
readonly Logic: "logic";
|
|
278
|
+
};
|
|
279
|
+
export type LogicLayersApiGetSpaceRulesetsFormatEnum = typeof LogicLayersApiGetSpaceRulesetsFormatEnum[keyof typeof LogicLayersApiGetSpaceRulesetsFormatEnum];
|