@spaciv/sdk 0.1.21 → 0.1.23
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 +24 -1
- package/README.md +2 -2
- package/dist/apis/FilesApi.d.ts +28 -1
- package/dist/apis/FilesApi.js +40 -0
- 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/FilesApi.d.ts +28 -1
- package/dist/esm/apis/FilesApi.js +41 -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/AccountTextFilePostBody.d.ts +38 -0
- package/dist/esm/models/AccountTextFilePostBody.js +45 -0
- 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/ModelRecord.d.ts +1 -1
- 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 +23 -0
- package/dist/esm/models/index.js +23 -0
- package/dist/models/AccountTextFilePostBody.d.ts +38 -0
- package/dist/models/AccountTextFilePostBody.js +52 -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/ModelRecord.d.ts +1 -1
- 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 +23 -0
- package/dist/models/index.js +23 -0
- package/package.json +1 -1
- package/src/apis/FilesApi.ts +72 -0
- 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/AccountTextFilePostBody.ts +74 -0
- 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/ModelRecord.ts +1 -1
- 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 +23 -0
- package/dist/apis/SpaceRulesetsApi.d.ts +0 -269
- package/dist/esm/apis/SpaceRulesetsApi.d.ts +0 -269
package/.openapi-generator/FILES
CHANGED
|
@@ -18,6 +18,7 @@ src/apis/FloorPlansApi.ts
|
|
|
18
18
|
src/apis/IntegrationsApi.ts
|
|
19
19
|
src/apis/InternalApi.ts
|
|
20
20
|
src/apis/LocalisationApi.ts
|
|
21
|
+
src/apis/LogicLayersApi.ts
|
|
21
22
|
src/apis/LookupsApi.ts
|
|
22
23
|
src/apis/NeedsApi.ts
|
|
23
24
|
src/apis/ObjectGroupsApi.ts
|
|
@@ -27,7 +28,6 @@ src/apis/ReportsApi.ts
|
|
|
27
28
|
src/apis/ScenariosApi.ts
|
|
28
29
|
src/apis/ScriptsApi.ts
|
|
29
30
|
src/apis/ServiceApi.ts
|
|
30
|
-
src/apis/SpaceRulesetsApi.ts
|
|
31
31
|
src/apis/TemplateProjectsApi.ts
|
|
32
32
|
src/apis/TopDownModelsApi.ts
|
|
33
33
|
src/apis/UsersApi.ts
|
|
@@ -55,6 +55,7 @@ src/models/AccountPostOIDCProviderReqBody.ts
|
|
|
55
55
|
src/models/AccountPostReqBody.ts
|
|
56
56
|
src/models/AccountPutOIDCClientSecretReqBody.ts
|
|
57
57
|
src/models/AccountPutReqBody.ts
|
|
58
|
+
src/models/AccountTextFilePostBody.ts
|
|
58
59
|
src/models/AccountUsageResBody.ts
|
|
59
60
|
src/models/ActivityData.ts
|
|
60
61
|
src/models/ActivityLocationData.ts
|
|
@@ -96,7 +97,11 @@ src/models/CalcAxis.ts
|
|
|
96
97
|
src/models/CalcAxisMember.ts
|
|
97
98
|
src/models/CalcBody.ts
|
|
98
99
|
src/models/CalcChildren.ts
|
|
100
|
+
src/models/CalcCompare.ts
|
|
101
|
+
src/models/CalcCondition.ts
|
|
99
102
|
src/models/CalcErrorBody.ts
|
|
103
|
+
src/models/CalcHasNode.ts
|
|
104
|
+
src/models/CalcIsObject.ts
|
|
100
105
|
src/models/CalcList.ts
|
|
101
106
|
src/models/CalcListEntry.ts
|
|
102
107
|
src/models/CalcListTwoD.ts
|
|
@@ -109,11 +114,16 @@ src/models/CalcRuleRefOneOf2.ts
|
|
|
109
114
|
src/models/CalcRuleRefOneOf3.ts
|
|
110
115
|
src/models/CalcRuleRefOneOf4.ts
|
|
111
116
|
src/models/CalcRuleRefOneOf5.ts
|
|
117
|
+
src/models/CalcRuleRefOneOf6.ts
|
|
112
118
|
src/models/CalcSegmentation.ts
|
|
113
119
|
src/models/CalcSegmentationOneOf.ts
|
|
114
120
|
src/models/CalcSegmentationOneOf1.ts
|
|
115
121
|
src/models/CalcSegmentationOneOf2.ts
|
|
116
122
|
src/models/CalcSelect.ts
|
|
123
|
+
src/models/CalcTest.ts
|
|
124
|
+
src/models/CalcTestOneOf.ts
|
|
125
|
+
src/models/CalcTestOneOf1.ts
|
|
126
|
+
src/models/CalcTestOneOf2.ts
|
|
117
127
|
src/models/CalcTreeList.ts
|
|
118
128
|
src/models/CalcTreeValue.ts
|
|
119
129
|
src/models/CalcTypeSingleValue.ts
|
|
@@ -239,6 +249,7 @@ src/models/GetEntry.ts
|
|
|
239
249
|
src/models/GetMappingRes.ts
|
|
240
250
|
src/models/GetResponseBody.ts
|
|
241
251
|
src/models/GetTopDownModelEntriesRes.ts
|
|
252
|
+
src/models/Group.ts
|
|
242
253
|
src/models/I18nTranslationsExportParamsWrapperBody.ts
|
|
243
254
|
src/models/I18nTranslationsImportParamsWrapperBody.ts
|
|
244
255
|
src/models/I18nTranslationsParamsWrapperBody.ts
|
|
@@ -263,6 +274,15 @@ src/models/ListAccountsForUserRow.ts
|
|
|
263
274
|
src/models/ListPage.ts
|
|
264
275
|
src/models/ListUserDetailsWithEmailRow.ts
|
|
265
276
|
src/models/LocationData.ts
|
|
277
|
+
src/models/LogicAssignment.ts
|
|
278
|
+
src/models/LogicAssignmentOneOf.ts
|
|
279
|
+
src/models/LogicAssignmentOneOf1.ts
|
|
280
|
+
src/models/LogicDemand.ts
|
|
281
|
+
src/models/LogicLayerConfig.ts
|
|
282
|
+
src/models/LogicPer.ts
|
|
283
|
+
src/models/LogicRule.ts
|
|
284
|
+
src/models/LogicSupply.ts
|
|
285
|
+
src/models/LogicSupplyWeight.ts
|
|
266
286
|
src/models/MappingProp.ts
|
|
267
287
|
src/models/MappingScenario.ts
|
|
268
288
|
src/models/MaybeVarFunc.ts
|
|
@@ -277,6 +297,7 @@ src/models/MeetingSizeData.ts
|
|
|
277
297
|
src/models/MetaVersionResponse.ts
|
|
278
298
|
src/models/MissingAttributeDetail.ts
|
|
279
299
|
src/models/MissingObjectDetail.ts
|
|
300
|
+
src/models/ModelObject.ts
|
|
280
301
|
src/models/ModelRecord.ts
|
|
281
302
|
src/models/MultiSelectChangelogData.ts
|
|
282
303
|
src/models/MultiSelectContributionData.ts
|
|
@@ -364,6 +385,8 @@ src/models/ScriptSummary.ts
|
|
|
364
385
|
src/models/ScriptUsage.ts
|
|
365
386
|
src/models/ScriptUsageResBody.ts
|
|
366
387
|
src/models/ScriptWebhookResBody.ts
|
|
388
|
+
src/models/SelectObjectsParamsWrapperBody.ts
|
|
389
|
+
src/models/Selection.ts
|
|
367
390
|
src/models/SendPasswordPutReqBody.ts
|
|
368
391
|
src/models/SerializedEvent.ts
|
|
369
392
|
src/models/ServerMessage.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.23
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @spaciv/sdk@0.1.
|
|
39
|
+
npm install @spaciv/sdk@0.1.23 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/dist/apis/FilesApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { AccountDirectoryPatchBody, AccountDirectoryPostBody, AccountFilePatchBody, Directory, DirectoryPage, ListPage, ModelRecord } from '../models/index';
|
|
13
|
+
import type { AccountDirectoryPatchBody, AccountDirectoryPostBody, AccountFilePatchBody, AccountTextFilePostBody, Directory, DirectoryPage, ListPage, ModelRecord } from '../models/index';
|
|
14
14
|
export interface FilesApiCreateAccountDirectoriesRequest {
|
|
15
15
|
accountDirectoryPostBody: AccountDirectoryPostBody;
|
|
16
16
|
}
|
|
@@ -18,6 +18,9 @@ export interface FilesApiCreateAccountFilesRequest {
|
|
|
18
18
|
filename?: Blob;
|
|
19
19
|
name?: string;
|
|
20
20
|
}
|
|
21
|
+
export interface FilesApiCreateAccountTextFilesRequest {
|
|
22
|
+
accountTextFilePostBody: AccountTextFilePostBody;
|
|
23
|
+
}
|
|
21
24
|
export interface FilesApiDeleteAccountDirectoriesRequest {
|
|
22
25
|
id: string;
|
|
23
26
|
}
|
|
@@ -86,6 +89,20 @@ export interface FilesApiInterface {
|
|
|
86
89
|
* Upload a file to the account
|
|
87
90
|
*/
|
|
88
91
|
createAccountFiles(requestParameters: FilesApiCreateAccountFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelRecord>;
|
|
92
|
+
/**
|
|
93
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
94
|
+
* @summary Create an empty text file in the account\'s files
|
|
95
|
+
* @param {AccountTextFilePostBody} accountTextFilePostBody
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
* @memberof FilesApiInterface
|
|
99
|
+
*/
|
|
100
|
+
createAccountTextFilesRaw(requestParameters: FilesApiCreateAccountTextFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelRecord>>;
|
|
101
|
+
/**
|
|
102
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
103
|
+
* Create an empty text file in the account\'s files
|
|
104
|
+
*/
|
|
105
|
+
createAccountTextFiles(requestParameters: FilesApiCreateAccountTextFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelRecord>;
|
|
89
106
|
/**
|
|
90
107
|
* Deletes an empty directory from the account\'s files. A directory that still holds a file or another directory is rejected with 409 `directory is not empty`: move or delete its contents first. Deleting a directory that is already gone succeeds rather than returning 404. Any other 409 means the directory changed during the request, and the request can be retried. Requires the *Edit file storage* permission.
|
|
91
108
|
* @summary Delete a directory
|
|
@@ -231,6 +248,16 @@ export declare class FilesApi extends runtime.BaseAPI implements FilesApiInterfa
|
|
|
231
248
|
* Upload a file to the account
|
|
232
249
|
*/
|
|
233
250
|
createAccountFiles(requestParameters?: FilesApiCreateAccountFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelRecord>;
|
|
251
|
+
/**
|
|
252
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
253
|
+
* Create an empty text file in the account\'s files
|
|
254
|
+
*/
|
|
255
|
+
createAccountTextFilesRaw(requestParameters: FilesApiCreateAccountTextFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelRecord>>;
|
|
256
|
+
/**
|
|
257
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
258
|
+
* Create an empty text file in the account\'s files
|
|
259
|
+
*/
|
|
260
|
+
createAccountTextFiles(requestParameters: FilesApiCreateAccountTextFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelRecord>;
|
|
234
261
|
/**
|
|
235
262
|
* Deletes an empty directory from the account\'s files. A directory that still holds a file or another directory is rejected with 409 `directory is not empty`: move or delete its contents first. Deleting a directory that is already gone succeeds rather than returning 404. Any other 409 means the directory changed during the request, and the request can be retried. Requires the *Edit file storage* permission.
|
|
236
263
|
* Delete a directory
|
package/dist/apis/FilesApi.js
CHANGED
|
@@ -126,6 +126,46 @@ class FilesApi extends runtime.BaseAPI {
|
|
|
126
126
|
return yield response.value();
|
|
127
127
|
});
|
|
128
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
131
|
+
* Create an empty text file in the account\'s files
|
|
132
|
+
*/
|
|
133
|
+
createAccountTextFilesRaw(requestParameters, initOverrides) {
|
|
134
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
if (requestParameters['accountTextFilePostBody'] == null) {
|
|
136
|
+
throw new runtime.RequiredError('accountTextFilePostBody', 'Required parameter "accountTextFilePostBody" was null or undefined when calling createAccountTextFiles().');
|
|
137
|
+
}
|
|
138
|
+
const queryParameters = {};
|
|
139
|
+
const headerParameters = {};
|
|
140
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
141
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
142
|
+
const token = this.configuration.accessToken;
|
|
143
|
+
const tokenString = yield token("accessToken", []);
|
|
144
|
+
if (tokenString) {
|
|
145
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
let urlPath = `/v1/account/text-files`;
|
|
149
|
+
const response = yield this.request({
|
|
150
|
+
path: urlPath,
|
|
151
|
+
method: 'POST',
|
|
152
|
+
headers: headerParameters,
|
|
153
|
+
query: queryParameters,
|
|
154
|
+
body: (0, index_1.AccountTextFilePostBodyToJSON)(requestParameters['accountTextFilePostBody']),
|
|
155
|
+
}, initOverrides);
|
|
156
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ModelRecordFromJSON)(jsonValue));
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Creates an empty file to write in, at the root or inside another directory, and returns its record. The file is always text, and the name\'s extension, compared ignoring case, chooses its type: `.md` gives `text/markdown; charset=utf-8`, `.py` `text/x-python; charset=utf-8`, `.js` `text/javascript; charset=utf-8`, `.ts` `text/x-typescript; charset=utf-8` and `.go` `text/x-go; charset=utf-8`. Any other name, with or without an extension, gives `text/plain; charset=utf-8`. The file keeps that type when its content is replaced, as long as the new content is detected as plain text. Write the file\'s content by replacing it, with the `ETag` its content is read with. The name is normalised to Unicode NFC, and names are unique within a directory among its files and directories, compared exactly: a name already taken there is rejected with 409 rather than numbered, as an upload\'s would be. Returns 404 if the account has no directory with the given `parentId`. The file counts towards the account\'s 1 GiB storage quota like an upload, and is rejected with 413 when the account is already past it. Requires the *Edit file storage* permission.
|
|
161
|
+
* Create an empty text file in the account\'s files
|
|
162
|
+
*/
|
|
163
|
+
createAccountTextFiles(requestParameters, initOverrides) {
|
|
164
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
165
|
+
const response = yield this.createAccountTextFilesRaw(requestParameters, initOverrides);
|
|
166
|
+
return yield response.value();
|
|
167
|
+
});
|
|
168
|
+
}
|
|
129
169
|
/**
|
|
130
170
|
* Deletes an empty directory from the account\'s files. A directory that still holds a file or another directory is rejected with 409 `directory is not empty`: move or delete its contents first. Deleting a directory that is already gone succeeds rather than returning 404. Any other 409 means the directory changed during the request, and the request can be retried. Requires the *Edit file storage* permission.
|
|
131
171
|
* Delete a directory
|
|
@@ -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];
|