PATCH: add head_id field to Document serializer (#669)

Author: Bimdata-io

docs/CollaborationApi.md

@@ -956,7 +956,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'GLTF', 'POINT_CLOUD', 'DWG', 'OBJ', 'IFC', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'GLTF', 'DXF', 'POINT_CLOUD', 'OBJ', 'IFC', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/Document.md

@@ -20,8 +20,9 @@ Name | Type | Description | Notes
 **modelId** | **Number** |  | [readonly] 
 **modelType** | **String** | Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD | [readonly] 
 **ifcId** | **Number** | DEPRECATED: Use 'model_id' instead. | [readonly] 
-**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
+**headId** | **Number** | Document id of head version | [readonly] 
 **isHeadVersion** | **Boolean** | Document is a head of version or is owned by another document | [readonly] 
+**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **officePreview** | **String** | Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt | [readonly] 
 
 

src/api/CollaborationApi.js

@@ -859,7 +859,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'GLTF', 'POINT_CLOUD', 'DWG', 'OBJ', 'IFC', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DXF', 'POINT_CLOUD', 'OBJ', 'IFC', '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
@@ -925,7 +925,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'GLTF', 'POINT_CLOUD', 'DWG', 'OBJ', 'IFC', 'DXF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DXF', 'POINT_CLOUD', 'OBJ', 'IFC', '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

src/model/Document.js

@@ -38,21 +38,22 @@ class Document {
      * @param modelId {Number} 
      * @param modelType {module:model/Document.ModelTypeEnum} Model's type. Values can be IFC, DWG, DXF, GLTF, PDF, JPEG, PNG, OBJ, POINT_CLOUD
      * @param ifcId {Number} DEPRECATED: Use 'model_id' instead.
-     * @param userPermission {module:model/Document.UserPermissionEnum} Aggregate of group user permissions and folder default permission
+     * @param headId {Number} Document id of head version
      * @param isHeadVersion {Boolean} Document is a head of version or is owned by another document
+     * @param userPermission {module:model/Document.UserPermissionEnum} Aggregate of group user permissions and folder default permission
      * @param officePreview {String} Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
      */
-    constructor(id, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, userPermission, isHeadVersion, officePreview) { 
+    constructor(id, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, headId, isHeadVersion, userPermission, officePreview) { 
 
-        Document.initialize(this, id, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, userPermission, isHeadVersion, officePreview);
+        Document.initialize(this, id, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, headId, isHeadVersion, userPermission, officePreview);
     }
 
     /**
      * 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, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, userPermission, isHeadVersion, officePreview) { 
+    static initialize(obj, id, createdBy, project, name, file, size, tags, visas, createdAt, updatedAt, modelId, modelType, ifcId, headId, isHeadVersion, userPermission, officePreview) { 
         obj['id'] = id;
         obj['created_by'] = createdBy;
         obj['project'] = project;
@@ -66,8 +67,9 @@ class Document {
         obj['model_id'] = modelId;
         obj['model_type'] = modelType;
         obj['ifc_id'] = ifcId;
-        obj['user_permission'] = userPermission;
+        obj['head_id'] = headId;
         obj['is_head_version'] = isHeadVersion;
+        obj['user_permission'] = userPermission;
         obj['office_preview'] = officePreview;
     }
 
@@ -130,12 +132,15 @@ class Document {
             if (data.hasOwnProperty('ifc_id')) {
                 obj['ifc_id'] = ApiClient.convertToType(data['ifc_id'], 'Number');
             }
-            if (data.hasOwnProperty('user_permission')) {
-                obj['user_permission'] = ApiClient.convertToType(data['user_permission'], 'Number');
+            if (data.hasOwnProperty('head_id')) {
+                obj['head_id'] = ApiClient.convertToType(data['head_id'], 'Number');
             }
             if (data.hasOwnProperty('is_head_version')) {
                 obj['is_head_version'] = ApiClient.convertToType(data['is_head_version'], 'Boolean');
             }
+            if (data.hasOwnProperty('user_permission')) {
+                obj['user_permission'] = ApiClient.convertToType(data['user_permission'], 'Number');
+            }
             if (data.hasOwnProperty('office_preview')) {
                 obj['office_preview'] = ApiClient.convertToType(data['office_preview'], 'String');
             }
@@ -235,17 +240,23 @@ Document.prototype['model_type'] = undefined;
 Document.prototype['ifc_id'] = undefined;
 
 /**
- * Aggregate of group user permissions and folder default permission
- * @member {module:model/Document.UserPermissionEnum} user_permission
+ * Document id of head version
+ * @member {Number} head_id
  */
-Document.prototype['user_permission'] = undefined;
+Document.prototype['head_id'] = undefined;
 
 /**
  * Document is a head of version or is owned by another document
  * @member {Boolean} is_head_version
  */
 Document.prototype['is_head_version'] = undefined;
 
+/**
+ * Aggregate of group user permissions and folder default permission
+ * @member {module:model/Document.UserPermissionEnum} user_permission
+ */
+Document.prototype['user_permission'] = undefined;
+
 /**
  * Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt
  * @member {String} office_preview

test/model/Document.spec.js

@@ -150,8 +150,8 @@
       //expect(instance).to.be();
     });
 
-    it('should have the property userPermission (base name: "user_permission")', function() {
-      // uncomment below and update the code to test the property userPermission
+    it('should have the property headId (base name: "head_id")', function() {
+      // uncomment below and update the code to test the property headId
       //var instance = new bimdata.Document();
       //expect(instance).to.be();
     });
@@ -162,6 +162,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property userPermission (base name: "user_permission")', function() {
+      // uncomment below and update the code to test the property userPermission
+      //var instance = new bimdata.Document();
+      //expect(instance).to.be();
+    });
+
     it('should have the property officePreview (base name: "office_preview")', function() {
       // uncomment below and update the code to test the property officePreview
       //var instance = new bimdata.Document();