@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.
Files changed (47) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/AssistantApi.d.ts +16 -16
  3. package/dist/apis/AssistantApi.js +8 -8
  4. package/dist/apis/FloorPlansApi.d.ts +4 -4
  5. package/dist/apis/FloorPlansApi.js +2 -2
  6. package/dist/apis/ObjectGroupsApi.d.ts +8 -8
  7. package/dist/apis/ObjectGroupsApi.js +4 -4
  8. package/dist/apis/PropertiesApi.d.ts +8 -8
  9. package/dist/apis/PropertiesApi.js +4 -4
  10. package/dist/apis/ScenariosApi.d.ts +8 -8
  11. package/dist/apis/ScenariosApi.js +4 -4
  12. package/dist/apis/SpaceRulesetsApi.d.ts +4 -4
  13. package/dist/apis/SpaceRulesetsApi.js +2 -2
  14. package/dist/esm/apis/AssistantApi.d.ts +16 -16
  15. package/dist/esm/apis/AssistantApi.js +8 -8
  16. package/dist/esm/apis/FloorPlansApi.d.ts +4 -4
  17. package/dist/esm/apis/FloorPlansApi.js +2 -2
  18. package/dist/esm/apis/ObjectGroupsApi.d.ts +8 -8
  19. package/dist/esm/apis/ObjectGroupsApi.js +4 -4
  20. package/dist/esm/apis/PropertiesApi.d.ts +8 -8
  21. package/dist/esm/apis/PropertiesApi.js +4 -4
  22. package/dist/esm/apis/ScenariosApi.d.ts +8 -8
  23. package/dist/esm/apis/ScenariosApi.js +4 -4
  24. package/dist/esm/apis/SpaceRulesetsApi.d.ts +4 -4
  25. package/dist/esm/apis/SpaceRulesetsApi.js +2 -2
  26. package/dist/esm/models/AssistantChatPollBody.d.ts +12 -0
  27. package/dist/esm/models/AssistantChatPollBody.js +8 -0
  28. package/dist/esm/models/AssistantChatPollMessage.d.ts +6 -0
  29. package/dist/esm/models/AssistantChatPollMessage.js +4 -0
  30. package/dist/esm/models/AssistantTranscriptBody.d.ts +18 -0
  31. package/dist/esm/models/AssistantTranscriptBody.js +12 -0
  32. package/dist/models/AssistantChatPollBody.d.ts +12 -0
  33. package/dist/models/AssistantChatPollBody.js +8 -0
  34. package/dist/models/AssistantChatPollMessage.d.ts +6 -0
  35. package/dist/models/AssistantChatPollMessage.js +4 -0
  36. package/dist/models/AssistantTranscriptBody.d.ts +18 -0
  37. package/dist/models/AssistantTranscriptBody.js +12 -0
  38. package/package.json +1 -1
  39. package/src/apis/AssistantApi.ts +16 -16
  40. package/src/apis/FloorPlansApi.ts +4 -4
  41. package/src/apis/ObjectGroupsApi.ts +8 -8
  42. package/src/apis/PropertiesApi.ts +8 -8
  43. package/src/apis/ScenariosApi.ts +8 -8
  44. package/src/apis/SpaceRulesetsApi.ts +4 -4
  45. package/src/models/AssistantChatPollBody.ts +18 -0
  46. package/src/models/AssistantChatPollMessage.ts +9 -0
  47. package/src/models/AssistantTranscriptBody.ts +27 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @spaciv/sdk@0.1.17
