MINOR: add model layout_name for DWG models (#780)

Bimdata-io · Bimdata-io · commit 593b28e0310b · 2024-10-23T10:16:19.000Z
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -961,7 +961,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;OBJ&#39;, &#39;GLTF&#39;, &#39;IFC&#39;, &#39;DWG&#39;, &#39;POINT_CLOUD&#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;IFC&#39;, &#39;GLTF&#39;, &#39;OBJ&#39;, &#39;DXF&#39;, &#39;POINT_CLOUD&#39;, &#39;DWG&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/CreateMultiPageModelRequest.md b/docs/CreateMultiPageModelRequest.md
@@ -5,5 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **mapFiles** | **[File]** |  | 
+**layoutNames** | **[String]** |  | [optional] 
 
 
diff --git a/docs/Model.md b/docs/Model.md
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **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] 
 **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] 
 **children** | [**[ModelSerializerWithoutChildren]**](ModelSerializerWithoutChildren.md) | Contains additional pages of a pdf | [readonly] 
 
 
diff --git a/docs/ModelSerializerWithoutChildren.md b/docs/ModelSerializerWithoutChildren.md
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **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] 
 **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] 
 
 
 
diff --git a/docs/PatchedModelRequest.md b/docs/PatchedModelRequest.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **version** | **String** | This field is only for information. Updating it won&#39;t impact the export. | [optional] 
 **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] 
 
 
 
diff --git a/docs/WriteFolderRequest.md b/docs/WriteFolderRequest.md
@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the folder | 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **parentId** | **Number** |  | [optional] 
-**name** | **String** | Name of the folder | 
 **children** | [**[WriteFolderRequest]**](WriteFolderRequest.md) |  | [optional] 
 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -867,7 +867,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'OBJ', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, 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
@@ -933,7 +933,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'OBJ', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'IFC', 'GLTF', 'OBJ', 'DXF', 'POINT_CLOUD', 'DWG'}, 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/CreateMultiPageModelRequest.js b/src/model/CreateMultiPageModelRequest.js
@@ -52,6 +52,9 @@ class CreateMultiPageModelRequest {
             if (data.hasOwnProperty('map_files')) {
                 obj['map_files'] = ApiClient.convertToType(data['map_files'], [File]);
             }
+            if (data.hasOwnProperty('layout_names')) {
+                obj['layout_names'] = ApiClient.convertToType(data['layout_names'], ['String']);
+            }
         }
         return obj;
     }
@@ -64,6 +67,11 @@ class CreateMultiPageModelRequest {
  */
 CreateMultiPageModelRequest.prototype['map_files'] = undefined;
 
+/**
+ * @member {Array.<String>} layout_names
+ */
+CreateMultiPageModelRequest.prototype['layout_names'] = undefined;
+
 
 
 
diff --git a/src/model/Model.js b/src/model/Model.js
@@ -187,6 +187,9 @@ class Model {
             if (data.hasOwnProperty('page_number')) {
                 obj['page_number'] = ApiClient.convertToType(data['page_number'], 'Number');
             }
+            if (data.hasOwnProperty('layout_name')) {
+                obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
+            }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [ModelSerializerWithoutChildren]);
             }
@@ -360,6 +363,12 @@ Model.prototype['parent_id'] = undefined;
  */
 Model.prototype['page_number'] = undefined;
 
+/**
+ * The name of the DWG layout (only set when type==DWG)
+ * @member {String} layout_name
+ */
+Model.prototype['layout_name'] = undefined;
+
 /**
  * Contains additional pages of a pdf
  * @member {Array.<module:model/ModelSerializerWithoutChildren>} children
diff --git a/src/model/ModelSerializerWithoutChildren.js b/src/model/ModelSerializerWithoutChildren.js
@@ -184,6 +184,9 @@ class ModelSerializerWithoutChildren {
             if (data.hasOwnProperty('page_number')) {
                 obj['page_number'] = ApiClient.convertToType(data['page_number'], 'Number');
             }
+            if (data.hasOwnProperty('layout_name')) {
+                obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
+            }
         }
         return obj;
     }
@@ -354,6 +357,12 @@ ModelSerializerWithoutChildren.prototype['parent_id'] = undefined;
  */
 ModelSerializerWithoutChildren.prototype['page_number'] = undefined;
 
