@spaciv/sdk 0.1.17 → 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/AssistantApi.d.ts +16 -16
- package/dist/apis/AssistantApi.js +8 -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 +8 -8
- package/dist/apis/ScenariosApi.js +4 -4
- package/dist/apis/SpaceRulesetsApi.d.ts +4 -4
- package/dist/apis/SpaceRulesetsApi.js +2 -2
- package/dist/esm/apis/AssistantApi.d.ts +16 -16
- package/dist/esm/apis/AssistantApi.js +8 -8
- 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 +8 -8
- package/dist/esm/apis/ScenariosApi.js +4 -4
- package/dist/esm/apis/SpaceRulesetsApi.d.ts +4 -4
- package/dist/esm/apis/SpaceRulesetsApi.js +2 -2
- package/dist/esm/models/AssistantChatPollBody.d.ts +12 -0
- package/dist/esm/models/AssistantChatPollBody.js +8 -0
- package/dist/esm/models/AssistantChatPollMessage.d.ts +6 -0
- package/dist/esm/models/AssistantChatPollMessage.js +4 -0
- package/dist/esm/models/AssistantTranscriptBody.d.ts +18 -0
- package/dist/esm/models/AssistantTranscriptBody.js +12 -0
- package/dist/models/AssistantChatPollBody.d.ts +12 -0
- package/dist/models/AssistantChatPollBody.js +8 -0
- package/dist/models/AssistantChatPollMessage.d.ts +6 -0
- package/dist/models/AssistantChatPollMessage.js +4 -0
- package/dist/models/AssistantTranscriptBody.d.ts +18 -0
- package/dist/models/AssistantTranscriptBody.js +12 -0
- package/package.json +1 -1
- package/src/apis/AssistantApi.ts +16 -16
- 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 +8 -8
- package/src/apis/SpaceRulesetsApi.ts +4 -4
- package/src/models/AssistantChatPollBody.ts +18 -0
- package/src/models/AssistantChatPollMessage.ts +9 -0
- package/src/models/AssistantTranscriptBody.ts +27 -0
package/src/apis/AssistantApi.ts
CHANGED
|
@@ -79,7 +79,7 @@ export interface AssistantApiUpdateConfigRequest {
|
|
|
79
79
|
*/
|
|
80
80
|
export interface AssistantApiInterface {
|
|
81
81
|
/**
|
|
82
|
-
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Requires the *AI assistant* permission.
|
|
82
|
+
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Returns `409` if `conversationId` names a conversation that cannot take messages: a subsession the assistant started for a tool call, which only ever answers the task it was given, or a deleted conversation. Requires the *AI assistant* permission.
|
|
83
83
|
* @summary Send a chat message
|
|
84
84
|
* @param {AssistantChatReq} [assistantChatReq]
|
|
85
85
|
* @param {*} [options] Override http request option.
|
|
@@ -89,13 +89,13 @@ export interface AssistantApiInterface {
|
|
|
89
89
|
createChatRaw(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantChatRes>>;
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Requires the *AI assistant* permission.
|
|
92
|
+
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Returns `409` if `conversationId` names a conversation that cannot take messages: a subsession the assistant started for a tool call, which only ever answers the task it was given, or a deleted conversation. Requires the *AI assistant* permission.
|
|
93
93
|
* Send a chat message
|
|
94
94
|
*/
|
|
95
95
|
createChat(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatRes>;
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
|
-
* Permanently removes a conversation
|
|
98
|
+
* Permanently removes a conversation, all its messages, and every subsession it started. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is deleted only with the conversation that started it. Requires the *AI assistant* permission.
|
|
99
99
|
* @summary Delete a conversation
|
|
100
100
|
* @param {string} id UUID of the conversation to delete.
|
|
101
101
|
* @param {*} [options] Override http request option.
|
|
@@ -105,7 +105,7 @@ export interface AssistantApiInterface {
|
|
|
105
105
|
deleteConversationsRaw(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* Permanently removes a conversation
|
|
108
|
+
* Permanently removes a conversation, all its messages, and every subsession it started. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is deleted only with the conversation that started it. Requires the *AI assistant* permission.
|
|
109
109
|
* Delete a conversation
|
|
110
110
|
*/
|
|
111
111
|
deleteConversations(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -126,7 +126,7 @@ export interface AssistantApiInterface {
|
|
|
126
126
|
getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
|
-
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call,
|
|
129
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, the summary that replaces the earliest messages once the conversation has been compacted, and the stored conversation of every subsession the assistant handed a task to. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
130
130
|
* @summary Get a conversation\'s transcript
|
|
131
131
|
* @param {string} id UUID of the conversation to read.
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
@@ -136,7 +136,7 @@ export interface AssistantApiInterface {
|
|
|
136
136
|
getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
|
|
137
137
|
|
|
138
138
|
/**
|
|
139
|
-
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call,
|
|
139
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, the summary that replaces the earliest messages once the conversation has been compacted, and the stored conversation of every subsession the assistant handed a task to. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
140
140
|
* Get a conversation\'s transcript
|
|
141
141
|
*/
|
|
142
142
|
getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
|
|
@@ -189,7 +189,7 @@ export interface AssistantApiInterface {
|
|
|
189
189
|
pollConversations(requestParameters: AssistantApiPollConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatPollBody>;
|
|
190
190
|
|
|
191
191
|
/**
|
|
192
|
-
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
|
|
192
|
+
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Stopping a conversation also stops a subsession it is running. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is stopped only by stopping the conversation that started it. Requires the *AI assistant* permission.
|
|
193
193
|
* @summary Stop the running turn
|
|
194
194
|
* @param {string} id UUID of the conversation whose turn to stop.
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
@@ -199,7 +199,7 @@ export interface AssistantApiInterface {
|
|
|
199
199
|
stopConversationsRaw(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
200
200
|
|
|
201
201
|
/**
|
|
202
|
-
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
|
|
202
|
+
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Stopping a conversation also stops a subsession it is running. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is stopped only by stopping the conversation that started it. Requires the *AI assistant* permission.
|
|
203
203
|
* Stop the running turn
|
|
204
204
|
*/
|
|
205
205
|
stopConversations(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -228,7 +228,7 @@ export interface AssistantApiInterface {
|
|
|
228
228
|
export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterface {
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
|
-
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Requires the *AI assistant* permission.
|
|
231
|
+
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Returns `409` if `conversationId` names a conversation that cannot take messages: a subsession the assistant started for a tool call, which only ever answers the task it was given, or a deleted conversation. Requires the *AI assistant* permission.
|
|
232
232
|
* Send a chat message
|
|
233
233
|
*/
|
|
234
234
|
async createChatRaw(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantChatRes>> {
|
|
@@ -261,7 +261,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
261
261
|
}
|
|
262
262
|
|
|
263
263
|
/**
|
|
264
|
-
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Requires the *AI assistant* permission.
|
|
264
|
+
* Submits a message to the assistant and dispatches it for asynchronous processing. Returns a `conversationId` and a `requestId` immediately; the reply arrives out-of-band, through `GET /v1/assistant/conversations/{id}/poll`. If `conversationId` is omitted a new conversation is started. `attachmentFileIds` attaches up to 10 distinct files from account file storage and requires View file storage permission. Files cannot be attached while the account has turned the assistant\'s tools off. Returns `409` if `conversationId` names a conversation that cannot take messages: a subsession the assistant started for a tool call, which only ever answers the task it was given, or a deleted conversation. Requires the *AI assistant* permission.
|
|
265
265
|
* Send a chat message
|
|
266
266
|
*/
|
|
267
267
|
async createChat(requestParameters: AssistantApiCreateChatRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatRes> {
|
|
@@ -270,7 +270,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
270
270
|
}
|
|
271
271
|
|
|
272
272
|
/**
|
|
273
|
-
* Permanently removes a conversation
|
|
273
|
+
* Permanently removes a conversation, all its messages, and every subsession it started. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is deleted only with the conversation that started it. Requires the *AI assistant* permission.
|
|
274
274
|
* Delete a conversation
|
|
275
275
|
*/
|
|
276
276
|
async deleteConversationsRaw(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -308,7 +308,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
308
308
|
}
|
|
309
309
|
|
|
310
310
|
/**
|
|
311
|
-
* Permanently removes a conversation
|
|
311
|
+
* Permanently removes a conversation, all its messages, and every subsession it started. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is deleted only with the conversation that started it. Requires the *AI assistant* permission.
|
|
312
312
|
* Delete a conversation
|
|
313
313
|
*/
|
|
314
314
|
async deleteConversations(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -355,7 +355,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
355
355
|
}
|
|
356
356
|
|
|
357
357
|
/**
|
|
358
|
-
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call,
|
|
358
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, the summary that replaces the earliest messages once the conversation has been compacted, and the stored conversation of every subsession the assistant handed a task to. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
359
359
|
* Get a conversation\'s transcript
|
|
360
360
|
*/
|
|
361
361
|
async getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>> {
|
|
@@ -393,7 +393,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
393
393
|
}
|
|
394
394
|
|
|
395
395
|
/**
|
|
396
|
-
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call,
|
|
396
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, the summary that replaces the earliest messages once the conversation has been compacted, and the stored conversation of every subsession the assistant handed a task to. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
397
397
|
* Get a conversation\'s transcript
|
|
398
398
|
*/
|
|
399
399
|
async getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody> {
|
|
@@ -531,7 +531,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
531
531
|
}
|
|
532
532
|
|
|
533
533
|
/**
|
|
534
|
-
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
|
|
534
|
+
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Stopping a conversation also stops a subsession it is running. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is stopped only by stopping the conversation that started it. Requires the *AI assistant* permission.
|
|
535
535
|
* Stop the running turn
|
|
536
536
|
*/
|
|
537
537
|
async stopConversationsRaw(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
@@ -569,7 +569,7 @@ export class AssistantApi extends runtime.BaseAPI implements AssistantApiInterfa
|
|
|
569
569
|
}
|
|
570
570
|
|
|
571
571
|
/**
|
|
572
|
-
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
|
|
572
|
+
* Asks the assistant to stop the turn it is working on. The turn ends at its next step - a tool call already sent finishes and is recorded - so the conversation stays usable and keeps everything the turn did before it was stopped. Succeeds with nothing to do if no turn is running. Stopping a conversation also stops a subsession it is running. Returns `404` if the conversation does not exist, and `409` if it is a subsession, which is stopped only by stopping the conversation that started it. Requires the *AI assistant* permission.
|
|
573
573
|
* Stop the running turn
|
|
574
574
|
*/
|
|
575
575
|
async stopConversations(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
@@ -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>;
|
|
@@ -167,7 +167,7 @@ export interface ScenariosApiInterface {
|
|
|
167
167
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
168
168
|
|
|
169
169
|
/**
|
|
170
|
-
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
|
|
170
|
+
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Returns `409` if the scenario keeps changing concurrently while the update is retried. Requires the *Edit scenario planning* permission.
|
|
171
171
|
* @summary Update a scenario
|
|
172
172
|
* @param {string} id
|
|
173
173
|
* @param {ScenarioPatch} [scenarioPatch]
|
|
@@ -178,7 +178,7 @@ export interface ScenariosApiInterface {
|
|
|
178
178
|
updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
179
179
|
|
|
180
180
|
/**
|
|
181
|
-
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
|
|
181
|
+
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Returns `409` if the scenario keeps changing concurrently while the update is retried. Requires the *Edit scenario planning* permission.
|
|
182
182
|
* Update a scenario
|
|
183
183
|
*/
|
|
184
184
|
update(requestParameters: ScenariosApiUpdateRequest, 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> {
|
|
@@ -468,7 +468,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
468
468
|
}
|
|
469
469
|
|
|
470
470
|
/**
|
|
471
|
-
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
|
|
471
|
+
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Returns `409` if the scenario keeps changing concurrently while the update is retried. Requires the *Edit scenario planning* permission.
|
|
472
472
|
* Update a scenario
|
|
473
473
|
*/
|
|
474
474
|
async updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
|
|
@@ -509,7 +509,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
|
|
|
509
509
|
}
|
|
510
510
|
|
|
511
511
|
/**
|
|
512
|
-
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Requires the *Edit scenario planning* permission.
|
|
512
|
+
* Updates the name, description, colour, and/or layers of the specified scenario. Only non-nil fields in the request body are applied. `hexCode` is a colour such as `#1f77b4` or `#abc`; an empty string clears it. A non-empty `layers` replaces the stored layers and `clearLayers` removes them all; sending both returns `400`. Returns `400` if the colour is not a valid hex code or a newly referenced layer points at an entity that does not exist. Returns `409` if the scenario keeps changing concurrently while the update is retried. Requires the *Edit scenario planning* permission.
|
|
513
513
|
* Update a scenario
|
|
514
514
|
*/
|
|
515
515
|
async update(requestParameters: ScenariosApiUpdateRequest, 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> {
|
|
@@ -71,6 +71,18 @@ export interface AssistantChatPollBody {
|
|
|
71
71
|
* @memberof AssistantChatPollBody
|
|
72
72
|
*/
|
|
73
73
|
status: string;
|
|
74
|
+
/**
|
|
75
|
+
* While a subsession is running, how many messages it has recorded so far, which grows with each of its steps even when it calls the same tool again. Zero when no subsession is running, including once it has ended and before the turn has recorded its result.
|
|
76
|
+
* @type {number}
|
|
77
|
+
* @memberof AssistantChatPollBody
|
|
78
|
+
*/
|
|
79
|
+
subsessionSteps: number;
|
|
80
|
+
/**
|
|
81
|
+
* While a subsession is running, the tool it is running now. Empty while it is thinking, and when no subsession is running. The running subsession is the run_subsession action whose toolCallId is not yet among the finished tool calls.
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof AssistantChatPollBody
|
|
84
|
+
*/
|
|
85
|
+
subsessionTool: string;
|
|
74
86
|
}
|
|
75
87
|
|
|
76
88
|
/**
|
|
@@ -81,6 +93,8 @@ export function instanceOfAssistantChatPollBody(value: object): value is Assista
|
|
|
81
93
|
if (!('finishedToolCallIds' in value) || value['finishedToolCallIds'] === undefined) return false;
|
|
82
94
|
if (!('messages' in value) || value['messages'] === undefined) return false;
|
|
83
95
|
if (!('status' in value) || value['status'] === undefined) return false;
|
|
96
|
+
if (!('subsessionSteps' in value) || value['subsessionSteps'] === undefined) return false;
|
|
97
|
+
if (!('subsessionTool' in value) || value['subsessionTool'] === undefined) return false;
|
|
84
98
|
return true;
|
|
85
99
|
}
|
|
86
100
|
|
|
@@ -99,6 +113,8 @@ export function AssistantChatPollBodyFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
99
113
|
'finishedToolCallIds': json['finishedToolCallIds'],
|
|
100
114
|
'messages': ((json['messages'] as Array<any>).map(AssistantChatPollMessageFromJSON)),
|
|
101
115
|
'status': json['status'],
|
|
116
|
+
'subsessionSteps': json['subsessionSteps'],
|
|
117
|
+
'subsessionTool': json['subsessionTool'],
|
|
102
118
|
};
|
|
103
119
|
}
|
|
104
120
|
|
|
@@ -118,6 +134,8 @@ export function AssistantChatPollBodyToJSONTyped(value?: AssistantChatPollBody |
|
|
|
118
134
|
'finishedToolCallIds': value['finishedToolCallIds'],
|
|
119
135
|
'messages': ((value['messages'] as Array<any>).map(AssistantChatPollMessageToJSON)),
|
|
120
136
|
'status': value['status'],
|
|
137
|
+
'subsessionSteps': value['subsessionSteps'],
|
|
138
|
+
'subsessionTool': value['subsessionTool'],
|
|
121
139
|
};
|
|
122
140
|
}
|
|
123
141
|
|
|
@@ -69,6 +69,12 @@ export interface AssistantChatPollMessage {
|
|
|
69
69
|
* @memberof AssistantChatPollMessage
|
|
70
70
|
*/
|
|
71
71
|
role: string;
|
|
72
|
+
/**
|
|
73
|
+
* Id of the conversation a run_subsession action message (kind 2) started, which is polled like any other conversation to follow the subsession's own steps. It is not found until the subsession has started. Empty on every other message.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof AssistantChatPollMessage
|
|
76
|
+
*/
|
|
77
|
+
subsessionId: string;
|
|
72
78
|
/**
|
|
73
79
|
*
|
|
74
80
|
* @type {string}
|
|
@@ -94,6 +100,7 @@ export function instanceOfAssistantChatPollMessage(value: object): value is Assi
|
|
|
94
100
|
if (!('payload' in value) || value['payload'] === undefined) return false;
|
|
95
101
|
if (!('requestId' in value) || value['requestId'] === undefined) return false;
|
|
96
102
|
if (!('role' in value) || value['role'] === undefined) return false;
|
|
103
|
+
if (!('subsessionId' in value) || value['subsessionId'] === undefined) return false;
|
|
97
104
|
if (!('text' in value) || value['text'] === undefined) return false;
|
|
98
105
|
if (!('toolCallId' in value) || value['toolCallId'] === undefined) return false;
|
|
99
106
|
return true;
|
|
@@ -116,6 +123,7 @@ export function AssistantChatPollMessageFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
116
123
|
'payload': json['payload'],
|
|
117
124
|
'requestId': json['requestId'],
|
|
118
125
|
'role': json['role'],
|
|
126
|
+
'subsessionId': json['subsessionId'],
|
|
119
127
|
'text': json['text'],
|
|
120
128
|
'toolCallId': json['toolCallId'],
|
|
121
129
|
};
|
|
@@ -139,6 +147,7 @@ export function AssistantChatPollMessageToJSONTyped(value?: AssistantChatPollMes
|
|
|
139
147
|
'payload': value['payload'],
|
|
140
148
|
'requestId': value['requestId'],
|
|
141
149
|
'role': value['role'],
|
|
150
|
+
'subsessionId': value['subsessionId'],
|
|
142
151
|
'text': value['text'],
|
|
143
152
|
'toolCallId': value['toolCallId'],
|
|
144
153
|
};
|