MINOR: add BCF topic/pins route (#855)

* MINOR: add BCF topic/pins route

* add topic guid filter test

Author: Bimdata-io

.openapi-generator/FILES

@@ -147,6 +147,7 @@ docs/PerspectiveCamera.md
 docs/PerspectiveCameraRequest.md
 docs/Pin.md
 docs/PinRequest.md
+docs/PinWithModels.md
 docs/Point.md
 docs/PointRequest.md
 docs/PositioningPlan.md
@@ -220,6 +221,7 @@ docs/Tag.md
 docs/TagIdRequest.md
 docs/TagRequest.md
 docs/Topic.md
+docs/TopicPin.md
 docs/TopicRequest.md
 docs/TopicStatus.md
 docs/TopicStatusRequest.md
@@ -415,6 +417,7 @@ src/model/PerspectiveCamera.js
 src/model/PerspectiveCameraRequest.js
 src/model/Pin.js
 src/model/PinRequest.js
+src/model/PinWithModels.js
 src/model/Point.js
 src/model/PointRequest.js
 src/model/PositioningPlan.js
@@ -487,6 +490,7 @@ src/model/Tag.js
 src/model/TagIdRequest.js
 src/model/TagRequest.js
 src/model/Topic.js
+src/model/TopicPin.js
 src/model/TopicRequest.js
 src/model/TopicStatus.js
 src/model/TopicStatusRequest.js
@@ -677,6 +681,7 @@ test/model/PerspectiveCamera.spec.js
 test/model/PerspectiveCameraRequest.spec.js
 test/model/Pin.spec.js
 test/model/PinRequest.spec.js
+test/model/PinWithModels.spec.js
 test/model/Point.spec.js
 test/model/PointRequest.spec.js
 test/model/PositioningPlan.spec.js
@@ -749,6 +754,7 @@ test/model/Tag.spec.js
 test/model/TagIdRequest.spec.js
 test/model/TagRequest.spec.js
 test/model/Topic.spec.js
+test/model/TopicPin.spec.js
 test/model/TopicRequest.spec.js
 test/model/TopicStatus.spec.js
 test/model/TopicStatusRequest.spec.js

README.md

@@ -185,6 +185,7 @@ Class | Method | HTTP request | Description
 *bimdata.BcfApi* | [**getTopicDocumentReferences**](docs/BcfApi.md#getTopicDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
 *bimdata.BcfApi* | [**getTopicViewpoints**](docs/BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
 *bimdata.BcfApi* | [**getTopics**](docs/BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
+*bimdata.BcfApi* | [**getTopicsPins**](docs/BcfApi.md#getTopicsPins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/pins | Get pins of all or many topics
 *bimdata.BcfApi* | [**getUser**](docs/BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
 *bimdata.BcfApi* | [**getVersions**](docs/BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
 *bimdata.BcfApi* | [**getViewpoinPin**](docs/BcfApi.md#getViewpoinPin) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Retrieve a Pin
@@ -633,6 +634,7 @@ Class | Method | HTTP request | Description
  - [bimdata.PerspectiveCameraRequest](docs/PerspectiveCameraRequest.md)
  - [bimdata.Pin](docs/Pin.md)
  - [bimdata.PinRequest](docs/PinRequest.md)
+ - [bimdata.PinWithModels](docs/PinWithModels.md)
  - [bimdata.Point](docs/Point.md)
  - [bimdata.PointRequest](docs/PointRequest.md)
  - [bimdata.PositioningPlan](docs/PositioningPlan.md)
@@ -705,6 +707,7 @@ Class | Method | HTTP request | Description
  - [bimdata.TagIdRequest](docs/TagIdRequest.md)
  - [bimdata.TagRequest](docs/TagRequest.md)
  - [bimdata.Topic](docs/Topic.md)
+ - [bimdata.TopicPin](docs/TopicPin.md)
  - [bimdata.TopicRequest](docs/TopicRequest.md)
  - [bimdata.TopicStatus](docs/TopicStatus.md)
  - [bimdata.TopicStatusRequest](docs/TopicStatusRequest.md)

docs/BcfApi.md

@@ -48,6 +48,7 @@ Method | HTTP request | Description
 [**getTopicDocumentReferences**](BcfApi.md#getTopicDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
 [**getTopicViewpoints**](BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
 [**getTopics**](BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
+[**getTopicsPins**](BcfApi.md#getTopicsPins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/pins | Get pins of all or many topics
 [**getUser**](BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
 [**getVersions**](BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
 [**getViewpoinPin**](BcfApi.md#getViewpoinPin) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Retrieve a Pin
@@ -2945,6 +2946,77 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getTopicsPins
+
+> [TopicPin] getTopicsPins(projectsPk, opts)
+
+Get pins of all or many topics
+
+This is not a standard route. Get pins of all or many topics  Required scopes: bcf:read
+
+### 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.BcfApi();
+let projectsPk = 56; // Number | 
+let opts = {
+  'format': "format_example", // String | 
+  'ifcs': [null], // [Number] | 
+  'models': [null], // [Number] | 
+  'topics': "topics_example" // String | topic guids to include, comma separated. Default = all
+};
+apiInstance.getTopicsPins(projectsPk, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **projectsPk** | **Number**|  | 
+ **format** | **String**|  | [optional] 
+ **ifcs** | [**[Number]**](Number.md)|  | [optional] 
+ **models** | [**[Number]**](Number.md)|  | [optional] 
+ **topics** | **String**| topic guids to include, comma separated. Default = all | [optional] 
+
+### Return type
+
+[**[TopicPin]**](TopicPin.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
+
+
 ## getUser
 
 > SelfBcfUser getUser()

docs/CollaborationApi.md

@@ -960,7 +960,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {'POINT_CLOUD', 'DWG', 'OBJ', 'DXF', 'IFC', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {'DXF', 'DWG', 'POINT_CLOUD', 'OBJ', 'IFC', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 

docs/PinWithModels.md

@@ -0,0 +1,14 @@
+# bimdata.PinWithModels
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**guid** | **String** |  | [readonly] 
+**name** | **String** |  | [readonly] 
+**color** | **String** |  | [readonly] 
+**point** | [**GeometryPoint**](GeometryPoint.md) |  | 
+**index** | **Number** |  | [readonly] 
+**modelIds** | **[Number]** |  | [readonly] 
+
+

docs/TopicPin.md

@@ -0,0 +1,10 @@
+# bimdata.TopicPin
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topicGuid** | **String** |  | [readonly] 
+**pins** | [**[PinWithModels]**](PinWithModels.md) |  | [readonly] 
+
+

docs/WriteFolder.md

@@ -5,16 +5,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly] 
+**id** | **Number** |  | [readonly] 
+**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
+**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
 **userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **defaultPermission** | **Number** | Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write | [optional] 
-**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
-**id** | **Number** |  | [readonly] 
-**parentId** | **Number** |  | [optional] 
 **createdAt** | **Date** | Creation date | [readonly] 
-**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**updatedAt** | **Date** | Date of the last update | [readonly] 
 **name** | **String** | Name of the folder | 
 **nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly] 
+**parentId** | **Number** |  | [optional] 
+**updatedAt** | **Date** | Date of the last update | [readonly] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 

docs/WriteFolderRequest.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **defaultPermission** | **Number** | Permission for a Folder  * `1` - denied * `50` - read_only * `100` - read_write | [optional] 
-**parentId** | **Number** |  | [optional] 
 **name** | **String** | Name of the folder | 
+**parentId** | **Number** |  | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 

src/api/BcfApi.js

@@ -45,6 +45,7 @@ import SelfBcfUser from '../model/SelfBcfUser';
 import Stage from '../model/Stage';
 import StageRequest from '../model/StageRequest';
 import Topic from '../model/Topic';
+import TopicPin from '../model/TopicPin';
 import TopicRequest from '../model/TopicRequest';
 import TopicStatus from '../model/TopicStatus';
 import TopicStatusRequest from '../model/TopicStatusRequest';
@@ -2666,6 +2667,69 @@ export default class BcfApi {
     }
 
 
+    /**
+     * Get pins of all or many topics
+     * This is not a standard route. Get pins of all or many topics  Required scopes: bcf:read
+     * @param {Number} projectsPk 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.format 
+     * @param {Array.<Number>} opts.ifcs 
+     * @param {Array.<Number>} opts.models 
+     * @param {String} opts.topics topic guids to include, comma separated. Default = all
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/TopicPin>} and HTTP response
+     */
+    getTopicsPinsWithHttpInfo(projectsPk, opts) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'projectsPk' is set
+      if (projectsPk === undefined || projectsPk === null) {
+        throw new Error("Missing the required parameter 'projectsPk' when calling getTopicsPins");
+      }
+
+      let pathParams = {
+        'projects_pk': projectsPk
+      };
+      let queryParams = {
+        'format': opts['format'],
+        'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
+        'models': this.apiClient.buildCollectionParam(opts['models'], 'multi'),
+        'topics': opts['topics']
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
+      let contentTypes = [];
+      let accepts = ['application/json'];
+      let returnType = [TopicPin];
+      return this.apiClient.callApi(
+        '/bcf/2.1/projects/{projects_pk}/topics/pins', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * Get pins of all or many topics
+     * This is not a standard route. Get pins of all or many topics  Required scopes: bcf:read
+     * @param {Number} projectsPk 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.format 
+     * @param {Array.<Number>} opts.ifcs 
+     * @param {Array.<Number>} opts.models 
+     * @param {String} opts.topics topic guids to include, comma separated. Default = all
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/TopicPin>}
+     */
+    getTopicsPins(projectsPk, opts) {
+      return this.getTopicsPinsWithHttpInfo(projectsPk, opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
     /**
      * Get current user info
      * 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

src/api/CollaborationApi.js

@@ -866,7 +866,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DWG', 'OBJ', 'DXF', 'IFC', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'DWG', 'POINT_CLOUD', 'OBJ', 'IFC', 'GLTF'}, 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
@@ -934,7 +934,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'DWG', 'OBJ', 'DXF', 'IFC', 'GLTF'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'DXF', 'DWG', 'POINT_CLOUD', 'OBJ', 'IFC', 'GLTF'}, 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