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

Commit 82b4e5f

Browse files
committed
MINOR: fix swagger.json
1 parent 826a344 commit 82b4e5f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+10374
-221
lines changed

README.md

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,9 @@ Bearer.apiKey = "YOUR API KEY"
105105

106106
var api = new bimdata.ApplicationApi()
107107
var cloudPk = "cloudPk_example"; // {String}
108+
var id = "id_example"; // {String}
108109
var webHook = new bimdata.WebHook(); // {WebHook}
109-
api.createWebHook(cloudPk, webHook).then(function(data) {
110+
api.cloudWebhookPing(cloudPk, id, webHook).then(function(data) {
110111
console.log('API called successfully. Returned data: ' + data);
111112
}, function(error) {
112113
console.error(error);
@@ -121,12 +122,61 @@ All URIs are relative to *https://api-beta.bimdata.io*
121122

122123
Class | Method | HTTP request | Description
123124
------------ | ------------- | ------------- | -------------
125+
*bimdata.ApplicationApi* | [**cloudWebhookPing**](docs/ApplicationApi.md#cloudWebhookPing) | **POST** /cloud/{cloud_pk}/webhook/{id}/ping |
124126
*bimdata.ApplicationApi* | [**createWebHook**](docs/ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook |
125127
*bimdata.ApplicationApi* | [**deleteWebHook**](docs/ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} |
126128
*bimdata.ApplicationApi* | [**fullUpdateWebHook**](docs/ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} |
127129
*bimdata.ApplicationApi* | [**getWebHook**](docs/ApplicationApi.md#getWebHook) | **GET** /cloud/{cloud_pk}/webhook/{id} |
128130
*bimdata.ApplicationApi* | [**getWebHooks**](docs/ApplicationApi.md#getWebHooks) | **GET** /cloud/{cloud_pk}/webhook |
129131
*bimdata.ApplicationApi* | [**updateWebHook**](docs/ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} |
132+
*bimdata.BcfApi* | [**createColoring**](docs/BcfApi.md#createColoring) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring |
133+
*bimdata.BcfApi* | [**createComment**](docs/BcfApi.md#createComment) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments |
134+
*bimdata.BcfApi* | [**createFullTopic**](docs/BcfApi.md#createFullTopic) | **POST** /bcf/2.1/projects/{projects_pk}/full-topic |
135+
*bimdata.BcfApi* | [**createSelection**](docs/BcfApi.md#createSelection) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection |
136+
*bimdata.BcfApi* | [**createTopic**](docs/BcfApi.md#createTopic) | **POST** /bcf/2.1/projects/{projects_pk}/topics |
137+
*bimdata.BcfApi* | [**createViewpoint**](docs/BcfApi.md#createViewpoint) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints |
138+
*bimdata.BcfApi* | [**createVisibility**](docs/BcfApi.md#createVisibility) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility |
139+
*bimdata.BcfApi* | [**deleteColoring**](docs/BcfApi.md#deleteColoring) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id} |
140+
*bimdata.BcfApi* | [**deleteComment**](docs/BcfApi.md#deleteComment) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} |
141+
*bimdata.BcfApi* | [**deleteSelection**](docs/BcfApi.md#deleteSelection) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id} |
142+
*bimdata.BcfApi* | [**deleteTopic**](docs/BcfApi.md#deleteTopic) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{guid} |
143+
*bimdata.BcfApi* | [**deleteViewpoint**](docs/BcfApi.md#deleteViewpoint) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} |
144+
*bimdata.BcfApi* | [**deleteVisibility**](docs/BcfApi.md#deleteVisibility) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id} |
145+
*bimdata.BcfApi* | [**fullUpdateBcfProject**](docs/BcfApi.md#fullUpdateBcfProject) | **PUT** /bcf/2.1/projects/{id} |
146+
*bimdata.BcfApi* | [**fullUpdateColoring**](docs/BcfApi.md#fullUpdateColoring) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id} |
147+
*bimdata.BcfApi* | [**fullUpdateComment**](docs/BcfApi.md#fullUpdateComment) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} |
148+
*bimdata.BcfApi* | [**fullUpdateFullTopic**](docs/BcfApi.md#fullUpdateFullTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
149+
*bimdata.BcfApi* | [**fullUpdateSelection**](docs/BcfApi.md#fullUpdateSelection) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id} |
150+
*bimdata.BcfApi* | [**fullUpdateTopic**](docs/BcfApi.md#fullUpdateTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} |
151+
*bimdata.BcfApi* | [**fullUpdateViewpoint**](docs/BcfApi.md#fullUpdateViewpoint) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} |
152+
*bimdata.BcfApi* | [**fullUpdateVisibility**](docs/BcfApi.md#fullUpdateVisibility) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id} |
153+
*bimdata.BcfApi* | [**getBcfProject**](docs/BcfApi.md#getBcfProject) | **GET** /bcf/2.1/projects/{id} |
154+
*bimdata.BcfApi* | [**getBcfProjects**](docs/BcfApi.md#getBcfProjects) | **GET** /bcf/2.1/projects |
155+
*bimdata.BcfApi* | [**getColoring**](docs/BcfApi.md#getColoring) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id} |
156+
*bimdata.BcfApi* | [**getColorings**](docs/BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring |
157+
*bimdata.BcfApi* | [**getComment**](docs/BcfApi.md#getComment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} |
158+
*bimdata.BcfApi* | [**getComments**](docs/BcfApi.md#getComments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments |
159+
*bimdata.BcfApi* | [**getExtension**](docs/BcfApi.md#getExtension) | **GET** /bcf/2.1/projects/{projects_pk}/extensions |
160+
*bimdata.BcfApi* | [**getFullTopic**](docs/BcfApi.md#getFullTopic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
161+
*bimdata.BcfApi* | [**getFullTopics**](docs/BcfApi.md#getFullTopics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic |
162+
*bimdata.BcfApi* | [**getSelection**](docs/BcfApi.md#getSelection) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id} |
163+
*bimdata.BcfApi* | [**getSelections**](docs/BcfApi.md#getSelections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection |
164+
*bimdata.BcfApi* | [**getSnapshots**](docs/BcfApi.md#getSnapshots) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/snapshot |
165+
*bimdata.BcfApi* | [**getTopic**](docs/BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} |
166+
*bimdata.BcfApi* | [**getTopics**](docs/BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics |
167+
*bimdata.BcfApi* | [**getUser**](docs/BcfApi.md#getUser) | **GET** /bcf/2.1/current-user |
168+
*bimdata.BcfApi* | [**getViewpoint**](docs/BcfApi.md#getViewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} |
169+
*bimdata.BcfApi* | [**getViewpoints**](docs/BcfApi.md#getViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints |
170+
*bimdata.BcfApi* | [**getVisibilities**](docs/BcfApi.md#getVisibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility |
171+
*bimdata.BcfApi* | [**getVisibility**](docs/BcfApi.md#getVisibility) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id} |
172+
*bimdata.BcfApi* | [**updateBcfProject**](docs/BcfApi.md#updateBcfProject) | **PATCH** /bcf/2.1/projects/{id} |
173+
*bimdata.BcfApi* | [**updateColoring**](docs/BcfApi.md#updateColoring) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id} |
174+
*bimdata.BcfApi* | [**updateComment**](docs/BcfApi.md#updateComment) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} |
175+
*bimdata.BcfApi* | [**updateFullTopic**](docs/BcfApi.md#updateFullTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
176+
*bimdata.BcfApi* | [**updateSelection**](docs/BcfApi.md#updateSelection) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id} |
177+
*bimdata.BcfApi* | [**updateTopic**](docs/BcfApi.md#updateTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} |
178+
*bimdata.BcfApi* | [**updateViewpoint**](docs/BcfApi.md#updateViewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} |
179+
*bimdata.BcfApi* | [**updateVisibility**](docs/BcfApi.md#updateVisibility) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id} |
130180
*bimdata.CheckplanApi* | [**createChecker**](docs/CheckplanApi.md#createChecker) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker |
131181
*bimdata.CheckplanApi* | [**createCheckerResult**](docs/CheckplanApi.md#createCheckerResult) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result |
132182
*bimdata.CheckplanApi* | [**createCheckplan**](docs/CheckplanApi.md#createCheckplan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/checkplan |
@@ -319,15 +369,22 @@ Class | Method | HTTP request | Description
319369

320370
## Documentation for Models
321371

372+
- [bimdata.BcfProject](docs/BcfProject.md)
322373
- [bimdata.CheckPlan](docs/CheckPlan.md)
323374
- [bimdata.CheckerResult](docs/CheckerResult.md)
324375
- [bimdata.Classification](docs/Classification.md)
376+
- [bimdata.ClippingPlane](docs/ClippingPlane.md)
325377
- [bimdata.Cloud](docs/Cloud.md)
326-
- [bimdata.CloudRole](docs/CloudRole.md)
378+
- [bimdata.Coloring](docs/Coloring.md)
379+
- [bimdata.Comment](docs/Comment.md)
380+
- [bimdata.Component](docs/Component.md)
381+
- [bimdata.ComponentsParent](docs/ComponentsParent.md)
382+
- [bimdata.Direction](docs/Direction.md)
327383
- [bimdata.Document](docs/Document.md)
328384
- [bimdata.Element](docs/Element.md)
329385
- [bimdata.ElementClassificationRelation](docs/ElementClassificationRelation.md)
330386
- [bimdata.ElementPropertySetRelation](docs/ElementPropertySetRelation.md)
387+
- [bimdata.Extensions](docs/Extensions.md)
331388
- [bimdata.Feature](docs/Feature.md)
332389
- [bimdata.Folder](docs/Folder.md)
333390
- [bimdata.ForgotPassword](docs/ForgotPassword.md)
@@ -338,9 +395,12 @@ Class | Method | HTTP request | Description
338395
- [bimdata.IfcFiles](docs/IfcFiles.md)
339396
- [bimdata.InviteUser](docs/InviteUser.md)
340397
- [bimdata.InvitedSignUpUser](docs/InvitedSignUpUser.md)
398+
- [bimdata.LineSeriaizer](docs/LineSeriaizer.md)
341399
- [bimdata.Notification](docs/Notification.md)
400+
- [bimdata.OrthogonalCamera](docs/OrthogonalCamera.md)
401+
- [bimdata.PerspectiveCamera](docs/PerspectiveCamera.md)
402+
- [bimdata.Point](docs/Point.md)
342403
- [bimdata.Project](docs/Project.md)
343-
- [bimdata.ProjectRole](docs/ProjectRole.md)
344404
- [bimdata.Property](docs/Property.md)
345405
- [bimdata.PropertyDefinition](docs/PropertyDefinition.md)
346406
- [bimdata.PropertySet](docs/PropertySet.md)
@@ -356,9 +416,15 @@ Class | Method | HTTP request | Description
356416
- [bimdata.Ruleset](docs/Ruleset.md)
357417
- [bimdata.SelfUser](docs/SelfUser.md)
358418
- [bimdata.SignUpUser](docs/SignUpUser.md)
419+
- [bimdata.SingleJsonTopic](docs/SingleJsonTopic.md)
420+
- [bimdata.Snapshot](docs/Snapshot.md)
359421
- [bimdata.Space](docs/Space.md)
422+
- [bimdata.Topic](docs/Topic.md)
360423
- [bimdata.Unit](docs/Unit.md)
361424
- [bimdata.User](docs/User.md)
425+
- [bimdata.ViewSetupHints](docs/ViewSetupHints.md)
426+
- [bimdata.Viewpoint](docs/Viewpoint.md)
427+
- [bimdata.Visibility](docs/Visibility.md)
362428
- [bimdata.WebHook](docs/WebHook.md)
363429
- [bimdata.Zone](docs/Zone.md)
364430
- [bimdata.ZoneSpace](docs/ZoneSpace.md)

docs/ApplicationApi.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ All URIs are relative to *https://api-beta.bimdata.io*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**cloudWebhookPing**](ApplicationApi.md#cloudWebhookPing) | **POST** /cloud/{cloud_pk}/webhook/{id}/ping |
78
[**createWebHook**](ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook |
89
[**deleteWebHook**](ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} |
910
[**fullUpdateWebHook**](ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} |
@@ -12,6 +13,55 @@ Method | HTTP request | Description
1213
[**updateWebHook**](ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} |
1314

1415

16+
<a name="cloudWebhookPing"></a>
17+
# **cloudWebhookPing**
18+
> WebHook cloudWebhookPing(cloudPk, id, webHook)
19+
20+
21+
22+
### Example
23+
```javascript
24+
var bimdata = require('@bimdata/bimdata-api-client');
25+
var defaultClient = bimdata.ApiClient.instance;
26+
// Configure API key authorization: Bearer
27+
var Bearer = defaultClient.authentications['Bearer'];
28+
Bearer.apiKey = 'YOUR API KEY';
29+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
30+
//Bearer.apiKeyPrefix = 'Token';
31+
32+
var apiInstance = new bimdata.ApplicationApi();
33+
var cloudPk = "cloudPk_example"; // String |
34+
var id = "id_example"; // String |
35+
var webHook = new bimdata.WebHook(); // WebHook |
36+
apiInstance.cloudWebhookPing(cloudPk, id, webHook).then(function(data) {
37+
console.log('API called successfully. Returned data: ' + data);
38+
}, function(error) {
39+
console.error(error);
40+
});
41+
42+
```
43+
44+
### Parameters
45+
46+
Name | Type | Description | Notes
47+
------------- | ------------- | ------------- | -------------
48+
**cloudPk** | **String**| |
49+
**id** | **String**| |
50+
**webHook** | [**WebHook**](WebHook.md)| |
51+
52+
### Return type
53+
54+
[**WebHook**](WebHook.md)
55+
56+
### Authorization
57+
58+
[Bearer](../README.md#Bearer)
59+
60+
### HTTP request headers
61+
62+
- **Content-Type**: application/json
63+
- **Accept**: application/json
64+
1565
<a name="createWebHook"></a>
1666
# **createWebHook**
1767
> WebHook createWebHook(cloudPk, webHook)

0 commit comments

Comments
 (0)