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

Commit 71dd6a4

Browse files
Bimdata-ioBimdata-io
committed
PATCH: fix webhook ping method name
1 parent b769b3a commit 71dd6a4

Some content is hidden

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

49 files changed

+2556
-3261
lines changed

‎README.md‎

Lines changed: 228 additions & 244 deletions
Large diffs are not rendered by default.

‎docs/ApplicationApi.md‎

Lines changed: 65 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@ 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 |
8-
[**createWebHook**](ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook |
9-
[**deleteWebHook**](ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} |
10-
[**fullUpdateWebHook**](ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} |
11-
[**getWebHook**](ApplicationApi.md#getWebHook) | **GET** /cloud/{cloud_pk}/webhook/{id} |
12-
[**getWebHooks**](ApplicationApi.md#getWebHooks) | **GET** /cloud/{cloud_pk}/webhook |
13-
[**updateWebHook**](ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} |
7+
[**createWebHook**](ApplicationApi.md#createWebHook) | **POST** /cloud/{cloud_pk}/webhook | Create a new Webhook
8+
[**deleteWebHook**](ApplicationApi.md#deleteWebHook) | **DELETE** /cloud/{cloud_pk}/webhook/{id} | Delete a webhook
9+
[**fullUpdateWebHook**](ApplicationApi.md#fullUpdateWebHook) | **PUT** /cloud/{cloud_pk}/webhook/{id} | Update all field of a webhook
10+
[**getWebHook**](ApplicationApi.md#getWebHook) | **GET** /cloud/{cloud_pk}/webhook/{id} | Retrieve one configured webhook
11+
[**getWebHooks**](ApplicationApi.md#getWebHooks) | **GET** /cloud/{cloud_pk}/webhook | Retrieve all configured webhooks
12+
[**pingWebHook**](ApplicationApi.md#pingWebHook) | **POST** /cloud/{cloud_pk}/webhook/{id}/ping | Test a webhook
13+
[**updateWebHook**](ApplicationApi.md#updateWebHook) | **PATCH** /cloud/{cloud_pk}/webhook/{id} | Update some field of a webhook
1414

1515

16-
<a name="cloudWebhookPing"></a>
17-
# **cloudWebhookPing**
18-
> WebHook cloudWebhookPing(cloudPk, id, webHook)
16+
<a name="createWebHook"></a>
17+
# **createWebHook**
18+
> WebHook createWebHook(cloudPk, webHook)
1919
20+
Create a new Webhook
2021

22+
Create a new Webhook Required scopes: webhook:manage
2123

2224
### Example
2325
```javascript
@@ -31,9 +33,8 @@ Bearer.apiKey = 'YOUR API KEY';
3133

3234
var apiInstance = new bimdata.ApplicationApi();
3335
var cloudPk = "cloudPk_example"; // String |
34-
var id = "id_example"; // String |
3536
var webHook = new bimdata.WebHook(); // WebHook |
36-
apiInstance.cloudWebhookPing(cloudPk, id, webHook).then(function(data) {
37+
apiInstance.createWebHook(cloudPk, webHook).then(function(data) {
3738
console.log('API called successfully. Returned data: ' + data);
3839
}, function(error) {
3940
console.error(error);
@@ -46,7 +47,6 @@ apiInstance.cloudWebhookPing(cloudPk, id, webHook).then(function(data) {
4647
Name | Type | Description | Notes
4748
------------- | ------------- | ------------- | -------------
4849
**cloudPk** | **String**| |
49-
**id** | **String**| |
5050
**webHook** | [**WebHook**](WebHook.md)| |
5151

5252
### Return type
@@ -62,11 +62,13 @@ Name | Type | Description | Notes
6262
- **Content-Type**: application/json
6363
- **Accept**: application/json
6464

65-
<a name="createWebHook"></a>
66-
# **createWebHook**
67-
> WebHook createWebHook(cloudPk, webHook)
65+
<a name="deleteWebHook"></a>
66+
# **deleteWebHook**
67+
> deleteWebHook(cloudPk, id)
6868
69+
Delete a webhook
6970

71+
Delete a webhook Required scopes: webhook:manage
7072

7173
### Example
7274
```javascript
@@ -80,9 +82,9 @@ Bearer.apiKey = 'YOUR API KEY';
8082

8183
var apiInstance = new bimdata.ApplicationApi();
8284
var cloudPk = "cloudPk_example"; // String |
83-
var webHook = new bimdata.WebHook(); // WebHook |
84-
apiInstance.createWebHook(cloudPk, webHook).then(function(data) {
85-
console.log('API called successfully. Returned data: ' + data);
85+
var id = "id_example"; // String |
86+
apiInstance.deleteWebHook(cloudPk, id).then(function() {
87+
console.log('API called successfully.');
8688
}, function(error) {
8789
console.error(error);
8890
});
@@ -94,26 +96,28 @@ apiInstance.createWebHook(cloudPk, webHook).then(function(data) {
9496
Name | Type | Description | Notes
9597
------------- | ------------- | ------------- | -------------
9698
**cloudPk** | **String**| |
97-
**webHook** | [**WebHook**](WebHook.md)| |
99+
**id** | **String**| |
98100

99101
### Return type
100102

101-
[**WebHook**](WebHook.md)
103+
null (empty response body)
102104

103105
### Authorization
104106

105107
[Bearer](../README.md#Bearer)
106108

107109
### HTTP request headers
108110

109-
- **Content-Type**: application/json
110-
- **Accept**: application/json
111+
- **Content-Type**: Not defined
112+
- **Accept**: Not defined
111113

112-
<a name="deleteWebHook"></a>
113-
# **deleteWebHook**
114-
> deleteWebHook(cloudPk, id)
114+
<a name="fullUpdateWebHook"></a>
115+
# **fullUpdateWebHook**
116+
> WebHook fullUpdateWebHook(cloudPk, id, webHook)
115117
118+
Update all field of a webhook
116119

120+
Update all field of a webhook Required scopes: webhook:manage
117121

118122
### Example
119123
```javascript
@@ -128,8 +132,9 @@ Bearer.apiKey = 'YOUR API KEY';
128132
var apiInstance = new bimdata.ApplicationApi();
129133
var cloudPk = "cloudPk_example"; // String |
130134
var id = "id_example"; // String |
131-
apiInstance.deleteWebHook(cloudPk, id).then(function() {
132-
console.log('API called successfully.');
135+
var webHook = new bimdata.WebHook(); // WebHook |
136+
apiInstance.fullUpdateWebHook(cloudPk, id, webHook).then(function(data) {
137+
console.log('API called successfully. Returned data: ' + data);
133138
}, function(error) {
134139
console.error(error);
135140
});
@@ -142,25 +147,28 @@ Name | Type | Description | Notes
142147
------------- | ------------- | ------------- | -------------
143148
**cloudPk** | **String**| |
144149
**id** | **String**| |
150+
**webHook** | [**WebHook**](WebHook.md)| |
145151

146152
### Return type
147153

148-
null (empty response body)
154+
[**WebHook**](WebHook.md)
149155

150156
### Authorization
151157

152158
[Bearer](../README.md#Bearer)
153159

154160
### HTTP request headers
155161

156-
- **Content-Type**: Not defined
157-
- **Accept**: Not defined
162+
- **Content-Type**: application/json
163+
- **Accept**: application/json
158164

159-
<a name="fullUpdateWebHook"></a>
160-
# **fullUpdateWebHook**
161-
> WebHook fullUpdateWebHook(cloudPk, id, webHook)
165+
<a name="getWebHook"></a>
166+
# **getWebHook**
167+
> WebHook getWebHook(cloudPk, id)
162168
169+
Retrieve one configured webhook
163170

171+
Retrieve one configured webhook Required scopes: webhook:manage
164172

165173
### Example
166174
```javascript
@@ -175,8 +183,7 @@ Bearer.apiKey = 'YOUR API KEY';
175183
var apiInstance = new bimdata.ApplicationApi();
176184
var cloudPk = "cloudPk_example"; // String |
177185
var id = "id_example"; // String |
178-
var webHook = new bimdata.WebHook(); // WebHook |
179-
apiInstance.fullUpdateWebHook(cloudPk, id, webHook).then(function(data) {
186+
apiInstance.getWebHook(cloudPk, id).then(function(data) {
180187
console.log('API called successfully. Returned data: ' + data);
181188
}, function(error) {
182189
console.error(error);
@@ -190,7 +197,6 @@ Name | Type | Description | Notes
190197
------------- | ------------- | ------------- | -------------
191198
**cloudPk** | **String**| |
192199
**id** | **String**| |
193-
**webHook** | [**WebHook**](WebHook.md)| |
194200

195201
### Return type
196202

@@ -202,14 +208,16 @@ Name | Type | Description | Notes
202208

203209
### HTTP request headers
204210

205-
- **Content-Type**: application/json
211+
- **Content-Type**: Not defined
206212
- **Accept**: application/json
207213

208-
<a name="getWebHook"></a>
209-
# **getWebHook**
210-
> WebHook getWebHook(cloudPk, id)
214+
<a name="getWebHooks"></a>
215+
# **getWebHooks**
216+
> [WebHook] getWebHooks(cloudPk)
211217
218+
Retrieve all configured webhooks
212219

220+
Retrieve all configured webhooks Required scopes: webhook:manage
213221

214222
### Example
215223
```javascript
@@ -223,8 +231,7 @@ Bearer.apiKey = 'YOUR API KEY';
223231

224232
var apiInstance = new bimdata.ApplicationApi();
225233
var cloudPk = "cloudPk_example"; // String |
226-
var id = "id_example"; // String |
227-
apiInstance.getWebHook(cloudPk, id).then(function(data) {
234+
apiInstance.getWebHooks(cloudPk).then(function(data) {
228235
console.log('API called successfully. Returned data: ' + data);
229236
}, function(error) {
230237
console.error(error);
@@ -237,11 +244,10 @@ apiInstance.getWebHook(cloudPk, id).then(function(data) {
237244
Name | Type | Description | Notes
238245
------------- | ------------- | ------------- | -------------
239246
**cloudPk** | **String**| |
240-
**id** | **String**| |
241247

242248
### Return type
243249

244-
[**WebHook**](WebHook.md)
250+
[**[WebHook]**](WebHook.md)
245251

246252
### Authorization
247253

@@ -252,11 +258,13 @@ Name | Type | Description | Notes
252258
- **Content-Type**: Not defined
253259
- **Accept**: application/json
254260

255-
<a name="getWebHooks"></a>
256-
# **getWebHooks**
257-
> [WebHook] getWebHooks(cloudPk)
261+
<a name="pingWebHook"></a>
262+
# **pingWebHook**
263+
> WebHook pingWebHook(cloudPk, id, webHook)
258264
265+
Test a webhook
259266

267+
Trigger a Ping Event sending {\&quot;ok\&quot;: true} to the webhook URL. Useful to test your app Required scopes: webhook:manage
260268

261269
### Example
262270
```javascript
@@ -270,7 +278,9 @@ Bearer.apiKey = 'YOUR API KEY';
270278

271279
var apiInstance = new bimdata.ApplicationApi();
272280
var cloudPk = "cloudPk_example"; // String |
273-
apiInstance.getWebHooks(cloudPk).then(function(data) {
281+
var id = "id_example"; // String |
282+
var webHook = new bimdata.WebHook(); // WebHook |
283+
apiInstance.pingWebHook(cloudPk, id, webHook).then(function(data) {
274284
console.log('API called successfully. Returned data: ' + data);
275285
}, function(error) {
276286
console.error(error);
@@ -283,25 +293,29 @@ apiInstance.getWebHooks(cloudPk).then(function(data) {
283293
Name | Type | Description | Notes
284294
------------- | ------------- | ------------- | -------------
285295
**cloudPk** | **String**| |
296+
**id** | **String**| |
297+
**webHook** | [**WebHook**](WebHook.md)| |
286298

287299
### Return type
288300

289-
[**[WebHook]**](WebHook.md)
301+
[**WebHook**](WebHook.md)
290302

291303
### Authorization
292304

293305
[Bearer](../README.md#Bearer)
294306

295307
### HTTP request headers
296308

297-
- **Content-Type**: Not defined
309+
- **Content-Type**: application/json
298310
- **Accept**: application/json
299311

300312
<a name="updateWebHook"></a>
301313
# **updateWebHook**
302314
> WebHook updateWebHook(cloudPk, id, webHook)
303315
316+
Update some field of a webhook
304317

318+
Update some field of a webhook Required scopes: webhook:manage
305319

306320
### Example
307321
```javascript

0 commit comments

Comments
 (0)