@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
|
@@ -53,7 +53,7 @@ export interface ScenariosApiInterface {
|
|
|
53
53
|
*/
|
|
54
54
|
create(requestParameters: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
55
55
|
/**
|
|
56
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
56
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
57
57
|
* @summary Delete or archive a scenario
|
|
58
58
|
* @param {string} id
|
|
59
59
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle action: \"archive\" moves the scenario to the archive, \"restore\" returns it to active, and \"purge\" permanently deletes it. Defaults to \"purge\" when omitted.
|
|
@@ -63,7 +63,7 @@ export interface ScenariosApiInterface {
|
|
|
63
63
|
*/
|
|
64
64
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
65
65
|
/**
|
|
66
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
66
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
67
67
|
* Delete or archive a scenario
|
|
68
68
|
*/
|
|
69
69
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -123,7 +123,7 @@ export interface ScenariosApiInterface {
|
|
|
123
123
|
*/
|
|
124
124
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
125
125
|
/**
|
|
126
|
-
* 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.
|
|
126
|
+
* 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.
|
|
127
127
|
* @summary Update a scenario
|
|
128
128
|
* @param {string} id
|
|
129
129
|
* @param {ScenarioPatch} [scenarioPatch]
|
|
@@ -133,7 +133,7 @@ export interface ScenariosApiInterface {
|
|
|
133
133
|
*/
|
|
134
134
|
updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
135
135
|
/**
|
|
136
|
-
* 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.
|
|
136
|
+
* 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.
|
|
137
137
|
* Update a scenario
|
|
138
138
|
*/
|
|
139
139
|
update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -153,12 +153,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
153
153
|
*/
|
|
154
154
|
create(requestParameters?: ScenariosApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
155
155
|
/**
|
|
156
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
156
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
157
157
|
* Delete or archive a scenario
|
|
158
158
|
*/
|
|
159
159
|
deleteRaw(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
160
160
|
/**
|
|
161
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
161
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
162
162
|
* Delete or archive a scenario
|
|
163
163
|
*/
|
|
164
164
|
delete(requestParameters: ScenariosApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -203,12 +203,12 @@ export declare class ScenariosApi extends runtime.BaseAPI implements ScenariosAp
|
|
|
203
203
|
*/
|
|
204
204
|
listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
|
|
205
205
|
/**
|
|
206
|
-
* 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.
|
|
206
|
+
* 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.
|
|
207
207
|
* Update a scenario
|
|
208
208
|
*/
|
|
209
209
|
updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
210
210
|
/**
|
|
211
|
-
* 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.
|
|
211
|
+
* 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.
|
|
212
212
|
* Update a scenario
|
|
213
213
|
*/
|
|
214
214
|
update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -72,7 +72,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
75
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
76
76
|
* Delete or archive a scenario
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -104,7 +104,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Requires the *Edit scenario planning* permission.
|
|
107
|
+
* Controls the lifecycle of a scenario. Pass `action=archive` to move it to the archive, `action=restore` to bring it back, or `action=purge` (the default when the parameter is omitted) to permanently delete the scenario. Purging removes the scenario from every variable\'s allowed `options`; a variable whose value was the scenario moves to its first remaining option. Requires the *Edit scenario planning* permission.
|
|
108
108
|
* Delete or archive a scenario
|
|
109
109
|
*/
|
|
110
110
|
delete(requestParameters, initOverrides) {
|
|
@@ -270,7 +270,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
270
270
|
});
|
|
271
271
|
}
|
|
272
272
|
/**
|
|
273
|
-
* 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.
|
|
273
|
+
* 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.
|
|
274
274
|
* Update a scenario
|
|
275
275
|
*/
|
|
276
276
|
updateRaw(requestParameters, initOverrides) {
|
|
@@ -301,7 +301,7 @@ class ScenariosApi extends runtime.BaseAPI {
|
|
|
301
301
|
});
|
|
302
302
|
}
|
|
303
303
|
/**
|
|
304
|
-
* 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.
|
|
304
|
+
* 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.
|
|
305
305
|
* Update a scenario
|
|
306
306
|
*/
|
|
307
307
|
update(requestParameters, initOverrides) {
|
|
@@ -74,7 +74,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
74
74
|
*/
|
|
75
75
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
76
76
|
/**
|
|
77
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
77
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
78
78
|
* @summary Delete a space ruleset
|
|
79
79
|
* @param {string} id
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
@@ -83,7 +83,7 @@ export interface SpaceRulesetsApiInterface {
|
|
|
83
83
|
*/
|
|
84
84
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
85
85
|
/**
|
|
86
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
86
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
87
87
|
* Delete a space ruleset
|
|
88
88
|
*/
|
|
89
89
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -197,12 +197,12 @@ export declare class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRu
|
|
|
197
197
|
*/
|
|
198
198
|
createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
199
199
|
/**
|
|
200
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
200
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
201
201
|
* Delete a space ruleset
|
|
202
202
|
*/
|
|
203
203
|
deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
204
204
|
/**
|
|
205
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
205
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
206
206
|
* Delete a space ruleset
|
|
207
207
|
*/
|
|
208
208
|
delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -131,7 +131,7 @@ class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
134
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
135
135
|
* Delete a space ruleset
|
|
136
136
|
*/
|
|
137
137
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -160,7 +160,7 @@ class SpaceRulesetsApi extends runtime.BaseAPI {
|
|
|
160
160
|
});
|
|
161
161
|
}
|
|
162
162
|
/**
|
|
163
|
-
* Permanently deletes a space ruleset from the current account. Requires the *Edit space rule set details* permission.
|
|
163
|
+
* Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
|
|
164
164
|
* Delete a space ruleset
|
|
165
165
|
*/
|
|
166
166
|
delete(requestParameters, initOverrides) {
|
|
@@ -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
|
|
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
|
|
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,
|
|
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,
|
|
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
|
|
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
|
|
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,
|
|
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,
|
|
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>;
|
|
@@ -27,7 +27,7 @@ import { AssistantChatPollBodyFromJSON, AssistantChatReqToJSON, AssistantChatRes
|
|
|
27
27
|
*/
|
|
28
28
|
export class AssistantApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* 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.
|
|
30
|
+
* 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.
|
|
31
31
|
* Send a chat message
|
|
32
32
|
*/
|
|
33
33
|
createChatRaw(requestParameters, initOverrides) {
|
|
@@ -54,7 +54,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
54
54
|
});
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* 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.
|
|
57
|
+
* 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.
|
|
58
58
|
* Send a chat message
|
|
59
59
|
*/
|
|
60
60
|
createChat() {
|
|
@@ -64,7 +64,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
64
64
|
});
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
* Permanently removes a conversation
|
|
67
|
+
* 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.
|
|
68
68
|
* Delete a conversation
|
|
69
69
|
*/
|
|
70
70
|
deleteConversationsRaw(requestParameters, initOverrides) {
|
|
@@ -93,7 +93,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
93
93
|
});
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
|
-
* Permanently removes a conversation
|
|
96
|
+
* 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.
|
|
97
97
|
* Delete a conversation
|
|
98
98
|
*/
|
|
99
99
|
deleteConversations(requestParameters, initOverrides) {
|
|
@@ -137,7 +137,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* 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,
|
|
140
|
+
* 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.
|
|
141
141
|
* Get a conversation\'s transcript
|
|
142
142
|
*/
|
|
143
143
|
getConversationsTranscriptRaw(requestParameters, initOverrides) {
|
|
@@ -166,7 +166,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
166
166
|
});
|
|
167
167
|
}
|
|
168
168
|
/**
|
|
169
|
-
* 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,
|
|
169
|
+
* 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.
|
|
170
170
|
* Get a conversation\'s transcript
|
|
171
171
|
*/
|
|
172
172
|
getConversationsTranscript(requestParameters, initOverrides) {
|
|
@@ -288,7 +288,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
288
288
|
});
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
291
|
-
* 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.
|
|
291
|
+
* 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.
|
|
292
292
|
* Stop the running turn
|
|
293
293
|
*/
|
|
294
294
|
stopConversationsRaw(requestParameters, initOverrides) {
|
|
@@ -317,7 +317,7 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
317
317
|
});
|
|
318
318
|
}
|
|
319
319
|
/**
|
|
320
|
-
* 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.
|
|
320
|
+
* 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.
|
|
321
321
|
* Stop the running turn
|
|
322
322
|
*/
|
|
323
323
|
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>;
|
|
@@ -72,7 +72,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
75
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
76
76
|
* Delete a floor plan
|
|
77
77
|
*/
|
|
78
78
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export class FloorPlansApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the floor plan and all of its associated space geometry. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
104
|
+
* Permanently deletes the floor plan and all of its associated space geometry. The floor plan is removed from every variable\'s allowed `options`, and a variable whose value was the floor plan moves to its first remaining option. The uploaded images are not removed by this operation. Requires the *Edit floorplans* permission.
|
|
105
105
|
* Delete a floor plan
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
101
101
|
*/
|
|
102
102
|
create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
104
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
105
105
|
* @summary Delete or archive an object group
|
|
106
106
|
* @param {string} id
|
|
107
107
|
* @param {'archive' | 'restore' | 'purge'} [action] Lifecycle transition to apply: \"archive\" moves the group to the archive, \"restore\" returns it to active, omitting the parameter (or \"purge\") permanently deletes the group and all its entries.
|
|
@@ -111,12 +111,12 @@ export interface ObjectGroupsApiInterface {
|
|
|
111
111
|
*/
|
|
112
112
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
113
113
|
/**
|
|
114
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
114
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
115
115
|
* Delete or archive an object group
|
|
116
116
|
*/
|
|
117
117
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
118
118
|
/**
|
|
119
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
119
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
120
120
|
* @summary Delete entries from an object group
|
|
121
121
|
* @param {string} id
|
|
122
122
|
* @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
|
|
@@ -126,7 +126,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
126
126
|
*/
|
|
127
127
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
128
128
|
/**
|
|
129
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
129
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
130
130
|
* Delete entries from an object group
|
|
131
131
|
*/
|
|
132
132
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -346,22 +346,22 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
346
346
|
*/
|
|
347
347
|
create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
348
348
|
/**
|
|
349
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
349
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
350
350
|
* Delete or archive an object group
|
|
351
351
|
*/
|
|
352
352
|
deleteRaw(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
353
353
|
/**
|
|
354
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
354
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
355
355
|
* Delete or archive an object group
|
|
356
356
|
*/
|
|
357
357
|
delete(requestParameters: ObjectGroupsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
358
358
|
/**
|
|
359
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
359
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
360
360
|
* Delete entries from an object group
|
|
361
361
|
*/
|
|
362
362
|
deleteEntriesRaw(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
363
363
|
/**
|
|
364
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
364
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
365
365
|
* Delete entries from an object group
|
|
366
366
|
*/
|
|
367
367
|
deleteEntries(requestParameters: ObjectGroupsApiDeleteEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -69,7 +69,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
69
69
|
});
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
72
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
73
73
|
* Delete or archive an object group
|
|
74
74
|
*/
|
|
75
75
|
deleteRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +101,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. Requires the *Edit objects* permission.
|
|
104
|
+
* Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
|
|
105
105
|
* Delete or archive an object group
|
|
106
106
|
*/
|
|
107
107
|
delete(requestParameters, initOverrides) {
|
|
@@ -111,7 +111,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
111
111
|
});
|
|
112
112
|
}
|
|
113
113
|
/**
|
|
114
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
114
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
115
115
|
* Delete entries from an object group
|
|
116
116
|
*/
|
|
117
117
|
deleteEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -145,7 +145,7 @@ export class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
145
145
|
});
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
148
|
+
* Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone. Deleted entries are removed from every object variable\'s allowed `options`; a variable whose value included them keeps its other allowed objects, or moves to its first remaining option. Once no option is left, every object is allowed again and the value is left as it was. Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
|
|
149
149
|
* Delete entries from an object group
|
|
150
150
|
*/
|
|
151
151
|
deleteEntries(requestParameters, initOverrides) {
|