1
+ ## @spaciv/sdk@0.1.19
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @spaciv/sdk@0.1.17 --save
39
+ npm install @spaciv/sdk@0.1.19 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -38,7 +38,7 @@ export interface AssistantApiUpdateConfigRequest {
38
38
  */
39
39
  export interface AssistantApiInterface {
40
40
  /**
41
- * 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.
41
+ * 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.
42
42
  * @summary Send a chat message
43
43
  * @param {AssistantChatReq} [assistantChatReq]
44
44
  * @param {*} [options] Override http request option.
@@ -47,12 +47,12 @@ export interface AssistantApiInterface {
47
47
  */
48
48
  createChatRaw(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantChatRes>>;
49
49
  /**
50
- * 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.
50
+ * 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.
51
51
  * Send a chat message
52
52
  */
53
53
  createChat(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatRes>;
54
54
  /**
55
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
55
+ * 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.
56
56
  * @summary Delete a conversation
57
57
  * @param {string} id UUID of the conversation to delete.
58
58
  * @param {*} [options] Override http request option.
@@ -61,7 +61,7 @@ export interface AssistantApiInterface {
61
61
  */
62
62
  deleteConversationsRaw(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
63
63
  /**
64
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
64
+ * 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.
65
65
  * Delete a conversation
66
66
  */
67
67
  deleteConversations(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -79,7 +79,7 @@ export interface AssistantApiInterface {
79
79
  */
80
80
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
81
81
  /**
82
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
82
+ * 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.
83
83
  * @summary Get a conversation\'s transcript
84
84
  * @param {string} id UUID of the conversation to read.
85
85
  * @param {*} [options] Override http request option.
@@ -88,7 +88,7 @@ export interface AssistantApiInterface {
88
88
  */
89
89
  getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
90
90
  /**
91
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
91
+ * 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.
92
92
  * Get a conversation\'s transcript
93
93
  */
94
94
  getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
@@ -134,7 +134,7 @@ export interface AssistantApiInterface {
134
134
  */
135
135
  pollConversations(requestParameters: AssistantApiPollConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatPollBody>;
136
136
  /**
137
- * 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.
137
+ * 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.
138
138
  * @summary Stop the running turn
139
139
  * @param {string} id UUID of the conversation whose turn to stop.
140
140
  * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export interface AssistantApiInterface {
143
143
  */
144
144
  stopConversationsRaw(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
145
145
  /**
146
- * 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.
146
+ * 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.
147
147
  * Stop the running turn
148
148
  */
149
149
  stopConversations(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -167,22 +167,22 @@ export interface AssistantApiInterface {
167
167
  */
168
168
  export declare class AssistantApi extends runtime.BaseAPI implements AssistantApiInterface {
169
169
  /**
170
- * 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.
170
+ * 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.
171
171
  * Send a chat message
172
172
  */
173
173
  createChatRaw(requestParameters: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantChatRes>>;
174
174
  /**
175
- * 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.
175
+ * 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.
176
176
  * Send a chat message
177
177
  */
178
178
  createChat(requestParameters?: AssistantApiCreateChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatRes>;
179
179
  /**
180
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
180
+ * 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.
181
181
  * Delete a conversation
182
182
  */
183
183
  deleteConversationsRaw(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
184
184
  /**
185
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
185
+ * 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.
186
186
  * Delete a conversation
187
187
  */
188
188
  deleteConversations(requestParameters: AssistantApiDeleteConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -197,12 +197,12 @@ export declare class AssistantApi extends runtime.BaseAPI implements AssistantAp
197
197
  */
198
198
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
199
199
  /**
200
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
200
+ * 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.
201
201
  * Get a conversation\'s transcript
202
202
  */
203
203
  getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
204
204
  /**
205
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
205
+ * 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.
206
206
  * Get a conversation\'s transcript
207
207
  */
208
208
  getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
@@ -237,12 +237,12 @@ export declare class AssistantApi extends runtime.BaseAPI implements AssistantAp
237
237
  */
238
238
  pollConversations(requestParameters: AssistantApiPollConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantChatPollBody>;
239
239
  /**
240
- * 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.
240
+ * 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.
241
241
  * Stop the running turn
242
242
  */
243
243
  stopConversationsRaw(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
244
244
  /**
245
- * 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.
245
+ * 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.
246
246
  * Stop the running turn
247
247
  */
248
248
  stopConversations(requestParameters: AssistantApiStopConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class AssistantApi extends runtime.BaseAPI {
32
32
  /**
33
- * 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.
33
+ * 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.
34
34
  * Send a chat message
35
35
  */
36
36
  createChatRaw(requestParameters, initOverrides) {
@@ -57,7 +57,7 @@ class AssistantApi extends runtime.BaseAPI {
57
57
  });
58
58
  }
59
59
  /**
60
- * 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.
60
+ * 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.
61
61
  * Send a chat message
62
62
  */
63
63
  createChat() {
@@ -67,7 +67,7 @@ class AssistantApi extends runtime.BaseAPI {
67
67
  });
68
68
  }
69
69
  /**
70
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
70
+ * 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.
71
71
  * Delete a conversation
72
72
  */
73
73
  deleteConversationsRaw(requestParameters, initOverrides) {
@@ -96,7 +96,7 @@ class AssistantApi extends runtime.BaseAPI {
96
96
  });
97
97
  }
98
98
  /**
99
- * Permanently removes a conversation and all its messages. Returns `404` if the conversation does not exist. Requires the *AI assistant* permission.
99
+ * 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.
100
100
  * Delete a conversation
101
101
  */
102
102
  deleteConversations(requestParameters, initOverrides) {
@@ -140,7 +140,7 @@ class AssistantApi extends runtime.BaseAPI {
140
140
  });
141
141
  }
142
142
  /**
143
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
143
+ * 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.
144
144
  * Get a conversation\'s transcript
145
145
  */
146
146
  getConversationsTranscriptRaw(requestParameters, initOverrides) {
@@ -169,7 +169,7 @@ class AssistantApi extends runtime.BaseAPI {
169
169
  });
170
170
  }
171
171
  /**
172
- * 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, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
172
+ * 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.
173
173
  * Get a conversation\'s transcript
174
174
  */
175
175
  getConversationsTranscript(requestParameters, initOverrides) {
@@ -291,7 +291,7 @@ class AssistantApi extends runtime.BaseAPI {
291
291
  });
292
292
  }
293
293
  /**
294
- * 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.
294
+ * 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.
295
295
  * Stop the running turn
296
296
  */
297
297
  stopConversationsRaw(requestParameters, initOverrides) {
@@ -320,7 +320,7 @@ class AssistantApi extends runtime.BaseAPI {
320
320
  });
321
321
  }
322
322
  /**
323
- * 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.
323
+ * 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.
324
324
  * Stop the running turn
325
325
  */
326
326
  stopConversations(requestParameters, initOverrides) {
@@ -57,7 +57,7 @@ export interface FloorPlansApiInterface {
57
57
  */
58
58
  create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
59
59
  /**
60
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
60
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
61
61
  * @summary Delete a floor plan
62
62
  * @param {string} id
63
63
  * @param {*} [options] Override http request option.
@@ -66,7 +66,7 @@ export interface FloorPlansApiInterface {
66
66
  */
67
67
  deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
68
68
  /**
69
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
69
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
70
70
  * Delete a floor plan
71
71
  */
72
72
  delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -161,12 +161,12 @@ export declare class FloorPlansApi extends runtime.BaseAPI implements FloorPlans
161
161
  */
162
162
  create(requestParameters: FloorPlansApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
163
163
  /**
164
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
164
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
165
165
  * Delete a floor plan
166
166
  */
167
167
  deleteRaw(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
168
168
  /**
169
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
169
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
170
170
  * Delete a floor plan
171
171
  */
172
172
  delete(requestParameters: FloorPlansApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -75,7 +75,7 @@ class FloorPlansApi extends runtime.BaseAPI {
75
75
  });
76
76
  }
77
77
  /**
78
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
78
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
79
79
  * Delete a floor plan
80
80
  */
81
81
  deleteRaw(requestParameters, initOverrides) {
@@ -104,7 +104,7 @@ class FloorPlansApi extends runtime.BaseAPI {
104
104
  });
105
105
  }
106
106
  /**
107
- * Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
107
+ * Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
108
108
  * Delete a floor plan
109
109
  */
110
110
  delete(requestParameters, initOverrides) {
@@ -101,7 +101,7 @@ export interface ObjectGroupsApiInterface {
101
101
  */
102
102
  create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
103
103
  /**
104
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
104
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
105
105
  * @summary Delete or archive an object group
106
106
  * @param {string} id
107
107
  * @param {'archive' | 'restore' | 'purge'} [action] Lifecycle transition to apply: \&quot;archive\&quot; moves the group to the archive, \&quot;restore\&quot; returns it to active, omitting the parameter (or \&quot;purge\&quot;) permanently deletes the group and all its entries.
@@ -111,12 +111,12 @@ export interface ObjectGroupsApiInterface {
111
111
  */
112
112
  deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
113
113
  /**
114
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
114
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
115
115
  * Delete or archive an object group
116
116
  */
117
117
  delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
118
118
  /**
119
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
119
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
120
120
  * @summary Delete entries from an object group
121
121
  * @param {string} id
122
122
  * @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
@@ -126,7 +126,7 @@ export interface ObjectGroupsApiInterface {
126
126
  */
127
127
  deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
128
128
  /**
129
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
129
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
130
130
  * Delete entries from an object group
131
131
  */
132
132
  deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -346,22 +346,22 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
346
346
  */
347
347
  create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
348
348
  /**
349
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
349
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
350
350
  * Delete or archive an object group
351
351
  */
352
352
  deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
353
353
  /**
354
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
354
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
355
355
  * Delete or archive an object group
356
356
  */
357
357
  delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
358
358
  /**
359
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
359
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
360
360
  * Delete entries from an object group
361
361
  */
362
362
  deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
363
363
  /**
364
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
364
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
365
365
  * Delete entries from an object group
366
366
  */
367
367
  deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -72,7 +72,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
72
72
  });
73
73
  }
74
74
  /**
75
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
75
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
76
76
  * Delete or archive an object group
77
77
  */
78
78
  deleteRaw(requestParameters, initOverrides) {
@@ -104,7 +104,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
104
104
  });
105
105
  }
106
106
  /**
107
- * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
107
+ * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
108
108
  * Delete or archive an object group
109
109
  */
110
110
  delete(requestParameters, initOverrides) {
@@ -114,7 +114,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
114
114
  });
115
115
  }
116
116
  /**
117
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
117
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
118
118
  * Delete entries from an object group
119
119
  */
120
120
  deleteEntriesRaw(requestParameters, initOverrides) {
@@ -148,7 +148,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
148
148
  });
149
149
  }
150
150
  /**
151
- * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
151
+ * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
152
152
  * Delete entries from an object group
153
153
  */
154
154
  deleteEntries(requestParameters, initOverrides) {
@@ -53,7 +53,7 @@ export interface PropertiesApiInterface {
53
53
  */
54
54
  create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
55
55
  /**
56
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
56
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
57
57
  * @summary Delete a property
58
58
  * @param {string} id
59
59
  * @param {*} [options] Override http request option.
@@ -62,7 +62,7 @@ export interface PropertiesApiInterface {
62
62
  */
63
63
  deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
64
64
  /**
65
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
65
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
66
66
  * Delete a property
67
67
  */
68
68
  delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -110,7 +110,7 @@ export interface PropertiesApiInterface {
110
110
  */
111
111
  list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
112
112
  /**
113
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
113
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
114
114
  * @summary Update a property
115
115
  * @param {string} id
116
116
  * @param {PropertyBody} [propertyBody]
@@ -120,7 +120,7 @@ export interface PropertiesApiInterface {
120
120
  */
121
121
  updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
122
122
  /**
123
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
123
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
124
124
  * Update a property
125
125
  */
126
126
  update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -140,12 +140,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
140
140
  */
141
141
  create(requestParameters?: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
142
142
  /**
143
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
143
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
144
144
  * Delete a property
145
145
  */
146
146
  deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
147
147
  /**
148
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
148
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
149
149
  * Delete a property
150
150
  */
151
151
  delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -180,12 +180,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
180
180
  */
181
181
  list(requestParameters?: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
182
182
  /**
183
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
183
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
184
184
  * Update a property
185
185
  */
186
186
  updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
187
187
  /**
188
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
188
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
189
189
  * Update a property
190
190
  */
191
191
  update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -72,7 +72,7 @@ class PropertiesApi extends runtime.BaseAPI {
72
72
  });
73
73
  }
74
74
  /**
75
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
75
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
76
76
  * Delete a property
77
77
  */
78
78
  deleteRaw(requestParameters, initOverrides) {
@@ -101,7 +101,7 @@ class PropertiesApi extends runtime.BaseAPI {
101
101
  });
102
102
  }
103
103
  /**
104
- * Permanently removes the specified property and all its nodes. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
104
+ * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
105
105
  * Delete a property
106
106
  */
107
107
  delete(requestParameters, initOverrides) {
@@ -234,7 +234,7 @@ class PropertiesApi extends runtime.BaseAPI {
234
234
  });
235
235
  }
236
236
  /**
237
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
237
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
238
238
  * Update a property
239
239
  */
240
240
  updateRaw(requestParameters, initOverrides) {
@@ -265,7 +265,7 @@ class PropertiesApi extends runtime.BaseAPI {
265
265
  });
266
266
  }
267
267
  /**
268
- * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
268
+ * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout. Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data. New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`. Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
269
269
  * Update a property
270
270
  */
271
271
  update(requestParameters, initOverrides) {