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

Commit f15bd1e

Browse files
Bimdata-ioBimdata-io
committed
PATCH: add id field to Pin
1 parent 4d73134 commit f15bd1e

File tree

7 files changed

+79
-62
lines changed

7 files changed

+79
-62
lines changed

‎docs/BcfApi.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2150,10 +2150,10 @@ Bearer.apiKey = 'YOUR API KEY';
21502150
let apiInstance = new bimdata.BcfApi();
21512151
let projectsPk = 56; // Number |
21522152
let opts = {
2153-
'format': "format_example", // String |
2154-
'ifcs': [null], // [Number] |
2153+
'format': "format_example", // String | format
2154+
'ifcs': "ifcs_example", // String | ifcs
21552155
'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64
2156-
'models': [null] // [Number] |
2156+
'models': "models_example" // String | models
21572157
};
21582158
apiInstance.getFullTopics(projectsPk, opts).then((data) => {
21592159
console.log('API called successfully. Returned data: ' + data);
@@ -2169,10 +2169,10 @@ apiInstance.getFullTopics(projectsPk, opts).then((data) => {
21692169
Name | Type | Description | Notes
21702170
------------- | ------------- | ------------- | -------------
21712171
**projectsPk** | **Number**| |
2172-
**format** | **String**| | [optional]
2173-
**ifcs** | [**[Number]**](Number.md)| | [optional]
2172+
**format** | **String**| format | [optional]
2173+
**ifcs** | **String**| ifcs | [optional]
21742174
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
2175-
**models** | [**[Number]**](Number.md)| | [optional]
2175+
**models** | **String**| models | [optional]
21762176

21772177
### Return type
21782178

@@ -2222,9 +2222,9 @@ let apiInstance = new bimdata.BcfApi();
22222222
let guid = "guid_example"; // String |
22232223
let projectsPk = 56; // Number |
22242224
let opts = {
2225-
'format': "format_example", // String |
2226-
'ifcs': [null], // [Number] |
2227-
'models': [null] // [Number] |
2225+
'format': "format_example", // String | format
2226+
'ifcs': "ifcs_example", // String | ifcs
2227+
'models': "models_example" // String | models
22282228
};
22292229
apiInstance.getRelatedTopics(guid, projectsPk, opts).then((data) => {
22302230
console.log('API called successfully. Returned data: ' + data);
@@ -2241,9 +2241,9 @@ Name | Type | Description | Notes
22412241
------------- | ------------- | ------------- | -------------
22422242
**guid** | **String**| |
22432243
**projectsPk** | **Number**| |
2244-
**format** | **String**| | [optional]
2245-
**ifcs** | [**[Number]**](Number.md)| | [optional]
2246-
**models** | [**[Number]**](Number.md)| | [optional]
2244+
**format** | **String**| format | [optional]
2245+
**ifcs** | **String**| ifcs | [optional]
2246+
**models** | **String**| models | [optional]
22472247

22482248
### Return type
22492249

@@ -2486,9 +2486,9 @@ let apiInstance = new bimdata.BcfApi();
24862486
let guid = "guid_example"; // String |
24872487
let projectsPk = 56; // Number |
24882488
let opts = {
2489-
'format': "format_example", // String |
2490-
'ifcs': [null], // [Number] |
2491-
'models': [null] // [Number] |
2489+
'format': "format_example", // String | format
2490+
'ifcs': "ifcs_example", // String | ifcs
2491+
'models': "models_example" // String | models
24922492
};
24932493
apiInstance.getTopicDocumentReferences(guid, projectsPk, opts).then((data) => {
24942494
console.log('API called successfully. Returned data: ' + data);
@@ -2505,9 +2505,9 @@ Name | Type | Description | Notes
25052505
------------- | ------------- | ------------- | -------------
25062506
**guid** | **String**| |
25072507
**projectsPk** | **Number**| |
2508-
**format** | **String**| | [optional]
2509-
**ifcs** | [**[Number]**](Number.md)| | [optional]
2510-
**models** | [**[Number]**](Number.md)| | [optional]
2508+
**format** | **String**| format | [optional]
2509+
**ifcs** | **String**| ifcs | [optional]
2510+
**models** | **String**| models | [optional]
25112511

25122512
### Return type
25132513

@@ -2623,9 +2623,9 @@ Bearer.apiKey = 'YOUR API KEY';
26232623
let apiInstance = new bimdata.BcfApi();
26242624
let projectsPk = 56; // Number |
26252625
let opts = {
2626-
'format': "format_example", // String |
2627-
'ifcs': [null], // [Number] |
2628-
'models': [null] // [Number] |
2626+
'format': "format_example", // String | format
2627+
'ifcs': "ifcs_example", // String | ifcs
2628+
'models': "models_example" // String | models
26292629
};
26302630
apiInstance.getTopics(projectsPk, opts).then((data) => {
26312631
console.log('API called successfully. Returned data: ' + data);
@@ -2641,9 +2641,9 @@ apiInstance.getTopics(projectsPk, opts).then((data) => {
26412641
Name | Type | Description | Notes
26422642
------------- | ------------- | ------------- | -------------
26432643
**projectsPk** | **Number**| |
2644-
**format** | **String**| | [optional]
2645-
**ifcs** | [**[Number]**](Number.md)| | [optional]
2646-
**models** | [**[Number]**](Number.md)| | [optional]
2644+
**format** | **String**| format | [optional]
2645+
**ifcs** | **String**| ifcs | [optional]
2646+
**models** | **String**| models | [optional]
26472647

26482648
### Return type
26492649

‎docs/CollaborationApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,7 @@ Name | Type | Description | Notes
954954
955955
Create a document
956956

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

959959
### Example
960960

‎docs/Pin.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7+
**id** | **Number** | | [readonly]
78
**name** | **String** | | [optional]
89
**color** | **String** | | [optional]
910
**point** | [**Point**](Point.md) | |

‎src/api/BcfApi.js‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1886,10 +1886,10 @@ export default class BcfApi {
18861886
* This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read
18871887
* @param {Number} projectsPk
18881888
* @param {Object} opts Optional parameters
1889-
* @param {String} opts.format
1890-
* @param {Array.<Number>} opts.ifcs
1889+
* @param {String} opts.format format
1890+
* @param {String} opts.ifcs ifcs
18911891
* @param {module:model/String} opts.imgFormat All snapshot_data will be returned as url instead of base64
1892-
* @param {Array.<Number>} opts.models
1892+
* @param {String} opts.models models
18931893
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/FullTopic>} and HTTP response
18941894
*/
18951895
getFullTopicsWithHttpInfo(projectsPk, opts) {
@@ -1905,9 +1905,9 @@ export default class BcfApi {
19051905
};
19061906
let queryParams = {
19071907
'format': opts['format'],
1908-
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
1908+
'ifcs': opts['ifcs'],
19091909
'img_format': opts['imgFormat'],
1910-
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
1910+
'models': opts['models']
19111911
};
19121912
let headerParams = {
19131913
};
@@ -1930,10 +1930,10 @@ export default class BcfApi {
19301930
* This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read
19311931
* @param {Number} projectsPk
19321932
* @param {Object} opts Optional parameters
1933-
* @param {String} opts.format
1934-
* @param {Array.<Number>} opts.ifcs
1933+
* @param {String} opts.format format
1934+
* @param {String} opts.ifcs ifcs
19351935
* @param {module:model/String} opts.imgFormat All snapshot_data will be returned as url instead of base64
1936-
* @param {Array.<Number>} opts.models
1936+
* @param {String} opts.models models
19371937
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/FullTopic>}
19381938
*/
19391939
getFullTopics(projectsPk, opts) {
@@ -1950,9 +1950,9 @@ export default class BcfApi {
19501950
* @param {String} guid
19511951
* @param {Number} projectsPk
19521952
* @param {Object} opts Optional parameters
1953-
* @param {String} opts.format
1954-
* @param {Array.<Number>} opts.ifcs
1955-
* @param {Array.<Number>} opts.models
1953+
* @param {String} opts.format format
1954+
* @param {String} opts.ifcs ifcs
1955+
* @param {String} opts.models models
19561956
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<String>} and HTTP response
19571957
*/
19581958
getRelatedTopicsWithHttpInfo(guid, projectsPk, opts) {
@@ -1973,8 +1973,8 @@ export default class BcfApi {
19731973
};
19741974
let queryParams = {
19751975
'format': opts['format'],
1976-
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
1977-
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
1976+
'ifcs': opts['ifcs'],
1977+
'models': opts['models']
19781978
};
19791979
let headerParams = {
19801980
};
@@ -1998,9 +1998,9 @@ export default class BcfApi {
19981998
* @param {String} guid
19991999
* @param {Number} projectsPk
20002000
* @param {Object} opts Optional parameters
2001-
* @param {String} opts.format
2002-
* @param {Array.<Number>} opts.ifcs
2003-
* @param {Array.<Number>} opts.models
2001+
* @param {String} opts.format format
2002+
* @param {String} opts.ifcs ifcs
2003+
* @param {String} opts.models models
20042004
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<String>}
20052005
*/
20062006
getRelatedTopics(guid, projectsPk, opts) {
@@ -2196,9 +2196,9 @@ export default class BcfApi {
21962196
* @param {String} guid
21972197
* @param {Number} projectsPk
21982198
* @param {Object} opts Optional parameters
2199-
* @param {String} opts.format
2200-
* @param {Array.<Number>} opts.ifcs
2201-
* @param {Array.<Number>} opts.models
2199+
* @param {String} opts.format format
2200+
* @param {String} opts.ifcs ifcs
2201+
* @param {String} opts.models models
22022202
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<String>} and HTTP response
22032203
*/
22042204
getTopicDocumentReferencesWithHttpInfo(guid, projectsPk, opts) {
@@ -2219,8 +2219,8 @@ export default class BcfApi {
22192219
};
22202220
let queryParams = {
22212221
'format': opts['format'],
2222-
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
2223-
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
2222+
'ifcs': opts['ifcs'],
2223+
'models': opts['models']
22242224
};
22252225
let headerParams = {
22262226
};
@@ -2244,9 +2244,9 @@ export default class BcfApi {
22442244
* @param {String} guid
22452245
* @param {Number} projectsPk
22462246
* @param {Object} opts Optional parameters
2247-
* @param {String} opts.format
2248-
* @param {Array.<Number>} opts.ifcs
2249-
* @param {Array.<Number>} opts.models
2247+
* @param {String} opts.format format
2248+
* @param {String} opts.ifcs ifcs
2249+
* @param {String} opts.models models
22502250
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<String>}
22512251
*/
22522252
getTopicDocumentReferences(guid, projectsPk, opts) {
@@ -2323,9 +2323,9 @@ export default class BcfApi {
23232323
* Retrieve all topics Required scopes: bcf:read
23242324
* @param {Number} projectsPk
23252325
* @param {Object} opts Optional parameters
2326-
* @param {String} opts.format
2327-
* @param {Array.<Number>} opts.ifcs
2328-
* @param {Array.<Number>} opts.models
2326+
* @param {String} opts.format format
2327+
* @param {String} opts.ifcs ifcs
2328+
* @param {String} opts.models models
23292329
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Topic>} and HTTP response
23302330
*/
23312331
getTopicsWithHttpInfo(projectsPk, opts) {
@@ -2341,8 +2341,8 @@ export default class BcfApi {
23412341
};
23422342
let queryParams = {
23432343
'format': opts['format'],
2344-
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
2345-
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
2344+
'ifcs': opts['ifcs'],
2345+
'models': opts['models']
23462346
};
23472347
let headerParams = {
23482348
};
@@ -2365,9 +2365,9 @@ export default class BcfApi {
23652365
* Retrieve all topics Required scopes: bcf:read
23662366
* @param {Number} projectsPk
23672367
* @param {Object} opts Optional parameters
2368-
* @param {String} opts.format
2369-
* @param {Array.<Number>} opts.ifcs
2370-
* @param {Array.<Number>} opts.models
2368+
* @param {String} opts.format format
2369+
* @param {String} opts.ifcs ifcs
2370+
* @param {String} opts.models models
23712371
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Topic>}
23722372
*/
23732373
getTopics(projectsPk, opts) {

‎src/api/CollaborationApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ export default class CollaborationApi {
857857

858858
/**
859859
* Create a document
860-
* Create a document. If the document is one of {'OBJ', 'DAE', 'GLTF', 'IFC', 'BFX', 'POINT_CLOUD', 'DWG', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
860+
* Create a document. If the document is one of {'POINT_CLOUD', 'BFX', 'DWG', 'DAE', 'GLTF', 'OBJ', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
861861
* @param {Number} cloudPk A unique integer value identifying this cloud.
862862
* @param {Number} projectPk A unique integer value identifying this project.
863863
* @param {String} name Shown name of the file
@@ -925,7 +925,7 @@ export default class CollaborationApi {
925925

926926
/**
927927
* Create a document
928-
* Create a document. If the document is one of {'OBJ', 'DAE', 'GLTF', 'IFC', 'BFX', 'POINT_CLOUD', 'DWG', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
928+
* Create a document. If the document is one of {'POINT_CLOUD', 'BFX', 'DWG', 'DAE', 'GLTF', 'OBJ', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
929929
* @param {Number} cloudPk A unique integer value identifying this cloud.
930930
* @param {Number} projectPk A unique integer value identifying this project.
931931
* @param {String} name Shown name of the file

‎src/model/Pin.js‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,21 @@ class Pin {
2424
* Constructs a new <code>Pin</code>.
2525
* Adds nested create feature
2626
* @alias module:model/Pin
27+
* @param id {Number}
2728
* @param point {module:model/Point}
2829
*/
29-
constructor(point) {
30+
constructor(id, point) {
3031

31-
Pin.initialize(this, point);
32+
Pin.initialize(this, id, point);
3233
}
3334

3435
/**
3536
* Initializes the fields of this object.
3637
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
3738
* Only for internal use.
3839
*/
39-
static initialize(obj, point) {
40+
static initialize(obj, id, point) {
41+
obj['id'] = id;
4042
obj['point'] = point;
4143
}
4244

@@ -51,6 +53,9 @@ class Pin {
5153
if (data) {
5254
obj = obj || new Pin();
5355

56+
if (data.hasOwnProperty('id')) {
57+
obj['id'] = ApiClient.convertToType(data['id'], 'Number');
58+
}
5459
if (data.hasOwnProperty('name')) {
5560
obj['name'] = ApiClient.convertToType(data['name'], 'String');
5661
}
@@ -67,6 +72,11 @@ class Pin {
6772

6873
}
6974

75+
/**
76+
* @member {Number} id
77+
*/
78+
Pin.prototype['id'] = undefined;
79+
7080
/**
7181
* @member {String} name
7282
*/

‎test/model/Pin.spec.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@
5454
//expect(instance).to.be.a(bimdata.Pin);
5555
});
5656

57+
it('should have the property id (base name: "id")', function() {
58+
// uncomment below and update the code to test the property id
59+
//var instance = new bimdata.Pin();
60+
//expect(instance).to.be();
61+
});
62+
5763
it('should have the property name (base name: "name")', function() {
5864
// uncomment below and update the code to test the property name
5965
//var instance = new bimdata.Pin();

0 commit comments

Comments
 (0)