PATCH: Fix mask_2d in model, can be null. (#840)

Bimdata-io · Bimdata-io · commit 7410ececefc1 · 2025-04-28T13:15:07.000Z
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -960,7 +960,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;POINT_CLOUD&#39;, &#39;IFC&#39;, &#39;GLTF&#39;, &#39;DWG&#39;, &#39;OBJ&#39;, &#39;DXF&#39;}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {&#39;DXF&#39;, &#39;OBJ&#39;, &#39;IFC&#39;, &#39;DWG&#39;, &#39;GLTF&#39;, &#39;POINT_CLOUD&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/Model.md b/docs/Model.md
@@ -35,7 +35,7 @@ Name | Type | Description | Notes
 **parentId** | **Number** | The first page of the pdf | [readonly] 
 **pageNumber** | **Number** | The page number of the related pdf | [readonly] 
 **layoutName** | **String** | The name of the DWG layout (only set when type&#x3D;&#x3D;DWG) | [optional] 
-**mask2d** | [**Mask2D**](Mask2D.md) |  | 
+**mask2d** | [**Mask2D**](Mask2D.md) |  | [readonly] 
 **children** | [**[ModelSerializerWithoutChildren]**](ModelSerializerWithoutChildren.md) | Contains additional pages of a pdf | [readonly] 
 
 
diff --git a/docs/ModelSerializerWithoutChildren.md b/docs/ModelSerializerWithoutChildren.md
@@ -35,7 +35,7 @@ Name | Type | Description | Notes
 **parentId** | **Number** | The first page of the pdf | [readonly] 
 **pageNumber** | **Number** | The page number of the related pdf | [readonly] 
 **layoutName** | **String** | The name of the DWG layout (only set when type&#x3D;&#x3D;DWG) | [optional] 
-**mask2d** | [**Mask2D**](Mask2D.md) |  | 
+**mask2d** | [**Mask2D**](Mask2D.md) |  | [readonly] 
 
 
 
diff --git a/docs/PatchedModelRequest.md b/docs/PatchedModelRequest.md
@@ -13,7 +13,6 @@ Name | Type | Description | Notes
 **northVector** | **[[Number]]** | This field is only for information. Updating it won&#39;t impact the export. | [optional] 
 **recommanded2dAngle** | **Number** | This is the angle in clockwise degree to apply on the 2D to optimise the horizontality of objects. This field is only for information. Updating it won&#39;t impact the export. | [optional] 
 **layoutName** | **String** | The name of the DWG layout (only set when type&#x3D;&#x3D;DWG) | [optional] 
-**mask2d** | [**Mask2DRequest**](Mask2DRequest.md) |  | [optional] 
 
 
 
diff --git a/docs/WriteFolder.md b/docs/WriteFolder.md
@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **nature** | **String** | Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**type** | **String** | DEPRECATED: Use &#39;nature&#39; instead. Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**createdAt** | **Date** | Creation date | [readonly] 
-**parentId** | **Number** |  | [optional] 
+**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
 **createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
+**type** | **String** | DEPRECATED: Use &#39;nature&#39; instead. Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
+**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
 **id** | **Number** |  | [readonly] 
-**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **name** | **String** | Name of the folder | 
-**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
+**createdAt** | **Date** | Creation date | [readonly] 
+**parentId** | **Number** |  | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/docs/WriteFolderRequest.md b/docs/WriteFolderRequest.md
@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**parentId** | **Number** |  | [optional] 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **name** | **String** | Name of the folder | 
+**parentId** | **Number** |  | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -866,7 +866,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'OBJ', 'IFC', 'DWG', 'GLTF', 'POINT_CLOUD'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
@@ -934,7 +934,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'OBJ', 'IFC', 'DWG', 'GLTF', 'POINT_CLOUD'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
diff --git a/src/model/Model.js b/src/model/Model.js
@@ -194,7 +194,7 @@ class Model {
                 obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
             }
             if (data.hasOwnProperty('mask_2d')) {
-                obj['mask_2d'] = Mask2D.constructFromObject(data['mask_2d']);
+                obj['mask_2d'] = ApiClient.convertToType(data['mask_2d'], Mask2D);
             }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [ModelSerializerWithoutChildren]);
diff --git a/src/model/ModelSerializerWithoutChildren.js b/src/model/ModelSerializerWithoutChildren.js
@@ -191,7 +191,7 @@ class ModelSerializerWithoutChildren {
                 obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
             }
             if (data.hasOwnProperty('mask_2d')) {
-                obj['mask_2d'] = Mask2D.constructFromObject(data['mask_2d']);
+                obj['mask_2d'] = ApiClient.convertToType(data['mask_2d'], Mask2D);
             }
         }
         return obj;
diff --git a/src/model/PatchedModelRequest.js b/src/model/PatchedModelRequest.js
@@ -12,7 +12,6 @@
  */
 
 import ApiClient from '../ApiClient';
-import Mask2DRequest from './Mask2DRequest';
 
 /**
  * The PatchedModelRequest model module.
@@ -75,9 +74,6 @@ class PatchedModelRequest {
             if (data.hasOwnProperty('layout_name')) {
                 obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
             }
-            if (data.hasOwnProperty('mask_2d')) {
-                obj['mask_2d'] = Mask2DRequest.constructFromObject(data['mask_2d']);
-            }
         }
         return obj;
     }
@@ -137,11 +133,6 @@ PatchedModelRequest.prototype['recommanded_2d_angle'] = undefined;
  */
 PatchedModelRequest.prototype['layout_name'] = undefined;
 
-/**
- * @member {module:model/Mask2DRequest} mask_2d
- */
-PatchedModelRequest.prototype['mask_2d'] = undefined;
-
 
 
 
diff --git a/src/model/WriteFolder.js b/src/model/WriteFolder.js
@@ -25,35 +25,35 @@ class WriteFolder {
      * Constructs a new <code>WriteFolder</code>.
      * @alias module:model/WriteFolder
      * @param nature {String} Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
-     * @param type {String} DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
-     * @param createdAt {Date} Creation date
+     * @param groupsPermissions {Array.<module:model/GroupFolderRead>} List of group permissions
      * @param createdBy {module:model/ShortUser} 
+     * @param type {String} DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
+     * @param userPermission {module:model/WriteFolder.UserPermissionEnum} Aggregate of group user permissions and folder default permission
      * @param updatedAt {Date} Date of the last update
      * @param id {Number} 
-     * @param groupsPermissions {Array.<module:model/GroupFolderRead>} List of group permissions
      * @param name {String} Name of the folder
-     * @param userPermission {module:model/WriteFolder.UserPermissionEnum} Aggregate of group user permissions and folder default permission
+     * @param createdAt {Date} Creation date
      */
-    constructor(nature, type, createdAt, createdBy, updatedAt, id, groupsPermissions, name, userPermission) { 
+    constructor(nature, groupsPermissions, createdBy, type, userPermission, updatedAt, id, name, createdAt) { 
         
-        WriteFolder.initialize(this, nature, type, createdAt, createdBy, updatedAt, id, groupsPermissions, name, userPermission);
+        WriteFolder.initialize(this, nature, groupsPermissions, createdBy, type, userPermission, updatedAt, id, name, createdAt);
     }
 
     /**
      * Initializes the fields of this object.
      * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
      * Only for internal use.
      */
-    static initialize(obj, nature, type, createdAt, createdBy, updatedAt, id, groupsPermissions, name, userPermission) { 
+    static initialize(obj, nature, groupsPermissions, createdBy, type, userPermission, updatedAt, id, name, createdAt) { 
         obj['nature'] = nature;
-        obj['type'] = type;
-        obj['created_at'] = createdAt;
+        obj['groups_permissions'] = groupsPermissions;
         obj['created_by'] = createdBy;
+        obj['type'] = type;
+        obj['user_permission'] = userPermission;
         obj['updated_at'] = updatedAt;
         obj['id'] = id;
-        obj['groups_permissions'] = groupsPermissions;
         obj['name'] = name;
-        obj['user_permission'] = userPermission;
+        obj['created_at'] = createdAt;
     }
 
     /**
@@ -67,38 +67,38 @@ class WriteFolder {
         if (data) {
             obj = obj || new WriteFolder();
 
+            if (data.hasOwnProperty('default_permission')) {
+                obj['default_permission'] = ApiClient.convertToType(data['default_permission'], 'Number');
+            }
             if (data.hasOwnProperty('nature')) {
                 obj['nature'] = ApiClient.convertToType(data['nature'], 'String');
             }
-            if (data.hasOwnProperty('type')) {
-                obj['type'] = ApiClient.convertToType(data['type'], 'String');
-            }
-            if (data.hasOwnProperty('created_at')) {
-                obj['created_at'] = ApiClient.convertToType(data['created_at'], 'Date');
-            }
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
+            if (data.hasOwnProperty('groups_permissions')) {
+                obj['groups_permissions'] = ApiClient.convertToType(data['groups_permissions'], [GroupFolderRead]);
             }
             if (data.hasOwnProperty('created_by')) {
                 obj['created_by'] = ApiClient.convertToType(data['created_by'], ShortUser);
             }
+            if (data.hasOwnProperty('type')) {
+                obj['type'] = ApiClient.convertToType(data['type'], 'String');
+            }
+            if (data.hasOwnProperty('user_permission')) {
+                obj['user_permission'] = ApiClient.convertToType(data['user_permission'], 'Number');
+            }
             if (data.hasOwnProperty('updated_at')) {
                 obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'Date');
             }
             if (data.hasOwnProperty('id')) {
                 obj['id'] = ApiClient.convertToType(data['id'], 'Number');
             }
-            if (data.hasOwnProperty('groups_permissions')) {
-                obj['groups_permissions'] = ApiClient.convertToType(data['groups_permissions'], [GroupFolderRead]);
-            }
-            if (data.hasOwnProperty('default_permission')) {
-                obj['default_permission'] = ApiClient.convertToType(data['default_permission'], 'Number');
-            }
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
-            if (data.hasOwnProperty('user_permission')) {
-                obj['user_permission'] = ApiClient.convertToType(data['user_permission'], 'Number');
+            if (data.hasOwnProperty('created_at')) {
+                obj['created_at'] = ApiClient.convertToType(data['created_at'], 'Date');
+            }
+            if (data.hasOwnProperty('parent_id')) {
+                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
             }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [WriteFolder]);
@@ -110,33 +110,40 @@ class WriteFolder {
 
 }
 
+/**
+ * Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write
+ * @member {module:model/WriteFolder.DefaultPermissionEnum} default_permission
+ */
+WriteFolder.prototype['default_permission'] = undefined;
+
 /**
  * Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
  * @member {String} nature
  */
 WriteFolder.prototype['nature'] = undefined;
 
 /**
- * DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
- * @member {String} type
+ * List of group permissions
+ * @member {Array.<module:model/GroupFolderRead>} groups_permissions
  */
-WriteFolder.prototype['type'] = undefined;
+WriteFolder.prototype['groups_permissions'] = undefined;
 
 /**
- * Creation date
- * @member {Date} created_at
+ * @member {module:model/ShortUser} created_by
  */
-WriteFolder.prototype['created_at'] = undefined;
+WriteFolder.prototype['created_by'] = undefined;
 
 /**
- * @member {Number} parent_id
+ * DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files
+ * @member {String} type
  */
-WriteFolder.prototype['parent_id'] = undefined;
+WriteFolder.prototype['type'] = undefined;
 
 /**
- * @member {module:model/ShortUser} created_by
+ * Aggregate of group user permissions and folder default permission
+ * @member {module:model/WriteFolder.UserPermissionEnum} user_permission
  */
-WriteFolder.prototype['created_by'] = undefined;
+WriteFolder.prototype['user_permission'] = undefined;
 
 /**
  * Date of the last update
@@ -149,29 +156,22 @@ WriteFolder.prototype['updated_at'] = undefined;
  */
 WriteFolder.prototype['id'] = undefined;
 
-/**
- * List of group permissions
- * @member {Array.<module:model/GroupFolderRead>} groups_permissions
- */
-WriteFolder.prototype['groups_permissions'] = undefined;
-
-/**
- * Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write
- * @member {module:model/WriteFolder.DefaultPermissionEnum} default_permission
- */
-WriteFolder.prototype['default_permission'] = undefined;
-
 /**
  * Name of the folder
  * @member {String} name
  */
 WriteFolder.prototype['name'] = undefined;
 
 /**
- * Aggregate of group user permissions and folder default permission
- * @member {module:model/WriteFolder.UserPermissionEnum} user_permission
+ * Creation date
+ * @member {Date} created_at
  */
-WriteFolder.prototype['user_permission'] = undefined;
+WriteFolder.prototype['created_at'] = undefined;
+
+/**
+ * @member {Number} parent_id
+ */
+WriteFolder.prototype['parent_id'] = undefined;
 
 /**
  * @member {Array.<module:model/WriteFolder>} children
diff --git a/src/model/WriteFolderRequest.js b/src/model/WriteFolderRequest.js
@@ -50,15 +50,15 @@ class WriteFolderRequest {
         if (data) {
             obj = obj || new WriteFolderRequest();
 
-            if (data.hasOwnProperty('parent_id')) {
-                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
-            }
             if (data.hasOwnProperty('default_permission')) {
                 obj['default_permission'] = ApiClient.convertToType(data['default_permission'], 'Number');
             }
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
+            if (data.hasOwnProperty('parent_id')) {
+                obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
+            }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [WriteFolder]);
             }
@@ -69,11 +69,6 @@ class WriteFolderRequest {
 
 }
 
-/**
- * @member {Number} parent_id
- */
-WriteFolderRequest.prototype['parent_id'] = undefined;
-
 /**
  * Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write
  * @member {module:model/WriteFolderRequest.DefaultPermissionEnum} default_permission
@@ -86,6 +81,11 @@ WriteFolderRequest.prototype['default_permission'] = undefined;
  */
 WriteFolderRequest.prototype['name'] = undefined;
 
+/**
+ * @member {Number} parent_id
+ */
+WriteFolderRequest.prototype['parent_id'] = undefined;
+
 /**
  * @member {Array.<module:model/WriteFolder>} children
  */
diff --git a/test/model/PatchedModelRequest.spec.js b/test/model/PatchedModelRequest.spec.js
@@ -108,12 +108,6 @@
       //expect(instance).to.be();
     });
 
-    it('should have the property mask2d (base name: "mask_2d")', function() {
-      // uncomment below and update the code to test the property mask2d
-      //var instance = new bimdata.PatchedModelRequest();
-      //expect(instance).to.be();
-    });
-
   });
 
 }));
diff --git a/test/model/WriteFolder.spec.js b/test/model/WriteFolder.spec.js
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js

Original file line number	Diff line number	Diff line change
`@@ -194,7 +194,7 @@ class Model {`
`194`	`194`	`obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');`
`195`	`195`	`}`
`196`	`196`	`if (data.hasOwnProperty('mask_2d')) {`
`197`		`- obj['mask_2d'] = Mask2D.constructFromObject(data['mask_2d']);`
	`197`	`+ obj['mask_2d'] = ApiClient.convertToType(data['mask_2d'], Mask2D);`
`198`	`198`	`}`
`199`	`199`	`if (data.hasOwnProperty('children')) {`
`200`	`200`	`obj['children'] = ApiClient.convertToType(data['children'], [ModelSerializerWithoutChildren]);`
Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ class ModelSerializerWithoutChildren {`
`191`	`191`	`obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');`
`192`	`192`	`}`
`193`	`193`	`if (data.hasOwnProperty('mask_2d')) {`
`194`		`- obj['mask_2d'] = Mask2D.constructFromObject(data['mask_2d']);`
	`194`	`+ obj['mask_2d'] = ApiClient.convertToType(data['mask_2d'], Mask2D);`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`	`return obj;`