@spaciv/sdk 0.1.18 → 0.1.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -0
- package/README.md +2 -2
- package/dist/apis/FilesApi.d.ts +132 -18
- package/dist/apis/FilesApi.js +175 -8
- 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/FilesApi.d.ts +132 -18
- package/dist/esm/apis/FilesApi.js +176 -9
- 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/dist/esm/models/AccountDirectoryPatchBody.d.ts +38 -0
- package/dist/esm/models/AccountDirectoryPatchBody.js +43 -0
- package/dist/esm/models/AccountDirectoryPostBody.d.ts +38 -0
- package/dist/esm/models/AccountDirectoryPostBody.js +45 -0
- package/dist/esm/models/AccountFilePatchBody.d.ts +8 -2
- package/dist/esm/models/AccountFilePatchBody.js +3 -3
- package/dist/esm/models/Directory.d.ts +56 -0
- package/dist/esm/models/Directory.js +57 -0
- package/dist/esm/models/DirectoryPage.d.ts +39 -0
- package/dist/esm/models/DirectoryPage.js +46 -0
- package/dist/esm/models/ListPage.d.ts +7 -0
- package/dist/esm/models/ListPage.js +3 -0
- package/dist/esm/models/ModelRecord.d.ts +7 -1
- package/dist/esm/models/ModelRecord.js +2 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/AccountDirectoryPatchBody.d.ts +38 -0
- package/dist/models/AccountDirectoryPatchBody.js +50 -0
- package/dist/models/AccountDirectoryPostBody.d.ts +38 -0
- package/dist/models/AccountDirectoryPostBody.js +52 -0
- package/dist/models/AccountFilePatchBody.d.ts +8 -2
- package/dist/models/AccountFilePatchBody.js +3 -3
- package/dist/models/Directory.d.ts +56 -0
- package/dist/models/Directory.js +64 -0
- package/dist/models/DirectoryPage.d.ts +39 -0
- package/dist/models/DirectoryPage.js +53 -0
- package/dist/models/ListPage.d.ts +7 -0
- package/dist/models/ListPage.js +3 -0
- package/dist/models/ModelRecord.d.ts +7 -1
- package/dist/models/ModelRecord.js +2 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/FilesApi.ts +319 -17
- 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/src/models/AccountDirectoryPatchBody.ts +73 -0
- package/src/models/AccountDirectoryPostBody.ts +74 -0
- package/src/models/AccountFilePatchBody.ts +11 -4
- package/src/models/Directory.ts +101 -0
- package/src/models/DirectoryPage.ts +82 -0
- package/src/models/ListPage.ts +15 -0
- package/src/models/ModelRecord.ts +9 -1
- package/src/models/index.ts +4 -0
|
@@ -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> {
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccountDirectoryPatchBody
|
|
20
|
+
*/
|
|
21
|
+
export interface AccountDirectoryPatchBody {
|
|
22
|
+
/**
|
|
23
|
+
* New display name for the directory. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash, and must not be . or ..
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AccountDirectoryPatchBody
|
|
26
|
+
*/
|
|
27
|
+
name?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the directory to move this one into, or an empty string to move it to the root.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccountDirectoryPatchBody
|
|
32
|
+
*/
|
|
33
|
+
parentId?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the AccountDirectoryPatchBody interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfAccountDirectoryPatchBody(value: object): value is AccountDirectoryPatchBody {
|
|
40
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export function AccountDirectoryPatchBodyFromJSON(json: any): AccountDirectoryPatchBody {
|
|
44
|
+
return AccountDirectoryPatchBodyFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function AccountDirectoryPatchBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountDirectoryPatchBody {
|
|
48
|
+
if (json == null) {
|
|
49
|
+
return json;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
|
|
53
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
54
|
+
'parentId': json['parentId'] == null ? undefined : json['parentId'],
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function AccountDirectoryPatchBodyToJSON(json: any): AccountDirectoryPatchBody {
|
|
59
|
+
return AccountDirectoryPatchBodyToJSONTyped(json, false);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function AccountDirectoryPatchBodyToJSONTyped(value?: AccountDirectoryPatchBody | null, ignoreDiscriminator: boolean = false): any {
|
|
63
|
+
if (value == null) {
|
|
64
|
+
return value;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return {
|
|
68
|
+
|
|
69
|
+
'name': value['name'],
|
|
70
|
+
'parentId': value['parentId'],
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccountDirectoryPostBody
|
|
20
|
+
*/
|
|
21
|
+
export interface AccountDirectoryPostBody {
|
|
22
|
+
/**
|
|
23
|
+
* Display name of the directory. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash, and must not be . or ..
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AccountDirectoryPostBody
|
|
26
|
+
*/
|
|
27
|
+
name: string;
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the directory to create this one in. Leave it out to create it at the root.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccountDirectoryPostBody
|
|
32
|
+
*/
|
|
33
|
+
parentId?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the AccountDirectoryPostBody interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfAccountDirectoryPostBody(value: object): value is AccountDirectoryPostBody {
|
|
40
|
+
if (!('name' in value) || value['name'] === undefined) return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export function AccountDirectoryPostBodyFromJSON(json: any): AccountDirectoryPostBody {
|
|
45
|
+
return AccountDirectoryPostBodyFromJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export function AccountDirectoryPostBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountDirectoryPostBody {
|
|
49
|
+
if (json == null) {
|
|
50
|
+
return json;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
|
|
54
|
+
'name': json['name'],
|
|
55
|
+
'parentId': json['parentId'] == null ? undefined : json['parentId'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function AccountDirectoryPostBodyToJSON(json: any): AccountDirectoryPostBody {
|
|
60
|
+
return AccountDirectoryPostBodyToJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function AccountDirectoryPostBodyToJSONTyped(value?: AccountDirectoryPostBody | null, ignoreDiscriminator: boolean = false): any {
|
|
64
|
+
if (value == null) {
|
|
65
|
+
return value;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
|
|
70
|
+
'name': value['name'],
|
|
71
|
+
'parentId': value['parentId'],
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
|
|
@@ -20,18 +20,23 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AccountFilePatchBody {
|
|
22
22
|
/**
|
|
23
|
-
* New display name for the file. Must not contain a forward slash or a backslash.
|
|
23
|
+
* New display name for the file. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash.
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof AccountFilePatchBody
|
|
26
26
|
*/
|
|
27
|
-
name
|
|
27
|
+
name?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the directory to move the file into, or an empty string to move it to the root.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccountFilePatchBody
|
|
32
|
+
*/
|
|
33
|
+
parentId?: string;
|
|
28
34
|
}
|
|
29
35
|
|
|
30
36
|
/**
|
|
31
37
|
* Check if a given object implements the AccountFilePatchBody interface.
|
|
32
38
|
*/
|
|
33
39
|
export function instanceOfAccountFilePatchBody(value: object): value is AccountFilePatchBody {
|
|
34
|
-
if (!('name' in value) || value['name'] === undefined) return false;
|
|
35
40
|
return true;
|
|
36
41
|
}
|
|
37
42
|
|
|
@@ -45,7 +50,8 @@ export function AccountFilePatchBodyFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
45
50
|
}
|
|
46
51
|
return {
|
|
47
52
|
|
|
48
|
-
'name': json['name'],
|
|
53
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
54
|
+
'parentId': json['parentId'] == null ? undefined : json['parentId'],
|
|
49
55
|
};
|
|
50
56
|
}
|
|
51
57
|
|
|
@@ -61,6 +67,7 @@ export function AccountFilePatchBodyToJSONTyped(value?: AccountFilePatchBody | n
|
|
|
61
67
|
return {
|
|
62
68
|
|
|
63
69
|
'name': value['name'],
|
|
70
|
+
'parentId': value['parentId'],
|
|
64
71
|
};
|
|
65
72
|
}
|
|
66
73
|
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface Directory
|
|
20
|
+
*/
|
|
21
|
+
export interface Directory {
|
|
22
|
+
/**
|
|
23
|
+
* When the directory was created (RFC 3339).
|
|
24
|
+
* @type {Date}
|
|
25
|
+
* @memberof Directory
|
|
26
|
+
*/
|
|
27
|
+
createdAt: Date;
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the user who created the directory.
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof Directory
|
|
32
|
+
*/
|
|
33
|
+
createdBy: number;
|
|
34
|
+
/**
|
|
35
|
+
* Opaque identifier of the directory.
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof Directory
|
|
38
|
+
*/
|
|
39
|
+
id: string;
|
|
40
|
+
/**
|
|
41
|
+
* Display name of the directory. Nothing else in the same parent has the same name, compared exactly and after normalising to Unicode NFC.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof Directory
|
|
44
|
+
*/
|
|
45
|
+
name: string;
|
|
46
|
+
/**
|
|
47
|
+
* Identifier of the directory this one is in. Absent for a directory at the root.
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof Directory
|
|
50
|
+
*/
|
|
51
|
+
parentId?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the Directory interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfDirectory(value: object): value is Directory {
|
|
58
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
59
|
+
if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
|
|
60
|
+
if (!('id' in value) || value['id'] === undefined) return false;
|
|
61
|
+
if (!('name' in value) || value['name'] === undefined) return false;
|
|
62
|
+
return true;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function DirectoryFromJSON(json: any): Directory {
|
|
66
|
+
return DirectoryFromJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function DirectoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): Directory {
|
|
70
|
+
if (json == null) {
|
|
71
|
+
return json;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
|
|
75
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
76
|
+
'createdBy': json['createdBy'],
|
|
77
|
+
'id': json['id'],
|
|
78
|
+
'name': json['name'],
|
|
79
|
+
'parentId': json['parentId'] == null ? undefined : json['parentId'],
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function DirectoryToJSON(json: any): Directory {
|
|
84
|
+
return DirectoryToJSONTyped(json, false);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function DirectoryToJSONTyped(value?: Directory | null, ignoreDiscriminator: boolean = false): any {
|
|
88
|
+
if (value == null) {
|
|
89
|
+
return value;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return {
|
|
93
|
+
|
|
94
|
+
'createdAt': ((value['createdAt']).toISOString()),
|
|
95
|
+
'createdBy': value['createdBy'],
|
|
96
|
+
'id': value['id'],
|
|
97
|
+
'name': value['name'],
|
|
98
|
+
'parentId': value['parentId'],
|
|
99
|
+
};
|
|
100
|
+
}
|
|
101
|
+
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* spaciv API
|
|
5
|
+
* The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@spaciv.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { Directory } from './Directory';
|
|
17
|
+
import {
|
|
18
|
+
DirectoryFromJSON,
|
|
19
|
+
DirectoryFromJSONTyped,
|
|
20
|
+
DirectoryToJSON,
|
|
21
|
+
DirectoryToJSONTyped,
|
|
22
|
+
} from './Directory';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface DirectoryPage
|
|
28
|
+
*/
|
|
29
|
+
export interface DirectoryPage {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {Array<Directory>}
|
|
33
|
+
* @memberof DirectoryPage
|
|
34
|
+
*/
|
|
35
|
+
directories: Array<Directory>;
|
|
36
|
+
/**
|
|
37
|
+
* Pass back as cursor to fetch the following page. Absent on the last page.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof DirectoryPage
|
|
40
|
+
*/
|
|
41
|
+
nextCursor?: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the DirectoryPage interface.
|
|
46
|
+
*/
|
|
47
|
+
export function instanceOfDirectoryPage(value: object): value is DirectoryPage {
|
|
48
|
+
if (!('directories' in value) || value['directories'] === undefined) return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function DirectoryPageFromJSON(json: any): DirectoryPage {
|
|
53
|
+
return DirectoryPageFromJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export function DirectoryPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): DirectoryPage {
|
|
57
|
+
if (json == null) {
|
|
58
|
+
return json;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
|
|
62
|
+
'directories': ((json['directories'] as Array<any>).map(DirectoryFromJSON)),
|
|
63
|
+
'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function DirectoryPageToJSON(json: any): DirectoryPage {
|
|
68
|
+
return DirectoryPageToJSONTyped(json, false);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function DirectoryPageToJSONTyped(value?: DirectoryPage | null, ignoreDiscriminator: boolean = false): any {
|
|
72
|
+
if (value == null) {
|
|
73
|
+
return value;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'directories': ((value['directories'] as Array<any>).map(DirectoryToJSON)),
|
|
79
|
+
'nextCursor': value['nextCursor'],
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|