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

Commit 647cafe

Browse files
Bimdata-ioBimdata-io
committed
PATCH: fix documents methods names
1 parent 71dd6a4 commit 647cafe

File tree

4 files changed

+171
-171
lines changed

4 files changed

+171
-171
lines changed

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -315,23 +315,23 @@ Class | Method | HTTP request | Description
315315
*bimdata.IfcApi* | [**updateZoneSpace**](docs/IfcApi.md#updateZoneSpace) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Update some fields of a space
316316
*bimdata.ProjectApi* | [**cancelProjectUserInvitation**](docs/ProjectApi.md#cancelProjectUserInvitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
317317
*bimdata.ProjectApi* | [**createClassification**](docs/ProjectApi.md#createClassification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
318-
*bimdata.ProjectApi* | [**createClassification_0**](docs/ProjectApi.md#createClassification_0) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a classification
318+
*bimdata.ProjectApi* | [**createDocument**](docs/ProjectApi.md#createDocument) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a document
319319
*bimdata.ProjectApi* | [**createFolder**](docs/ProjectApi.md#createFolder) | **POST** /cloud/{cloud_pk}/project/{project_pk}/folder | Create a folder
320320
*bimdata.ProjectApi* | [**createProject**](docs/ProjectApi.md#createProject) | **POST** /cloud/{cloud_pk}/project | Create a project
321321
*bimdata.ProjectApi* | [**deleteClassification**](docs/ProjectApi.md#deleteClassification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
322-
*bimdata.ProjectApi* | [**deleteClassification_0**](docs/ProjectApi.md#deleteClassification_0) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete a classification
322+
*bimdata.ProjectApi* | [**deleteDocument**](docs/ProjectApi.md#deleteDocument) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete the document
323323
*bimdata.ProjectApi* | [**deleteFolder**](docs/ProjectApi.md#deleteFolder) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Delete a folder
324324
*bimdata.ProjectApi* | [**deleteProject**](docs/ProjectApi.md#deleteProject) | **DELETE** /cloud/{cloud_pk}/project/{id} | Delete a project
325325
*bimdata.ProjectApi* | [**deleteProjectUser**](docs/ProjectApi.md#deleteProjectUser) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Remove a user from a project
326326
*bimdata.ProjectApi* | [**fullUpdateClassification**](docs/ProjectApi.md#fullUpdateClassification) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update all fields of a classification
327-
*bimdata.ProjectApi* | [**fullUpdateClassification_0**](docs/ProjectApi.md#fullUpdateClassification_0) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update all fields of a classification
327+
*bimdata.ProjectApi* | [**fullUpdateDocument**](docs/ProjectApi.md#fullUpdateDocument) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update all fields of the document
328328
*bimdata.ProjectApi* | [**fullUpdateFolder**](docs/ProjectApi.md#fullUpdateFolder) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update all fields of a folder
329329
*bimdata.ProjectApi* | [**fullUpdateProject**](docs/ProjectApi.md#fullUpdateProject) | **PUT** /cloud/{cloud_pk}/project/{id} | Update all fields of a project
330330
*bimdata.ProjectApi* | [**fullUpdateProjectUser**](docs/ProjectApi.md#fullUpdateProjectUser) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Update all fields of a project user
331331
*bimdata.ProjectApi* | [**getClassification**](docs/ProjectApi.md#getClassification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Retrieve a classification
332-
*bimdata.ProjectApi* | [**getClassification_0**](docs/ProjectApi.md#getClassification_0) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a classification
333332
*bimdata.ProjectApi* | [**getClassifications**](docs/ProjectApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
334-
*bimdata.ProjectApi* | [**getClassifications_0**](docs/ProjectApi.md#getClassifications_0) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all classifications
333+
*bimdata.ProjectApi* | [**getDocument**](docs/ProjectApi.md#getDocument) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a document
334+
*bimdata.ProjectApi* | [**getDocuments**](docs/ProjectApi.md#getDocuments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all documents
335335
*bimdata.ProjectApi* | [**getFolder**](docs/ProjectApi.md#getFolder) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Retrieve a folder
336336
*bimdata.ProjectApi* | [**getFolders**](docs/ProjectApi.md#getFolders) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder | Retrieve all folders
337337
*bimdata.ProjectApi* | [**getProject**](docs/ProjectApi.md#getProject) | **GET** /cloud/{cloud_pk}/project/{id} | Retrieve a project
@@ -342,7 +342,7 @@ Class | Method | HTTP request | Description
342342
*bimdata.ProjectApi* | [**getProjects**](docs/ProjectApi.md#getProjects) | **GET** /cloud/{cloud_pk}/project | Retrieve all projects
343343
*bimdata.ProjectApi* | [**inviteProjectUser**](docs/ProjectApi.md#inviteProjectUser) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
344344
*bimdata.ProjectApi* | [**updateClassification**](docs/ProjectApi.md#updateClassification) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update some fields of a classification
345-
*bimdata.ProjectApi* | [**updateClassification_0**](docs/ProjectApi.md#updateClassification_0) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of a classification
345+
*bimdata.ProjectApi* | [**updateDocument**](docs/ProjectApi.md#updateDocument) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
346346
*bimdata.ProjectApi* | [**updateFolder**](docs/ProjectApi.md#updateFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
347347
*bimdata.ProjectApi* | [**updateProject**](docs/ProjectApi.md#updateProject) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
348348
*bimdata.ProjectApi* | [**updateProjectUser**](docs/ProjectApi.md#updateProjectUser) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Update some fields of a project user

‎docs/ProjectApi.md‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**cancelProjectUserInvitation**](ProjectApi.md#cancelProjectUserInvitation) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} | Cancel a pending invitation
88
[**createClassification**](ProjectApi.md#createClassification) | **POST** /cloud/{cloud_pk}/project/{project_pk}/classification | Create a classification
9-
[**createClassification_0**](ProjectApi.md#createClassification_0) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a classification
9+
[**createDocument**](ProjectApi.md#createDocument) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document | Create a document
1010
[**createFolder**](ProjectApi.md#createFolder) | **POST** /cloud/{cloud_pk}/project/{project_pk}/folder | Create a folder
1111
[**createProject**](ProjectApi.md#createProject) | **POST** /cloud/{cloud_pk}/project | Create a project
1212
[**deleteClassification**](ProjectApi.md#deleteClassification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
13-
[**deleteClassification_0**](ProjectApi.md#deleteClassification_0) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete a classification
13+
[**deleteDocument**](ProjectApi.md#deleteDocument) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Delete the document
1414
[**deleteFolder**](ProjectApi.md#deleteFolder) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Delete a folder
1515
[**deleteProject**](ProjectApi.md#deleteProject) | **DELETE** /cloud/{cloud_pk}/project/{id} | Delete a project
1616
[**deleteProjectUser**](ProjectApi.md#deleteProjectUser) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Remove a user from a project
1717
[**fullUpdateClassification**](ProjectApi.md#fullUpdateClassification) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update all fields of a classification
18-
[**fullUpdateClassification_0**](ProjectApi.md#fullUpdateClassification_0) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update all fields of a classification
18+
[**fullUpdateDocument**](ProjectApi.md#fullUpdateDocument) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update all fields of the document
1919
[**fullUpdateFolder**](ProjectApi.md#fullUpdateFolder) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update all fields of a folder
2020
[**fullUpdateProject**](ProjectApi.md#fullUpdateProject) | **PUT** /cloud/{cloud_pk}/project/{id} | Update all fields of a project
2121
[**fullUpdateProjectUser**](ProjectApi.md#fullUpdateProjectUser) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Update all fields of a project user
2222
[**getClassification**](ProjectApi.md#getClassification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Retrieve a classification
23-
[**getClassification_0**](ProjectApi.md#getClassification_0) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a classification
2423
[**getClassifications**](ProjectApi.md#getClassifications) | **GET** /cloud/{cloud_pk}/project/{project_pk}/classification | Retrieve all classifications
25-
[**getClassifications_0**](ProjectApi.md#getClassifications_0) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all classifications
24+
[**getDocument**](ProjectApi.md#getDocument) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Retrieve a document
25+
[**getDocuments**](ProjectApi.md#getDocuments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/document | Retrieve all documents
2626
[**getFolder**](ProjectApi.md#getFolder) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Retrieve a folder
2727
[**getFolders**](ProjectApi.md#getFolders) | **GET** /cloud/{cloud_pk}/project/{project_pk}/folder | Retrieve all folders
2828
[**getProject**](ProjectApi.md#getProject) | **GET** /cloud/{cloud_pk}/project/{id} | Retrieve a project
@@ -33,7 +33,7 @@ Method | HTTP request | Description
3333
[**getProjects**](ProjectApi.md#getProjects) | **GET** /cloud/{cloud_pk}/project | Retrieve all projects
3434
[**inviteProjectUser**](ProjectApi.md#inviteProjectUser) | **POST** /cloud/{cloud_pk}/project/{project_pk}/invitation | Invite a project member
3535
[**updateClassification**](ProjectApi.md#updateClassification) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Update some fields of a classification
36-
[**updateClassification_0**](ProjectApi.md#updateClassification_0) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of a classification
36+
[**updateDocument**](ProjectApi.md#updateDocument) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{id} | Update some fields of the document
3737
[**updateFolder**](ProjectApi.md#updateFolder) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/folder/{id} | Update some fields of a folder
3838
[**updateProject**](ProjectApi.md#updateProject) | **PATCH** /cloud/{cloud_pk}/project/{id} | Update some fields of a project
3939
[**updateProjectUser**](ProjectApi.md#updateProjectUser) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/user/{id} | Update some fields of a project user
@@ -141,13 +141,13 @@ Name | Type | Description | Notes
141141
- **Content-Type**: application/json
142142
- **Accept**: application/json
143143

144-
<a name="createClassification_0"></a>
145-
# **createClassification_0**
146-
> Document createClassification_0(cloudPk, projectPk, name, opts)
144+
<a name="createDocument"></a>
145+
# **createDocument**
146+
> Document createDocument(cloudPk, projectPk, name, opts)
147147
148-
Create a classification
148+
Create a document
149149

150-
Required scopes: document:write
150+
RCreate a document. If the document is an IFC, an IFC model will be created and attached to this document Required scopes: document:write
151151

152152
### Example
153153
```javascript
@@ -173,7 +173,7 @@ var opts = {
173173
'file': "/path/to/file", // File |
174174
'size': 56 // Number | Size of the file. The file may be compressed and show a smaller size
175175
};
176-
apiInstance.createClassification_0(cloudPk, projectPk, name, opts).then(function(data) {
176+
apiInstance.createDocument(cloudPk, projectPk, name, opts).then(function(data) {
177177
console.log('API called successfully. Returned data: ' + data);
178178
}, function(error) {
179179
console.error(error);
@@ -361,13 +361,13 @@ null (empty response body)
361361
- **Content-Type**: Not defined
362362
- **Accept**: Not defined
363363

364-
<a name="deleteClassification_0"></a>
365-
# **deleteClassification_0**
366-
> deleteClassification_0(cloudPk, id, projectPk)
364+
<a name="deleteDocument"></a>
365+
# **deleteDocument**
366+
> deleteDocument(cloudPk, id, projectPk)
367367
368-
Delete a classification
368+
Delete the document
369369

370-
All elements having this classification will lose it Required scopes: document:write
370+
Delete the document Required scopes: document:write
371371

372372
### Example
373373
```javascript
@@ -383,7 +383,7 @@ var apiInstance = new bimdata.ProjectApi();
383383
var cloudPk = "cloudPk_example"; // String |
384384
var id = 56; // Number | A unique integer value identifying this document.
385385
var projectPk = "projectPk_example"; // String |
386-
apiInstance.deleteClassification_0(cloudPk, id, projectPk).then(function() {
386+
apiInstance.deleteDocument(cloudPk, id, projectPk).then(function() {
387387
console.log('API called successfully.');
388388
}, function(error) {
389389
console.error(error);
@@ -616,13 +616,13 @@ Name | Type | Description | Notes
616616
- **Content-Type**: application/json
617617
- **Accept**: application/json
618618

619-
<a name="fullUpdateClassification_0"></a>
620-
# **fullUpdateClassification_0**
621-
> Document fullUpdateClassification_0(cloudPk, id, projectPk, name, opts)
619+
<a name="fullUpdateDocument"></a>
620+
# **fullUpdateDocument**
621+
> Document fullUpdateDocument(cloudPk, id, projectPk, name, opts)
622622
623-
Update all fields of a classification
623+
Update all fields of the document
624624

625-
Update all fields of a classification Required scopes: document:write
625+
Update all fields of the document Required scopes: document:write
626626

627627
### Example
628628
```javascript
@@ -649,7 +649,7 @@ var opts = {
649649
'file': "/path/to/file", // File |
650650
'size': 56 // Number | Size of the file. The file may be compressed and show a smaller size
651651
};
652-
apiInstance.fullUpdateClassification_0(cloudPk, id, projectPk, name, opts).then(function(data) {
652+
apiInstance.fullUpdateDocument(cloudPk, id, projectPk, name, opts).then(function(data) {
653653
console.log('API called successfully. Returned data: ' + data);
654654
}, function(error) {
655655
console.error(error);
@@ -895,13 +895,13 @@ Name | Type | Description | Notes
895895
- **Content-Type**: Not defined
896896
- **Accept**: application/json
897897

898-
<a name="getClassification_0"></a>
899-
# **getClassification_0**
900-
> Document getClassification_0(cloudPk, id, projectPk)
898+
<a name="getClassifications"></a>
899+
# **getClassifications**
900+
> [Classification] getClassifications(cloudPk, projectPk)
901901
902-
Retrieve a classification
902+
Retrieve all classifications
903903

904-
Retrieve a classification Required scopes: document:read
904+
Retrieve all classifications of all models in the project Required scopes: ifc:read
905905

906906
### Example
907907
```javascript
@@ -915,9 +915,8 @@ Bearer.apiKey = 'YOUR API KEY';
915915

916916
var apiInstance = new bimdata.ProjectApi();
917917
var cloudPk = "cloudPk_example"; // String |
918-
var id = 56; // Number | A unique integer value identifying this document.
919918
var projectPk = "projectPk_example"; // String |
920-
apiInstance.getClassification_0(cloudPk, id, projectPk).then(function(data) {
919+
apiInstance.getClassifications(cloudPk, projectPk).then(function(data) {
921920
console.log('API called successfully. Returned data: ' + data);
922921
}, function(error) {
923922
console.error(error);
@@ -930,12 +929,11 @@ apiInstance.getClassification_0(cloudPk, id, projectPk).then(function(data) {
930929
Name | Type | Description | Notes
931930
------------- | ------------- | ------------- | -------------
932931
**cloudPk** | **String**| |
933-
**id** | **Number**| A unique integer value identifying this document. |
934932
**projectPk** | **String**| |
935933

936934
### Return type
937935

938-
[**Document**](Document.md)
936+
[**[Classification]**](Classification.md)
939937

940938
### Authorization
941939

@@ -946,13 +944,13 @@ Name | Type | Description | Notes
946944
- **Content-Type**: Not defined
947945
- **Accept**: application/json
948946

949-
<a name="getClassifications"></a>
950-
# **getClassifications**
951-
> [Classification] getClassifications(cloudPk, projectPk)
947+
<a name="getDocument"></a>
948+
# **getDocument**
949+
> Document getDocument(cloudPk, id, projectPk)
952950
953-
Retrieve all classifications
951+
Retrieve a document
954952

955-
Retrieve all classifications of all models in the project Required scopes: ifc:read
953+
Retrieve a document in the project Required scopes: document:read
956954

957955
### Example
958956
```javascript
@@ -966,8 +964,9 @@ Bearer.apiKey = 'YOUR API KEY';
966964

967965
var apiInstance = new bimdata.ProjectApi();
968966
var cloudPk = "cloudPk_example"; // String |
967+
var id = 56; // Number | A unique integer value identifying this document.
969968
var projectPk = "projectPk_example"; // String |
970-
apiInstance.getClassifications(cloudPk, projectPk).then(function(data) {
969+
apiInstance.getDocument(cloudPk, id, projectPk).then(function(data) {
971970
console.log('API called successfully. Returned data: ' + data);
972971
}, function(error) {
973972
console.error(error);
@@ -980,11 +979,12 @@ apiInstance.getClassifications(cloudPk, projectPk).then(function(data) {
980979
Name | Type | Description | Notes
981980
------------- | ------------- | ------------- | -------------
982981
**cloudPk** | **String**| |
982+
**id** | **Number**| A unique integer value identifying this document. |
983983
**projectPk** | **String**| |
984984

985985
### Return type
986986

987-
[**[Classification]**](Classification.md)
987+
[**Document**](Document.md)
988988

989989
### Authorization
990990

@@ -995,13 +995,13 @@ Name | Type | Description | Notes
995995
- **Content-Type**: Not defined
996996
- **Accept**: application/json
997997

998-
<a name="getClassifications_0"></a>
999-
# **getClassifications_0**
1000-
> [Document] getClassifications_0(cloudPk, projectPk)
998+
<a name="getDocuments"></a>
999+
# **getDocuments**
1000+
> [Document] getDocuments(cloudPk, projectPk)
10011001
1002-
Retrieve all classifications
1002+
Retrieve all documents
10031003

1004-
Retrieve all classifications of all models in the project Required scopes: document:read
1004+
Retrieve all documents in the project Required scopes: document:read
10051005

10061006
### Example
10071007
```javascript
@@ -1016,7 +1016,7 @@ Bearer.apiKey = 'YOUR API KEY';
10161016
var apiInstance = new bimdata.ProjectApi();
10171017
var cloudPk = "cloudPk_example"; // String |
10181018
var projectPk = "projectPk_example"; // String |
1019-
apiInstance.getClassifications_0(cloudPk, projectPk).then(function(data) {
1019+
apiInstance.getDocuments(cloudPk, projectPk).then(function(data) {
10201020
console.log('API called successfully. Returned data: ' + data);
10211021
}, function(error) {
10221022
console.error(error);
@@ -1542,13 +1542,13 @@ Name | Type | Description | Notes
15421542
- **Content-Type**: application/json
15431543
- **Accept**: application/json
15441544

1545-
<a name="updateClassification_0"></a>
1546-
# **updateClassification_0**
1547-
> Document updateClassification_0(cloudPk, id, projectPk, document)
1545+
<a name="updateDocument"></a>
1546+
# **updateDocument**
1547+
> Document updateDocument(cloudPk, id, projectPk, document)
15481548
1549-
Update some fields of a classification
1549+
Update some fields of the document
15501550

1551-
Update some fields of a classification Required scopes: document:write
1551+
Update some fields of the document Required scopes: document:write
15521552

15531553
### Example
15541554
```javascript
@@ -1565,7 +1565,7 @@ var cloudPk = "cloudPk_example"; // String |
15651565
var id = 56; // Number | A unique integer value identifying this document.
15661566
var projectPk = "projectPk_example"; // String |
15671567
var document = new bimdata.Document(); // Document |
1568-
apiInstance.updateClassification_0(cloudPk, id, projectPk, document).then(function(data) {
1568+
apiInstance.updateDocument(cloudPk, id, projectPk, document).then(function(data) {
15691569
console.log('API called successfully. Returned data: ' + data);
15701570
}, function(error) {
15711571
console.error(error);

0 commit comments

Comments
 (0)