PATCH: fix BCF projects serialization

Bimdata-io · Bimdata-io · commit f2ce2ea25ae7 · 2021-01-26T16:07:37.000Z
diff --git a/README.md b/README.md
@@ -237,7 +237,7 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**getClassifications**](docs/CollaborationApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
 *bimdata.CollaborationApi* | [**getCloud**](docs/CollaborationApi.md#getCloud) | **GET** /cloud/{id} | Retrieve one cloud
 *bimdata.CollaborationApi* | [**getCloudInvitations**](docs/CollaborationApi.md#getCloudInvitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
-*bimdata.CollaborationApi* | [**getCloudSize**](docs/CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all files in the cloud
+*bimdata.CollaborationApi* | [**getCloudSize**](docs/CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all ifc files in the cloud
 *bimdata.CollaborationApi* | [**getCloudUser**](docs/CollaborationApi.md#getCloudUser) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
 *bimdata.CollaborationApi* | [**getCloudUsers**](docs/CollaborationApi.md#getCloudUsers) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
 *bimdata.CollaborationApi* | [**getClouds**](docs/CollaborationApi.md#getClouds) | **GET** /cloud | Retrieve all clouds
@@ -413,7 +413,6 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [bimdata.BcfProject](docs/BcfProject.md)
- - [bimdata.BcfUser](docs/BcfUser.md)
  - [bimdata.CheckPlan](docs/CheckPlan.md)
  - [bimdata.CheckerResult](docs/CheckerResult.md)
  - [bimdata.Classification](docs/Classification.md)
diff --git a/docs/BcfApi.md b/docs/BcfApi.md
@@ -460,7 +460,7 @@ null (empty response body)
 
 ## downloadBcfExport
 
-> downloadBcfExport(id, opts)
+> File downloadBcfExport(id, opts)
 
 Export project&#39;s topics in bcf-xml format
 
@@ -489,8 +489,8 @@ let opts = {
   'topics': "topics_example", // String | topic guids to export, comma separated. Default = all
   'format': "format_example" // String | topic format to export, comma separated. Default = all
 };
-apiInstance.downloadBcfExport(id, opts).then(() => {
-  console.log('API called successfully.');
+apiInstance.downloadBcfExport(id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
   console.error(error);
 });
@@ -508,7 +508,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-null (empty response body)
+**File**
 
 ### Authorization
 
@@ -517,7 +517,7 @@ null (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## fullUpdateBcfProject
@@ -1588,7 +1588,7 @@ Name | Type | Description  | Notes
 
 Get current user info
 
-Get current user info Required scopes: bcf:read
+Get current user info. If request comes from an App, the response is always:         {             \&quot;id\&quot;: None,             \&quot;name\&quot;: None,             \&quot;is_client\&quot;: True,         } Required scopes: bcf:read
 
 ### Example
 
diff --git a/docs/BcfProject.md b/docs/BcfProject.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [optional] [readonly] 
+**projectId** | **String** |  | [optional] [readonly] 
 **name** | **String** | Name of the project | 
 
 
diff --git a/docs/BcfUser.md b/docs/BcfUser.md
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -35,7 +35,7 @@ Method | HTTP request | Description
 [**getClassifications**](CollaborationApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
 [**getCloud**](CollaborationApi.md#getCloud) | **GET** /cloud/{id} | Retrieve one cloud
 [**getCloudInvitations**](CollaborationApi.md#getCloudInvitations) | **GET** /cloud/{cloud_pk}/invitation | Retrieve all pending invitations in the cloud
-[**getCloudSize**](CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all files in the cloud
+[**getCloudSize**](CollaborationApi.md#getCloudSize) | **GET** /cloud/{id}/size | Get size of all ifc files in the cloud
 [**getCloudUser**](CollaborationApi.md#getCloudUser) | **GET** /cloud/{cloud_pk}/user/{id} | Retrieve a user in a cloud
 [**getCloudUsers**](CollaborationApi.md#getCloudUsers) | **GET** /cloud/{cloud_pk}/user | Retrieve all users in a cloud, or a list with a filter by email
 [**getClouds**](CollaborationApi.md#getClouds) | **GET** /cloud | Retrieve all clouds
@@ -1941,7 +1941,7 @@ Name | Type | Description  | Notes
 
 > Number getCloudSize(id)
 
-Get size of all files in the cloud
+Get size of all ifc files in the cloud
 
 Returns the size of the cloud in Bytes
 
diff --git a/docs/Comment.md b/docs/Comment.md
@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [optional] 
 **_date** | **Date** |  | [optional] 
-**author** | **String** |  | [optional] [readonly] 
+**author** | **String** |  | [optional] 
 **comment** | **String** |  | [optional] 
 **viewpointGuid** | **String** |  | [optional] 
 **replyToCommentGuid** | **String** |  | [optional] 
 **topicGuid** | **String** |  | [optional] [readonly] 
-**modifiedAuthor** | **String** |  | [optional] [readonly] 
+**modifiedAuthor** | **String** |  | [optional] 
 **modifiedDate** | **Date** |  | [optional] [readonly] 
 **viewpointTempId** | **Number** | Only used when using POST on the full-topic route to bind viewpoint with comment | [optional] 
 
diff --git a/docs/FullTopic.md b/docs/FullTopic.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [optional] 
 **creationDate** | **Date** |  | [optional] 
-**creationAuthor** | **String** |  | [optional] [readonly] 
+**creationAuthor** | **String** |  | [optional] 
 **modifiedDate** | **Date** |  | [optional] [readonly] 
-**modifiedAuthor** | **String** |  | [optional] [readonly] 
+**modifiedAuthor** | **String** |  | [optional] 
 **title** | **String** |  | 
 **description** | **String** |  | [optional] 
 **referenceLinks** | **[String]** |  | [optional] 
diff --git a/docs/Organization.md b/docs/Organization.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [optional] [readonly] 
 **name** | **String** | Name of the organization | 
-**isPersonnal** | **Boolean** |  | [optional] 
+**isPersonnal** | **Boolean** |  | [optional] [readonly] 
 
 
diff --git a/docs/SelfBcfUser.md b/docs/SelfBcfUser.md
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **id** | **String** |  | 
 **name** | **String** |  | [optional] [readonly] 
 **email** | **String** |  | 
+**isClient** | **Boolean** |  | [optional] [readonly] 
 
 
diff --git a/docs/Topic.md b/docs/Topic.md
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 **priority** | **String** |  | [optional] 
 **labels** | **[String]** |  | [optional] 
 **creationDate** | **Date** |  | [optional] 
-**creationAuthor** | **String** |  | [optional] [readonly] 
+**creationAuthor** | **String** |  | [optional] 
 **modifiedDate** | **Date** |  | [optional] [readonly] 
-**modifiedAuthor** | **String** |  | [optional] [readonly] 
+**modifiedAuthor** | **String** |  | [optional] 
 **assignedTo** | **String** |  | [optional] 
 **referenceLinks** | **[String]** |  | [optional] 
 **stage** | **String** |  | [optional] 
diff --git a/src/api/BcfApi.js b/src/api/BcfApi.js
@@ -460,7 +460,7 @@ export default class BcfApi {
      * @param {Object} opts Optional parameters
      * @param {String} opts.topics topic guids to export, comma separated. Default = all
      * @param {String} opts.format topic format to export, comma separated. Default = all
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link File} and HTTP response
      */
     downloadBcfExportWithHttpInfo(id, opts) {
       opts = opts || {};
@@ -484,8 +484,8 @@ export default class BcfApi {
 
       let authNames = ['Bearer', 'bimdata_connect', 'client_credentials'];
       let contentTypes = [];
-      let accepts = [];
-      let returnType = null;
+      let accepts = ['application/json'];
+      let returnType = File;
       return this.apiClient.callApi(
         '/bcf/2.1/projects/{id}/export', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
@@ -500,7 +500,7 @@ export default class BcfApi {
      * @param {Object} opts Optional parameters
      * @param {String} opts.topics topic guids to export, comma separated. Default = all
      * @param {String} opts.format topic format to export, comma separated. Default = all
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
      */
     downloadBcfExport(id, opts) {
       return this.downloadBcfExportWithHttpInfo(id, opts)
@@ -1543,7 +1543,7 @@ export default class BcfApi {
 
     /**
      * Get current user info
-     * Get current user info Required scopes: bcf:read
+     * Get current user info. If request comes from an App, the response is always:         {             \"id\": None,             \"name\": None,             \"is_client\": True,         } Required scopes: bcf:read
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SelfBcfUser} and HTTP response
      */
     getUserWithHttpInfo() {
@@ -1571,7 +1571,7 @@ export default class BcfApi {
 
     /**
      * Get current user info
-     * Get current user info Required scopes: bcf:read
+     * Get current user info. If request comes from an App, the response is always:         {             \"id\": None,             \"name\": None,             \"is_client\": True,         } Required scopes: bcf:read
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SelfBcfUser}
      */
     getUser() {
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -1926,7 +1926,7 @@ export default class CollaborationApi {
 
 
     /**
-     * Get size of all files in the cloud
+     * Get size of all ifc files in the cloud
      * Returns the size of the cloud in Bytes
      * @param {Number} id A unique integer value identifying this cloud.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Number} and HTTP response
@@ -1960,7 +1960,7 @@ export default class CollaborationApi {
     }
 
     /**
-     * Get size of all files in the cloud
+     * Get size of all ifc files in the cloud
      * Returns the size of the cloud in Bytes
      * @param {Number} id A unique integer value identifying this cloud.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Number}
diff --git a/src/index.js b/src/index.js
@@ -14,7 +14,6 @@
 
 import ApiClient from './ApiClient';
 import BcfProject from './model/BcfProject';
-import BcfUser from './model/BcfUser';
 import CheckPlan from './model/CheckPlan';
 import CheckerResult from './model/CheckerResult';
 import Classification from './model/Classification';
@@ -150,12 +149,6 @@ export {
      */
     BcfProject,
 
-    /**
-     * The BcfUser model constructor.
-     * @property {module:model/BcfUser}
-     */
-    BcfUser,
-
     /**
      * The CheckPlan model constructor.
      * @property {module:model/CheckPlan}
diff --git a/src/model/BcfProject.js b/src/model/BcfProject.js
@@ -52,6 +52,9 @@ class BcfProject {
             if (data.hasOwnProperty('id')) {
                 obj['id'] = ApiClient.convertToType(data['id'], 'Number');
             }
+            if (data.hasOwnProperty('project_id')) {
+                obj['project_id'] = ApiClient.convertToType(data['project_id'], 'String');
+            }
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
@@ -67,6 +70,11 @@ class BcfProject {
  */
 BcfProject.prototype['id'] = undefined;
 
+/**
+ * @member {String} project_id
+ */
+BcfProject.prototype['project_id'] = undefined;
+
 /**
  * Name of the project
  * @member {String} name
diff --git a/src/model/SelfBcfUser.js b/src/model/SelfBcfUser.js
@@ -60,6 +60,9 @@ class SelfBcfUser {
             if (data.hasOwnProperty('email')) {
                 obj['email'] = ApiClient.convertToType(data['email'], 'String');
             }
+            if (data.hasOwnProperty('is_client')) {
+                obj['is_client'] = ApiClient.convertToType(data['is_client'], 'Boolean');
+            }
         }
         return obj;
     }
@@ -82,6 +85,11 @@ SelfBcfUser.prototype['name'] = undefined;
  */
 SelfBcfUser.prototype['email'] = undefined;
 
+/**
+ * @member {Boolean} is_client
+ */
+SelfBcfUser.prototype['is_client'] = undefined;
+
 
 
 
diff --git a/test/model/BcfProject.spec.js b/test/model/BcfProject.spec.js
@@ -60,6 +60,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property projectId (base name: "project_id")', function() {
+      // uncomment below and update the code to test the property projectId
+      //var instane = new bimdata.BcfProject();
+      //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
       //var instane = new bimdata.BcfProject();
diff --git a/test/model/BcfUser.spec.js b/test/model/BcfUser.spec.js
diff --git a/test/model/SelfBcfUser.spec.js b/test/model/SelfBcfUser.spec.js
@@ -72,6 +72,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property isClient (base name: "is_client")', function() {
+      // uncomment below and update the code to test the property isClient
+      //var instane = new bimdata.SelfBcfUser();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));
