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

Commit 94c05ed

Browse files
Bimdata-ioBimdata-io
committed
MINOR: add params to ifc/export route
1 parent f7f2988 commit 94c05ed

10 files changed

Lines changed: 558 additions & 16 deletions

File tree

‎docs/IdentityProviderApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ null (empty response body)
7474
7575
Delete user form BIMData
7676

77-
Delete the user and all clouds where the user is alone
77+
NON HANDLED EDGE CASE: The user has been created on the identity provider (exists on the IDP) The user (or an app) has requested an access token (exists on keycloak) But the user has never used the API (doesn't exist on the API) So the API can't delete the user and can't forward the call to keycloak so a zombie user will stay on keycloak
7878

7979
### Example
8080

‎docs/Ifc.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**name** | **String** | | [optional]
99
**creator** | [**User**](User.md) | | [optional]
1010
**status** | **String** | | [optional]
11+
**source** | **String** | | [optional]
1112
**createdAt** | **Date** | | [optional]
1213
**updatedAt** | **Date** | | [optional]
1314
**documentId** | **String** | | [optional]
@@ -25,3 +26,18 @@ Name | Type | Description | Notes
2526
**warnings** | **[String]** | List of warnings that happened during IFC processing | [optional]
2627

2728

29+
30+
## Enum: SourceEnum
31+
32+
33+
* `UPLOAD` (value: `"UPLOAD"`)
34+
35+
* `SPLIT` (value: `"SPLIT"`)
36+
37+
* `MERGE` (value: `"MERGE"`)
38+
39+
* `EXPORT` (value: `"EXPORT"`)
40+
41+
42+
43+

‎docs/IfcApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2753,7 +2753,7 @@ null (empty response body)
27532753
27542754
Export IFC
27552755

2756-
Export IFC as requested in parameters. This call doesn't return the IFC. When the export is finished, a new IFC file with '_export_DD_MM_YYYY' suffix will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
2756+
Export IFC as requested in parameters. When the export is finished, a new IFC file with will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
27572757

27582758
### Example
27592759

@@ -5360,7 +5360,8 @@ let apiInstance = new bimdata.IfcApi();
53605360
let cloudPk = "cloudPk_example"; // String |
53615361
let projectPk = "projectPk_example"; // String |
53625362
let opts = {
5363-
'status': "status_example" // String | Filter the returned list by status
5363+
'status': "status_example", // String | Filter the returned list by status
5364+
'source': "source_example" // String | Filter the returned list by source
53645365
};
53655366
apiInstance.getIfcs(cloudPk, projectPk, opts).then((data) => {
53665367
console.log('API called successfully. Returned data: ' + data);
@@ -5378,6 +5379,7 @@ Name | Type | Description | Notes
53785379
**cloudPk** | **String**| |
53795380
**projectPk** | **String**| |
53805381
**status** | **String**| Filter the returned list by status | [optional]
5382+
**source** | **String**| Filter the returned list by source | [optional]
53815383

53825384
### Return type
53835385

‎docs/IfcExport.md‎

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,119 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**classifications** | **Boolean** | Exported Ifc will include API classifications updates | [optional]
7+
**classifications** | **String** | Exported IFC will include classifications from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include classifications(NONE) | [optional] [default to 'UPDATED']
8+
**zones** | **String** | Exported IFC will include zones from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include zones(NONE) | [optional] [default to 'UPDATED']
9+
**properties** | **String** | Exported IFC will include properties from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include properties(NONE) | [optional] [default to 'UPDATED']
10+
**systems** | **String** | Exported IFC will include systems from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include systems(NONE) | [optional] [default to 'UPDATED']
11+
**layers** | **String** | Exported IFC will include layers from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include layers(NONE) | [optional] [default to 'UPDATED']
12+
**materials** | **String** | Exported IFC will include materials from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include materials(NONE) | [optional] [default to 'UPDATED']
13+
**attributes** | **String** | Exported IFC will include attributes from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include attributes(NONE) | [optional] [default to 'UPDATED']
14+
**structure** | **String** | Exported IFC will include the structure from original IFC file (ORIGINAL), from latest API updates (UPDATED), or won't include structure(NONE) | [optional] [default to 'UPDATED']
15+
**uuids** | **[String]** | Exported IFC will only have those elements. If omitted, all elements will be exported | [optional]
16+
**fileName** | **String** | The name of the exported IFC file. It MUST end with .ifc or the exported file won't be processed by BIMData |
17+
18+
19+
20+
## Enum: ClassificationsEnum
21+
22+
23+
* `ORIGINAL` (value: `"ORIGINAL"`)
24+
25+
* `UPDATED` (value: `"UPDATED"`)
26+
27+
* `NONE` (value: `"NONE"`)
28+
29+
30+
31+
32+
33+
## Enum: ZonesEnum
34+
35+
36+
* `ORIGINAL` (value: `"ORIGINAL"`)
37+
38+
* `UPDATED` (value: `"UPDATED"`)
39+
40+
* `NONE` (value: `"NONE"`)
41+
42+
43+
44+
45+
46+
## Enum: PropertiesEnum
47+
48+
49+
* `ORIGINAL` (value: `"ORIGINAL"`)
50+
51+
* `UPDATED` (value: `"UPDATED"`)
52+
53+
* `NONE` (value: `"NONE"`)
54+
55+
56+
57+
58+
59+
## Enum: SystemsEnum
60+
61+
62+
* `ORIGINAL` (value: `"ORIGINAL"`)
63+
64+
* `UPDATED` (value: `"UPDATED"`)
65+
66+
* `NONE` (value: `"NONE"`)
67+
68+
69+
70+
71+
72+
## Enum: LayersEnum
73+
74+
75+
* `ORIGINAL` (value: `"ORIGINAL"`)
76+
77+
* `UPDATED` (value: `"UPDATED"`)
78+
79+
* `NONE` (value: `"NONE"`)
80+
81+
82+
83+
84+
85+
## Enum: MaterialsEnum
86+
87+
88+
* `ORIGINAL` (value: `"ORIGINAL"`)
89+
90+
* `UPDATED` (value: `"UPDATED"`)
91+
92+
* `NONE` (value: `"NONE"`)
93+
94+
95+
96+
97+
98+
## Enum: AttributesEnum
99+
100+
101+
* `ORIGINAL` (value: `"ORIGINAL"`)
102+
103+
* `UPDATED` (value: `"UPDATED"`)
104+
105+
* `NONE` (value: `"NONE"`)
106+
107+
108+
109+
110+
111+
## Enum: StructureEnum
112+
113+
114+
* `ORIGINAL` (value: `"ORIGINAL"`)
115+
116+
* `UPDATED` (value: `"UPDATED"`)
117+
118+
* `NONE` (value: `"NONE"`)
119+
120+
8121

9122

‎src/api/IdentityProviderApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export default class IdentityProviderApi {
8686

8787
/**
8888
* Delete user form BIMData
89-
* Delete the user and all clouds where the user is alone
89+
* NON HANDLED EDGE CASE: The user has been created on the identity provider (exists on the IDP) The user (or an app) has requested an access token (exists on keycloak) But the user has never used the API (doesn't exist on the API) So the API can't delete the user and can't forward the call to keycloak so a zombie user will stay on keycloak
9090
* @param {module:model/SelectUser} data
9191
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
9292
*/
@@ -119,7 +119,7 @@ export default class IdentityProviderApi {
119119

120120
/**
121121
* Delete user form BIMData
122-
* Delete the user and all clouds where the user is alone
122+
* NON HANDLED EDGE CASE: The user has been created on the identity provider (exists on the IDP) The user (or an app) has requested an access token (exists on keycloak) But the user has never used the API (doesn't exist on the API) So the API can't delete the user and can't forward the call to keycloak so a zombie user will stay on keycloak
123123
* @param {module:model/SelectUser} data
124124
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
125125
*/

‎src/api/IfcApi.js‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2981,7 +2981,7 @@ export default class IfcApi {
29812981

29822982
/**
29832983
* Export IFC
2984-
* Export IFC as requested in parameters. This call doesn't return the IFC. When the export is finished, a new IFC file with '_export_DD_MM_YYYY' suffix will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
2984+
* Export IFC as requested in parameters. When the export is finished, a new IFC file with will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
29852985
* @param {String} cloudPk
29862986
* @param {Number} id A unique integer value identifying this ifc.
29872987
* @param {String} projectPk
@@ -3032,7 +3032,7 @@ export default class IfcApi {
30323032

30333033
/**
30343034
* Export IFC
3035-
* Export IFC as requested in parameters. This call doesn't return the IFC. When the export is finished, a new IFC file with '_export_DD_MM_YYYY' suffix will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
3035+
* Export IFC as requested in parameters. When the export is finished, a new IFC file with will be created in the same folder than the original IFC. You can query the folder or subscribe to the new document webhook to retrieve the result Required scopes: ifc:write
30363036
* @param {String} cloudPk
30373037
* @param {Number} id A unique integer value identifying this ifc.
30383038
* @param {String} projectPk
@@ -5932,6 +5932,7 @@ export default class IfcApi {
59325932
* @param {String} projectPk
59335933
* @param {Object} opts Optional parameters
59345934
* @param {String} opts.status Filter the returned list by status
5935+
* @param {String} opts.source Filter the returned list by source
59355936
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Ifc>} and HTTP response
59365937
*/
59375938
getIfcsWithHttpInfo(cloudPk, projectPk, opts) {
@@ -5951,7 +5952,8 @@ export default class IfcApi {
59515952
'project_pk': projectPk
59525953
};
59535954
let queryParams = {
5954-
'status': opts['status']
5955+
'status': opts['status'],
5956+
'source': opts['source']
59555957
};
59565958
let headerParams = {
59575959
};
@@ -5976,6 +5978,7 @@ export default class IfcApi {
59765978
* @param {String} projectPk
59775979
* @param {Object} opts Optional parameters
59785980
* @param {String} opts.status Filter the returned list by status
5981+
* @param {String} opts.source Filter the returned list by source
59795982
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Ifc>}
59805983
*/
59815984
getIfcs(cloudPk, projectPk, opts) {

‎src/model/Ifc.js‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ class Ifc {
6161
if (data.hasOwnProperty('status')) {
6262
obj['status'] = ApiClient.convertToType(data['status'], 'String');
6363
}
64+
if (data.hasOwnProperty('source')) {
65+
obj['source'] = ApiClient.convertToType(data['source'], 'String');
66+
}
6467
if (data.hasOwnProperty('created_at')) {
6568
obj['created_at'] = ApiClient.convertToType(data['created_at'], 'Date');
6669
}
@@ -133,6 +136,11 @@ Ifc.prototype['creator'] = undefined;
133136
*/
134137
Ifc.prototype['status'] = undefined;
135138

139+
/**
140+
* @member {module:model/Ifc.SourceEnum} source
141+
*/
142+
Ifc.prototype['source'] = undefined;
143+
136144
/**
137145
* @member {Date} created_at
138146
*/
@@ -215,6 +223,39 @@ Ifc.prototype['warnings'] = undefined;
215223

216224

217225

226+
/**
227+
* Allowed values for the <code>source</code> property.
228+
* @enum {String}
229+
* @readonly
230+
*/
231+
Ifc['SourceEnum'] = {
232+
233+
/**
234+
* value: "UPLOAD"
235+
* @const
236+
*/
237+
"UPLOAD": "UPLOAD",
238+
239+
/**
240+
* value: "SPLIT"
241+
* @const
242+
*/
243+
"SPLIT": "SPLIT",
244+
245+
/**
246+
* value: "MERGE"
247+
* @const
248+
*/
249+
"MERGE": "MERGE",
250+
251+
/**
252+
* value: "EXPORT"
253+
* @const
254+
*/
255+
"EXPORT": "EXPORT"
256+
};
257+
258+
218259

219260
export default Ifc;
220261

0 commit comments

Comments
 (0)