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

Commit 0018c81

Browse files
Bimdata-ioBimdata-io
committed
MINOR: add webhooks routes
1 parent df973d6 commit 0018c81

File tree

10 files changed

+1042
-12
lines changed

10 files changed

+1042
-12
lines changed

‎README.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,10 @@ Bearer.apiKey = "YOUR API KEY"
103103
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
104104
//Bearer.apiKeyPrefix['Authorization'] = "Token"
105105

106-
var api = new bimdata.CheckplanApi()
106+
var api = new bimdata.ApplicationApi()
107107
var cloudPk = "cloudPk_example"; // {String}
108-
var ifcPk = "ifcPk_example"; // {String}
109-
var projectPk = "projectPk_example"; // {String}
110-
var ifcChecker = new bimdata.IfcChecker(); // {IfcChecker}
111-
api.createChecker(cloudPk, ifcPk, projectPk, ifcChecker).then(function(data) {
108+
var webHook = new bimdata.WebHook(); // {WebHook}
109+
api.createWebHook(cloudPk, webHook).then(function(data) {
112110
console.log('API called successfully. Returned data: ' + data);
113111
}, function(error) {
114112
console.error(error);
@@ -123,6 +121,12 @@ All URIs are relative to *https://api-beta.bimdata.io*
123121

124122
Class | Method | HTTP request | Description
125123
------------ | ------------- | ------------- | -------------
124+
*bimdata.ApplicationApi* | [**createWebHook**](docs/ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook |
125+
*bimdata.ApplicationApi* | [**deleteWebHook**](docs/ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} |
126+
*bimdata.ApplicationApi* | [**fullUpdateWebHook**](docs/ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} |
127+
*bimdata.ApplicationApi* | [**getWebHook**](docs/ApplicationApi.md#getWebHook) | **GET** /cloud/{cloud_pk}/webhook/{id} |
128+
*bimdata.ApplicationApi* | [**getWebHooks**](docs/ApplicationApi.md#getWebHooks) | **GET** /cloud/{cloud_pk}/webhook |
129+
*bimdata.ApplicationApi* | [**updateWebHook**](docs/ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} |
126130
*bimdata.CheckplanApi* | [**createChecker**](docs/CheckplanApi.md#createChecker) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker |
127131
*bimdata.CheckplanApi* | [**createCheckerResult**](docs/CheckplanApi.md#createCheckerResult) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result |
128132
*bimdata.CheckplanApi* | [**createCheckplan**](docs/CheckplanApi.md#createCheckplan) | **POST** /cloud/{cloud_pk}/project/{project_pk}/checkplan |
@@ -354,6 +358,7 @@ Class | Method | HTTP request | Description
354358
- [bimdata.Space](docs/Space.md)
355359
- [bimdata.Unit](docs/Unit.md)
356360
- [bimdata.User](docs/User.md)
361+
- [bimdata.WebHook](docs/WebHook.md)
357362
- [bimdata.Zone](docs/Zone.md)
358363
- [bimdata.ZoneSpace](docs/ZoneSpace.md)
359364

‎docs/ApplicationApi.md‎

Lines changed: 298 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,298 @@
1+
# bimdata.ApplicationApi
2+
3+
All URIs are relative to *https://api-beta.bimdata.io*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createWebHook**](ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook |
8+
[**deleteWebHook**](ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} |
9+
[**fullUpdateWebHook**](ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} |
10+
[**getWebHook**](ApplicationApi.md#getWebHook) | **GET** /cloud/{cloud_pk}/webhook/{id} |
11+
[**getWebHooks**](ApplicationApi.md#getWebHooks) | **GET** /cloud/{cloud_pk}/webhook |
12+
[**updateWebHook**](ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} |
13+
14+
15+
<a name="createWebHook"></a>
16+
# **createWebHook**
17+
> WebHook createWebHook(cloudPk, webHook)
18+
19+
20+
21+
### Example
22+
```javascript
23+
var bimdata = require('@bimdata/bimdata-api-client');
24+
var defaultClient = bimdata.ApiClient.instance;
25+
// Configure API key authorization: Bearer
26+
var Bearer = defaultClient.authentications['Bearer'];
27+
Bearer.apiKey = 'YOUR API KEY';
28+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
29+
//Bearer.apiKeyPrefix = 'Token';
30+
31+
var apiInstance = new bimdata.ApplicationApi();
32+
var cloudPk = "cloudPk_example"; // String |
33+
var webHook = new bimdata.WebHook(); // WebHook |
34+
apiInstance.createWebHook(cloudPk, webHook).then(function(data) {
35+
console.log('API called successfully. Returned data: ' + data);
36+
}, function(error) {
37+
console.error(error);
38+
});
39+
40+
```
41+
42+
### Parameters
43+
44+
Name | Type | Description | Notes
45+
------------- | ------------- | ------------- | -------------
46+
**cloudPk** | **String**| |
47+
**webHook** | [**WebHook**](WebHook.md)| |
48+
49+
### Return type
50+
51+
[**WebHook**](WebHook.md)
52+
53+
### Authorization
54+
55+
[Bearer](../README.md#Bearer)
56+
57+
### HTTP request headers
58+
59+
- **Content-Type**: application/json
60+
- **Accept**: application/json
61+
62+
<a name="deleteWebHook"></a>
63+
# **deleteWebHook**
64+
> deleteWebHook(cloudPk, id)
65+
66+
67+
68+
### Example
69+
```javascript
70+
var bimdata = require('@bimdata/bimdata-api-client');
71+
var defaultClient = bimdata.ApiClient.instance;
72+
// Configure API key authorization: Bearer
73+
var Bearer = defaultClient.authentications['Bearer'];
74+
Bearer.apiKey = 'YOUR API KEY';
75+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
76+
//Bearer.apiKeyPrefix = 'Token';
77+
78+
var apiInstance = new bimdata.ApplicationApi();
79+
var cloudPk = "cloudPk_example"; // String |
80+
var id = "id_example"; // String |
81+
apiInstance.deleteWebHook(cloudPk, id).then(function() {
82+
console.log('API called successfully.');
83+
}, function(error) {
84+
console.error(error);
85+
});
86+
87+
```
88+
89+
### Parameters
90+
91+
Name | Type | Description | Notes
92+
------------- | ------------- | ------------- | -------------
93+
**cloudPk** | **String**| |
94+
**id** | **String**| |
95+
96+
### Return type
97+
98+
null (empty response body)
99+
100+
### Authorization
101+
102+
[Bearer](../README.md#Bearer)
103+
104+
### HTTP request headers
105+
106+
- **Content-Type**: Not defined
107+
- **Accept**: Not defined
108+
109+
<a name="fullUpdateWebHook"></a>
110+
# **fullUpdateWebHook**
111+
> WebHook fullUpdateWebHook(cloudPk, id, webHook)
112+
113+
114+
115+
### Example
116+
```javascript
117+
var bimdata = require('@bimdata/bimdata-api-client');
118+
var defaultClient = bimdata.ApiClient.instance;
119+
// Configure API key authorization: Bearer
120+
var Bearer = defaultClient.authentications['Bearer'];
121+
Bearer.apiKey = 'YOUR API KEY';
122+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
123+
//Bearer.apiKeyPrefix = 'Token';
124+
125+
var apiInstance = new bimdata.ApplicationApi();
126+
var cloudPk = "cloudPk_example"; // String |
127+
var id = "id_example"; // String |
128+
var webHook = new bimdata.WebHook(); // WebHook |
129+
apiInstance.fullUpdateWebHook(cloudPk, id, webHook).then(function(data) {
130+
console.log('API called successfully. Returned data: ' + data);
131+
}, function(error) {
132+
console.error(error);
133+
});
134+
135+
```
136+
137+
### Parameters
138+
139+
Name | Type | Description | Notes
140+
------------- | ------------- | ------------- | -------------
141+
**cloudPk** | **String**| |
142+
**id** | **String**| |
143+
**webHook** | [**WebHook**](WebHook.md)| |
144+
145+
### Return type
146+
147+
[**WebHook**](WebHook.md)
148+
149+
### Authorization
150+
151+
[Bearer](../README.md#Bearer)
152+
153+
### HTTP request headers
154+
155+
- **Content-Type**: application/json
156+
- **Accept**: application/json
157+
158+
<a name="getWebHook"></a>
159+
# **getWebHook**
160+
> WebHook getWebHook(cloudPk, id)
161+
162+
163+
164+
### Example
165+
```javascript
166+
var bimdata = require('@bimdata/bimdata-api-client');
167+
var defaultClient = bimdata.ApiClient.instance;
168+
// Configure API key authorization: Bearer
169+
var Bearer = defaultClient.authentications['Bearer'];
170+
Bearer.apiKey = 'YOUR API KEY';
171+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
172+
//Bearer.apiKeyPrefix = 'Token';
173+
174+
var apiInstance = new bimdata.ApplicationApi();
175+
var cloudPk = "cloudPk_example"; // String |
176+
var id = "id_example"; // String |
177+
apiInstance.getWebHook(cloudPk, id).then(function(data) {
178+
console.log('API called successfully. Returned data: ' + data);
179+
}, function(error) {
180+
console.error(error);
181+
});
182+
183+
```
184+
185+
### Parameters
186+
187+
Name | Type | Description | Notes
188+
------------- | ------------- | ------------- | -------------
189+
**cloudPk** | **String**| |
190+
**id** | **String**| |
191+
192+
### Return type
193+
194+
[**WebHook**](WebHook.md)
195+
196+
### Authorization
197+
198+
[Bearer](../README.md#Bearer)
199+
200+
### HTTP request headers
201+
202+
- **Content-Type**: Not defined
203+
- **Accept**: application/json
204+
205+
<a name="getWebHooks"></a>
206+
# **getWebHooks**
207+
> [WebHook] getWebHooks(cloudPk)
208+
209+
210+
211+
### Example
212+
```javascript
213+
var bimdata = require('@bimdata/bimdata-api-client');
214+
var defaultClient = bimdata.ApiClient.instance;
215+
// Configure API key authorization: Bearer
216+
var Bearer = defaultClient.authentications['Bearer'];
217+
Bearer.apiKey = 'YOUR API KEY';
218+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
219+
//Bearer.apiKeyPrefix = 'Token';
220+
221+
var apiInstance = new bimdata.ApplicationApi();
222+
var cloudPk = "cloudPk_example"; // String |
223+
apiInstance.getWebHooks(cloudPk).then(function(data) {
224+
console.log('API called successfully. Returned data: ' + data);
225+
}, function(error) {
226+
console.error(error);
227+
});
228+
229+
```
230+
231+
### Parameters
232+
233+
Name | Type | Description | Notes
234+
------------- | ------------- | ------------- | -------------
235+
**cloudPk** | **String**| |
236+
237+
### Return type
238+
239+
[**[WebHook]**](WebHook.md)
240+
241+
### Authorization
242+
243+
[Bearer](../README.md#Bearer)
244+
245+
### HTTP request headers
246+
247+
- **Content-Type**: Not defined
248+
- **Accept**: application/json
249+
250+
<a name="updateWebHook"></a>
251+
# **updateWebHook**
252+
> WebHook updateWebHook(cloudPk, id, webHook)
253+
254+
255+
256+
### Example
257+
```javascript
258+
var bimdata = require('@bimdata/bimdata-api-client');
259+
var defaultClient = bimdata.ApiClient.instance;
260+
// Configure API key authorization: Bearer
261+
var Bearer = defaultClient.authentications['Bearer'];
262+
Bearer.apiKey = 'YOUR API KEY';
263+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
264+
//Bearer.apiKeyPrefix = 'Token';
265+
266+
var apiInstance = new bimdata.ApplicationApi();
267+
var cloudPk = "cloudPk_example"; // String |
268+
var id = "id_example"; // String |
269+
var webHook = new bimdata.WebHook(); // WebHook |
270+
apiInstance.updateWebHook(cloudPk, id, webHook).then(function(data) {
271+
console.log('API called successfully. Returned data: ' + data);
272+
}, function(error) {
273+
console.error(error);
274+
});
275+
276+
```
277+
278+
### Parameters
279+
280+
Name | Type | Description | Notes
281+
------------- | ------------- | ------------- | -------------
282+
**cloudPk** | **String**| |
283+
**id** | **String**| |
284+
**webHook** | [**WebHook**](WebHook.md)| |
285+
286+
### Return type
287+
288+
[**WebHook**](WebHook.md)
289+
290+
### Authorization
291+
292+
[Bearer](../README.md#Bearer)
293+
294+
### HTTP request headers
295+
296+
- **Content-Type**: application/json
297+
- **Accept**: application/json
298+

‎docs/CloudApi.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,6 @@ Name | Type | Description | Notes
259259
260260

261261

262-
Returns user and his cloud role
263-
264262
### Example
265263
```javascript
266264
var bimdata = require('@bimdata/bimdata-api-client');

‎docs/WebHook.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# bimdata.WebHook
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **Number** | | [optional]
7+
**events** | **[String]** | |
8+
**url** | **String** | |
9+
**secret** | **String** | | [optional]
10+
11+

0 commit comments

Comments
 (0)