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

* MINOR: add BCF topic/pins route

* add topic guid filter test

Author: Bimdata-io

package/.openapi-generator/FILES

@@ -147,6 +147,7 @@ src/models/PerspectiveCamera.ts
 src/models/PerspectiveCameraRequest.ts
 src/models/Pin.ts
 src/models/PinRequest.ts
+src/models/PinWithModels.ts
 src/models/Point.ts
 src/models/PointRequest.ts
 src/models/PositioningPlan.ts
@@ -219,6 +220,7 @@ src/models/Tag.ts
 src/models/TagIdRequest.ts
 src/models/TagRequest.ts
 src/models/Topic.ts
+src/models/TopicPin.ts
 src/models/TopicRequest.ts
 src/models/TopicStatus.ts
 src/models/TopicStatusRequest.ts

package/src/apis/BcfApi.ts

@@ -111,6 +111,9 @@ import {
     Topic,
     TopicFromJSON,
     TopicToJSON,
+    TopicPin,
+    TopicPinFromJSON,
+    TopicPinToJSON,
     TopicRequest,
     TopicRequestFromJSON,
     TopicRequestToJSON,
@@ -393,6 +396,14 @@ export interface GetTopicsRequest {
     models?: Array<number>;
 }
 
+export interface GetTopicsPinsRequest {
+    projects_pk: number;
+    format?: string;
+    ifcs?: Array<number>;
+    models?: Array<number>;
+    topics?: string;
+}
+
 export interface GetViewpoinPinRequest {
     guid: string;
     projects_pk: number;
@@ -3056,6 +3067,72 @@ export class BcfApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * This is not a standard route. Get pins of all or many topics  Required scopes: bcf:read
+     * Get pins of all or many topics
+     */
+    async getTopicsPinsRaw(requestParameters: GetTopicsPinsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<TopicPin>>> {
+        if (requestParameters.projects_pk === null || requestParameters.projects_pk === undefined) {
+            throw new runtime.RequiredError('projects_pk','Required parameter requestParameters.projects_pk was null or undefined when calling getTopicsPins.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.format !== undefined) {
+            queryParameters['format'] = requestParameters.format;
+        }
+
+        if (requestParameters.ifcs) {
+            queryParameters['ifcs'] = requestParameters.ifcs;
+        }
+
+        if (requestParameters.models) {
+            queryParameters['models'] = requestParameters.models;
+        }
+
+        if (requestParameters.topics !== undefined) {
+            queryParameters['topics'] = requestParameters.topics;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("BIMData_Connect", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // Bearer authentication
+        }
+
+        const response = await this.request({
+            path: `/bcf/2.1/projects/{projects_pk}/topics/pins`.replace(`{${"projects_pk"}}`, encodeURIComponent(String(requestParameters.projects_pk))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TopicPinFromJSON));
+    }
+
+    /**
+     * This is not a standard route. Get pins of all or many topics  Required scopes: bcf:read
+     * Get pins of all or many topics
+     */
+    async getTopicsPins(projects_pk: number, format?: string, ifcs?: Array<number>, models?: Array<number>, topics?: string, initOverrides?: RequestInit): Promise<Array<TopicPin>> {
+        const response = await this.getTopicsPinsRaw({ projects_pk: projects_pk, format: format, ifcs: ifcs, models: models, topics: topics }, initOverrides);
+        return await response.value();
+    }
+
     /**
      * 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
      * Get current user info

package/src/apis/CollaborationApi.ts

@@ -1671,7 +1671,7 @@ export class CollaborationApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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
      * Create a document
      */
     async createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Document>> {
@@ -1778,7 +1778,7 @@ export class CollaborationApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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
      * Create a document
      */
     async createDocument(cloud_pk: number, project_pk: number, name: string, file: Blob, parent_id?: number | null, file_name?: string, description?: string | null, model_source?: CreateDocumentModelSourceEnum, ifc_source?: CreateDocumentIfcSourceEnum, successor_of?: number, process_hint?: CreateDocumentProcessHintEnum, initOverrides?: RequestInit): Promise<Document> {

package/src/models/PinWithModels.ts

@@ -0,0 +1,98 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    GeometryPoint,
+    GeometryPointFromJSON,
+    GeometryPointFromJSONTyped,
+    GeometryPointToJSON,
+} from './GeometryPoint';
+
+/**
+ * 
+ * @export
+ * @interface PinWithModels
+ */
+export interface PinWithModels {
+    /**
+     * 
+     * @type {string}
+     * @memberof PinWithModels
+     */
+    readonly guid: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PinWithModels
+     */
+    readonly name: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PinWithModels
+     */
+    readonly color: string | null;
+    /**
+     * 
+     * @type {GeometryPoint}
+     * @memberof PinWithModels
+     */
+    point: GeometryPoint;
+    /**
+     * 
+     * @type {number}
+     * @memberof PinWithModels
+     */
+    readonly index: number | null;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof PinWithModels
+     */
+    readonly model_ids: Array<number>;
+}
+
+export function PinWithModelsFromJSON(json: any): PinWithModels {
+    return PinWithModelsFromJSONTyped(json, false);
+}
+
+export function PinWithModelsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PinWithModels {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'guid': json['guid'],
+        'name': json['name'],
+        'color': json['color'],
+        'point': GeometryPointFromJSON(json['point']),
+        'index': json['index'],
+        'model_ids': json['model_ids'],
+    };
+}
+
+export function PinWithModelsToJSON(value?: PinWithModels | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'point': GeometryPointToJSON(value.point),
+    };
+}
+

package/src/models/TopicPin.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    PinWithModels,
+    PinWithModelsFromJSON,
+    PinWithModelsFromJSONTyped,
+    PinWithModelsToJSON,
+} from './PinWithModels';
+
+/**
+ * 
+ * @export
+ * @interface TopicPin
+ */
+export interface TopicPin {
+    /**
+     * 
+     * @type {string}
+     * @memberof TopicPin
+     */
+    readonly topic_guid: string;
+    /**
+     * 
+     * @type {Array<PinWithModels>}
+     * @memberof TopicPin
+     */
+    readonly pins: Array<PinWithModels>;
+}
+
+export function TopicPinFromJSON(json: any): TopicPin {
+    return TopicPinFromJSONTyped(json, false);
+}
+
+export function TopicPinFromJSONTyped(json: any, ignoreDiscriminator: boolean): TopicPin {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'topic_guid': json['topic_guid'],
+        'pins': ((json['pins'] as Array<any>).map(PinWithModelsFromJSON)),
+    };
+}
+
+export function TopicPinToJSON(value?: TopicPin | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+    };
+}
+