PATCH: rename model 360 field (#576)

Bimdata-io · Bimdata-io · commit 705f0d5787be · 2022-10-21T09:31:13.000Z
* rename model 360 field

* keep viewer_360_file field

* remove useless field in write only serializer
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -889,7 +889,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;DWG&#39;, &#39;POINT_CLOUD&#39;, &#39;BFX&#39;, &#39;OBJ&#39;, &#39;IFC&#39;, &#39;DXF&#39;, &#39;DAE&#39;, &#39;GLTF&#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;DAE&#39;, &#39;DXF&#39;, &#39;POINT_CLOUD&#39;, &#39;IFC&#39;, &#39;DWG&#39;, &#39;BFX&#39;, &#39;OBJ&#39;, &#39;GLTF&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/IfcApi.md b/docs/IfcApi.md
@@ -9738,7 +9738,7 @@ let opts = {
   'gltfFile': "/path/to/file", // File | 
   'gltfWithOpeningsFile': "/path/to/file", // File | 
   'bvhTreeFile': "/path/to/file", // File | 
-  'viewer360File': "/path/to/file", // File | 
+  'previewFile': "/path/to/file", // File | 
   'xktFile': "/path/to/file" // File | 
 };
 apiInstance.updateIfcFilesDeprecated(cloudPk, id, projectPk, opts).then((data) => {
@@ -9763,7 +9763,7 @@ Name | Type | Description  | Notes
  **gltfFile** | **File**|  | [optional] 
  **gltfWithOpeningsFile** | **File**|  | [optional] 
  **bvhTreeFile** | **File**|  | [optional] 
- **viewer360File** | **File**|  | [optional] 
+ **previewFile** | **File**|  | [optional] 
  **xktFile** | **File**|  | [optional] 
 
 ### Return type
diff --git a/docs/Model.md b/docs/Model.md
@@ -19,7 +19,8 @@ Name | Type | Description | Notes
 **mapFile** | **String** |  | [readonly] 
 **gltfFile** | **String** |  | [readonly] 
 **bvhTreeFile** | **String** |  | [readonly] 
-**viewer360File** | **String** |  | [readonly] 
+**previewFile** | **String** |  | [readonly] 
+**viewer360File** | **String** | DEPRECATED: Use &#39;preview_file&#39; instead. | 
 **xktFile** | **String** |  | [readonly] 
 **projectId** | **Number** |  | [readonly] 
 **worldPosition** | **[Number]** | [x,y,z] array of the position of the local_placement in world coordinates | [optional] 
diff --git a/docs/ModelApi.md b/docs/ModelApi.md
@@ -9039,7 +9039,7 @@ let opts = {
   'gltfFile': "/path/to/file", // File | 
   'gltfWithOpeningsFile': "/path/to/file", // File | 
   'bvhTreeFile': "/path/to/file", // File | 
-  'viewer360File': "/path/to/file", // File | 
+  'previewFile': "/path/to/file", // File | 
   'xktFile': "/path/to/file" // File | 
 };
 apiInstance.updateModelFiles(cloudPk, id, projectPk, opts).then((data) => {
@@ -9064,7 +9064,7 @@ Name | Type | Description  | Notes
  **gltfFile** | **File**|  | [optional] 
  **gltfWithOpeningsFile** | **File**|  | [optional] 
  **bvhTreeFile** | **File**|  | [optional] 
- **viewer360File** | **File**|  | [optional] 
+ **previewFile** | **File**|  | [optional] 
  **xktFile** | **File**|  | [optional] 
 
 ### Return type
diff --git a/docs/ModelFiles.md b/docs/ModelFiles.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **gltfFile** | **String** |  | [optional] 
 **gltfWithOpeningsFile** | **String** |  | [optional] 
 **bvhTreeFile** | **String** |  | [optional] 
-**viewer360File** | **String** |  | [optional] 
+**previewFile** | **String** |  | [optional] 
 **xktFile** | **String** |  | [optional] 
 
 
diff --git a/docs/ModelRequest.md b/docs/ModelRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | [optional] 
 **source** | **String** |  | [optional] 
+**viewer360File** | **File** | DEPRECATED: Use &#39;preview_file&#39; instead. | 
 **worldPosition** | **[Number]** | [x,y,z] array of the position of the local_placement in world coordinates | [optional] 
 **sizeRatio** | **Number** | How many meters a unit represents | [optional] 
 **archived** | **Boolean** |  | [optional] 
diff --git a/docs/PatchedModelRequest.md b/docs/PatchedModelRequest.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | [optional] 
 **source** | **String** |  | [optional] 
+**viewer360File** | **File** | DEPRECATED: Use &#39;preview_file&#39; instead. | [optional] 
 **worldPosition** | **[Number]** | [x,y,z] array of the position of the local_placement in world coordinates | [optional] 
 **sizeRatio** | **Number** | How many meters a unit represents | [optional] 
 **archived** | **Boolean** |  | [optional] 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -800,7 +800,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'BFX', 'OBJ', 'IFC', 'DXF', 'DAE', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DAE', 'DXF', 'POINT_CLOUD', 'IFC', 'DWG', 'BFX', 'OBJ', 'GLTF'}, 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
@@ -868,7 +868,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'BFX', 'OBJ', 'IFC', 'DXF', 'DAE', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DAE', 'DXF', 'POINT_CLOUD', 'IFC', 'DWG', 'BFX', 'OBJ', 'GLTF'}, 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/api/IfcApi.js b/src/api/IfcApi.js
@@ -10024,7 +10024,7 @@ export default class IfcApi {
      * @param {File} opts.gltfFile 
      * @param {File} opts.gltfWithOpeningsFile 
      * @param {File} opts.bvhTreeFile 
-     * @param {File} opts.viewer360File 
+     * @param {File} opts.previewFile 
      * @param {File} opts.xktFile 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ModelFiles} and HTTP response
      */
@@ -10060,7 +10060,7 @@ export default class IfcApi {
         'gltf_file': opts['gltfFile'],
         'gltf_with_openings_file': opts['gltfWithOpeningsFile'],
         'bvh_tree_file': opts['bvhTreeFile'],
-        'viewer_360_file': opts['viewer360File'],
+        'preview_file': opts['previewFile'],
         'xkt_file': opts['xktFile']
       };
 
@@ -10088,7 +10088,7 @@ export default class IfcApi {
      * @param {File} opts.gltfFile 
      * @param {File} opts.gltfWithOpeningsFile 
      * @param {File} opts.bvhTreeFile 
-     * @param {File} opts.viewer360File 
+     * @param {File} opts.previewFile 
      * @param {File} opts.xktFile 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ModelFiles}
      */
diff --git a/src/api/ModelApi.js b/src/api/ModelApi.js
@@ -9301,7 +9301,7 @@ export default class ModelApi {
      * @param {File} opts.gltfFile 
      * @param {File} opts.gltfWithOpeningsFile 
      * @param {File} opts.bvhTreeFile 
-     * @param {File} opts.viewer360File 
+     * @param {File} opts.previewFile 
      * @param {File} opts.xktFile 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ModelFiles} and HTTP response
      */
@@ -9337,7 +9337,7 @@ export default class ModelApi {
         'gltf_file': opts['gltfFile'],
         'gltf_with_openings_file': opts['gltfWithOpeningsFile'],
         'bvh_tree_file': opts['bvhTreeFile'],
-        'viewer_360_file': opts['viewer360File'],
+        'preview_file': opts['previewFile'],
         'xkt_file': opts['xktFile']
       };
 
@@ -9365,7 +9365,7 @@ export default class ModelApi {
      * @param {File} opts.gltfFile 
      * @param {File} opts.gltfWithOpeningsFile 
      * @param {File} opts.bvhTreeFile 
-     * @param {File} opts.viewer360File 
+     * @param {File} opts.previewFile 
      * @param {File} opts.xktFile 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ModelFiles}
      */
diff --git a/src/model/Model.js b/src/model/Model.js
@@ -37,23 +37,24 @@ class Model {
      * @param mapFile {String} 
      * @param gltfFile {String} 
      * @param bvhTreeFile {String} 
-     * @param viewer360File {String} 
+     * @param previewFile {String} 
+     * @param viewer360File {String} DEPRECATED: Use 'preview_file' instead.
      * @param xktFile {String} 
      * @param projectId {Number} 
      * @param errors {Array.<String>} List of errors that happened during IFC processing
      * @param warnings {Array.<String>} List of warnings that happened during IFC processing
      */
-    constructor(id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, viewer360File, xktFile, projectId, errors, warnings) { 
+    constructor(id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, previewFile, viewer360File, xktFile, projectId, errors, warnings) { 
         
-        Model.initialize(this, id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, viewer360File, xktFile, projectId, errors, warnings);
+        Model.initialize(this, id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, previewFile, viewer360File, xktFile, projectId, errors, warnings);
     }
 
     /**
      * 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, id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, viewer360File, xktFile, projectId, errors, warnings) { 
+    static initialize(obj, id, type, creator, status, createdAt, updatedAt, documentId, document, structureFile, systemsFile, mapFile, gltfFile, bvhTreeFile, previewFile, viewer360File, xktFile, projectId, errors, warnings) { 
         obj['id'] = id;
         obj['type'] = type;
         obj['creator'] = creator;
@@ -67,6 +68,7 @@ class Model {
         obj['map_file'] = mapFile;
         obj['gltf_file'] = gltfFile;
         obj['bvh_tree_file'] = bvhTreeFile;
+        obj['preview_file'] = previewFile;
         obj['viewer_360_file'] = viewer360File;
         obj['xkt_file'] = xktFile;
         obj['project_id'] = projectId;
@@ -130,6 +132,9 @@ class Model {
             if (data.hasOwnProperty('bvh_tree_file')) {
                 obj['bvh_tree_file'] = ApiClient.convertToType(data['bvh_tree_file'], 'String');
             }
+            if (data.hasOwnProperty('preview_file')) {
+                obj['preview_file'] = ApiClient.convertToType(data['preview_file'], 'String');
+            }
             if (data.hasOwnProperty('viewer_360_file')) {
                 obj['viewer_360_file'] = ApiClient.convertToType(data['viewer_360_file'], 'String');
             }
@@ -246,6 +251,12 @@ Model.prototype['gltf_file'] = undefined;
 Model.prototype['bvh_tree_file'] = undefined;
 
 /**
+ * @member {String} preview_file
+ */
+Model.prototype['preview_file'] = undefined;
+
+/**
+ * DEPRECATED: Use 'preview_file' instead.
  * @member {String} viewer_360_file
  */
 Model.prototype['viewer_360_file'] = undefined;
diff --git a/src/model/ModelFiles.js b/src/model/ModelFiles.js
@@ -65,8 +65,8 @@ class ModelFiles {
             if (data.hasOwnProperty('bvh_tree_file')) {
                 obj['bvh_tree_file'] = ApiClient.convertToType(data['bvh_tree_file'], 'String');
             }
-            if (data.hasOwnProperty('viewer_360_file')) {
-                obj['viewer_360_file'] = ApiClient.convertToType(data['viewer_360_file'], 'String');
+            if (data.hasOwnProperty('preview_file')) {
+                obj['preview_file'] = ApiClient.convertToType(data['preview_file'], 'String');
             }
             if (data.hasOwnProperty('xkt_file')) {
                 obj['xkt_file'] = ApiClient.convertToType(data['xkt_file'], 'String');
@@ -109,9 +109,9 @@ ModelFiles.prototype['gltf_with_openings_file'] = undefined;
 ModelFiles.prototype['bvh_tree_file'] = undefined;
 
 /**
- * @member {String} viewer_360_file
+ * @member {String} preview_file
  */
-ModelFiles.prototype['viewer_360_file'] = undefined;
+ModelFiles.prototype['preview_file'] = undefined;
 
 /**
  * @member {String} xkt_file
diff --git a/src/model/ModelRequest.js b/src/model/ModelRequest.js
@@ -22,18 +22,20 @@ class ModelRequest {
     /**
      * Constructs a new <code>ModelRequest</code>.
      * @alias module:model/ModelRequest
+     * @param viewer360File {File} DEPRECATED: Use 'preview_file' instead.
      */
-    constructor() { 
+    constructor(viewer360File) { 
         
-        ModelRequest.initialize(this);
+        ModelRequest.initialize(this, viewer360File);
     }
 
     /**
      * 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) { 
+    static initialize(obj, viewer360File) { 
+        obj['viewer_360_file'] = viewer360File;
     }
 
     /**
@@ -53,6 +55,9 @@ class ModelRequest {
             if (data.hasOwnProperty('source')) {
                 obj['source'] = ApiClient.convertToType(data['source'], 'String');
             }
+            if (data.hasOwnProperty('viewer_360_file')) {
+                obj['viewer_360_file'] = ApiClient.convertToType(data['viewer_360_file'], File);
+            }
             if (data.hasOwnProperty('world_position')) {
                 obj['world_position'] = ApiClient.convertToType(data['world_position'], ['Number']);
             }
@@ -88,6 +93,12 @@ ModelRequest.prototype['name'] = undefined;
  */
 ModelRequest.prototype['source'] = undefined;
 
+/**
+ * DEPRECATED: Use 'preview_file' instead.
+ * @member {File} viewer_360_file
+ */
+ModelRequest.prototype['viewer_360_file'] = undefined;
+
 /**
  * [x,y,z] array of the position of the local_placement in world coordinates
  * @member {Array.<Number>} world_position
diff --git a/src/model/PatchedModelRequest.js b/src/model/PatchedModelRequest.js
@@ -53,6 +53,9 @@ class PatchedModelRequest {
             if (data.hasOwnProperty('source')) {
                 obj['source'] = ApiClient.convertToType(data['source'], 'String');
             }
+            if (data.hasOwnProperty('viewer_360_file')) {
+                obj['viewer_360_file'] = ApiClient.convertToType(data['viewer_360_file'], File);
+            }
             if (data.hasOwnProperty('world_position')) {
                 obj['world_position'] = ApiClient.convertToType(data['world_position'], ['Number']);
             }
@@ -88,6 +91,12 @@ PatchedModelRequest.prototype['name'] = undefined;
  */
 PatchedModelRequest.prototype['source'] = undefined;
 
+/**
+ * DEPRECATED: Use 'preview_file' instead.
+ * @member {File} viewer_360_file
+ */
+PatchedModelRequest.prototype['viewer_360_file'] = undefined;
+
 /**
  * [x,y,z] array of the position of the local_placement in world coordinates
  * @member {Array.<Number>} world_position
diff --git a/test/model/Model.spec.js b/test/model/Model.spec.js
@@ -144,6 +144,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property previewFile (base name: "preview_file")', function() {
+      // uncomment below and update the code to test the property previewFile
+      //var instance = new bimdata.Model();
+      //expect(instance).to.be();
+    });
+
     it('should have the property viewer360File (base name: "viewer_360_file")', function() {
       // uncomment below and update the code to test the property viewer360File
       //var instance = new bimdata.Model();
diff --git a/test/model/ModelFiles.spec.js b/test/model/ModelFiles.spec.js
@@ -90,8 +90,8 @@
       //expect(instance).to.be();
     });
 
-    it('should have the property viewer360File (base name: "viewer_360_file")', function() {
-      // uncomment below and update the code to test the property viewer360File
+    it('should have the property previewFile (base name: "preview_file")', function() {
+      // uncomment below and update the code to test the property previewFile
       //var instance = new bimdata.ModelFiles();
       //expect(instance).to.be();
     });
diff --git a/test/model/ModelRequest.spec.js b/test/model/ModelRequest.spec.js
@@ -66,6 +66,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property viewer360File (base name: "viewer_360_file")', function() {
+      // uncomment below and update the code to test the property viewer360File
+      //var instance = new bimdata.ModelRequest();
+      //expect(instance).to.be();
+    });
+
     it('should have the property worldPosition (base name: "world_position")', function() {
       // uncomment below and update the code to test the property worldPosition
       //var instance = new bimdata.ModelRequest();
diff --git a/test/model/PatchedModelRequest.spec.js b/test/model/PatchedModelRequest.spec.js
@@ -66,6 +66,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property viewer360File (base name: "viewer_360_file")', function() {
+      // uncomment below and update the code to test the property viewer360File
+      //var instance = new bimdata.PatchedModelRequest();
+      //expect(instance).to.be();
+    });
+
     it('should have the property worldPosition (base name: "world_position")', function() {
       // uncomment below and update the code to test the property worldPosition
       //var instance = new bimdata.PatchedModelRequest();
