PATCH: add group short name. (#920)

Bimdata-io · Bimdata-io · commit 8011414b8887 · 2025-11-06T15:04:27.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;POINT_CLOUD&#39;, &#39;DXF&#39;, &#39;OBJ&#39;, &#39;DWG&#39;, &#39;IFC&#39;, &#39;PHOTOSPHERE&#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;PHOTOSPHERE&#39;, &#39;GLTF&#39;, &#39;IFC&#39;, &#39;DWG&#39;, &#39;POINT_CLOUD&#39;, &#39;DXF&#39;, &#39;OBJ&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/DocumentText.md b/docs/DocumentText.md
@@ -6,13 +6,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
-**language** | **String** | * &#x60;french&#x60; - french * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english * &#x60;spanish&#x60; - spanish * &#x60;german&#x60; - german | [optional] 
+**language** | **String** | * &#x60;german&#x60; - german * &#x60;french&#x60; - french * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english * &#x60;spanish&#x60; - spanish | [optional] 
 
 
 
 ## Enum: LanguageEnum
 
 
+* `german` (value: `"german"`)
+
 * `french` (value: `"french"`)
 
 * `italian` (value: `"italian"`)
@@ -21,8 +23,6 @@ Name | Type | Description | Notes
 
 * `spanish` (value: `"spanish"`)
 
-* `german` (value: `"german"`)
-
 * `null` (value: `"null"`)
 
 
diff --git a/docs/Group.md b/docs/Group.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **name** | **String** | Full name of the group | 
+**shortName** | **String** | Short name of the group | [optional] 
 **color** | **String** |  | [optional] 
 **members** | [**[UserProject]**](UserProject.md) |  | [readonly] 
 
diff --git a/docs/GroupRequest.md b/docs/GroupRequest.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Full name of the group | 
+**shortName** | **String** | Short name of the group | [optional] 
 **color** | **String** |  | [optional] 
 
 
diff --git a/docs/PatchedDocumentTextRequest.md b/docs/PatchedDocumentTextRequest.md
@@ -5,13 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
-**language** | **String** | * &#x60;french&#x60; - french * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english * &#x60;spanish&#x60; - spanish * &#x60;german&#x60; - german | [optional] 
+**language** | **String** | * &#x60;german&#x60; - german * &#x60;french&#x60; - french * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english * &#x60;spanish&#x60; - spanish | [optional] 
 
 
 
 ## Enum: LanguageEnum
 
 
+* `german` (value: `"german"`)
+
 * `french` (value: `"french"`)
 
 * `italian` (value: `"italian"`)
@@ -20,8 +22,6 @@ Name | Type | Description | Notes
 
 * `spanish` (value: `"spanish"`)
 
-* `german` (value: `"german"`)
-
 * `null` (value: `"null"`)
 
 
diff --git a/docs/PatchedGroupRequest.md b/docs/PatchedGroupRequest.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Full name of the group | [optional] 
+**shortName** | **String** | Short name of the group | [optional] 
 **color** | **String** |  | [optional] 
 
 
diff --git a/docs/WriteFolder.md b/docs/WriteFolder.md
@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**createdAt** | **Date** | Creation date | [readonly] 
+**id** | **Number** |  | [readonly] 
 **createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
-**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
-**name** | **String** | Name of the folder | 
 **type** | **String** | DEPRECATED: Use &#39;nature&#39; instead. Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
+**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
+**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
-**id** | **Number** |  | [readonly] 
 **parentId** | **Number** |  | [optional] 
-**updatedAt** | **Date** | Date of the last update | [readonly] 
-**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**createdAt** | **Date** | Creation date | [readonly] 
+**name** | **String** | Name of the folder | 
 **nature** | **String** | Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
+**updatedAt** | **Date** | Date of the last update | [readonly] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [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** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -868,7 +868,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'PHOTOSPHERE', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', 'DXF', 'OBJ'}, 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
@@ -936,7 +936,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'OBJ', 'DWG', 'IFC', 'PHOTOSPHERE', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'PHOTOSPHERE', 'GLTF', 'IFC', 'DWG', 'POINT_CLOUD', 'DXF', 'OBJ'}, 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/DocumentText.js b/src/model/DocumentText.js
@@ -77,7 +77,7 @@ DocumentText.prototype['id'] = undefined;
 DocumentText.prototype['text'] = undefined;
 
 /**
- * * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german
+ * * `german` - german * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish
  * @member {module:model/DocumentText.LanguageEnum} language
  */
 DocumentText.prototype['language'] = undefined;
@@ -93,6 +93,12 @@ DocumentText.prototype['language'] = undefined;
  */
 DocumentText['LanguageEnum'] = {
 
+    /**
+     * value: "german"
+     * @const
+     */
+    "german": "german",
+
     /**
      * value: "french"
      * @const
@@ -117,12 +123,6 @@ DocumentText['LanguageEnum'] = {
      */
     "spanish": "spanish",
 
-    /**
-     * value: "german"
-     * @const
-     */
-    "german": "german",
-
     /**
      * value: "null"
      * @const
diff --git a/src/model/Group.js b/src/model/Group.js
@@ -60,6 +60,9 @@ class Group {
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
+            if (data.hasOwnProperty('short_name')) {
+                obj['short_name'] = ApiClient.convertToType(data['short_name'], 'String');
+            }
             if (data.hasOwnProperty('color')) {
                 obj['color'] = ApiClient.convertToType(data['color'], 'String');
             }
@@ -84,6 +87,12 @@ Group.prototype['id'] = undefined;
  */
 Group.prototype['name'] = undefined;
 
+/**
+ * Short name of the group
+ * @member {String} short_name
+ */
+Group.prototype['short_name'] = undefined;
+
 /**
  * @member {String} color
  */
diff --git a/src/model/GroupRequest.js b/src/model/GroupRequest.js
@@ -52,6 +52,9 @@ class GroupRequest {
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
+            if (data.hasOwnProperty('short_name')) {
+                obj['short_name'] = ApiClient.convertToType(data['short_name'], 'String');
+            }
             if (data.hasOwnProperty('color')) {
                 obj['color'] = ApiClient.convertToType(data['color'], 'String');
             }
@@ -68,6 +71,12 @@ class GroupRequest {
  */
 GroupRequest.prototype['name'] = undefined;
 
+/**
+ * Short name of the group
+ * @member {String} short_name
+ */
+GroupRequest.prototype['short_name'] = undefined;
+
 /**
  * @member {String} color
  */
diff --git a/src/model/PatchedDocumentTextRequest.js b/src/model/PatchedDocumentTextRequest.js
@@ -67,7 +67,7 @@ class PatchedDocumentTextRequest {
 PatchedDocumentTextRequest.prototype['text'] = undefined;
 
 /**
- * * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish * `german` - german
+ * * `german` - german * `french` - french * `italian` - italian * `english` - english * `spanish` - spanish
  * @member {module:model/PatchedDocumentTextRequest.LanguageEnum} language
  */
 PatchedDocumentTextRequest.prototype['language'] = undefined;
@@ -83,6 +83,12 @@ PatchedDocumentTextRequest.prototype['language'] = undefined;
  */
 PatchedDocumentTextRequest['LanguageEnum'] = {
 
+    /**
+     * value: "german"
+     * @const
+     */
+    "german": "german",
+
     /**
      * value: "french"
      * @const
@@ -107,12 +113,6 @@ PatchedDocumentTextRequest['LanguageEnum'] = {
      */
     "spanish": "spanish",
 
-    /**
-     * value: "german"
-     * @const
-     */
-    "german": "german",
-
     /**
      * value: "null"
      * @const
diff --git a/src/model/PatchedGroupRequest.js b/src/model/PatchedGroupRequest.js
@@ -50,6 +50,9 @@ class PatchedGroupRequest {
             if (data.hasOwnProperty('name')) {
                 obj['name'] = ApiClient.convertToType(data['name'], 'String');
             }
+            if (data.hasOwnProperty('short_name')) {
+                obj['short_name'] = ApiClient.convertToType(data['short_name'], 'String');
+            }
             if (data.hasOwnProperty('color')) {
                 obj['color'] = ApiClient.convertToType(data['color'], 'String');
             }
@@ -66,6 +69,12 @@ class PatchedGroupRequest {
  */
 PatchedGroupRequest.prototype['name'] = undefined;
 
+/**
+ * Short name of the group
+ * @member {String} short_name
+ */
+PatchedGroupRequest.prototype['short_name'] = undefined;
+
 /**
  * @member {String} color
  */
diff --git a/src/model/WriteFolder.js b/src/model/WriteFolder.js
diff --git a/src/model/WriteFolderRequest.js b/src/model/WriteFolderRequest.js
diff --git a/test/model/Group.spec.js b/test/model/Group.spec.js
diff --git a/test/model/GroupRequest.spec.js b/test/model/GroupRequest.spec.js
diff --git a/test/model/PatchedGroupRequest.spec.js b/test/model/PatchedGroupRequest.spec.js
diff --git a/test/model/WriteFolder.spec.js b/test/model/WriteFolder.spec.js
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js