+/**
+ * The name of the DWG layout (only set when type==DWG)
+ * @member {String} layout_name
+ */
+ModelSerializerWithoutChildren.prototype['layout_name'] = undefined;
+
 
 
 
diff --git a/src/model/PatchedModelRequest.js b/src/model/PatchedModelRequest.js
@@ -71,6 +71,9 @@ class PatchedModelRequest {
             if (data.hasOwnProperty('recommanded_2d_angle')) {
                 obj['recommanded_2d_angle'] = ApiClient.convertToType(data['recommanded_2d_angle'], 'Number');
             }
+            if (data.hasOwnProperty('layout_name')) {
+                obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');
+            }
         }
         return obj;
     }
@@ -124,6 +127,12 @@ PatchedModelRequest.prototype['north_vector'] = undefined;
  */
 PatchedModelRequest.prototype['recommanded_2d_angle'] = undefined;
 
+/**
+ * The name of the DWG layout (only set when type==DWG)
+ * @member {String} layout_name
+ */
+PatchedModelRequest.prototype['layout_name'] = undefined;
+
 
 
 
diff --git a/src/model/WriteFolderRequest.js b/src/model/WriteFolderRequest.js
@@ -49,15 +49,15 @@ class WriteFolderRequest {
         if (data) {
             obj = obj || new WriteFolderRequest();
 
+            if (data.hasOwnProperty('name')) {
+                obj['name'] = ApiClient.convertToType(data['name'], 'String');
+            }
             if (data.hasOwnProperty('default_permission')) {
                 obj['default_permission'] = ApiClient.convertToType(data['default_permission'], 'Number');
             }
             if (data.hasOwnProperty('parent_id')) {
                 obj['parent_id'] = ApiClient.convertToType(data['parent_id'], 'Number');
             }
-            if (data.hasOwnProperty('name')) {
-                obj['name'] = ApiClient.convertToType(data['name'], 'String');
-            }
             if (data.hasOwnProperty('children')) {
                 obj['children'] = ApiClient.convertToType(data['children'], [WriteFolderRequest]);
             }
@@ -68,6 +68,12 @@ class WriteFolderRequest {
 
 }
 
+/**
+ * Name of the folder
+ * @member {String} name
+ */
+WriteFolderRequest.prototype['name'] = undefined;
+
 /**
  * Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write
  * @member {module:model/WriteFolderRequest.DefaultPermissionEnum} default_permission
@@ -79,12 +85,6 @@ WriteFolderRequest.prototype['default_permission'] = undefined;
  */
 WriteFolderRequest.prototype['parent_id'] = undefined;
 
-/**
- * Name of the folder
- * @member {String} name
- */
-WriteFolderRequest.prototype['name'] = undefined;
-
 /**
  * @member {Array.<module:model/WriteFolderRequest>} children
  */
diff --git a/test/model/CreateMultiPageModelRequest.spec.js b/test/model/CreateMultiPageModelRequest.spec.js
@@ -60,6 +60,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property layoutNames (base name: "layout_names")', function() {
+      // uncomment below and update the code to test the property layoutNames
+      //var instance = new bimdata.CreateMultiPageModelRequest();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));
diff --git a/test/model/Model.spec.js b/test/model/Model.spec.js
@@ -234,6 +234,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property layoutName (base name: "layout_name")', function() {
+      // uncomment below and update the code to test the property layoutName
+      //var instance = new bimdata.Model();
+      //expect(instance).to.be();
+    });
+
     it('should have the property children (base name: "children")', function() {
       // uncomment below and update the code to test the property children
       //var instance = new bimdata.Model();
diff --git a/test/model/ModelSerializerWithoutChildren.spec.js b/test/model/ModelSerializerWithoutChildren.spec.js
@@ -234,6 +234,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property layoutName (base name: "layout_name")', function() {
+      // uncomment below and update the code to test the property layoutName
+      //var instance = new bimdata.ModelSerializerWithoutChildren();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));
diff --git a/test/model/PatchedModelRequest.spec.js b/test/model/PatchedModelRequest.spec.js
@@ -102,6 +102,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property layoutName (base name: "layout_name")', function() {
+      // uncomment below and update the code to test the property layoutName
+      //var instance = new bimdata.PatchedModelRequest();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js
@@ -54,20 +54,20 @@
       //expect(instance).to.be.a(bimdata.WriteFolderRequest);
     });
 
