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

Commit 3832be2

Browse files
Bimdata-ioBimdata-io
committed
MINOR: Add bcf topic format filter
1 parent 82b4e5f commit 3832be2

File tree

8 files changed

+48
-13
lines changed

8 files changed

+48
-13
lines changed

‎docs/BcfApi.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1479,7 +1479,7 @@ Name | Type | Description | Notes
14791479

14801480
<a name="getFullTopics"></a>
14811481
# **getFullTopics**
1482-
> [SingleJsonTopic] getFullTopics(projectsPk)
1482+
> [SingleJsonTopic] getFullTopics(projectsPk, opts)
14831483
14841484

14851485

@@ -1495,7 +1495,11 @@ Bearer.apiKey = 'YOUR API KEY';
14951495

14961496
var apiInstance = new bimdata.BcfApi();
14971497
var projectsPk = "projectsPk_example"; // String |
1498-
apiInstance.getFullTopics(projectsPk).then(function(data) {
1498+
var opts = {
1499+
'ifcs': "ifcs_example", // String | Filter the returned list by ifcs
1500+
'format': "format_example" // String | Filter the returned list by format
1501+
};
1502+
apiInstance.getFullTopics(projectsPk, opts).then(function(data) {
14991503
console.log('API called successfully. Returned data: ' + data);
15001504
}, function(error) {
15011505
console.error(error);
@@ -1508,6 +1512,8 @@ apiInstance.getFullTopics(projectsPk).then(function(data) {
15081512
Name | Type | Description | Notes
15091513
------------- | ------------- | ------------- | -------------
15101514
**projectsPk** | **String**| |
1515+
**ifcs** | **String**| Filter the returned list by ifcs | [optional]
1516+
**format** | **String**| Filter the returned list by format | [optional]
15111517

15121518
### Return type
15131519

@@ -1737,7 +1743,8 @@ Bearer.apiKey = 'YOUR API KEY';
17371743
var apiInstance = new bimdata.BcfApi();
17381744
var projectsPk = "projectsPk_example"; // String |
17391745
var opts = {
1740-
'ifcs': "ifcs_example" // String | Filter the returned list by ifcs
1746+
'ifcs': "ifcs_example", // String | Filter the returned list by ifcs
1747+
'format': "format_example" // String | Filter the returned list by format
17411748
};
17421749
apiInstance.getTopics(projectsPk, opts).then(function(data) {
17431750
console.log('API called successfully. Returned data: ' + data);
@@ -1753,6 +1760,7 @@ Name | Type | Description | Notes
17531760
------------- | ------------- | ------------- | -------------
17541761
**projectsPk** | **String**| |
17551762
**ifcs** | **String**| Filter the returned list by ifcs | [optional]
1763+
**format** | **String**| Filter the returned list by format | [optional]
17561764

17571765
### Return type
17581766

‎docs/SingleJsonTopic.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
1919
**priority** | **String** | | [optional]
2020
**index** | **Number** | | [optional]
2121
**assignedTo** | **String** | | [optional]
22+
**format** | **String** | | [optional]
2223
**comments** | [**[Comment]**](Comment.md) | | [optional]
2324
**viewpoints** | [**[Viewpoint]**](Viewpoint.md) | | [optional]
2425

‎docs/Topic.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
1919
**description** | **String** | | [optional]
2020
**dueDate** | **Date** | | [optional]
2121
**ifcs** | **[Number]** | | [optional]
22-
**topicFormat** | **String** | | [optional]
22+
**format** | **String** | | [optional]
2323
**index** | **Number** | | [optional]
2424

2525

‎src/api/BcfApi.js‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1937,9 +1937,13 @@
19371937

19381938
/**
19391939
* @param {String} projectsPk
1940+
* @param {Object} opts Optional parameters
1941+
* @param {String} opts.ifcs Filter the returned list by ifcs
1942+
* @param {String} opts.format Filter the returned list by format
19401943
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/SingleJsonTopic>} and HTTP response
19411944
*/
1942-
this.getFullTopicsWithHttpInfo = function(projectsPk) {
1945+
this.getFullTopicsWithHttpInfo = function(projectsPk, opts) {
1946+
opts = opts || {};
19431947
var postBody = null;
19441948

19451949
// verify the required parameter 'projectsPk' is set
@@ -1952,6 +1956,8 @@
19521956
'projects_pk': projectsPk
19531957
};
19541958
var queryParams = {
1959+
'ifcs': opts['ifcs'],
1960+
'format': opts['format'],
19551961
};
19561962
var collectionQueryParams = {
19571963
};
@@ -1974,10 +1980,13 @@
19741980

19751981
/**
19761982
* @param {String} projectsPk
1983+
* @param {Object} opts Optional parameters
1984+
* @param {String} opts.ifcs Filter the returned list by ifcs
1985+
* @param {String} opts.format Filter the returned list by format
19771986
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/SingleJsonTopic>}
19781987
*/
1979-
this.getFullTopics = function(projectsPk) {
1980-
return this.getFullTopicsWithHttpInfo(projectsPk)
1988+
this.getFullTopics = function(projectsPk, opts) {
1989+
return this.getFullTopicsWithHttpInfo(projectsPk, opts)
19811990
.then(function(response_and_data) {
19821991
return response_and_data.data;
19831992
});
@@ -2248,6 +2257,7 @@
22482257
* @param {String} projectsPk
22492258
* @param {Object} opts Optional parameters
22502259
* @param {String} opts.ifcs Filter the returned list by ifcs
2260+
* @param {String} opts.format Filter the returned list by format
22512261
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Topic>} and HTTP response
22522262
*/
22532263
this.getTopicsWithHttpInfo = function(projectsPk, opts) {
@@ -2265,6 +2275,7 @@
22652275
};
22662276
var queryParams = {
22672277
'ifcs': opts['ifcs'],
2278+
'format': opts['format'],
22682279
};
22692280
var collectionQueryParams = {
22702281
};
@@ -2289,6 +2300,7 @@
22892300
* @param {String} projectsPk
22902301
* @param {Object} opts Optional parameters
22912302
* @param {String} opts.ifcs Filter the returned list by ifcs
2303+
* @param {String} opts.format Filter the returned list by format
22922304
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Topic>}
22932305
*/
22942306
this.getTopics = function(projectsPk, opts) {

‎src/model/SingleJsonTopic.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767

6868

6969

70+
7071
};
7172

7273
/**
@@ -128,6 +129,9 @@
128129
if (data.hasOwnProperty('assigned_to')) {
129130
obj['assigned_to'] = ApiClient.convertToType(data['assigned_to'], 'String');
130131
}
132+
if (data.hasOwnProperty('format')) {
133+
obj['format'] = ApiClient.convertToType(data['format'], 'String');
134+
}
131135
if (data.hasOwnProperty('comments')) {
132136
obj['comments'] = ApiClient.convertToType(data['comments'], [Comment]);
133137
}
@@ -202,6 +206,10 @@
202206
* @member {String} assigned_to
203207
*/
204208
exports.prototype['assigned_to'] = undefined;
209+
/**
210+
* @member {String} format
211+
*/
212+
exports.prototype['format'] = undefined;
205213
/**
206214
* @member {Array.<module:model/Comment>} comments
207215
*/

‎src/model/Topic.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@
128128
if (data.hasOwnProperty('ifcs')) {
129129
obj['ifcs'] = ApiClient.convertToType(data['ifcs'], ['Number']);
130130
}
131-
if (data.hasOwnProperty('topic_format')) {
132-
obj['topic_format'] = ApiClient.convertToType(data['topic_format'], 'String');
131+
if (data.hasOwnProperty('format')) {
132+
obj['format'] = ApiClient.convertToType(data['format'], 'String');
133133
}
134134
if (data.hasOwnProperty('index')) {
135135
obj['index'] = ApiClient.convertToType(data['index'], 'Number');
@@ -203,9 +203,9 @@
203203
*/
204204
exports.prototype['ifcs'] = undefined;
205205
/**
206-
* @member {String} topic_format
206+
* @member {String} format
207207
*/
208-
exports.prototype['topic_format'] = undefined;
208+
exports.prototype['format'] = undefined;
209209
/**
210210
* @member {Number} index
211211
*/

‎test/model/SingleJsonTopic.spec.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@
153153
//expect(instance).to.be();
154154
});
155155

156+
it('should have the property format (base name: "format")', function() {
157+
// uncomment below and update the code to test the property format
158+
//var instance = new bimdata.SingleJsonTopic();
159+
//expect(instance).to.be();
160+
});
161+
156162
it('should have the property comments (base name: "comments")', function() {
157163
// uncomment below and update the code to test the property comments
158164
//var instance = new bimdata.SingleJsonTopic();

‎test/model/Topic.spec.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@
153153
//expect(instance).to.be();
154154
});
155155

156-
it('should have the property topicFormat (base name: "topic_format")', function() {
157-
// uncomment below and update the code to test the property topicFormat
156+
it('should have the property format (base name: "format")', function() {
157+
// uncomment below and update the code to test the property format
158158
//var instance = new bimdata.Topic();
159159
//expect(instance).to.be();
160160
});

0 commit comments

Comments
 (0)