MINOR: add routes to manage zone_space relations (#690)

Author: Bimdata-io

package/.openapi-generator/FILES

@@ -242,6 +242,7 @@ src/models/XktFile.ts
 src/models/Zone.ts
 src/models/ZoneRequest.ts
 src/models/ZoneSpace.ts
+src/models/ZoneSpaceRelationRequest.ts
 src/models/ZoneSpaceRequest.ts
 src/models/index.ts
 src/runtime.ts

package/src/apis/CollaborationApi.ts

@@ -1564,7 +1564,7 @@ export class CollaborationApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a document. If the document is one of {\'OBJ\', \'DWG\', \'POINT_CLOUD\', \'DXF\', \'IFC\', \'GLTF\'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {\'OBJ\', \'IFC\', \'GLTF\', \'DXF\', \'POINT_CLOUD\', \'DWG\'}, a model will be created and attached to this document  Required scopes: document:write
      * Create a document
      */
     async createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Document>> {
@@ -1667,7 +1667,7 @@ export class CollaborationApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a document. If the document is one of {\'OBJ\', \'DWG\', \'POINT_CLOUD\', \'DXF\', \'IFC\', \'GLTF\'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {\'OBJ\', \'IFC\', \'GLTF\', \'DXF\', \'POINT_CLOUD\', \'DWG\'}, a model will be created and attached to this document  Required scopes: document:write
      * Create a document
      */
     async createDocument(cloud_pk: number, project_pk: number, name: string, file: Blob, parent_id?: number | null, file_name?: string, description?: string | null, model_source?: CreateDocumentModelSourceEnum, ifc_source?: CreateDocumentIfcSourceEnum, successor_of?: number, initOverrides?: RequestInit): Promise<Document> {

package/src/apis/IfcApi.ts

@@ -210,6 +210,9 @@ import {
     ZoneSpace,
     ZoneSpaceFromJSON,
     ZoneSpaceToJSON,
+    ZoneSpaceRelationRequest,
+    ZoneSpaceRelationRequestFromJSON,
+    ZoneSpaceRelationRequestToJSON,
     ZoneSpaceRequest,
     ZoneSpaceRequestFromJSON,
     ZoneSpaceRequestToJSON,
@@ -222,6 +225,14 @@ export interface AddIfcErrorsDeprecatedRequest {
     ModelErrorsRequest?: ModelErrorsRequest;
 }
 
+export interface AddZoneSpaceDeprecatedRequest {
+    cloud_pk: number;
+    ifc_pk: number;
+    project_pk: number;
+    zone_pk: number;
+    ZoneSpaceRelationRequest: ZoneSpaceRelationRequest;
+}
+
 export interface BulkDeleteIfcClassificationsDeprecatedRequest {
     cloud_pk: number;
     ifc_pk: number;
@@ -1387,6 +1398,75 @@ export class IfcApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Add a space to a zone. The IFC file will not be updated. The created space will be accessible over the API and when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Add a space to a zone
+     */
+    async addZoneSpaceDeprecatedRaw(requestParameters: AddZoneSpaceDeprecatedRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ZoneSpace>> {
+        if (requestParameters.cloud_pk === null || requestParameters.cloud_pk === undefined) {
+            throw new runtime.RequiredError('cloud_pk','Required parameter requestParameters.cloud_pk was null or undefined when calling addZoneSpaceDeprecated.');
+        }
+
+        if (requestParameters.ifc_pk === null || requestParameters.ifc_pk === undefined) {
+            throw new runtime.RequiredError('ifc_pk','Required parameter requestParameters.ifc_pk was null or undefined when calling addZoneSpaceDeprecated.');
+        }
+
+        if (requestParameters.project_pk === null || requestParameters.project_pk === undefined) {
+            throw new runtime.RequiredError('project_pk','Required parameter requestParameters.project_pk was null or undefined when calling addZoneSpaceDeprecated.');
+        }
+
+        if (requestParameters.zone_pk === null || requestParameters.zone_pk === undefined) {
+            throw new runtime.RequiredError('zone_pk','Required parameter requestParameters.zone_pk was null or undefined when calling addZoneSpaceDeprecated.');
+        }
+
+        if (requestParameters.ZoneSpaceRelationRequest === null || requestParameters.ZoneSpaceRelationRequest === undefined) {
+            throw new runtime.RequiredError('ZoneSpaceRelationRequest','Required parameter requestParameters.ZoneSpaceRelationRequest was null or undefined when calling addZoneSpaceDeprecated.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // Bearer authentication
+        }
+
+        const response = await this.request({
+            path: `/cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/add`.replace(`{${"cloud_pk"}}`, encodeURIComponent(String(requestParameters.cloud_pk))).replace(`{${"ifc_pk"}}`, encodeURIComponent(String(requestParameters.ifc_pk))).replace(`{${"project_pk"}}`, encodeURIComponent(String(requestParameters.project_pk))).replace(`{${"zone_pk"}}`, encodeURIComponent(String(requestParameters.zone_pk))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ZoneSpaceRelationRequestToJSON(requestParameters.ZoneSpaceRelationRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ZoneSpaceFromJSON(jsonValue));
+    }
+
+    /**
+     * Add a space to a zone. The IFC file will not be updated. The created space will be accessible over the API and when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Add a space to a zone
+     */
+    async addZoneSpaceDeprecated(cloud_pk: number, ifc_pk: number, project_pk: number, zone_pk: number, ZoneSpaceRelationRequest: ZoneSpaceRelationRequest, initOverrides?: RequestInit): Promise<ZoneSpace> {
+        const response = await this.addZoneSpaceDeprecatedRaw({ cloud_pk: cloud_pk, ifc_pk: ifc_pk, project_pk: project_pk, zone_pk: zone_pk, ZoneSpaceRelationRequest: ZoneSpaceRelationRequest }, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Delete relation between filtered classifications (eg. /classifications?name=untec) and all mode\'s elements. No classification will be deleted on this endpoint, only the relation between model\'s elements and their classification.  Required scopes: ifc:write, model:write
      * Remove all classifications from model\'s elements
@@ -4991,8 +5071,8 @@ export class IfcApi extends runtime.BaseAPI {
     }
 
     /**
-     * The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
-     * Delete a space of a zone
+     * Delete the relation between a space and a zone. The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Delete the relation between a space and a zone
      */
     async deleteZoneSpaceDeprecatedRaw(requestParameters: DeleteZoneSpaceDeprecatedRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.cloud_pk === null || requestParameters.cloud_pk === undefined) {
@@ -5048,8 +5128,8 @@ export class IfcApi extends runtime.BaseAPI {
     }
 
     /**
-     * The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
-     * Delete a space of a zone
+     * Delete the relation between a space and a zone. The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Delete the relation between a space and a zone
      */
     async deleteZoneSpaceDeprecated(cloud_pk: number, id: number, ifc_pk: number, project_pk: number, zone_pk: number, initOverrides?: RequestInit): Promise<void> {
         await this.deleteZoneSpaceDeprecatedRaw({ cloud_pk: cloud_pk, id: id, ifc_pk: ifc_pk, project_pk: project_pk, zone_pk: zone_pk }, initOverrides);

package/src/apis/ModelApi.ts

@@ -210,6 +210,9 @@ import {
     ZoneSpace,
     ZoneSpaceFromJSON,
     ZoneSpaceToJSON,
+    ZoneSpaceRelationRequest,
+    ZoneSpaceRelationRequestFromJSON,
+    ZoneSpaceRelationRequestToJSON,
     ZoneSpaceRequest,
     ZoneSpaceRequestFromJSON,
     ZoneSpaceRequestToJSON,
@@ -222,6 +225,14 @@ export interface AddModelErrorsRequest {
     ModelErrorsRequest?: ModelErrorsRequest;
 }
 
+export interface AddZoneSpaceRequest {
+    cloud_pk: number;
+    model_pk: number;
+    project_pk: number;
+    zone_pk: number;
+    ZoneSpaceRelationRequest: ZoneSpaceRelationRequest;
+}
+
 export interface BulkDeleteModelClassificationsRequest {
     cloud_pk: number;
     model_pk: number;
@@ -1393,6 +1404,75 @@ export class ModelApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Add a space to a zone. The IFC file will not be updated. The created space will be accessible over the API and when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Add a space to a zone
+     */
+    async addZoneSpaceRaw(requestParameters: AddZoneSpaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ZoneSpace>> {
+        if (requestParameters.cloud_pk === null || requestParameters.cloud_pk === undefined) {
+            throw new runtime.RequiredError('cloud_pk','Required parameter requestParameters.cloud_pk was null or undefined when calling addZoneSpace.');
+        }
+
+        if (requestParameters.model_pk === null || requestParameters.model_pk === undefined) {
+            throw new runtime.RequiredError('model_pk','Required parameter requestParameters.model_pk was null or undefined when calling addZoneSpace.');
+        }
+
+        if (requestParameters.project_pk === null || requestParameters.project_pk === undefined) {
+            throw new runtime.RequiredError('project_pk','Required parameter requestParameters.project_pk was null or undefined when calling addZoneSpace.');
+        }
+
+        if (requestParameters.zone_pk === null || requestParameters.zone_pk === undefined) {
+            throw new runtime.RequiredError('zone_pk','Required parameter requestParameters.zone_pk was null or undefined when calling addZoneSpace.');
+        }
+
+        if (requestParameters.ZoneSpaceRelationRequest === null || requestParameters.ZoneSpaceRelationRequest === undefined) {
+            throw new runtime.RequiredError('ZoneSpaceRelationRequest','Required parameter requestParameters.ZoneSpaceRelationRequest was null or undefined when calling addZoneSpace.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // Bearer authentication
+        }
+
+        const response = await this.request({
+            path: `/cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/add`.replace(`{${"cloud_pk"}}`, encodeURIComponent(String(requestParameters.cloud_pk))).replace(`{${"model_pk"}}`, encodeURIComponent(String(requestParameters.model_pk))).replace(`{${"project_pk"}}`, encodeURIComponent(String(requestParameters.project_pk))).replace(`{${"zone_pk"}}`, encodeURIComponent(String(requestParameters.zone_pk))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ZoneSpaceRelationRequestToJSON(requestParameters.ZoneSpaceRelationRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ZoneSpaceFromJSON(jsonValue));
+    }
+
+    /**
+     * Add a space to a zone. The IFC file will not be updated. The created space will be accessible over the API and when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Add a space to a zone
+     */
+    async addZoneSpace(cloud_pk: number, model_pk: number, project_pk: number, zone_pk: number, ZoneSpaceRelationRequest: ZoneSpaceRelationRequest, initOverrides?: RequestInit): Promise<ZoneSpace> {
+        const response = await this.addZoneSpaceRaw({ cloud_pk: cloud_pk, model_pk: model_pk, project_pk: project_pk, zone_pk: zone_pk, ZoneSpaceRelationRequest: ZoneSpaceRelationRequest }, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Delete relation between filtered classifications (eg. /classifications?name=untec) and all mode\'s elements. No classification will be deleted on this endpoint, only the relation between model\'s elements and their classification.  Required scopes: ifc:write, model:write
      * Remove all classifications from model\'s elements
@@ -4997,8 +5077,8 @@ export class ModelApi extends runtime.BaseAPI {
     }
 
     /**
-     * The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
-     * Delete a space of a zone
+     * Delete the relation between a space and a zone. The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Delete the relation between a space and a zone
      */
     async deleteZoneSpaceRaw(requestParameters: DeleteZoneSpaceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.cloud_pk === null || requestParameters.cloud_pk === undefined) {
@@ -5054,8 +5134,8 @@ export class ModelApi extends runtime.BaseAPI {
     }
 
     /**
-     * The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
-     * Delete a space of a zone
+     * Delete the relation between a space and a zone. The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file  Required scopes: ifc:write, model:write
+     * Delete the relation between a space and a zone
      */
     async deleteZoneSpace(cloud_pk: number, id: number, model_pk: number, project_pk: number, zone_pk: number, initOverrides?: RequestInit): Promise<void> {
         await this.deleteZoneSpaceRaw({ cloud_pk: cloud_pk, id: id, model_pk: model_pk, project_pk: project_pk, zone_pk: zone_pk }, initOverrides);

package/src/models/ZoneSpaceRelationRequest.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BIMData API
+ * BIMData API is a tool to interact with your models stored on BIMData’s servers.     Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints.
+ *
+ * The version of the OpenAPI document: v1 (v1)
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ZoneSpaceRelationRequest
+ */
+export interface ZoneSpaceRelationRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof ZoneSpaceRelationRequest
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ZoneSpaceRelationRequest
+     */
+    order?: number;
+}
+
+export function ZoneSpaceRelationRequestFromJSON(json: any): ZoneSpaceRelationRequest {
+    return ZoneSpaceRelationRequestFromJSONTyped(json, false);
+}
+
+export function ZoneSpaceRelationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZoneSpaceRelationRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'order': !exists(json, 'order') ? undefined : json['order'],
+    };
+}
+
+export function ZoneSpaceRelationRequestToJSON(value?: ZoneSpaceRelationRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'order': value.order,
+    };
+}
+

package/src/models/index.ts

@@ -235,4 +235,5 @@ export * from './XktFile';
 export * from './Zone';
 export * from './ZoneRequest';
 export * from './ZoneSpace';
+export * from './ZoneSpaceRelationRequest';
 export * from './ZoneSpaceRequest';