-    it('should have the property defaultPermission (base name: "default_permission")', function() {
-      // uncomment below and update the code to test the property defaultPermission
+    it('should have the property name (base name: "name")', function() {
+      // uncomment below and update the code to test the property name
       //var instance = new bimdata.WriteFolderRequest();
       //expect(instance).to.be();
     });
 
-    it('should have the property parentId (base name: "parent_id")', function() {
-      // uncomment below and update the code to test the property parentId
+    it('should have the property defaultPermission (base name: "default_permission")', function() {
+      // uncomment below and update the code to test the property defaultPermission
       //var instance = new bimdata.WriteFolderRequest();
       //expect(instance).to.be();
     });
 
-    it('should have the property name (base name: "name")', function() {
-      // uncomment below and update the code to test the property name
+    it('should have the property parentId (base name: "parent_id")', function() {
+      // uncomment below and update the code to test the property parentId
       //var instance = new bimdata.WriteFolderRequest();
       //expect(instance).to.be();
     });

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,9 @@ class CreateMultiPageModelRequest {`
`52`	`52`	`if (data.hasOwnProperty('map_files')) {`
`53`	`53`	`obj['map_files'] = ApiClient.convertToType(data['map_files'], [File]);`
`54`	`54`	`}`
	`55`	`+ if (data.hasOwnProperty('layout_names')) {`
	`56`	`+ obj['layout_names'] = ApiClient.convertToType(data['layout_names'], ['String']);`
	`57`	`+ }`
`55`	`58`	`}`
`56`	`59`	`return obj;`
`57`	`60`	`}`
`@@ -64,6 +67,11 @@ class CreateMultiPageModelRequest {`
`64`	`67`	`*/`
`65`	`68`	`CreateMultiPageModelRequest.prototype['map_files'] = undefined;`
`66`	`69`
	`70`	`+/**`
	`71`	`+ * @member {Array.<String>} layout_names`
	`72`	`+ */`
	`73`	`+CreateMultiPageModelRequest.prototype['layout_names'] = undefined;`
	`74`	`+`
`67`	`75`
`68`	`76`
`69`	`77`
Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,9 @@ class ModelSerializerWithoutChildren {`
`184`	`184`	`if (data.hasOwnProperty('page_number')) {`
`185`	`185`	`obj['page_number'] = ApiClient.convertToType(data['page_number'], 'Number');`
`186`	`186`	`}`
	`187`	`+ if (data.hasOwnProperty('layout_name')) {`
	`188`	`+ obj['layout_name'] = ApiClient.convertToType(data['layout_name'], 'String');`
	`189`	`+ }`
`187`	`190`	`}`
`188`	`191`	`return obj;`
`189`	`192`	`}`
`@@ -354,6 +357,12 @@ ModelSerializerWithoutChildren.prototype['parent_id'] = undefined;`
`354`	`357`	`*/`
`355`	`358`	`ModelSerializerWithoutChildren.prototype['page_number'] = undefined;`
`356`	`359`
	`360`	`+/**`
	`361`	`+ * The name of the DWG layout (only set when type==DWG)`
	`362`	`+ * @member {String} layout_name`
	`363`	`+ */`
	`364`	`+ModelSerializerWithoutChildren.prototype['layout_name'] = undefined;`
	`365`	`+`
`357`	`366`
`358`	`367`
`359`	`368`