MINOR: import from project route (#664)

* feat: clone project route

* renaming route, reverse pk and project_id

* renaming

* simpler help text

Author: Bimdata-io

.openapi-generator/FILES

@@ -145,6 +145,7 @@ docs/Project.md
 docs/ProjectAccessToken.md
 docs/ProjectAccessTokenRequest.md
 docs/ProjectFolderTree.md
+docs/ProjectImportRequest.md
 docs/ProjectInvitation.md
 docs/ProjectInvitationRequest.md
 docs/ProjectRequest.md
@@ -389,6 +390,7 @@ src/model/Project.js
 src/model/ProjectAccessToken.js
 src/model/ProjectAccessTokenRequest.js
 src/model/ProjectFolderTree.js
+src/model/ProjectImportRequest.js
 src/model/ProjectInvitation.js
 src/model/ProjectInvitationRequest.js
 src/model/ProjectRequest.js
@@ -627,6 +629,7 @@ test/model/Project.spec.js
 test/model/ProjectAccessToken.spec.js
 test/model/ProjectAccessTokenRequest.spec.js
 test/model/ProjectFolderTree.spec.js
+test/model/ProjectImportRequest.spec.js
 test/model/ProjectInvitation.spec.js
 test/model/ProjectInvitationRequest.spec.js
 test/model/ProjectRequest.spec.js

README.md

@@ -286,6 +286,7 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**getVisaComment**](docs/CollaborationApi.md#getVisaComment) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Retrieve a comment
 *bimdata.CollaborationApi* | [**getVisaComments**](docs/CollaborationApi.md#getVisaComments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | List all comment of a visa
 *bimdata.CollaborationApi* | [**getVisas**](docs/CollaborationApi.md#getVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | List all visas of a document
+*bimdata.CollaborationApi* | [**importFromProject**](docs/CollaborationApi.md#importFromProject) | **POST** /cloud/{cloud_pk}/project/{id}/import_from | Import data from a project
 *bimdata.CollaborationApi* | [**importManageGroup**](docs/CollaborationApi.md#importManageGroup) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/import | Import a group from another project
 *bimdata.CollaborationApi* | [**inviteCloudUser**](docs/CollaborationApi.md#inviteCloudUser) | **POST** /cloud/{cloud_pk}/invitation | Invite a cloud administrator
 *bimdata.CollaborationApi* | [**inviteProjectUser**](docs/CollaborationApi.md#inviteProjectUser) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
@@ -758,6 +759,7 @@ Class | Method | HTTP request | Description
  - [bimdata.ProjectAccessToken](docs/ProjectAccessToken.md)
  - [bimdata.ProjectAccessTokenRequest](docs/ProjectAccessTokenRequest.md)
  - [bimdata.ProjectFolderTree](docs/ProjectFolderTree.md)
+ - [bimdata.ProjectImportRequest](docs/ProjectImportRequest.md)
  - [bimdata.ProjectInvitation](docs/ProjectInvitation.md)
  - [bimdata.ProjectInvitationRequest](docs/ProjectInvitationRequest.md)
  - [bimdata.ProjectRequest](docs/ProjectRequest.md)

docs/CollaborationApi.md

@@ -87,6 +87,7 @@ Method | HTTP request | Description
 [**getVisaComment**](CollaborationApi.md#getVisaComment) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Retrieve a comment
 [**getVisaComments**](CollaborationApi.md#getVisaComments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | List all comment of a visa
 [**getVisas**](CollaborationApi.md#getVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | List all visas of a document
+[**importFromProject**](CollaborationApi.md#importFromProject) | **POST** /cloud/{cloud_pk}/project/{id}/import_from | Import data from a project
 [**importManageGroup**](CollaborationApi.md#importManageGroup) | **POST** /cloud/{cloud_pk}/project/{project_pk}/group/import | Import a group from another project
 [**inviteCloudUser**](CollaborationApi.md#inviteCloudUser) | **POST** /cloud/{cloud_pk}/invitation | Invite a cloud administrator
 [**inviteProjectUser**](CollaborationApi.md#inviteProjectUser) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
@@ -955,7 +956,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+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
 
 ### Example
 
@@ -5471,13 +5472,78 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## importFromProject
+
+> Project importFromProject(cloudPk, id, projectImportRequest)
+
+Import data from a project
+
+Import dms tree and/or the groups from a project  Required scopes: org:manage
+
+### Example
+
+```javascript
+import bimdata from '@bimdata/bimdata-api-client';
+let defaultClient = bimdata.ApiClient.instance;
+// Configure API key authorization: ApiKey
+let ApiKey = defaultClient.authentications['ApiKey'];
+ApiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//ApiKey.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure OAuth2 access token for authorization: BIMData_Connect
+let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
+BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
+// Configure API key authorization: Bearer
+let Bearer = defaultClient.authentications['Bearer'];
+Bearer.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//Bearer.apiKeyPrefix = 'Token';
+
+let apiInstance = new bimdata.CollaborationApi();
+let cloudPk = 56; // Number | 
+let id = 56; // Number | A unique integer value identifying this project.
+let projectImportRequest = new bimdata.ProjectImportRequest(); // ProjectImportRequest | 
+apiInstance.importFromProject(cloudPk, id, projectImportRequest).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloudPk** | **Number**|  | 
+ **id** | **Number**| A unique integer value identifying this project. | 
+ **projectImportRequest** | [**ProjectImportRequest**](ProjectImportRequest.md)|  | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## importManageGroup
 
 > [Group] importManageGroup(cloudPk, projectPk, importGroupRequest)
 
 Import a group from another project
 
-Import a group from another project. Must be an admin of the project  Required scopes: org:manage
+DEPECRATED: Use ImportFromProject instead  Required scopes: org:manage
 
 ### Example
 

docs/ProjectImportRequest.md

@@ -0,0 +1,12 @@
+# bimdata.ProjectImportRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**projectId** | **Number** | The source project_id | 
+**importDms** | **Boolean** |  | [optional] [default to true]
+**importUsers** | **Boolean** |  | [optional] [default to true]
+**importGroups** | **Boolean** |  | [optional] [default to true]
+
+

src/api/CollaborationApi.js

@@ -48,6 +48,7 @@ import Project from '../model/Project';
 import ProjectAccessToken from '../model/ProjectAccessToken';
 import ProjectAccessTokenRequest from '../model/ProjectAccessTokenRequest';
 import ProjectFolderTree from '../model/ProjectFolderTree';
+import ProjectImportRequest from '../model/ProjectImportRequest';
 import ProjectInvitation from '../model/ProjectInvitation';
 import ProjectInvitationRequest from '../model/ProjectInvitationRequest';
 import ProjectRequest from '../model/ProjectRequest';
@@ -858,7 +859,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * 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
      * @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
@@ -924,7 +925,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DXF', 'OBJ', 'IFC', 'POINT_CLOUD', 'GLTF', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
+     * 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
      * @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
@@ -5034,9 +5035,70 @@ export default class CollaborationApi {
     }
 
 
+    /**
+     * Import data from a project
+     * Import dms tree and/or the groups from a project  Required scopes: org:manage
+     * @param {Number} cloudPk 
+     * @param {Number} id A unique integer value identifying this project.
+     * @param {module:model/ProjectImportRequest} projectImportRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Project} and HTTP response
+     */
+    importFromProjectWithHttpInfo(cloudPk, id, projectImportRequest) {
+      let postBody = projectImportRequest;
+      // verify the required parameter 'cloudPk' is set
+      if (cloudPk === undefined || cloudPk === null) {
+        throw new Error("Missing the required parameter 'cloudPk' when calling importFromProject");
+      }
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling importFromProject");
+      }
+      // verify the required parameter 'projectImportRequest' is set
+      if (projectImportRequest === undefined || projectImportRequest === null) {
+        throw new Error("Missing the required parameter 'projectImportRequest' when calling importFromProject");
+      }
+
+      let pathParams = {
+        'cloud_pk': cloudPk,
+        'id': id
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
+      let contentTypes = ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'];
+      let accepts = ['application/json'];
+      let returnType = Project;
+      return this.apiClient.callApi(
+        '/cloud/{cloud_pk}/project/{id}/import_from', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Import data from a project
+     * Import dms tree and/or the groups from a project  Required scopes: org:manage
+     * @param {Number} cloudPk 
+     * @param {Number} id A unique integer value identifying this project.
+     * @param {module:model/ProjectImportRequest} projectImportRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Project}
+     */
+    importFromProject(cloudPk, id, projectImportRequest) {
+      return this.importFromProjectWithHttpInfo(cloudPk, id, projectImportRequest)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Import a group from another project
-     * Import a group from another project. Must be an admin of the project  Required scopes: org:manage
+     * DEPECRATED: Use ImportFromProject instead  Required scopes: org:manage
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {module:model/ImportGroupRequest} importGroupRequest 
@@ -5081,7 +5143,7 @@ export default class CollaborationApi {
 
     /**
      * Import a group from another project
-     * Import a group from another project. Must be an admin of the project  Required scopes: org:manage
+     * DEPECRATED: Use ImportFromProject instead  Required scopes: org:manage
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {module:model/ImportGroupRequest} importGroupRequest 

src/index.js

@@ -152,6 +152,7 @@ import Project from './model/Project';
 import ProjectAccessToken from './model/ProjectAccessToken';
 import ProjectAccessTokenRequest from './model/ProjectAccessTokenRequest';
 import ProjectFolderTree from './model/ProjectFolderTree';
+import ProjectImportRequest from './model/ProjectImportRequest';
 import ProjectInvitation from './model/ProjectInvitation';
 import ProjectInvitationRequest from './model/ProjectInvitationRequest';
 import ProjectRequest from './model/ProjectRequest';
@@ -1125,6 +1126,12 @@ export {
      */
     ProjectFolderTree,
 
+    /**
+     * The ProjectImportRequest model constructor.
+     * @property {module:model/ProjectImportRequest}
+     */
+    ProjectImportRequest,
+
     /**
      * The ProjectInvitation model constructor.
      * @property {module:model/ProjectInvitation}

src/model/ProjectImportRequest.js

@@ -0,0 +1,101 @@
+/**
+ * BIMData API
+ * BIMData API is a tool to interact with your models stored on BIMData’s servers.     Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints.
+ *
+ * The version of the OpenAPI document: v1 (v1)
+ * Contact: support@bimdata.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+
+/**
+ * The ProjectImportRequest model module.
+ * @module model/ProjectImportRequest
+ * @version 0.0.0
+ */
+class ProjectImportRequest {
+    /**
+     * Constructs a new <code>ProjectImportRequest</code>.
+     * @alias module:model/ProjectImportRequest
+     * @param projectId {Number} The source project_id
+     */
+    constructor(projectId) { 
+        
+        ProjectImportRequest.initialize(this, projectId);
+    }
+
+    /**
+     * 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, projectId) { 
+        obj['project_id'] = projectId;
+    }
+
+    /**
+     * Constructs a <code>ProjectImportRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/ProjectImportRequest} obj Optional instance to populate.
+     * @return {module:model/ProjectImportRequest} The populated <code>ProjectImportRequest</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new ProjectImportRequest();
+
+            if (data.hasOwnProperty('project_id')) {
+                obj['project_id'] = ApiClient.convertToType(data['project_id'], 'Number');
+            }
+            if (data.hasOwnProperty('import_dms')) {
+                obj['import_dms'] = ApiClient.convertToType(data['import_dms'], 'Boolean');
+            }
+            if (data.hasOwnProperty('import_users')) {
+                obj['import_users'] = ApiClient.convertToType(data['import_users'], 'Boolean');
+            }
+            if (data.hasOwnProperty('import_groups')) {
+                obj['import_groups'] = ApiClient.convertToType(data['import_groups'], 'Boolean');
+            }
+        }
+        return obj;
+    }
+
+
+}
+
+/**
+ * The source project_id
+ * @member {Number} project_id
+ */
+ProjectImportRequest.prototype['project_id'] = undefined;
+
+/**
+ * @member {Boolean} import_dms
+ * @default true
+ */
+ProjectImportRequest.prototype['import_dms'] = true;
+
+/**
+ * @member {Boolean} import_users
+ * @default true
+ */
+ProjectImportRequest.prototype['import_users'] = true;
+
+/**
+ * @member {Boolean} import_groups
+ * @default true
+ */
+ProjectImportRequest.prototype['import_groups'] = true;
+
+
+
+
+
+
+export default ProjectImportRequest;
+

test/api/CollaborationApi.spec.js

@@ -878,6 +878,16 @@
         done();
       });
     });
+    describe('importFromProject', function() {
+      it('should call importFromProject successfully', function(done) {
+        //uncomment below and update the code to test importFromProject
+        //instance.importFromProject(function(error) {
+        //  if (error) throw error;
+        //expect().to.be();
+        //});
+        done();
+      });
+    });
     describe('importManageGroup', function() {
       it('should call importManageGroup successfully', function(done) {
         //uncomment below and update the code to test importManageGroup