@spaciv/sdk 0.1.16 → 0.1.18

package/src/apis/ScenariosApi.ts

@@ -167,7 +167,7 @@ export interface ScenariosApiInterface {
     listLayerVariables(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LayerVariablesRes>;
 
     /**
-     * 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.
+     * 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.
      * @summary Update a scenario
      * @param {string} id 
      * @param {ScenarioPatch} [scenarioPatch] 
@@ -178,7 +178,7 @@ export interface ScenariosApiInterface {
     updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * 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.
+     * 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.
      * Update a scenario
      */
     update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -468,7 +468,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
     }
 
     /**
-     * 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.
+     * 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.
      * Update a scenario
      */
     async updateRaw(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -509,7 +509,7 @@ export class ScenariosApi extends runtime.BaseAPI implements ScenariosApiInterfa
     }
 
     /**
-     * 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.
+     * 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.
      * Update a scenario
      */
     async update(requestParameters: ScenariosApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {

package/src/models/AssistantChatPollBody.ts

@@ -71,6 +71,18 @@ export interface AssistantChatPollBody {
      * @memberof AssistantChatPollBody
      */
     status: string;
+    /**
+     * While a subsession is running, how many messages it has recorded so far, which grows with each of its steps even when it calls the same tool again. Zero when no subsession is running, including once it has ended and before the turn has recorded its result.
+     * @type {number}
+     * @memberof AssistantChatPollBody
+     */
+    subsessionSteps: number;
+    /**
+     * While a subsession is running, the tool it is running now. Empty while it is thinking, and when no subsession is running. The running subsession is the run_subsession action whose toolCallId is not yet among the finished tool calls.
+     * @type {string}
+     * @memberof AssistantChatPollBody
+     */
+    subsessionTool: string;
 }
 
 /**
@@ -81,6 +93,8 @@ export function instanceOfAssistantChatPollBody(value: object): value is Assista
     if (!('finishedToolCallIds' in value) || value['finishedToolCallIds'] === undefined) return false;
     if (!('messages' in value) || value['messages'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('subsessionSteps' in value) || value['subsessionSteps'] === undefined) return false;
+    if (!('subsessionTool' in value) || value['subsessionTool'] === undefined) return false;
     return true;
 }
 
@@ -99,6 +113,8 @@ export function AssistantChatPollBodyFromJSONTyped(json: any, ignoreDiscriminato
         'finishedToolCallIds': json['finishedToolCallIds'],
         'messages': ((json['messages'] as Array<any>).map(AssistantChatPollMessageFromJSON)),
         'status': json['status'],
+        'subsessionSteps': json['subsessionSteps'],
+        'subsessionTool': json['subsessionTool'],
     };
 }
 
@@ -118,6 +134,8 @@ export function AssistantChatPollBodyToJSONTyped(value?: AssistantChatPollBody |
         'finishedToolCallIds': value['finishedToolCallIds'],
         'messages': ((value['messages'] as Array<any>).map(AssistantChatPollMessageToJSON)),
         'status': value['status'],
+        'subsessionSteps': value['subsessionSteps'],
+        'subsessionTool': value['subsessionTool'],
     };
 }
 

package/src/models/AssistantChatPollMessage.ts

@@ -69,6 +69,12 @@ export interface AssistantChatPollMessage {
      * @memberof AssistantChatPollMessage
      */
     role: string;
+    /**
+     * Id of the conversation a run_subsession action message (kind 2) started, which is polled like any other conversation to follow the subsession's own steps. It is not found until the subsession has started. Empty on every other message.
+     * @type {string}
+     * @memberof AssistantChatPollMessage
+     */
+    subsessionId: string;
     /**
      * 
      * @type {string}
@@ -94,6 +100,7 @@ export function instanceOfAssistantChatPollMessage(value: object): value is Assi
     if (!('payload' in value) || value['payload'] === undefined) return false;
     if (!('requestId' in value) || value['requestId'] === undefined) return false;
     if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('subsessionId' in value) || value['subsessionId'] === undefined) return false;
     if (!('text' in value) || value['text'] === undefined) return false;
     if (!('toolCallId' in value) || value['toolCallId'] === undefined) return false;
     return true;
@@ -116,6 +123,7 @@ export function AssistantChatPollMessageFromJSONTyped(json: any, ignoreDiscrimin
         'payload': json['payload'],
         'requestId': json['requestId'],
         'role': json['role'],
+        'subsessionId': json['subsessionId'],
         'text': json['text'],
         'toolCallId': json['toolCallId'],
     };
@@ -139,6 +147,7 @@ export function AssistantChatPollMessageToJSONTyped(value?: AssistantChatPollMes
         'payload': value['payload'],
         'requestId': value['requestId'],
         'role': value['role'],
+        'subsessionId': value['subsessionId'],
         'text': value['text'],
         'toolCallId': value['toolCallId'],
     };

package/src/models/AssistantTranscriptBody.ts

@@ -27,12 +27,30 @@ import {
  * @interface AssistantTranscriptBody
  */
 export interface AssistantTranscriptBody {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssistantTranscriptBody
+     */
+    conversationId: string;
     /**
      * 
      * @type {Array<AssistantTranscriptMessage>}
      * @memberof AssistantTranscriptBody
      */
     messages: Array<AssistantTranscriptMessage>;
+    /**
+     * For a subsession, the id of the run_subsession tool call that started it. Empty for a conversation the user started.
+     * @type {string}
+     * @memberof AssistantTranscriptBody
+     */
+    parentToolCallId: string;
+    /**
+     * The transcript of each subsession the assistant started, in the order it started them. A subsession's messages are not part of messages: the tool message answering its run_subsession call holds only its reply. A subsession is never compacted and starts none of its own, so its summary fields and its own subsessions are empty.
+     * @type {Array<AssistantTranscriptBody>}
+     * @memberof AssistantTranscriptBody
+     */
+    subsessions: Array<AssistantTranscriptBody>;
     /**
      * What the assistant is told of the messages it no longer replays, once the conversation has been compacted. Empty until then.
      * @type {string}
@@ -51,7 +69,10 @@ export interface AssistantTranscriptBody {
  * Check if a given object implements the AssistantTranscriptBody interface.
  */
 export function instanceOfAssistantTranscriptBody(value: object): value is AssistantTranscriptBody {
+    if (!('conversationId' in value) || value['conversationId'] === undefined) return false;
     if (!('messages' in value) || value['messages'] === undefined) return false;
+    if (!('parentToolCallId' in value) || value['parentToolCallId'] === undefined) return false;
+    if (!('subsessions' in value) || value['subsessions'] === undefined) return false;
     if (!('summary' in value) || value['summary'] === undefined) return false;
     if (!('summaryUpTo' in value) || value['summaryUpTo'] === undefined) return false;
     return true;
@@ -67,7 +88,10 @@ export function AssistantTranscriptBodyFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
+        'conversationId': json['conversationId'],
         'messages': ((json['messages'] as Array<any>).map(AssistantTranscriptMessageFromJSON)),
+        'parentToolCallId': json['parentToolCallId'],
+        'subsessions': ((json['subsessions'] as Array<any>).map(AssistantTranscriptBodyFromJSON)),
         'summary': json['summary'],
         'summaryUpTo': json['summaryUpTo'],
     };
@@ -84,7 +108,10 @@ export function AssistantTranscriptBodyToJSONTyped(value?: AssistantTranscriptBo
 
     return {
         
+        'conversationId': value['conversationId'],
         'messages': ((value['messages'] as Array<any>).map(AssistantTranscriptMessageToJSON)),
+        'parentToolCallId': value['parentToolCallId'],
+        'subsessions': ((value['subsessions'] as Array<any>).map(AssistantTranscriptBodyToJSON)),
         'summary': value['summary'],
         'summaryUpTo': value['summaryUpTo'],
     };

package/src/models/FloorplanCreateSpace.ts

@@ -33,6 +33,12 @@ export interface FloorplanCreateSpace {
      * @memberof FloorplanCreateSpace
      */
     endHeight?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof FloorplanCreateSpace
+     */
+    endHeightMetres?: number;
     /**
      * 
      * @type {string}
@@ -51,6 +57,12 @@ export interface FloorplanCreateSpace {
      * @memberof FloorplanCreateSpace
      */
     startHeight?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof FloorplanCreateSpace
+     */
+    startHeightMetres?: number;
 }
 
 /**
@@ -73,9 +85,11 @@ export function FloorplanCreateSpaceFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
+        'endHeightMetres': json['endHeightMetres'] == null ? undefined : json['endHeightMetres'],
         'location': json['location'],
         'paths': ((json['paths'] as Array<any>).map(FloorplanSpaceChangelogPathFromJSON)),
         'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
+        'startHeightMetres': json['startHeightMetres'] == null ? undefined : json['startHeightMetres'],
     };
 }
 
@@ -91,9 +105,11 @@ export function FloorplanCreateSpaceToJSONTyped(value?: FloorplanCreateSpace | n
     return {
         
         'endHeight': value['endHeight'],
+        'endHeightMetres': value['endHeightMetres'],
         'location': value['location'],
         'paths': ((value['paths'] as Array<any>).map(FloorplanSpaceChangelogPathToJSON)),
         'startHeight': value['startHeight'],
+        'startHeightMetres': value['startHeightMetres'],
     };
 }
 

package/src/models/FloorplanGetBody.ts

@@ -82,6 +82,12 @@ export interface FloorplanGetBody {
      * @memberof FloorplanGetBody
      */
     spaces: Array<FloorplanGetBodySpace>;
+    /**
+     * How many of the spaces' path units make one metre, which scales space heights in 3D. Absent until the floor plan's scale has been set.
+     * @type {number}
+     * @memberof FloorplanGetBody
+     */
+    unitsPerMetre?: number;
     /**
      * Whether the floor plan can be shown in 2D, in 3D, or both. Defaults to 2d-and-3d.
      * @type {string}
@@ -134,6 +140,7 @@ export function FloorplanGetBodyFromJSONTyped(json: any, ignoreDiscriminator: bo
         'property': json['property'],
         'propertyNode': json['propertyNode'],
         'spaces': ((json['spaces'] as Array<any>).map(FloorplanGetBodySpaceFromJSON)),
+        'unitsPerMetre': json['unitsPerMetre'] == null ? undefined : json['unitsPerMetre'],
         'viewMode': json['viewMode'],
     };
 }
@@ -157,6 +164,7 @@ export function FloorplanGetBodyToJSONTyped(value?: FloorplanGetBody | null, ign
         'property': value['property'],
         'propertyNode': value['propertyNode'],
         'spaces': ((value['spaces'] as Array<any>).map(FloorplanGetBodySpaceToJSON)),
+        'unitsPerMetre': value['unitsPerMetre'],
         'viewMode': value['viewMode'],
     };
 }

package/src/models/FloorplanGetBodySpace.ts

@@ -28,11 +28,17 @@ import {
  */
 export interface FloorplanGetBodySpace {
     /**
-     * Height the space ends at in 3D, in the same units as its paths. Absent when the space uses the default heights.
+     * Height the space ends at in 3D, in the spaces' path units, as written by editors that predate metres. Absent once converted to metres.
      * @type {number}
      * @memberof FloorplanGetBodySpace
      */
     endHeight?: number;
+    /**
+     * Height the space ends at in 3D, in metres. Absent when the space uses the default heights.
+     * @type {number}
+     * @memberof FloorplanGetBodySpace
+     */
+    endHeightMetres?: number;
     /**
      * 
      * @type {string}
@@ -46,11 +52,17 @@ export interface FloorplanGetBodySpace {
      */
     paths: Array<Array<FloorplanGetBodySpacePoint>>;
     /**
-     * Height the space starts at in 3D, in the same units as its paths. Absent when the space uses the default heights.
+     * Height the space starts at in 3D, in the spaces' path units, as written by editors that predate metres. Absent once converted to metres.
      * @type {number}
      * @memberof FloorplanGetBodySpace
      */
     startHeight?: number;
+    /**
+     * Height the space starts at in 3D, in metres. Absent when the space uses the default heights.
+     * @type {number}
+     * @memberof FloorplanGetBodySpace
+     */
+    startHeightMetres?: number;
 }
 
 /**
@@ -73,9 +85,11 @@ export function FloorplanGetBodySpaceFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'endHeight': json['endHeight'] == null ? undefined : json['endHeight'],
+        'endHeightMetres': json['endHeightMetres'] == null ? undefined : json['endHeightMetres'],
         'location': json['location'],
         'paths': json['paths'],
         'startHeight': json['startHeight'] == null ? undefined : json['startHeight'],
+        'startHeightMetres': json['startHeightMetres'] == null ? undefined : json['startHeightMetres'],
     };
 }
 
@@ -91,9 +105,11 @@ export function FloorplanGetBodySpaceToJSONTyped(value?: FloorplanGetBodySpace |
     return {
         
         'endHeight': value['endHeight'],
+        'endHeightMetres': value['endHeightMetres'],
         'location': value['location'],
         'paths': value['paths'],
         'startHeight': value['startHeight'],
+        'startHeightMetres': value['startHeightMetres'],
     };
 }
 

package/src/models/FloorplanPatchParamsBody.ts

@@ -82,6 +82,12 @@ export interface FloorplanPatchParamsBody {
      * @memberof FloorplanPatchParamsBody
      */
     spaces?: FloorplanCreateSpaceRepeated;
+    /**
+     * 
+     * @type {number}
+     * @memberof FloorplanPatchParamsBody
+     */
+    unitsPerMetre?: number;
     /**
      * 
      * @type {string}
@@ -115,6 +121,7 @@ export function FloorplanPatchParamsBodyFromJSONTyped(json: any, ignoreDiscrimin
         'property': json['property'] == null ? undefined : json['property'],
         'propertyNode': json['propertyNode'] == null ? undefined : json['propertyNode'],
         'spaces': json['spaces'] == null ? undefined : FloorplanCreateSpaceRepeatedFromJSON(json['spaces']),
+        'unitsPerMetre': json['unitsPerMetre'] == null ? undefined : json['unitsPerMetre'],
         'viewMode': json['viewMode'] == null ? undefined : json['viewMode'],
     };
 }
@@ -138,6 +145,7 @@ export function FloorplanPatchParamsBodyToJSONTyped(value?: FloorplanPatchParams
         'property': value['property'],
         'propertyNode': value['propertyNode'],
         'spaces': FloorplanCreateSpaceRepeatedToJSON(value['spaces']),
+        'unitsPerMetre': value['unitsPerMetre'],
         'viewMode': value['viewMode'],
     };
 }