PATCH: added missing value (client name) to User Invitation Serializer (#590)

Bimdata-io · Bimdata-io · commit d9bc24e3093c · 2022-11-16T09:49:23.000Z
diff --git a/docs/BcfApi.md b/docs/BcfApi.md
@@ -1185,7 +1185,7 @@ Bearer.apiKey = 'YOUR API KEY';
 let apiInstance = new bimdata.BcfApi();
 let id = 56; // Number | A unique integer value identifying this project.
 let opts = {
-  'format': "format_example", // String | topic format to export, comma separated. Default = all
+  'format': "format_example", // String | topic format to export, comma separated. Default = standard
   'topics': "topics_example" // String | topic guids to export, comma separated. Default = all
 };
 apiInstance.downloadBcfExport(id, opts).then((data) => {
@@ -1202,7 +1202,7 @@ apiInstance.downloadBcfExport(id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **Number**| A unique integer value identifying this project. | 
- **format** | **String**| topic format to export, comma separated. Default &#x3D; all | [optional] 
+ **format** | **String**| topic format to export, comma separated. Default &#x3D; standard | [optional] 
  **topics** | **String**| topic guids to export, comma separated. Default &#x3D; all | [optional] 
 
 ### Return type
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;POINT_CLOUD&#39;, &#39;DWG&#39;, &#39;DXF&#39;, &#39;DAE&#39;, &#39;OBJ&#39;, &#39;BFX&#39;, &#39;GLTF&#39;, &#39;IFC&#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;GLTF&#39;, &#39;DWG&#39;, &#39;DXF&#39;, &#39;DAE&#39;, &#39;OBJ&#39;, &#39;POINT_CLOUD&#39;, &#39;BFX&#39;, &#39;IFC&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/FullTopic.md b/docs/FullTopic.md
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **priority** | **String** |  | [optional] 
 **index** | **Number** |  | [optional] 
 **assignedTo** | **String** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **dueDate** | **Date** |  | [optional] 
 **comments** | [**[Comment]**](Comment.md) |  | [optional] 
 **viewpoints** | [**[Viewpoint]**](Viewpoint.md) |  | [optional] 
diff --git a/docs/FullTopicRequest.md b/docs/FullTopicRequest.md
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **priority** | **String** |  | [optional] 
 **index** | **Number** |  | [optional] 
 **assignedTo** | **String** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **dueDate** | **Date** |  | [optional] 
 **comments** | [**[CommentRequest]**](CommentRequest.md) |  | [optional] 
 **viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) |  | [optional] 
diff --git a/docs/PatchedFullTopicRequest.md b/docs/PatchedFullTopicRequest.md
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **priority** | **String** |  | [optional] 
 **index** | **Number** |  | [optional] 
 **assignedTo** | **String** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **dueDate** | **Date** |  | [optional] 
 **comments** | [**[CommentRequest]**](CommentRequest.md) |  | [optional] 
 **viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) |  | [optional] 
diff --git a/docs/PatchedTopicRequest.md b/docs/PatchedTopicRequest.md
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **dueDate** | **Date** |  | [optional] 
 **ifcs** | **[Number]** | DEPRECATED: Use &#39;models&#39; instead | [optional] 
 **models** | **[Number]** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **project** | **Number** |  | [optional] 
 
diff --git a/docs/Topic.md b/docs/Topic.md
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
 **dueDate** | **Date** |  | [optional] 
 **ifcs** | **[Number]** | DEPRECATED: Use &#39;models&#39; instead | [optional] 
 **models** | **[Number]** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **project** | **Number** |  | 
 
diff --git a/docs/TopicRequest.md b/docs/TopicRequest.md
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **dueDate** | **Date** |  | [optional] 
 **ifcs** | **[Number]** | DEPRECATED: Use &#39;models&#39; instead | [optional] 
 **models** | **[Number]** |  | [optional] 
-**format** | **String** |  | [optional] 
+**format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **project** | **Number** |  | 
 
diff --git a/docs/UserInvitation.md b/docs/UserInvitation.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **projectId** | **Number** |  | [readonly] 
 **projectName** | **String** |  | [optional] 
 **status** | **String** |          A: Accepted         D: Denied         P: Pending          | [optional] 
+**clientName** | **String** |  | 
 **sender** | [**User**](User.md) |  | 
 **createdAt** | **Date** |  | [readonly] 
 **respondedAt** | **Date** |  | [optional] 
diff --git a/src/api/BcfApi.js b/src/api/BcfApi.js
@@ -1042,7 +1042,7 @@ export default class BcfApi {
      * This is not a standard route. Export project's topics in bcf-xml format  Required scopes: bcf:read
      * @param {Number} id A unique integer value identifying this project.
      * @param {Object} opts Optional parameters
-     * @param {String} opts.format topic format to export, comma separated. Default = all
+     * @param {String} opts.format topic format to export, comma separated. Default = standard
      * @param {String} opts.topics topic guids to export, comma separated. Default = all
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link File} and HTTP response
      */
@@ -1082,7 +1082,7 @@ export default class BcfApi {
      * This is not a standard route. Export project's topics in bcf-xml format  Required scopes: bcf:read
      * @param {Number} id A unique integer value identifying this project.
      * @param {Object} opts Optional parameters
-     * @param {String} opts.format topic format to export, comma separated. Default = all
+     * @param {String} opts.format topic format to export, comma separated. Default = standard
      * @param {String} opts.topics topic guids to export, comma separated. Default = all
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
      */
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 {'POINT_CLOUD', 'DWG', 'DXF', 'DAE', 'OBJ', 'BFX', 'GLTF', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'DAE', 'OBJ', 'POINT_CLOUD', 'BFX', 'IFC'}, 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 {'POINT_CLOUD', 'DWG', 'DXF', 'DAE', 'OBJ', 'BFX', 'GLTF', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'GLTF', 'DWG', 'DXF', 'DAE', 'OBJ', 'POINT_CLOUD', 'BFX', 'IFC'}, 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/FullTopic.js b/src/model/FullTopic.js
@@ -215,6 +215,7 @@ FullTopic.prototype['index'] = undefined;
 FullTopic.prototype['assigned_to'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 FullTopic.prototype['format'] = undefined;
diff --git a/src/model/FullTopicRequest.js b/src/model/FullTopicRequest.js
@@ -205,6 +205,7 @@ FullTopicRequest.prototype['index'] = undefined;
 FullTopicRequest.prototype['assigned_to'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 FullTopicRequest.prototype['format'] = undefined;
diff --git a/src/model/PatchedFullTopicRequest.js b/src/model/PatchedFullTopicRequest.js
@@ -201,6 +201,7 @@ PatchedFullTopicRequest.prototype['index'] = undefined;
 PatchedFullTopicRequest.prototype['assigned_to'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 PatchedFullTopicRequest.prototype['format'] = undefined;
diff --git a/src/model/PatchedTopicRequest.js b/src/model/PatchedTopicRequest.js
@@ -193,6 +193,7 @@ PatchedTopicRequest.prototype['ifcs'] = undefined;
 PatchedTopicRequest.prototype['models'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 PatchedTopicRequest.prototype['format'] = undefined;
diff --git a/src/model/Topic.js b/src/model/Topic.js
@@ -207,6 +207,7 @@ Topic.prototype['ifcs'] = undefined;
 Topic.prototype['models'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 Topic.prototype['format'] = undefined;
diff --git a/src/model/TopicRequest.js b/src/model/TopicRequest.js
@@ -197,6 +197,7 @@ TopicRequest.prototype['ifcs'] = undefined;
 TopicRequest.prototype['models'] = undefined;
 
 /**
+ *          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \"standard\".         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \"standard\" format.         
  * @member {String} format
  */
 TopicRequest.prototype['format'] = undefined;
diff --git a/src/model/UserInvitation.js b/src/model/UserInvitation.js
@@ -28,25 +28,27 @@ class UserInvitation {
      * @param cloudId {Number} 
      * @param cloudName {String} 
      * @param projectId {Number} 
+     * @param clientName {String} 
      * @param sender {module:model/User} 
      * @param createdAt {Date} 
      */
-    constructor(id, redirectUri, cloudId, cloudName, projectId, sender, createdAt) { 
+    constructor(id, redirectUri, cloudId, cloudName, projectId, clientName, sender, createdAt) { 
         
-        UserInvitation.initialize(this, id, redirectUri, cloudId, cloudName, projectId, sender, createdAt);
+        UserInvitation.initialize(this, id, redirectUri, cloudId, cloudName, projectId, clientName, sender, 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, id, redirectUri, cloudId, cloudName, projectId, sender, createdAt) { 
+    static initialize(obj, id, redirectUri, cloudId, cloudName, projectId, clientName, sender, createdAt) { 
         obj['id'] = id;
         obj['redirect_uri'] = redirectUri;
         obj['cloud_id'] = cloudId;
         obj['cloud_name'] = cloudName;
         obj['project_id'] = projectId;
+        obj['client_name'] = clientName;
         obj['sender'] = sender;
         obj['created_at'] = createdAt;
     }
@@ -83,6 +85,9 @@ class UserInvitation {
             if (data.hasOwnProperty('status')) {
                 obj['status'] = ApiClient.convertToType(data['status'], 'String');
             }
+            if (data.hasOwnProperty('client_name')) {
+                obj['client_name'] = ApiClient.convertToType(data['client_name'], 'String');
+            }
             if (data.hasOwnProperty('sender')) {
                 obj['sender'] = User.constructFromObject(data['sender']);
             }
@@ -136,6 +141,11 @@ UserInvitation.prototype['project_name'] = undefined;
  */
 UserInvitation.prototype['status'] = undefined;
 
+/**
+ * @member {String} client_name
+ */
+UserInvitation.prototype['client_name'] = undefined;
+
 /**
  * @member {module:model/User} sender
  */
diff --git a/test/model/UserInvitation.spec.js b/test/model/UserInvitation.spec.js
@@ -96,6 +96,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property clientName (base name: "client_name")', function() {
+      // uncomment below and update the code to test the property clientName
+      //var instance = new bimdata.UserInvitation();
+      //expect(instance).to.be();
+    });
+
     it('should have the property sender (base name: "sender")', function() {
       // uncomment below and update the code to test the property sender
       //var instance = new bimdata.UserInvitation();
