@spaciv/sdk 0.1.18 → 0.1.19
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/README.md +2 -2
- package/dist/apis/FloorPlansApi.d.ts +4 -4
- package/dist/apis/FloorPlansApi.js +2 -2
- package/dist/apis/ObjectGroupsApi.d.ts +8 -8
- package/dist/apis/ObjectGroupsApi.js +4 -4
- package/dist/apis/PropertiesApi.d.ts +8 -8
- package/dist/apis/PropertiesApi.js +4 -4
- package/dist/apis/ScenariosApi.d.ts +4 -4
- package/dist/apis/ScenariosApi.js +2 -2
- package/dist/apis/SpaceRulesetsApi.d.ts +4 -4
- package/dist/apis/SpaceRulesetsApi.js +2 -2
- package/dist/esm/apis/FloorPlansApi.d.ts +4 -4
- package/dist/esm/apis/FloorPlansApi.js +2 -2
- package/dist/esm/apis/ObjectGroupsApi.d.ts +8 -8
- package/dist/esm/apis/ObjectGroupsApi.js +4 -4
- package/dist/esm/apis/PropertiesApi.d.ts +8 -8
- package/dist/esm/apis/PropertiesApi.js +4 -4
- package/dist/esm/apis/ScenariosApi.d.ts +4 -4
- package/dist/esm/apis/ScenariosApi.js +2 -2
- package/dist/esm/apis/SpaceRulesetsApi.d.ts +4 -4
- package/dist/esm/apis/SpaceRulesetsApi.js +2 -2
- package/package.json +1 -1
- package/src/apis/FloorPlansApi.ts +4 -4
- package/src/apis/ObjectGroupsApi.ts +8 -8
- package/src/apis/PropertiesApi.ts +8 -8
- package/src/apis/ScenariosApi.ts +4 -4
- package/src/apis/SpaceRulesetsApi.ts +4 -4
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.19
|
|
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.19 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -57,7 +57,7 @@ export interface FloorPlansApiInterface {
|
|
|
57
57
|
*/
|
|
58
58
|
create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
59
59
|
/**
|
|
60
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
60
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
61
61
|
* @summary Delete a floor plan
|
|
62
62
|
* @param {string} id
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export interface FloorPlansApiInterface {
|
|
|
66
66
|
*/
|
|
67
67
|
deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
68
68
|
/**
|
|
69
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
69
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
70
70
|
* Delete a floor plan
|
|
71
71
|
*/
|
|
72
72
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -161,12 +161,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
|
|
|
161
161
|
*/
|
|
162
162
|
create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
163
163
|
/**
|
|
164
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
164
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
165
165
|
* Delete a floor plan
|
|
166
166
|
*/
|
|
167
167
|
deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
168
168
|
/**
|
|
169
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
169
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
170
170
|
* Delete a floor plan
|
|
171
171
|
*/
|
|
172
172
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -75,7 +75,7 @@ class FloorPlansApi extends runtime.BaseAPI {
|
|
|
75
75
|
});
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
78
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
79
79
|
* Delete a floor plan
|
|
80
80
|
*/
|
|
81
81
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -104,7 +104,7 @@ class FloorPlansApi extends runtime.BaseAPI {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
107
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
108
108
|
* Delete a floor plan
|
|
109
109
|
*/
|
|
110
110
|
delete(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
101
101
|
*/
|
|
102
102
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
104
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
105
105
|
* @summary Delete or archive an object group
|
|
106
106
|
* @param {string} id
|
|
107
107
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle transition to apply: \"archive\" moves the group to the archive, \"restore\" returns it to active, omitting the parameter (or \"purge\") permanently deletes the group and all its entries.
|
|
@@ -111,12 +111,12 @@ export interface ObjectGroupsApiInterface {
|
|
|
111
111
|
*/
|
|
112
112
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
113
113
|
/**
|
|
114
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
114
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
115
115
|
* Delete or archive an object group
|
|
116
116
|
*/
|
|
117
117
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
118
118
|
/**
|
|
119
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
119
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
120
120
|
* @summary Delete entries from an object group
|
|
121
121
|
* @param {string} id
|
|
122
122
|
* @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
|
|
@@ -126,7 +126,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
126
126
|
*/
|
|
127
127
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
128
128
|
/**
|
|
129
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
129
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
130
130
|
* Delete entries from an object group
|
|
131
131
|
*/
|
|
132
132
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -346,22 +346,22 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
346
346
|
*/
|
|
347
347
|
create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
348
348
|
/**
|
|
349
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
349
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
350
350
|
* Delete or archive an object group
|
|
351
351
|
*/
|
|
352
352
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
353
353
|
/**
|
|
354
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
354
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
355
355
|
* Delete or archive an object group
|
|
356
356
|
*/
|
|
357
357
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
358
358
|
/**
|
|
359
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
359
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
360
360
|
* Delete entries from an object group
|
|
361
361
|
*/
|
|
362
362
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
363
363
|
/**
|
|
364
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
364
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
365
365
|
* Delete entries from an object group
|
|
366
366
|
*/
|
|
367
367
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -72,7 +72,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
75
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
76
76
|
* Delete or archive an object group
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -104,7 +104,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
107
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
108
108
|
* Delete or archive an object group
|
|
109
109
|
*/
|
|
110
110
|
delete(requestParameters, initOverrides) {
|
|
@@ -114,7 +114,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
114
114
|
});
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
117
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
118
118
|
* Delete entries from an object group
|
|
119
119
|
*/
|
|
120
120
|
deleteEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -148,7 +148,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
148
148
|
});
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
151
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
152
152
|
* Delete entries from an object group
|
|
153
153
|
*/
|
|
154
154
|
deleteEntries(requestParameters, initOverrides) {
|
|
@@ -53,7 +53,7 @@ export interface PropertiesApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
56
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
57
57
|
* @summary Delete a property
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
@@ -62,7 +62,7 @@ export interface PropertiesApiInterface {
|
|
|
62
62
|
*/
|
|
63
63
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
64
64
|
/**
|
|
65
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
65
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
66
66
|
* Delete a property
|
|
67
67
|
*/
|
|
68
68
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -110,7 +110,7 @@ export interface PropertiesApiInterface {
|
|
|
110
110
|
*/
|
|
111
111
|
list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
112
112
|
/**
|
|
113
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
113
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
114
114
|
* @summary Update a property
|
|
115
115
|
* @param {string} id
|
|
116
116
|
* @param {PropertyBody} [propertyBody]
|
|
@@ -120,7 +120,7 @@ export interface PropertiesApiInterface {
|
|
|
120
120
|
*/
|
|
121
121
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
122
122
|
/**
|
|
123
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
123
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
124
124
|
* Update a property
|
|
125
125
|
*/
|
|
126
126
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -140,12 +140,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
140
140
|
*/
|
|
141
141
|
create(requestParameters?: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
142
142
|
/**
|
|
143
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
143
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
144
144
|
* Delete a property
|
|
145
145
|
*/
|
|
146
146
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
147
147
|
/**
|
|
148
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
148
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
149
149
|
* Delete a property
|
|
150
150
|
*/
|
|
151
151
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -180,12 +180,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
180
180
|
*/
|
|
181
181
|
list(requestParameters?: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
182
182
|
/**
|
|
183
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
183
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
184
184
|
* Update a property
|
|
185
185
|
*/
|
|
186
186
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
187
187
|
/**
|
|
188
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
188
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
189
189
|
* Update a property
|
|
190
190
|
*/
|
|
191
191
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -72,7 +72,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
75
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
76
76
|
* Delete a property
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
104
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
105
105
|
* Delete a property
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -234,7 +234,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
234
234
|
});
|
|
235
235
|
}
|
|
236
236
|
/**
|
|
237
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
237
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
238
238
|
* Update a property
|
|
239
239
|
*/
|
|
240
240
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -265,7 +265,7 @@ class PropertiesApi extends runtime.BaseAPI {
|
|
|
265
265
|
});
|
|
266
266
|
}
|
|
267
267
|
/**
|
|
268
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
268
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
269
269
|
* Update a property
|
|
270
270
|
*/
|
|
271
271
|
update(requestParameters, initOverrides) {
|
|
@@ -53,7 +53,7 @@ export interface ScenariosApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
56
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
57
57
|
* @summary Delete or archive a scenario
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \"archive\" moves the scenario to the archive, \"restore\" returns it to active, and \"purge\" permanently deletes it. Defaults to \"purge\" when omitted.
|
|
@@ -63,7 +63,7 @@ export interface ScenariosApiInterface {
|
|
|
63
63
|
*/
|
|
64
64
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
65
65
|
/**
|
|
66
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
66
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
67
67
|
* Delete or archive a scenario
|
|
68
68
|
*/
|
|
69
69
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -153,12 +153,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
153
153
|
*/
|
|
154
154
|
create(requestParameters?: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
155
155
|
/**
|
|
156
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
156
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
157
157
|
* Delete or archive a scenario
|
|
158
158
|
*/
|
|
159
159
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
160
160
|
/**
|
|
161
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
161
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
162
162
|
* Delete or archive a scenario
|
|
163
163
|
*/
|
|
164
164
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -72,7 +72,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
75
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
76
76
|
* Delete or archive a scenario
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -104,7 +104,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
107
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
108
108
|
* Delete or archive a scenario
|
|
109
109
|
*/
|
|
110
110
|
delete(requestParameters, initOverrides) {
|
|
@@ -74,7 +74,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
74
74
|
*/
|
|
75
75
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
76
76
|
/**
|
|
77
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
77
|
+
* 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.
|
|
78
78
|
* @summary Delete a space ruleset
|
|
79
79
|
* @param {string} id
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
@@ -83,7 +83,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
83
83
|
*/
|
|
84
84
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
85
85
|
/**
|
|
86
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
86
|
+
* 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.
|
|
87
87
|
* Delete a space ruleset
|
|
88
88
|
*/
|
|
89
89
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -197,12 +197,12 @@ export declare class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRu
|
|
|
197
197
|
*/
|
|
198
198
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
199
199
|
/**
|
|
200
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
200
|
+
* 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.
|
|
201
201
|
* Delete a space ruleset
|
|
202
202
|
*/
|
|
203
203
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
204
204
|
/**
|
|
205
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
205
|
+
* 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.
|
|
206
206
|
* Delete a space ruleset
|
|
207
207
|
*/
|
|
208
208
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -131,7 +131,7 @@ class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
134
|
+
* 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.
|
|
135
135
|
* Delete a space ruleset
|
|
136
136
|
*/
|
|
137
137
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -160,7 +160,7 @@ class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
160
160
|
});
|
|
161
161
|
}
|
|
162
162
|
/**
|
|
163
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
163
|
+
* 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.
|
|
164
164
|
* Delete a space ruleset
|
|
165
165
|
*/
|
|
166
166
|
delete(requestParameters, initOverrides) {
|
|
@@ -57,7 +57,7 @@ export interface FloorPlansApiInterface {
|
|
|
57
57
|
*/
|
|
58
58
|
create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
59
59
|
/**
|
|
60
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
60
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
61
61
|
* @summary Delete a floor plan
|
|
62
62
|
* @param {string} id
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export interface FloorPlansApiInterface {
|
|
|
66
66
|
*/
|
|
67
67
|
deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
68
68
|
/**
|
|
69
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
69
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
70
70
|
* Delete a floor plan
|
|
71
71
|
*/
|
|
72
72
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -161,12 +161,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
|
|
|
161
161
|
*/
|
|
162
162
|
create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
163
163
|
/**
|
|
164
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
164
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
165
165
|
* Delete a floor plan
|
|
166
166
|
*/
|
|
167
167
|
deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
168
168
|
/**
|
|
169
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
169
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
170
170
|
* Delete a floor plan
|
|
171
171
|
*/
|
|
172
172
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -72,7 +72,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
75
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
76
76
|
* Delete a floor plan
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
104
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
105
105
|
* Delete a floor plan
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
101
101
|
*/
|
|
102
102
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
104
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
105
105
|
* @summary Delete or archive an object group
|
|
106
106
|
* @param {string} id
|
|
107
107
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle transition to apply: \"archive\" moves the group to the archive, \"restore\" returns it to active, omitting the parameter (or \"purge\") permanently deletes the group and all its entries.
|
|
@@ -111,12 +111,12 @@ export interface ObjectGroupsApiInterface {
|
|
|
111
111
|
*/
|
|
112
112
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
113
113
|
/**
|
|
114
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
114
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
115
115
|
* Delete or archive an object group
|
|
116
116
|
*/
|
|
117
117
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
118
118
|
/**
|
|
119
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
119
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
120
120
|
* @summary Delete entries from an object group
|
|
121
121
|
* @param {string} id
|
|
122
122
|
* @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
|
|
@@ -126,7 +126,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
126
126
|
*/
|
|
127
127
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
128
128
|
/**
|
|
129
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
129
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
130
130
|
* Delete entries from an object group
|
|
131
131
|
*/
|
|
132
132
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -346,22 +346,22 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
346
346
|
*/
|
|
347
347
|
create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
348
348
|
/**
|
|
349
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
349
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
350
350
|
* Delete or archive an object group
|
|
351
351
|
*/
|
|
352
352
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
353
353
|
/**
|
|
354
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
354
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
355
355
|
* Delete or archive an object group
|
|
356
356
|
*/
|
|
357
357
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
358
358
|
/**
|
|
359
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
359
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
360
360
|
* Delete entries from an object group
|
|
361
361
|
*/
|
|
362
362
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
363
363
|
/**
|
|
364
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
364
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
365
365
|
* Delete entries from an object group
|
|
366
366
|
*/
|
|
367
367
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -69,7 +69,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
69
69
|
});
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
72
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
73
73
|
* Delete or archive an object group
|
|
74
74
|
*/
|
|
75
75
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
104
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
105
105
|
* Delete or archive an object group
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -111,7 +111,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
111
111
|
});
|
|
112
112
|
}
|
|
113
113
|
/**
|
|
114
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
114
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
115
115
|
* Delete entries from an object group
|
|
116
116
|
*/
|
|
117
117
|
deleteEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -145,7 +145,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
145
145
|
});
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
148
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
149
149
|
* Delete entries from an object group
|
|
150
150
|
*/
|
|
151
151
|
deleteEntries(requestParameters, initOverrides) {
|
|
@@ -53,7 +53,7 @@ export interface PropertiesApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
56
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
57
57
|
* @summary Delete a property
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
@@ -62,7 +62,7 @@ export interface PropertiesApiInterface {
|
|
|
62
62
|
*/
|
|
63
63
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
64
64
|
/**
|
|
65
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
65
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
66
66
|
* Delete a property
|
|
67
67
|
*/
|
|
68
68
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -110,7 +110,7 @@ export interface PropertiesApiInterface {
|
|
|
110
110
|
*/
|
|
111
111
|
list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
112
112
|
/**
|
|
113
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
113
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
114
114
|
* @summary Update a property
|
|
115
115
|
* @param {string} id
|
|
116
116
|
* @param {PropertyBody} [propertyBody]
|
|
@@ -120,7 +120,7 @@ export interface PropertiesApiInterface {
|
|
|
120
120
|
*/
|
|
121
121
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
122
122
|
/**
|
|
123
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
123
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
124
124
|
* Update a property
|
|
125
125
|
*/
|
|
126
126
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -140,12 +140,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
140
140
|
*/
|
|
141
141
|
create(requestParameters?: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
142
142
|
/**
|
|
143
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
143
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
144
144
|
* Delete a property
|
|
145
145
|
*/
|
|
146
146
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
147
147
|
/**
|
|
148
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
148
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
149
149
|
* Delete a property
|
|
150
150
|
*/
|
|
151
151
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -180,12 +180,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
|
|
|
180
180
|
*/
|
|
181
181
|
list(requestParameters?: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
182
182
|
/**
|
|
183
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
183
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
184
184
|
* Update a property
|
|
185
185
|
*/
|
|
186
186
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
187
187
|
/**
|
|
188
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
188
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
189
189
|
* Update a property
|
|
190
190
|
*/
|
|
191
191
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -69,7 +69,7 @@ export class PropertiesApi extends runtime.BaseAPI {
|
|
|
69
69
|
});
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
72
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
73
73
|
* Delete a property
|
|
74
74
|
*/
|
|
75
75
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -98,7 +98,7 @@ export class PropertiesApi extends runtime.BaseAPI {
|
|
|
98
98
|
});
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
101
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
102
102
|
* Delete a property
|
|
103
103
|
*/
|
|
104
104
|
delete(requestParameters, initOverrides) {
|
|
@@ -231,7 +231,7 @@ export class PropertiesApi extends runtime.BaseAPI {
|
|
|
231
231
|
});
|
|
232
232
|
}
|
|
233
233
|
/**
|
|
234
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
234
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
235
235
|
* Update a property
|
|
236
236
|
*/
|
|
237
237
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -262,7 +262,7 @@ export class PropertiesApi extends runtime.BaseAPI {
|
|
|
262
262
|
});
|
|
263
263
|
}
|
|
264
264
|
/**
|
|
265
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
265
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
266
266
|
* Update a property
|
|
267
267
|
*/
|
|
268
268
|
update(requestParameters, initOverrides) {
|
|
@@ -53,7 +53,7 @@ export interface ScenariosApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
56
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
57
57
|
* @summary Delete or archive a scenario
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \"archive\" moves the scenario to the archive, \"restore\" returns it to active, and \"purge\" permanently deletes it. Defaults to \"purge\" when omitted.
|
|
@@ -63,7 +63,7 @@ export interface ScenariosApiInterface {
|
|
|
63
63
|
*/
|
|
64
64
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
65
65
|
/**
|
|
66
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
66
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
67
67
|
* Delete or archive a scenario
|
|
68
68
|
*/
|
|
69
69
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -153,12 +153,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
153
153
|
*/
|
|
154
154
|
create(requestParameters?: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
155
155
|
/**
|
|
156
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
156
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
157
157
|
* Delete or archive a scenario
|
|
158
158
|
*/
|
|
159
159
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
160
160
|
/**
|
|
161
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
161
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
162
162
|
* Delete or archive a scenario
|
|
163
163
|
*/
|
|
164
164
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -69,7 +69,7 @@ export class ScenariosApi extends runtime.BaseAPI {
|
|
|
69
69
|
});
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
72
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
73
73
|
* Delete or archive a scenario
|
|
74
74
|
*/
|
|
75
75
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export class ScenariosApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
104
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
105
105
|
* Delete or archive a scenario
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -74,7 +74,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
74
74
|
*/
|
|
75
75
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
76
76
|
/**
|
|
77
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
77
|
+
* 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.
|
|
78
78
|
* @summary Delete a space ruleset
|
|
79
79
|
* @param {string} id
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
@@ -83,7 +83,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
83
83
|
*/
|
|
84
84
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
85
85
|
/**
|
|
86
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
86
|
+
* 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.
|
|
87
87
|
* Delete a space ruleset
|
|
88
88
|
*/
|
|
89
89
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -197,12 +197,12 @@ export declare class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRu
|
|
|
197
197
|
*/
|
|
198
198
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
199
199
|
/**
|
|
200
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
200
|
+
* 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.
|
|
201
201
|
* Delete a space ruleset
|
|
202
202
|
*/
|
|
203
203
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
204
204
|
/**
|
|
205
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
205
|
+
* 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.
|
|
206
206
|
* Delete a space ruleset
|
|
207
207
|
*/
|
|
208
208
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -128,7 +128,7 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
128
128
|
});
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
131
|
+
* 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.
|
|
132
132
|
* Delete a space ruleset
|
|
133
133
|
*/
|
|
134
134
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -157,7 +157,7 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
157
157
|
});
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
160
|
+
* 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.
|
|
161
161
|
* Delete a space ruleset
|
|
162
162
|
*/
|
|
163
163
|
delete(requestParameters, initOverrides) {
|
package/package.json
CHANGED
|
@@ -88,7 +88,7 @@ export interface FloorPlansApiInterface {
|
|
|
88
88
|
create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
89
89
|
|
|
90
90
|
/**
|
|
91
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
91
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
92
92
|
* @summary Delete a floor plan
|
|
93
93
|
* @param {string} id
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
@@ -98,7 +98,7 @@ export interface FloorPlansApiInterface {
|
|
|
98
98
|
deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
99
99
|
|
|
100
100
|
/**
|
|
101
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
101
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
102
102
|
* Delete a floor plan
|
|
103
103
|
*/
|
|
104
104
|
delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -249,7 +249,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
|
|
|
249
249
|
}
|
|
250
250
|
|
|
251
251
|
/**
|
|
252
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
252
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
253
253
|
* Delete a floor plan
|
|
254
254
|
*/
|
|
255
255
|
async deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -287,7 +287,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
|
|
|
287
287
|
}
|
|
288
288
|
|
|
289
289
|
/**
|
|
290
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
290
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
291
291
|
* Delete a floor plan
|
|
292
292
|
*/
|
|
293
293
|
async delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|
|
@@ -148,7 +148,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
148
148
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
149
149
|
|
|
150
150
|
/**
|
|
151
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
151
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
152
152
|
* @summary Delete or archive an object group
|
|
153
153
|
* @param {string} id
|
|
154
154
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle transition to apply: \"archive\" moves the group to the archive, \"restore\" returns it to active, omitting the parameter (or \"purge\") permanently deletes the group and all its entries.
|
|
@@ -159,13 +159,13 @@ export interface ObjectGroupsApiInterface {
|
|
|
159
159
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
160
160
|
|
|
161
161
|
/**
|
|
162
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
162
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
163
163
|
* Delete or archive an object group
|
|
164
164
|
*/
|
|
165
165
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
166
166
|
|
|
167
167
|
/**
|
|
168
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
168
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
169
169
|
* @summary Delete entries from an object group
|
|
170
170
|
* @param {string} id
|
|
171
171
|
* @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
|
|
@@ -176,7 +176,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
176
176
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
177
177
|
|
|
178
178
|
/**
|
|
179
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
179
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
180
180
|
* Delete entries from an object group
|
|
181
181
|
*/
|
|
182
182
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -461,7 +461,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGroupsApiI
|
|
|
461
461
|
}
|
|
462
462
|
|
|
463
463
|
/**
|
|
464
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
464
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
465
465
|
* Delete or archive an object group
|
|
466
466
|
*/
|
|
467
467
|
async deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -503,7 +503,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGroupsApiI
|
|
|
503
503
|
}
|
|
504
504
|
|
|
505
505
|
/**
|
|
506
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
506
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
507
507
|
* Delete or archive an object group
|
|
508
508
|
*/
|
|
509
509
|
async delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|
|
@@ -512,7 +512,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGroupsApiI
|
|
|
512
512
|
}
|
|
513
513
|
|
|
514
514
|
/**
|
|
515
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
515
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
516
516
|
* Delete entries from an object group
|
|
517
517
|
*/
|
|
518
518
|
async deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -560,7 +560,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGroupsApiI
|
|
|
560
560
|
}
|
|
561
561
|
|
|
562
562
|
/**
|
|
563
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
563
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
564
564
|
* Delete entries from an object group
|
|
565
565
|
*/
|
|
566
566
|
async deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -81,7 +81,7 @@ export interface PropertiesApiInterface {
|
|
|
81
81
|
create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
84
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
85
85
|
* @summary Delete a property
|
|
86
86
|
* @param {string} id
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
@@ -91,7 +91,7 @@ export interface PropertiesApiInterface {
|
|
|
91
91
|
deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
94
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
95
95
|
* Delete a property
|
|
96
96
|
*/
|
|
97
97
|
delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -146,7 +146,7 @@ export interface PropertiesApiInterface {
|
|
|
146
146
|
list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
|
|
147
147
|
|
|
148
148
|
/**
|
|
149
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
149
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
150
150
|
* @summary Update a property
|
|
151
151
|
* @param {string} id
|
|
152
152
|
* @param {PropertyBody} [propertyBody]
|
|
@@ -157,7 +157,7 @@ export interface PropertiesApiInterface {
|
|
|
157
157
|
updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
158
158
|
|
|
159
159
|
/**
|
|
160
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
160
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
161
161
|
* Update a property
|
|
162
162
|
*/
|
|
163
163
|
update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -216,7 +216,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
216
216
|
}
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
219
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
220
220
|
* Delete a property
|
|
221
221
|
*/
|
|
222
222
|
async deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -254,7 +254,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
254
254
|
}
|
|
255
255
|
|
|
256
256
|
/**
|
|
257
|
-
* Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
257
|
+
* Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
|
|
258
258
|
* Delete a property
|
|
259
259
|
*/
|
|
260
260
|
async delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -407,7 +407,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
407
407
|
}
|
|
408
408
|
|
|
409
409
|
/**
|
|
410
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
410
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
411
411
|
* Update a property
|
|
412
412
|
*/
|
|
413
413
|
async updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -448,7 +448,7 @@ export class PropertiesApi extends runtime.BaseAPI implements PropertiesApiInter
|
|
|
448
448
|
}
|
|
449
449
|
|
|
450
450
|
/**
|
|
451
|
-
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
451
|
+
* Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
|
|
452
452
|
* Update a property
|
|
453
453
|
*/
|
|
454
454
|
async update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
package/src/apis/ScenariosApi.ts
CHANGED
|
@@ -87,7 +87,7 @@ export interface ScenariosApiInterface {
|
|
|
87
87
|
create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
90
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
91
91
|
* @summary Delete or archive a scenario
|
|
92
92
|
* @param {string} id
|
|
93
93
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \"archive\" moves the scenario to the archive, \"restore\" returns it to active, and \"purge\" permanently deletes it. Defaults to \"purge\" when omitted.
|
|
@@ -98,7 +98,7 @@ export interface ScenariosApiInterface {
|
|
|
98
98
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
99
99
|
|
|
100
100
|
/**
|
|
101
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
101
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
102
102
|
* Delete or archive a scenario
|
|
103
103
|
*/
|
|
104
104
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -237,7 +237,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
237
237
|
}
|
|
238
238
|
|
|
239
239
|
/**
|
|
240
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
240
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
241
241
|
* Delete or archive a scenario
|
|
242
242
|
*/
|
|
243
243
|
async deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -279,7 +279,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
279
279
|
}
|
|
280
280
|
|
|
281
281
|
/**
|
|
282
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
282
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
283
283
|
* Delete or archive a scenario
|
|
284
284
|
*/
|
|
285
285
|
async delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|
|
@@ -111,7 +111,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
111
111
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
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
115
|
* @summary Delete a space ruleset
|
|
116
116
|
* @param {string} id
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
@@ -121,7 +121,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
121
121
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
122
122
|
|
|
123
123
|
/**
|
|
124
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
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
125
|
* Delete a space ruleset
|
|
126
126
|
*/
|
|
127
127
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -351,7 +351,7 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
|
|
|
351
351
|
}
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
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
355
|
* Delete a space ruleset
|
|
356
356
|
*/
|
|
357
357
|
async deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -389,7 +389,7 @@ export class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsAp
|
|
|
389
389
|
}
|
|
390
390
|
|
|
391
391
|
/**
|
|
392
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
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
393
|
* Delete a space ruleset
|
|
394
394
|
*/
|
|
395
395
|
async delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
|