Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Commit 19afe2d

Browse files
committed
MINOR: add BCF events
1 parent 60d8f82 commit 19afe2d

32 files changed

+1424
-152
lines changed

.openapi-generator/FILES

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ docs/Coloring.md
2525
docs/ColoringDefinition.md
2626
docs/ColoringRequest.md
2727
docs/Comment.md
28+
docs/CommentEvent.md
29+
docs/CommentEventAction.md
2830
docs/CommentRequest.md
2931
docs/Component.md
3032
docs/ComponentRequest.md
@@ -236,6 +238,8 @@ docs/Tag.md
236238
docs/TagIdRequest.md
237239
docs/TagRequest.md
238240
docs/Topic.md
241+
docs/TopicEvent.md
242+
docs/TopicEventAction.md
239243
docs/TopicPin.md
240244
docs/TopicRequest.md
241245
docs/TopicStatus.md
@@ -311,6 +315,8 @@ src/model/Coloring.js
311315
src/model/ColoringDefinition.js
312316
src/model/ColoringRequest.js
313317
src/model/Comment.js
318+
src/model/CommentEvent.js
319+
src/model/CommentEventAction.js
314320
src/model/CommentRequest.js
315321
src/model/Component.js
316322
src/model/ComponentRequest.js
@@ -520,6 +526,8 @@ src/model/Tag.js
520526
src/model/TagIdRequest.js
521527
src/model/TagRequest.js
522528
src/model/Topic.js
529+
src/model/TopicEvent.js
530+
src/model/TopicEventAction.js
523531
src/model/TopicPin.js
524532
src/model/TopicRequest.js
525533
src/model/TopicStatus.js
@@ -590,6 +598,8 @@ test/model/Coloring.spec.js
590598
test/model/ColoringDefinition.spec.js
591599
test/model/ColoringRequest.spec.js
592600
test/model/Comment.spec.js
601+
test/model/CommentEvent.spec.js
602+
test/model/CommentEventAction.spec.js
593603
test/model/CommentRequest.spec.js
594604
test/model/Component.spec.js
595605
test/model/ComponentRequest.spec.js
@@ -799,6 +809,8 @@ test/model/Tag.spec.js
799809
test/model/TagIdRequest.spec.js
800810
test/model/TagRequest.spec.js
801811
test/model/Topic.spec.js
812+
test/model/TopicEvent.spec.js
813+
test/model/TopicEventAction.spec.js
802814
test/model/TopicPin.spec.js
803815
test/model/TopicRequest.spec.js
804816
test/model/TopicStatus.spec.js

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ Class | Method | HTTP request | Description
175175
*bimdata.BcfApi* | [**getColorings**](docs/BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
176176
*bimdata.BcfApi* | [**getComment**](docs/BcfApi.md#getComment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Retrieve a comment
177177
*bimdata.BcfApi* | [**getComments**](docs/BcfApi.md#getComments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Retrieve all comments
178+
*bimdata.BcfApi* | [**getCommentsEvents**](docs/BcfApi.md#getCommentsEvents) | **GET** /bcf/2.1/projects/{projects_pk}/topics/comments/events | Get comments events
178179
*bimdata.BcfApi* | [**getDetailedExtensions**](docs/BcfApi.md#getDetailedExtensions) | **GET** /bcf/2.1/projects/{id}/detailed-extensions | Retrieve project detailed extensions
179180
*bimdata.BcfApi* | [**getDocumentReferences**](docs/BcfApi.md#getDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Retrieve all documents referenced by the topic
180181
*bimdata.BcfApi* | [**getExtensions**](docs/BcfApi.md#getExtensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
@@ -187,6 +188,7 @@ Class | Method | HTTP request | Description
187188
*bimdata.BcfApi* | [**getTopic**](docs/BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
188189
*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
189190
*bimdata.BcfApi* | [**getTopics**](docs/BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
191+
*bimdata.BcfApi* | [**getTopicsEvents**](docs/BcfApi.md#getTopicsEvents) | **GET** /bcf/2.1/projects/{projects_pk}/topics/events | Get topics events
190192
*bimdata.BcfApi* | [**getTopicsPins**](docs/BcfApi.md#getTopicsPins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/pins | Get pins of all or many topics
191193
*bimdata.BcfApi* | [**getUser**](docs/BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
192194
*bimdata.BcfApi* | [**getVersions**](docs/BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
@@ -530,6 +532,8 @@ Class | Method | HTTP request | Description
530532
- [bimdata.ColoringDefinition](docs/ColoringDefinition.md)
531533
- [bimdata.ColoringRequest](docs/ColoringRequest.md)
532534
- [bimdata.Comment](docs/Comment.md)
535+
- [bimdata.CommentEvent](docs/CommentEvent.md)
536+
- [bimdata.CommentEventAction](docs/CommentEventAction.md)
533537
- [bimdata.CommentRequest](docs/CommentRequest.md)
534538
- [bimdata.Component](docs/Component.md)
535539
- [bimdata.ComponentRequest](docs/ComponentRequest.md)
@@ -739,6 +743,8 @@ Class | Method | HTTP request | Description
739743
- [bimdata.TagIdRequest](docs/TagIdRequest.md)
740744
- [bimdata.TagRequest](docs/TagRequest.md)
741745
- [bimdata.Topic](docs/Topic.md)
746+
- [bimdata.TopicEvent](docs/TopicEvent.md)
747+
- [bimdata.TopicEventAction](docs/TopicEventAction.md)
742748
- [bimdata.TopicPin](docs/TopicPin.md)
743749
- [bimdata.TopicRequest](docs/TopicRequest.md)
744750
- [bimdata.TopicStatus](docs/TopicStatus.md)

docs/BcfApi.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Method | HTTP request | Description
3838
[**getColorings**](BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
3939
[**getComment**](BcfApi.md#getComment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Retrieve a comment
4040
[**getComments**](BcfApi.md#getComments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Retrieve all comments
41+
[**getCommentsEvents**](BcfApi.md#getCommentsEvents) | **GET** /bcf/2.1/projects/{projects_pk}/topics/comments/events | Get comments events
4142
[**getDetailedExtensions**](BcfApi.md#getDetailedExtensions) | **GET** /bcf/2.1/projects/{id}/detailed-extensions | Retrieve project detailed extensions
4243
[**getDocumentReferences**](BcfApi.md#getDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Retrieve all documents referenced by the topic
4344
[**getExtensions**](BcfApi.md#getExtensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
@@ -50,6 +51,7 @@ Method | HTTP request | Description
5051
[**getTopic**](BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
5152
[**getTopicViewpoints**](BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
5253
[**getTopics**](BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
54+
[**getTopicsEvents**](BcfApi.md#getTopicsEvents) | **GET** /bcf/2.1/projects/{projects_pk}/topics/events | Get topics events
5355
[**getTopicsPins**](BcfApi.md#getTopicsPins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/pins | Get pins of all or many topics
5456
[**getUser**](BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
5557
[**getVersions**](BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
@@ -2282,6 +2284,73 @@ Name | Type | Description | Notes
22822284
- **Accept**: application/json
22832285

22842286

2287+
## getCommentsEvents
2288+
2289+
> [CommentEvent] getCommentsEvents(projectsPk, opts)
2290+
2291+
Get comments events
2292+
2293+
Get comments events Required scopes: bcf:read
2294+
2295+
### Example
2296+
2297+
```javascript
2298+
import bimdata from '@bimdata/bimdata-api-client';
2299+
let defaultClient = bimdata.ApiClient.instance;
2300+
// Configure API key authorization: ApiKey
2301+
let ApiKey = defaultClient.authentications['ApiKey'];
2302+
ApiKey.apiKey = 'YOUR API KEY';
2303+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2304+
//ApiKey.apiKeyPrefix = 'Token';
2305+
// Configure OAuth2 access token for authorization: BIMData_Connect
2306+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2307+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2308+
// Configure OAuth2 access token for authorization: BIMData_Connect
2309+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2310+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2311+
// Configure API key authorization: Bearer
2312+
let Bearer = defaultClient.authentications['Bearer'];
2313+
Bearer.apiKey = 'YOUR API KEY';
2314+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2315+
//Bearer.apiKeyPrefix = 'Token';
2316+
2317+
let apiInstance = new bimdata.BcfApi();
2318+
let projectsPk = 56; // Number |
2319+
let opts = {
2320+
'filter': "filter_example", // String | OData filters as defined in BCF spec
2321+
'orderby': "orderby_example" // String | OData orderby as defined in BCF spec
2322+
};
2323+
apiInstance.getCommentsEvents(projectsPk, opts).then((data) => {
2324+
console.log('API called successfully. Returned data: ' + data);
2325+
}, (error) => {
2326+
console.error(error);
2327+
});
2328+
2329+
```
2330+
2331+
### Parameters
2332+
2333+
2334+
Name | Type | Description | Notes
2335+
------------- | ------------- | ------------- | -------------
2336+
**projectsPk** | **Number**| |
2337+
**filter** | **String**| OData filters as defined in BCF spec | [optional]
2338+
**orderby** | **String**| OData orderby as defined in BCF spec | [optional]
2339+
2340+
### Return type
2341+
2342+
[**[CommentEvent]**](CommentEvent.md)
2343+
2344+
### Authorization
2345+
2346+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
2347+
2348+
### HTTP request headers
2349+
2350+
- **Content-Type**: Not defined
2351+
- **Accept**: application/json
2352+
2353+
22852354
## getDetailedExtensions
22862355

22872356
> DetailedExtensions getDetailedExtensions(id)
@@ -3086,6 +3155,73 @@ Name | Type | Description | Notes
30863155
- **Accept**: application/json
30873156

30883157

3158+
## getTopicsEvents
3159+
3160+
> [TopicEvent] getTopicsEvents(projectsPk, opts)
3161+
3162+
Get topics events
3163+
3164+
Get topics events Required scopes: bcf:read
3165+
3166+
### Example
3167+
3168+
```javascript
3169+
import bimdata from '@bimdata/bimdata-api-client';
3170+
let defaultClient = bimdata.ApiClient.instance;
3171+
// Configure API key authorization: ApiKey
3172+
let ApiKey = defaultClient.authentications['ApiKey'];
3173+
ApiKey.apiKey = 'YOUR API KEY';
3174+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3175+
//ApiKey.apiKeyPrefix = 'Token';
3176+
// Configure OAuth2 access token for authorization: BIMData_Connect
3177+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
3178+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
3179+
// Configure OAuth2 access token for authorization: BIMData_Connect
3180+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
3181+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
3182+
// Configure API key authorization: Bearer
3183+
let Bearer = defaultClient.authentications['Bearer'];
3184+
Bearer.apiKey = 'YOUR API KEY';
3185+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
3186+
//Bearer.apiKeyPrefix = 'Token';
3187+
3188+
let apiInstance = new bimdata.BcfApi();
3189+
let projectsPk = 56; // Number |
3190+
let opts = {
3191+
'filter': "filter_example", // String | OData filters as defined in BCF spec
3192+
'orderby': "orderby_example" // String | OData orderby as defined in BCF spec
3193+
};
3194+
apiInstance.getTopicsEvents(projectsPk, opts).then((data) => {
3195+
console.log('API called successfully. Returned data: ' + data);
3196+
}, (error) => {
3197+
console.error(error);
3198+
});
3199+
3200+
```
3201+
3202+
### Parameters
3203+
3204+
3205+
Name | Type | Description | Notes
3206+
------------- | ------------- | ------------- | -------------
3207+
**projectsPk** | **Number**| |
3208+
**filter** | **String**| OData filters as defined in BCF spec | [optional]
3209+
**orderby** | **String**| OData orderby as defined in BCF spec | [optional]
3210+
3211+
### Return type
3212+
3213+
[**[TopicEvent]**](TopicEvent.md)
3214+
3215+
### Authorization
3216+
3217+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
3218+
3219+
### HTTP request headers
3220+
3221+
- **Content-Type**: Not defined
3222+
- **Accept**: application/json
3223+
3224+
30893225
## getTopicsPins
30903226

30913227
> [TopicPin] getTopicsPins(projectsPk, opts)

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -961,7 +961,7 @@ Name | Type | Description | Notes
961961
962962
Create a document
963963

964-
Create a document. If the document is one of {'OBJ', 'GLTF', 'DXF', 'POINT_CLOUD', 'IFC', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
964+
Create a document. If the document is one of {'GLTF', 'DXF', 'IFC', 'DWG', 'POINT_CLOUD', 'OBJ'}, a model will be created and attached to this document Required scopes: document:write
965965

966966
### Example
967967

docs/CommentEvent.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# bimdata.CommentEvent
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**topicGuid** | **String** | | [readonly]
8+
**commentGuid** | **String** | | [readonly]
9+
**author** | **String** | | [readonly]
10+
**date** | **Date** | | [readonly]
11+
**events** | [**[CommentEventAction]**](CommentEventAction.md) | |
12+
13+

docs/CommentEventAction.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# bimdata.CommentEventAction
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**type** | **String** | * `comment_created` - comment_created * `comment_text_updated` - comment_text_updated * `viewpoint_updated` - viewpoint_updated * `viewpoint_removed` - viewpoint_removed * `reply_to_comment_updated` - reply_to_comment_updated * `reply_to_comment_removed` - reply_to_comment_removed |
8+
**value** | **String** | |
9+
10+
11+
12+
## Enum: TypeEnum
13+
14+
15+
* `comment_created` (value: `"comment_created"`)
16+
17+
* `comment_text_updated` (value: `"comment_text_updated"`)
18+
19+
* `viewpoint_updated` (value: `"viewpoint_updated"`)
20+
21+
* `viewpoint_removed` (value: `"viewpoint_removed"`)
22+
23+
* `reply_to_comment_updated` (value: `"reply_to_comment_updated"`)
24+
25+
* `reply_to_comment_removed` (value: `"reply_to_comment_removed"`)
26+
27+
28+
29+

docs/DocumentText.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Number** | | [readonly]
88
**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
9-
**language** | **String** | * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german | [optional]
9+
**language** | **String** | * `italian` - italian * `german` - german * `english` - english * `spanish` - spanish * `french` - french | [optional]
1010

1111

1212

1313
## Enum: LanguageEnum
1414

1515

16+
* `italian` (value: `"italian"`)
17+
18+
* `german` (value: `"german"`)
19+
1620
* `english` (value: `"english"`)
1721

1822
* `spanish` (value: `"spanish"`)
1923

2024
* `french` (value: `"french"`)
2125

22-
* `italian` (value: `"italian"`)
23-
24-
* `german` (value: `"german"`)
25-
2626
* `null` (value: `"null"`)
2727

2828

docs/ModelApi.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7832,9 +7832,6 @@ let cloudPk = 56; // Number | A unique integer value identifying this cloud.
78327832
let modelPk = 56; // Number | A unique integer value identifying this model.
78337833
let projectPk = 56; // Number | A unique integer value identifying this project.
78347834
let opts = {
7835-
'classification': "classification_example", // String |
7836-
'classificationNotation': "classificationNotation_example", // String |
7837-
'propertyFilter': "propertyFilter_example", // String |
78387835
'type': "type_example" // String | Filter by IfcType
78397836
};
78407837
apiInstance.getPropertiesTypes(cloudPk, modelPk, projectPk, opts).then((data) => {
@@ -7853,9 +7850,6 @@ Name | Type | Description | Notes
78537850
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
78547851
**modelPk** | **Number**| A unique integer value identifying this model. |
78557852
**projectPk** | **Number**| A unique integer value identifying this project. |
7856-
**classification** | **String**| | [optional]
7857-
**classificationNotation** | **String**| | [optional]
7858-
**propertyFilter** | **String**| | [optional]
78597853
**type** | **String**| Filter by IfcType | [optional]
78607854

78617855
### Return type

docs/PatchedDocumentTextRequest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional]
8-
**language** | **String** | * `english` - english * `spanish` - spanish * `french` - french * `italian` - italian * `german` - german | [optional]
8+
**language** | **String** | * `italian` - italian * `german` - german * `english` - english * `spanish` - spanish * `french` - french | [optional]
99

1010

1111

1212
## Enum: LanguageEnum
1313

1414

15+
* `italian` (value: `"italian"`)
16+
17+
* `german` (value: `"german"`)
18+
1519
* `english` (value: `"english"`)
1620

1721
* `spanish` (value: `"spanish"`)
1822

1923
* `french` (value: `"french"`)
2024

21-
* `italian` (value: `"italian"`)
22-
23-
* `german` (value: `"german"`)
24-
2525
* `null` (value: `"null"`)
2626

2727

docs/TopicEvent.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# bimdata.TopicEvent
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**topicGuid** | **String** | | [readonly]
8+
**author** | **String** | | [readonly]
9+
**date** | **Date** | | [readonly]
10+
**events** | [**[TopicEventAction]**](TopicEventAction.md) | |
11+
12+

0 commit comments

Comments
 (0)