@spaciv/sdk 0.1.20 → 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.
Files changed (236) hide show
  1. package/.openapi-generator/FILES +27 -1
  2. package/README.md +2 -2
  3. package/dist/apis/LogicLayersApi.d.ts +279 -0
  4. package/dist/apis/{SpaceRulesetsApi.js → LogicLayersApi.js} +72 -62
  5. package/dist/apis/ObjectGroupsApi.d.ts +28 -1
  6. package/dist/apis/ObjectGroupsApi.js +40 -0
  7. package/dist/apis/PropertiesApi.d.ts +16 -16
  8. package/dist/apis/PropertiesApi.js +8 -8
  9. package/dist/apis/ScenariosApi.d.ts +4 -4
  10. package/dist/apis/ScenariosApi.js +2 -2
  11. package/dist/apis/ScriptsApi.d.ts +57 -1
  12. package/dist/apis/ScriptsApi.js +82 -0
  13. package/dist/apis/TopDownModelsApi.d.ts +4 -4
  14. package/dist/apis/TopDownModelsApi.js +2 -2
  15. package/dist/apis/VariablesApi.d.ts +4 -4
  16. package/dist/apis/VariablesApi.js +2 -2
  17. package/dist/apis/index.d.ts +1 -1
  18. package/dist/apis/index.js +1 -1
  19. package/dist/esm/apis/LogicLayersApi.d.ts +279 -0
  20. package/dist/esm/apis/{SpaceRulesetsApi.js → LogicLayersApi.js} +70 -60
  21. package/dist/esm/apis/ObjectGroupsApi.d.ts +28 -1
  22. package/dist/esm/apis/ObjectGroupsApi.js +41 -1
  23. package/dist/esm/apis/PropertiesApi.d.ts +16 -16
  24. package/dist/esm/apis/PropertiesApi.js +8 -8
  25. package/dist/esm/apis/ScenariosApi.d.ts +4 -4
  26. package/dist/esm/apis/ScenariosApi.js +2 -2
  27. package/dist/esm/apis/ScriptsApi.d.ts +57 -1
  28. package/dist/esm/apis/ScriptsApi.js +83 -1
  29. package/dist/esm/apis/TopDownModelsApi.d.ts +4 -4
  30. package/dist/esm/apis/TopDownModelsApi.js +2 -2
  31. package/dist/esm/apis/VariablesApi.d.ts +4 -4
  32. package/dist/esm/apis/VariablesApi.js +2 -2
  33. package/dist/esm/apis/index.d.ts +1 -1
  34. package/dist/esm/apis/index.js +1 -1
  35. package/dist/esm/models/CalcCompare.d.ts +45 -0
  36. package/dist/esm/models/CalcCompare.js +52 -0
  37. package/dist/esm/models/CalcCondition.d.ts +46 -0
  38. package/dist/esm/models/CalcCondition.js +53 -0
  39. package/dist/esm/models/CalcHasNode.d.ts +44 -0
  40. package/dist/esm/models/CalcHasNode.js +51 -0
  41. package/dist/esm/models/CalcIsObject.d.ts +32 -0
  42. package/dist/esm/models/CalcIsObject.js +43 -0
  43. package/dist/esm/models/CalcRuleRef.d.ts +2 -1
  44. package/dist/esm/models/CalcRuleRef.js +7 -0
  45. package/dist/esm/models/CalcRuleRefOneOf2.d.ts +3 -2
  46. package/dist/esm/models/CalcRuleRefOneOf2.js +4 -3
  47. package/dist/esm/models/CalcRuleRefOneOf3.d.ts +2 -3
  48. package/dist/esm/models/CalcRuleRefOneOf3.js +3 -4
  49. package/dist/esm/models/CalcRuleRefOneOf4.d.ts +3 -3
  50. package/dist/esm/models/CalcRuleRefOneOf4.js +4 -4
  51. package/dist/esm/models/CalcRuleRefOneOf5.d.ts +3 -2
  52. package/dist/esm/models/CalcRuleRefOneOf5.js +4 -3
  53. package/dist/esm/models/CalcRuleRefOneOf6.d.ts +32 -0
  54. package/dist/esm/models/CalcRuleRefOneOf6.js +43 -0
  55. package/dist/esm/models/CalcTest.d.ts +24 -0
  56. package/dist/esm/models/CalcTest.js +58 -0
  57. package/dist/esm/models/CalcTestOneOf.d.ts +33 -0
  58. package/dist/esm/models/CalcTestOneOf.js +44 -0
  59. package/dist/esm/models/CalcTestOneOf1.d.ts +33 -0
  60. package/dist/esm/models/CalcTestOneOf1.js +44 -0
  61. package/dist/esm/models/CalcTestOneOf2.d.ts +33 -0
  62. package/dist/esm/models/CalcTestOneOf2.js +44 -0
  63. package/dist/esm/models/Group.d.ts +45 -0
  64. package/dist/esm/models/Group.js +52 -0
  65. package/dist/esm/models/LayerVariablesRes.d.ts +1 -1
  66. package/dist/esm/models/LogicAssignment.d.ts +23 -0
  67. package/dist/esm/models/LogicAssignment.js +51 -0
  68. package/dist/esm/models/LogicAssignmentOneOf.d.ts +32 -0
  69. package/dist/esm/models/LogicAssignmentOneOf.js +43 -0
  70. package/dist/esm/models/LogicAssignmentOneOf1.d.ts +32 -0
  71. package/dist/esm/models/LogicAssignmentOneOf1.js +43 -0
  72. package/dist/esm/models/LogicDemand.d.ts +40 -0
  73. package/dist/esm/models/LogicDemand.js +49 -0
  74. package/dist/esm/models/LogicLayerConfig.d.ts +39 -0
  75. package/dist/esm/models/LogicLayerConfig.js +48 -0
  76. package/dist/esm/models/LogicPer.d.ts +45 -0
  77. package/dist/esm/models/LogicPer.js +52 -0
  78. package/dist/esm/models/LogicRule.d.ts +66 -0
  79. package/dist/esm/models/LogicRule.js +67 -0
  80. package/dist/esm/models/LogicSupply.d.ts +48 -0
  81. package/dist/esm/models/LogicSupply.js +54 -0
  82. package/dist/esm/models/LogicSupplyWeight.d.ts +32 -0
  83. package/dist/esm/models/LogicSupplyWeight.js +43 -0
  84. package/dist/esm/models/MaybeVarInt.d.ts +2 -2
  85. package/dist/esm/models/MaybeVarInt.js +5 -5
  86. package/dist/esm/models/MaybeVarProp.d.ts +2 -2
  87. package/dist/esm/models/MaybeVarProp.js +5 -5
  88. package/dist/esm/models/MaybeVarStr.d.ts +2 -2
  89. package/dist/esm/models/MaybeVarStr.js +5 -5
  90. package/dist/esm/models/ModelObject.d.ts +38 -0
  91. package/dist/esm/models/ModelObject.js +47 -0
  92. package/dist/esm/models/ObjectGroupListEntry.d.ts +0 -6
  93. package/dist/esm/models/ObjectGroupListEntry.js +0 -4
  94. package/dist/esm/models/ScratchpadOutput.d.ts +69 -0
  95. package/dist/esm/models/ScratchpadOutput.js +64 -0
  96. package/dist/esm/models/ScratchpadOutputFile.d.ts +44 -0
  97. package/dist/esm/models/ScratchpadOutputFile.js +49 -0
  98. package/dist/esm/models/ScratchpadRun.d.ts +127 -0
  99. package/dist/esm/models/ScratchpadRun.js +91 -0
  100. package/dist/esm/models/ScratchpadRunPostReqBody.d.ts +58 -0
  101. package/dist/esm/models/ScratchpadRunPostReqBody.js +53 -0
  102. package/dist/esm/models/SelectObjectsParamsWrapperBody.d.ts +33 -0
  103. package/dist/esm/models/SelectObjectsParamsWrapperBody.js +44 -0
  104. package/dist/esm/models/Selection.d.ts +39 -0
  105. package/dist/esm/models/Selection.js +48 -0
  106. package/dist/esm/models/SpaceRuleSetJSON.d.ts +3 -2
  107. package/dist/esm/models/SpaceRuleSetJSON.js +3 -2
  108. package/dist/esm/models/SpaceRulesetCreate.d.ts +1 -1
  109. package/dist/esm/models/index.d.ts +26 -0
  110. package/dist/esm/models/index.js +26 -0
  111. package/dist/models/CalcCompare.d.ts +45 -0
  112. package/dist/models/CalcCompare.js +59 -0
  113. package/dist/models/CalcCondition.d.ts +46 -0
  114. package/dist/models/CalcCondition.js +60 -0
  115. package/dist/models/CalcHasNode.d.ts +44 -0
  116. package/dist/models/CalcHasNode.js +58 -0
  117. package/dist/models/CalcIsObject.d.ts +32 -0
  118. package/dist/models/CalcIsObject.js +50 -0
  119. package/dist/models/CalcRuleRef.d.ts +2 -1
  120. package/dist/models/CalcRuleRef.js +7 -0
  121. package/dist/models/CalcRuleRefOneOf2.d.ts +3 -2
  122. package/dist/models/CalcRuleRefOneOf2.js +4 -3
  123. package/dist/models/CalcRuleRefOneOf3.d.ts +2 -3
  124. package/dist/models/CalcRuleRefOneOf3.js +3 -4
  125. package/dist/models/CalcRuleRefOneOf4.d.ts +3 -3
  126. package/dist/models/CalcRuleRefOneOf4.js +4 -4
  127. package/dist/models/CalcRuleRefOneOf5.d.ts +3 -2
  128. package/dist/models/CalcRuleRefOneOf5.js +4 -3
  129. package/dist/models/CalcRuleRefOneOf6.d.ts +32 -0
  130. package/dist/models/CalcRuleRefOneOf6.js +50 -0
  131. package/dist/models/CalcTest.d.ts +24 -0
  132. package/dist/models/CalcTest.js +64 -0
  133. package/dist/models/CalcTestOneOf.d.ts +33 -0
  134. package/dist/models/CalcTestOneOf.js +51 -0
  135. package/dist/models/CalcTestOneOf1.d.ts +33 -0
  136. package/dist/models/CalcTestOneOf1.js +51 -0
  137. package/dist/models/CalcTestOneOf2.d.ts +33 -0
  138. package/dist/models/CalcTestOneOf2.js +51 -0
  139. package/dist/models/Group.d.ts +45 -0
  140. package/dist/models/Group.js +59 -0
  141. package/dist/models/LayerVariablesRes.d.ts +1 -1
  142. package/dist/models/LogicAssignment.d.ts +23 -0
  143. package/dist/models/LogicAssignment.js +57 -0
  144. package/dist/models/LogicAssignmentOneOf.d.ts +32 -0
  145. package/dist/models/LogicAssignmentOneOf.js +50 -0
  146. package/dist/models/LogicAssignmentOneOf1.d.ts +32 -0
  147. package/dist/models/LogicAssignmentOneOf1.js +50 -0
  148. package/dist/models/LogicDemand.d.ts +40 -0
  149. package/dist/models/LogicDemand.js +56 -0
  150. package/dist/models/LogicLayerConfig.d.ts +39 -0
  151. package/dist/models/LogicLayerConfig.js +55 -0
  152. package/dist/models/LogicPer.d.ts +45 -0
  153. package/dist/models/LogicPer.js +59 -0
  154. package/dist/models/LogicRule.d.ts +66 -0
  155. package/dist/models/LogicRule.js +74 -0
  156. package/dist/models/LogicSupply.d.ts +48 -0
  157. package/dist/models/LogicSupply.js +61 -0
  158. package/dist/models/LogicSupplyWeight.d.ts +32 -0
  159. package/dist/models/LogicSupplyWeight.js +50 -0
  160. package/dist/models/MaybeVarInt.d.ts +2 -2
  161. package/dist/models/MaybeVarInt.js +5 -5
  162. package/dist/models/MaybeVarProp.d.ts +2 -2
  163. package/dist/models/MaybeVarProp.js +5 -5
  164. package/dist/models/MaybeVarStr.d.ts +2 -2
  165. package/dist/models/MaybeVarStr.js +5 -5
  166. package/dist/models/ModelObject.d.ts +38 -0
  167. package/dist/models/ModelObject.js +54 -0
  168. package/dist/models/ObjectGroupListEntry.d.ts +0 -6
  169. package/dist/models/ObjectGroupListEntry.js +0 -4
  170. package/dist/models/ScratchpadOutput.d.ts +69 -0
  171. package/dist/models/ScratchpadOutput.js +71 -0
  172. package/dist/models/ScratchpadOutputFile.d.ts +44 -0
  173. package/dist/models/ScratchpadOutputFile.js +56 -0
  174. package/dist/models/ScratchpadRun.d.ts +127 -0
  175. package/dist/models/ScratchpadRun.js +99 -0
  176. package/dist/models/ScratchpadRunPostReqBody.d.ts +58 -0
  177. package/dist/models/ScratchpadRunPostReqBody.js +60 -0
  178. package/dist/models/SelectObjectsParamsWrapperBody.d.ts +33 -0
  179. package/dist/models/SelectObjectsParamsWrapperBody.js +51 -0
  180. package/dist/models/Selection.d.ts +39 -0
  181. package/dist/models/Selection.js +55 -0
  182. package/dist/models/SpaceRuleSetJSON.d.ts +3 -2
  183. package/dist/models/SpaceRuleSetJSON.js +3 -2
  184. package/dist/models/SpaceRulesetCreate.d.ts +1 -1
  185. package/dist/models/index.d.ts +26 -0
  186. package/dist/models/index.js +26 -0
  187. package/package.json +1 -1
  188. package/src/apis/{SpaceRulesetsApi.ts → LogicLayersApi.ts} +136 -121
  189. package/src/apis/ObjectGroupsApi.ts +75 -0
  190. package/src/apis/PropertiesApi.ts +16 -16
  191. package/src/apis/ScenariosApi.ts +4 -4
  192. package/src/apis/ScriptsApi.ts +148 -0
  193. package/src/apis/TopDownModelsApi.ts +4 -4
  194. package/src/apis/VariablesApi.ts +4 -4
  195. package/src/apis/index.ts +1 -1
  196. package/src/models/CalcCompare.ts +92 -0
  197. package/src/models/CalcCondition.ts +99 -0
  198. package/src/models/CalcHasNode.ts +84 -0
  199. package/src/models/CalcIsObject.ts +66 -0
  200. package/src/models/CalcRuleRef.ts +14 -1
  201. package/src/models/CalcRuleRefOneOf2.ts +13 -5
  202. package/src/models/CalcRuleRefOneOf3.ts +5 -13
  203. package/src/models/CalcRuleRefOneOf4.ts +11 -11
  204. package/src/models/CalcRuleRefOneOf5.ts +13 -5
  205. package/src/models/CalcRuleRefOneOf6.ts +66 -0
  206. package/src/models/CalcTest.ts +89 -0
  207. package/src/models/CalcTestOneOf.ts +74 -0
  208. package/src/models/CalcTestOneOf1.ts +74 -0
  209. package/src/models/CalcTestOneOf2.ts +74 -0
  210. package/src/models/Group.ts +92 -0
  211. package/src/models/LayerVariablesRes.ts +1 -1
  212. package/src/models/LogicAssignment.ts +76 -0
  213. package/src/models/LogicAssignmentOneOf.ts +66 -0
  214. package/src/models/LogicAssignmentOneOf1.ts +66 -0
  215. package/src/models/LogicDemand.ts +90 -0
  216. package/src/models/LogicLayerConfig.ts +83 -0
  217. package/src/models/LogicPer.ts +92 -0
  218. package/src/models/LogicRule.ts +140 -0
  219. package/src/models/LogicSupply.ts +99 -0
  220. package/src/models/LogicSupplyWeight.ts +66 -0
  221. package/src/models/MaybeVarInt.ts +11 -11
  222. package/src/models/MaybeVarProp.ts +11 -11
  223. package/src/models/MaybeVarStr.ts +11 -11
  224. package/src/models/ModelObject.ts +75 -0
  225. package/src/models/ObjectGroupListEntry.ts +0 -9
  226. package/src/models/ScratchpadOutput.ts +126 -0
  227. package/src/models/ScratchpadOutputFile.ts +83 -0
  228. package/src/models/ScratchpadRun.ts +203 -0
  229. package/src/models/ScratchpadRunPostReqBody.ts +99 -0
  230. package/src/models/SelectObjectsParamsWrapperBody.ts +74 -0
  231. package/src/models/Selection.ts +83 -0
  232. package/src/models/SpaceRuleSetJSON.ts +12 -4
  233. package/src/models/SpaceRulesetCreate.ts +1 -1
  234. package/src/models/index.ts +26 -0
  235. package/dist/apis/SpaceRulesetsApi.d.ts +0 -269
  236. package/dist/esm/apis/SpaceRulesetsApi.d.ts +0 -269
