MINOR: add project check access route(#561)

* Add projcte check-access route

* add route description

* update tests with new invitation routes

Author: Bimdata-io

.openapi-generator/FILES

@@ -9,6 +9,7 @@ docs/Building.md
 docs/BuildingModelPlanRequest.md
 docs/CheckPlan.md
 docs/CheckPlanRequest.md
+docs/CheckProjectAccess.md
 docs/CheckerApi.md
 docs/CheckerResult.md
 docs/CheckerResultRequest.md
@@ -269,6 +270,7 @@ src/model/Building.js
 src/model/BuildingModelPlanRequest.js
 src/model/CheckPlan.js
 src/model/CheckPlanRequest.js
+src/model/CheckProjectAccess.js
 src/model/CheckerResult.js
 src/model/CheckerResultRequest.js
 src/model/Classification.js
@@ -519,6 +521,7 @@ test/model/Building.spec.js
 test/model/BuildingModelPlanRequest.spec.js
 test/model/CheckPlan.spec.js
 test/model/CheckPlanRequest.spec.js
+test/model/CheckProjectAccess.spec.js
 test/model/CheckerResult.spec.js
 test/model/CheckerResultRequest.spec.js
 test/model/Classification.spec.js

README.md

@@ -231,6 +231,7 @@ Class | Method | HTTP request | Description
 *bimdata.CollaborationApi* | [**cancelCloudUserInvitation**](docs/CollaborationApi.md#cancelCloudUserInvitation) | **DELETE** /cloud/{cloud_pk}/invitation/{id} | Cancel a pending invitation
 *bimdata.CollaborationApi* | [**cancelProjectUserInvitation**](docs/CollaborationApi.md#cancelProjectUserInvitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
 *bimdata.CollaborationApi* | [**checkAccess**](docs/CollaborationApi.md#checkAccess) | **GET** /cloud/{id}/check-access | Check app access from cloud
+*bimdata.CollaborationApi* | [**checkProjectAccess**](docs/CollaborationApi.md#checkProjectAccess) | **GET** /cloud/{cloud_pk}/project/{id}/check-access | Check if the current token has access to the requested project
 *bimdata.CollaborationApi* | [**closeVisa**](docs/CollaborationApi.md#closeVisa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/close | Close a visa of a document
 *bimdata.CollaborationApi* | [**createClassification**](docs/CollaborationApi.md#createClassification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
 *bimdata.CollaborationApi* | [**createCloud**](docs/CollaborationApi.md#createCloud) | **POST** /cloud | Create a cloud
@@ -650,6 +651,7 @@ Class | Method | HTTP request | Description
  - [bimdata.BuildingModelPlanRequest](docs/BuildingModelPlanRequest.md)
  - [bimdata.CheckPlan](docs/CheckPlan.md)
  - [bimdata.CheckPlanRequest](docs/CheckPlanRequest.md)
+ - [bimdata.CheckProjectAccess](docs/CheckProjectAccess.md)
  - [bimdata.CheckerResult](docs/CheckerResult.md)
  - [bimdata.CheckerResultRequest](docs/CheckerResultRequest.md)
  - [bimdata.Classification](docs/Classification.md)

docs/CheckProjectAccess.md

@@ -0,0 +1,27 @@
+# bimdata.CheckProjectAccess
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hasReadPermission** | **Boolean** |  | 
+**hasWritePermission** | **Boolean** |  | 
+**hasAdminPermission** | **Boolean** |  | 
+**tokenScopes** | **[String]** |  | 
+**usableScopes** | **[String]** | Some tokens may have write scopes (eg: model:write) but the user of the token is a guest in the project so they can't use the scopes. | 
+**userRole** | **Number** |  | [optional] 
+
+
+
+## Enum: UserRoleEnum
+
+
+* `100` (value: `100`)
+
+* `50` (value: `50`)
+
+* `25` (value: `25`)
+
+
+
+

docs/CollaborationApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**cancelCloudUserInvitation**](CollaborationApi.md#cancelCloudUserInvitation) | **DELETE** /cloud/{cloud_pk}/invitation/{id} | Cancel a pending invitation
 [**cancelProjectUserInvitation**](CollaborationApi.md#cancelProjectUserInvitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
 [**checkAccess**](CollaborationApi.md#checkAccess) | **GET** /cloud/{id}/check-access | Check app access from cloud
+[**checkProjectAccess**](CollaborationApi.md#checkProjectAccess) | **GET** /cloud/{cloud_pk}/project/{id}/check-access | Check if the current token has access to the requested project
 [**closeVisa**](CollaborationApi.md#closeVisa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/close | Close a visa of a document
 [**createClassification**](CollaborationApi.md#createClassification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
 [**createCloud**](CollaborationApi.md#createCloud) | **POST** /cloud | Create a cloud
@@ -564,6 +565,69 @@ null (empty response body)
 - **Accept**: Not defined
 
 
+## checkProjectAccess
+
+> CheckProjectAccess checkProjectAccess(cloudPk, id)
+
+Check if the current token has access to the requested project
+
+                 The response gives you details about the right of the user or app, the scopes of the token and the usable scopes (scopes filtered by the right of the user).                 It works with user tokens, app tokens and ProjectAccessToken             
+
+### 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.
+apiInstance.checkProjectAccess(cloudPk, id).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. | 
+
+### Return type
+
+[**CheckProjectAccess**](CheckProjectAccess.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**: Not defined
+- **Accept**: application/json
+
+
 ## closeVisa
 
 > closeVisa(cloudPk, documentPk, id, projectPk)
@@ -889,7 +953,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'DXF', 'GLTF', 'BFX', 'DWG', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'DAE', 'DXF', 'DWG', 'POINT_CLOUD', 'BFX', 'IFC', 'GLTF', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

src/api/CollaborationApi.js

@@ -13,6 +13,7 @@
 
 
 import ApiClient from "../ApiClient";
+import CheckProjectAccess from '../model/CheckProjectAccess';
 import Classification from '../model/Classification';
 import ClassificationRequest from '../model/ClassificationRequest';
 import Cloud from '../model/Cloud';
@@ -512,6 +513,61 @@ export default class CollaborationApi {
     }
 
 
+    /**
+     * Check if the current token has access to the requested project
+     *                  The response gives you details about the right of the user or app, the scopes of the token and the usable scopes (scopes filtered by the right of the user).                 It works with user tokens, app tokens and ProjectAccessToken             
+     * @param {Number} cloudPk 
+     * @param {Number} id A unique integer value identifying this project.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CheckProjectAccess} and HTTP response
+     */
+    checkProjectAccessWithHttpInfo(cloudPk, id) {
+      let postBody = null;
+      // verify the required parameter 'cloudPk' is set
+      if (cloudPk === undefined || cloudPk === null) {
+        throw new Error("Missing the required parameter 'cloudPk' when calling checkProjectAccess");
+      }
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling checkProjectAccess");
+      }
+
+      let pathParams = {
+        'cloud_pk': cloudPk,
+        'id': id
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = CheckProjectAccess;
+      return this.apiClient.callApi(
+        '/cloud/{cloud_pk}/project/{id}/check-access', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Check if the current token has access to the requested project
+     *                  The response gives you details about the right of the user or app, the scopes of the token and the usable scopes (scopes filtered by the right of the user).                 It works with user tokens, app tokens and ProjectAccessToken             
+     * @param {Number} cloudPk 
+     * @param {Number} id A unique integer value identifying this project.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CheckProjectAccess}
+     */
+    checkProjectAccess(cloudPk, id) {
+      return this.checkProjectAccessWithHttpInfo(cloudPk, id)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Close a visa of a document
      * Close a visa of a document  Required scopes: document:write
@@ -800,7 +856,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'DXF', 'GLTF', 'BFX', 'DWG', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DAE', 'DXF', 'DWG', 'POINT_CLOUD', 'BFX', 'IFC', 'GLTF', '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
@@ -868,7 +924,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DAE', 'DXF', 'GLTF', 'BFX', 'DWG', 'IFC', 'OBJ'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DAE', 'DXF', 'DWG', 'POINT_CLOUD', 'BFX', 'IFC', 'GLTF', '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

src/index.js

@@ -19,6 +19,7 @@ import Building from './model/Building';
 import BuildingModelPlanRequest from './model/BuildingModelPlanRequest';
 import CheckPlan from './model/CheckPlan';
 import CheckPlanRequest from './model/CheckPlanRequest';
+import CheckProjectAccess from './model/CheckProjectAccess';
 import CheckerResult from './model/CheckerResult';
 import CheckerResultRequest from './model/CheckerResultRequest';
 import Classification from './model/Classification';
@@ -339,6 +340,12 @@ export {
      */
     CheckPlanRequest,
 
+    /**
+     * The CheckProjectAccess model constructor.
+     * @property {module:model/CheckProjectAccess}
+     */
+    CheckProjectAccess,
+
     /**
      * The CheckerResult model constructor.
      * @property {module:model/CheckerResult}