@@ -37,60 +37,61 @@ import {
37
37
  SpaceRulesetUpdateToJSON,
38
38
  } from '../models/index';
39
39
 
40
- export interface SpaceRulesetsApiCreateRequest {
40
+ export interface LogicLayersApiCreateSpaceRulesetsRequest {
41
41
  spaceRulesetCreate: SpaceRulesetCreate;
42
42
  }
43
43
 
44
- export interface SpaceRulesetsApiCreateImageRequest {
44
+ export interface LogicLayersApiCreateSpaceRulesetsImageRequest {
45
45
  id: string;
46
46
  filename?: Blob;
47
47
  name?: string;
48
48
  }
49
49
 
50
- export interface SpaceRulesetsApiDeleteRequest {
50
+ export interface LogicLayersApiDeleteSpaceRulesetsRequest {
51
51
  id: string;
52
52
  }
53
53
 
54
- export interface SpaceRulesetsApiDeleteImageRequest {
54
+ export interface LogicLayersApiDeleteSpaceRulesetsImageRequest {
55
55
  id: string;
56
56
  }
57
57
 
58
- export interface SpaceRulesetsApiGetRequest {
58
+ export interface LogicLayersApiGetSpaceRulesetsRequest {
59
59
  id: string;
60
+ format?: LogicLayersApiGetSpaceRulesetsFormatEnum;
60
61
  }
61
62
 
62
- export interface SpaceRulesetsApiGetImageRequest {
63
+ export interface LogicLayersApiGetSpaceRulesetsImageRequest {
63
64
  id: string;
64
65
  noFallback?: boolean;
65
66
  }
66
67
 
67
- export interface SpaceRulesetsApiUpdateRequest {
68
+ export interface LogicLayersApiUpdateSpaceRulesetsRequest {
68
69
  id: string;
69
70
  spaceRulesetUpdate: SpaceRulesetUpdate;
70
71
  }
71
72
 
72
73
  /**
73
- * SpaceRulesetsApi - interface
74
+ * LogicLayersApi - interface
74
75
  *
75
76
  * @export
76
- * @interface SpaceRulesetsApiInterface
77
+ * @interface LogicLayersApiInterface
77
78
  */
78
- export interface SpaceRulesetsApiInterface {
79
+ export interface LogicLayersApiInterface {
79
80
  /**
80
- * Creates a new space ruleset 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 an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
81
- * @summary Create a space ruleset
81
+ * 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.
82
+ * @summary Create a logic layer
82
83
  * @param {SpaceRulesetCreate} spaceRulesetCreate
83
84
  * @param {*} [options] Override http request option.
84
85
  * @throws {RequiredError}
85
- * @memberof SpaceRulesetsApiInterface
86
+ * @memberof LogicLayersApiInterface
86
87
  */
87
- createRaw(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
88
+ createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
88
89
 
89
90
  /**
90
- * Creates a new space ruleset 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 an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
91
- * Create a space ruleset
91
+ * 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.
92
+ * Create a logic layer
92
93
  */
93
- create(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
94
+ createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
94
95
 
95
96
  /**
96
97
  * 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.
@@ -100,31 +101,31 @@ export interface SpaceRulesetsApiInterface {
100
101
  * @param {string} [name] general purpose name for multipart form value
101
102
  * @param {*} [options] Override http request option.
102
103
  * @throws {RequiredError}
103
- * @memberof SpaceRulesetsApiInterface
104
+ * @memberof LogicLayersApiInterface
104
105
  */
105
- createImageRaw(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
106
+ createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
106
107
 
107
108
  /**
108
109
  * 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.
109
110
  * Upload a space ruleset image
110
111
  */
111
- createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
112
+ createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
112
113
 
113
114
  /**
114
- * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
115
- * @summary Delete a space ruleset
115
+ * 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.
116
+ * @summary Delete a logic layer
116
117
  * @param {string} id
117
118
  * @param {*} [options] Override http request option.
118
119
  * @throws {RequiredError}
119
- * @memberof SpaceRulesetsApiInterface
120
+ * @memberof LogicLayersApiInterface
120
121
  */
121
- deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
122
+ deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
122
123
 
123
124
  /**
124
- * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
125
- * Delete a space ruleset
125
+ * 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.
126
+ * Delete a logic layer
126
127
  */
127
- delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
128
+ deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
128
129
 
129
130
  /**
130
131
  * 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.
@@ -132,31 +133,32 @@ export interface SpaceRulesetsApiInterface {
132
133
  * @param {string} id
133
134
  * @param {*} [options] Override http request option.
134
135
  * @throws {RequiredError}
135
- * @memberof SpaceRulesetsApiInterface
136
+ * @memberof LogicLayersApiInterface
136
137
  */
137
- deleteImageRaw(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
138
+ deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
138
139
 
139
140
  /**
140
141
  * 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.
141
142
  * Delete a space ruleset image
142
143
  */
143
- deleteImage(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
144
+ deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
144
145
 
145
146
  /**
146
- * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
147
- * @summary Get a space ruleset
147
+ * 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.
148
+ * @summary Get a logic layer
148
149
  * @param {string} id
150
+ * @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.
149
151
  * @param {*} [options] Override http request option.
150
152
  * @throws {RequiredError}
151
- * @memberof SpaceRulesetsApiInterface
153
+ * @memberof LogicLayersApiInterface
152
154
  */
153
- getRaw(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
155
+ getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
154
156
 
155
157
  /**
156
- * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
157
- * Get a space ruleset
158
+ * 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.
159
+ * Get a logic layer
158
160
  */
159
- get(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
161
+ getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
160
162
 
161
163
  /**
162
164
  * 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.
@@ -165,79 +167,79 @@ export interface SpaceRulesetsApiInterface {
165
167
  * @param {boolean} [noFallback] When true, returns 404 if no custom image has been uploaded rather than generating a default image from the ruleset name.
166
168
  * @param {*} [options] Override http request option.
167
169
  * @throws {RequiredError}
168
- * @memberof SpaceRulesetsApiInterface
170
+ * @memberof LogicLayersApiInterface
169
171
  */
170
- getImageRaw(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
172
+ getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
171
173
 
172
174
  /**
173
175
  * 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.
174
176
  * Get a space ruleset image
175
177
  */
176
- getImage(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
178
+ getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
177
179
 
178
180
  /**
179
- * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
180
- * @summary List space rulesets
181
+ * 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.
182
+ * @summary List logic layers
181
183
  * @param {*} [options] Override http request option.
182
184
  * @throws {RequiredError}
183
- * @memberof SpaceRulesetsApiInterface
185
+ * @memberof LogicLayersApiInterface
184
186
  */
185
- listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
187
+ listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
186
188
 
187
189
  /**
188
- * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
189
- * List space rulesets
190
+ * 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.
191
+ * List logic layers
190
192
  */
191
- list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
193
+ listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
192
194
 
193
195
  /**
194
- * Returns the spaciv-supplied preset space rulesets 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.
195
- * @summary List preset space rulesets
196
+ * 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.
197
+ * @summary List preset logic layers
196
198
  * @param {*} [options] Override http request option.
197
199
  * @throws {RequiredError}
198
- * @memberof SpaceRulesetsApiInterface
200
+ * @memberof LogicLayersApiInterface
199
201
  */
200
- listPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
202
+ listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
201
203
 
202
204
  /**
203
- * Returns the spaciv-supplied preset space rulesets 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.
204
- * List preset space rulesets
205
+ * 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.
206
+ * List preset logic layers
205
207
  */
206
- listPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
208
+ listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
207
209
 
208
210
  /**
209
- * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
210
- * @summary Update a space ruleset
211
+ * 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.
212
+ * @summary Update a logic layer
211
213
  * @param {string} id
212
214
  * @param {SpaceRulesetUpdate} spaceRulesetUpdate
213
215
  * @param {*} [options] Override http request option.
214
216
  * @throws {RequiredError}
215
- * @memberof SpaceRulesetsApiInterface
217
+ * @memberof LogicLayersApiInterface
216
218
  */
217
- updateRaw(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
219
+ updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
218
220
 
219
221
  /**
220
- * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
221
- * Update a space ruleset
222
+ * 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.
223
+ * Update a logic layer
222
224
  */
223
- update(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
225
+ updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
224
226
 
225
227
  }
226
228
 
227
229
  /**
228
230
  *
229
231
  */
230
- export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsApiInterface {
232
+ export class LogicLayersApi extends runtime.BaseAPI implements LogicLayersApiInterface {
231
233
 
232
234
  /**
233
- * Creates a new space ruleset 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 an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
234
- * Create a space ruleset
235
+ * 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.
236
+ * Create a logic layer
235
237
  */
236
- async createRaw(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
238
+ async createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
237
239
  if (requestParameters['spaceRulesetCreate'] == null) {
238
240
  throw new runtime.RequiredError(
239
241
  'spaceRulesetCreate',
240
- 'Required parameter "spaceRulesetCreate" was null or undefined when calling create().'
242
+ 'Required parameter "spaceRulesetCreate" was null or undefined when calling createSpaceRulesets().'
241
243
  );
242
244
  }
243
245
 
@@ -270,11 +272,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
270
272
  }
271
273
 
272
274
  /**
273
- * Creates a new space ruleset 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 an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
274
- * Create a space ruleset
275
+ * 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.
276
+ * Create a logic layer
275
277
  */
276
- async create(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
277
- const response = await this.createRaw(requestParameters, initOverrides);
278
+ async createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
279
+ const response = await this.createSpaceRulesetsRaw(requestParameters, initOverrides);
278
280
  return await response.value();
279
281
  }
280
282
 
@@ -282,11 +284,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
282
284
  * 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.
283
285
  * Upload a space ruleset image
284
286
  */
285
- async createImageRaw(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
287
+ async createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
286
288
  if (requestParameters['id'] == null) {
287
289
  throw new runtime.RequiredError(
288
290
  'id',
289
- 'Required parameter "id" was null or undefined when calling createImage().'
291
+ 'Required parameter "id" was null or undefined when calling createSpaceRulesetsImage().'
290
292
  );
291
293
  }
292
294
 
@@ -345,20 +347,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
345
347
  * 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.
346
348
  * Upload a space ruleset image
347
349
  */
348
- async createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
349
- const response = await this.createImageRaw(requestParameters, initOverrides);
350
+ async createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
351
+ const response = await this.createSpaceRulesetsImageRaw(requestParameters, initOverrides);
350
352
  return await response.value();
351
353
  }
352
354
 
353
355
  /**
354
- * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
355
- * Delete a space ruleset
356
+ * 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.
357
+ * Delete a logic layer
356
358
  */
357
- async deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
359
+ async deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
358
360
  if (requestParameters['id'] == null) {
359
361
  throw new runtime.RequiredError(
360
362
  'id',
361
- 'Required parameter "id" was null or undefined when calling delete().'
363
+ 'Required parameter "id" was null or undefined when calling deleteSpaceRulesets().'
362
364
  );
363
365
  }
364
366
 
@@ -389,11 +391,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
389
391
  }
390
392
 
391
393
  /**
392
- * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
393
- * Delete a space ruleset
394
+ * 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.
395
+ * Delete a logic layer
394
396
  */
395
- async delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
396
- const response = await this.deleteRaw(requestParameters, initOverrides);
397
+ async deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
398
+ const response = await this.deleteSpaceRulesetsRaw(requestParameters, initOverrides);
397
399
  return await response.value();
398
400
  }
399
401
 
@@ -401,11 +403,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
401
403
  * 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.
402
404
  * Delete a space ruleset image
403
405
  */
404
- async deleteImageRaw(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
406
+ async deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
405
407
  if (requestParameters['id'] == null) {
406
408
  throw new runtime.RequiredError(
407
409
  'id',
408
- 'Required parameter "id" was null or undefined when calling deleteImage().'
410
+ 'Required parameter "id" was null or undefined when calling deleteSpaceRulesetsImage().'
409
411
  );
410
412
  }
411
413
 
@@ -439,25 +441,29 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
439
441
  * 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.
440
442
  * Delete a space ruleset image
441
443
  */
442
- async deleteImage(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
443
- const response = await this.deleteImageRaw(requestParameters, initOverrides);
444
+ async deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
445
+ const response = await this.deleteSpaceRulesetsImageRaw(requestParameters, initOverrides);
444
446
  return await response.value();
445
447
  }
446
448
 
447
449
  /**
448
- * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
449
- * Get a space ruleset
450
+ * 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.
451
+ * Get a logic layer
450
452
  */
451
- async getRaw(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>> {
453
+ async getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>> {
452
454
  if (requestParameters['id'] == null) {
453
455
  throw new runtime.RequiredError(
454
456
  'id',
455
- 'Required parameter "id" was null or undefined when calling get().'
457
+ 'Required parameter "id" was null or undefined when calling getSpaceRulesets().'
456
458
  );
457
459
  }
458
460
 
459
461
  const queryParameters: any = {};
460
462
 
463
+ if (requestParameters['format'] != null) {
464
+ queryParameters['format'] = requestParameters['format'];
465
+ }
466
+
461
467
  const headerParameters: runtime.HTTPHeaders = {};
462
468
 
463
469
  if (this.configuration && this.configuration.accessToken) {
@@ -483,11 +489,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
483
489
  }
484
490
 
485
491
  /**
486
- * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
487
- * Get a space ruleset
492
+ * 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.
493
+ * Get a logic layer
488
494
  */
489
- async get(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON> {
490
- const response = await this.getRaw(requestParameters, initOverrides);
495
+ async getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON> {
496
+ const response = await this.getSpaceRulesetsRaw(requestParameters, initOverrides);
491
497
  return await response.value();
492
498
  }
493
499
 
@@ -495,11 +501,11 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
495
501
  * 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.
496
502
  * Get a space ruleset image
497
503
  */
498
- async getImageRaw(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
504
+ async getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
499
505
  if (requestParameters['id'] == null) {
500
506
  throw new runtime.RequiredError(
501
507
  'id',
502
- 'Required parameter "id" was null or undefined when calling getImage().'
508
+ 'Required parameter "id" was null or undefined when calling getSpaceRulesetsImage().'
503
509
  );
504
510
  }
505
511
 
@@ -541,16 +547,16 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
541
547
  * 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.
542
548
  * Get a space ruleset image
543
549
  */
544
- async getImage(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
545
- const response = await this.getImageRaw(requestParameters, initOverrides);
550
+ async getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
551
+ const response = await this.getSpaceRulesetsImageRaw(requestParameters, initOverrides);
546
552
  return await response.value();
547
553
  }
548
554
 
549
555
  /**
550
- * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
551
- * List space rulesets
556
+ * 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.
557
+ * List logic layers
552
558
  */
553
- async listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>> {
559
+ async listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>> {
554
560
  const queryParameters: any = {};
555
561
 
556
562
  const headerParameters: runtime.HTTPHeaders = {};
@@ -577,19 +583,19 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
577
583
  }
578
584
 
579
585
  /**
580
- * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
581
- * List space rulesets
586
+ * 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.
587
+ * List logic layers
582
588
  */
583
- async list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>> {
584
- const response = await this.listRaw(initOverrides);
589
+ async listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>> {
590
+ const response = await this.listSpaceRulesetsRaw(initOverrides);
585
591
  return await response.value();
586
592
  }
587
593
 
588
594
  /**
589
- * Returns the spaciv-supplied preset space rulesets 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.
590
- * List preset space rulesets
595
+ * 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.
596
+ * List preset logic layers
591
597
  */
592
- async listPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>> {
598
+ async listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>> {
593
599
  const queryParameters: any = {};
594
600
 
595
601
  const headerParameters: runtime.HTTPHeaders = {};
@@ -616,30 +622,30 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
616
622
  }
617
623
 
618
624
  /**
619
- * Returns the spaciv-supplied preset space rulesets 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.
620
- * List preset space rulesets
625
+ * 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.
626
+ * List preset logic layers
621
627
  */
622
- async listPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>> {
623
- const response = await this.listPresetsRaw(initOverrides);
628
+ async listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>> {
629
+ const response = await this.listSpaceRulesetsPresetsRaw(initOverrides);
624
630
  return await response.value();
625
631
  }
626
632
 
627
633
  /**
628
- * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
629
- * Update a space ruleset
634
+ * 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.
635
+ * Update a logic layer
630
636
  */
631
- async updateRaw(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
637
+ async updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
632
638
  if (requestParameters['id'] == null) {
633
639
  throw new runtime.RequiredError(
634
640
  'id',
635
- 'Required parameter "id" was null or undefined when calling update().'
641
+ 'Required parameter "id" was null or undefined when calling updateSpaceRulesets().'
636
642
  );
637
643
  }
638
644
 
639
645
  if (requestParameters['spaceRulesetUpdate'] == null) {
640
646
  throw new runtime.RequiredError(
641
647
  'spaceRulesetUpdate',
642
- 'Required parameter "spaceRulesetUpdate" was null or undefined when calling update().'
648
+ 'Required parameter "spaceRulesetUpdate" was null or undefined when calling updateSpaceRulesets().'
643
649
  );
644
650
  }
645
651
 
@@ -673,12 +679,21 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
673
679
  }
674
680
 
675
681
  /**
676
- * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
677
- * Update a space ruleset
682
+ * 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.
683
+ * Update a logic layer
678
684
  */
679
- async update(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
680
- const response = await this.updateRaw(requestParameters, initOverrides);
685
+ async updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
686
+ const response = await this.updateSpaceRulesetsRaw(requestParameters, initOverrides);
681
687
  return await response.value();
682
688
  }
683
689
 
684
690
  }
691
+
692
+ /**
693
+ * @export
694
+ */
695
+ export const LogicLayersApiGetSpaceRulesetsFormatEnum = {
696
+ Stored: 'stored',
697
+ Logic: 'logic'
698
+ } as const;
699
+ export type LogicLayersApiGetSpaceRulesetsFormatEnum = typeof LogicLayersApiGetSpaceRulesetsFormatEnum[keyof typeof LogicLayersApiGetSpaceRulesetsFormatEnum];