@connectedxm/admin-sdk 11.0.2 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +3 -2
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +381 -32
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +212 -33
- package/dist/api.js +298 -26
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +212 -33
- package/dist/esm/api.js +277 -9
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/{CreateOrganizationWebhook200Response.md → AddEventPassChangeWebhook200Response.md} +3 -3
- package/docs/EventsPasschangewebhooksApi.md +181 -0
- package/docs/{GetOrganizationWebhooks200Response.md → GetEventPassChangeWebhooks200Response.md} +3 -3
- package/docs/OrganizationWebhooksApi.md +10 -10
- package/package.json +1 -1
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
12
12
|
|[**verifyOrganizationWebhook**](#verifyorganizationwebhook) | **POST** /organization/webhooks/{webhookId}/verify | Verify an organization webhook endpoint|
|
|
13
13
|
|
|
14
14
|
# **createOrganizationWebhook**
|
|
15
|
-
>
|
|
15
|
+
> AddEventPassChangeWebhook200Response createOrganizationWebhook(webhookCreateInputs)
|
|
16
16
|
|
|
17
17
|
Registers a new outbound webhook endpoint for the organization with a name, URL, and secret, requires organization read and update permissions; the new webhook starts unverified until the verify endpoint is called.
|
|
18
18
|
|
|
@@ -44,7 +44,7 @@ const { status, data } = await apiInstance.createOrganizationWebhook(
|
|
|
44
44
|
|
|
45
45
|
### Return type
|
|
46
46
|
|
|
47
|
-
**
|
|
47
|
+
**AddEventPassChangeWebhook200Response**
|
|
48
48
|
|
|
49
49
|
### Authorization
|
|
50
50
|
|
|
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.deleteOrganizationWebhook(
|
|
|
115
115
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
116
116
|
|
|
117
117
|
# **getOrganizationWebhook**
|
|
118
|
-
>
|
|
118
|
+
> AddEventPassChangeWebhook200Response getOrganizationWebhook()
|
|
119
119
|
|
|
120
120
|
Retrieves a single outbound webhook configuration by ID for the current organization, including its URL, subscribed events, and status; requires read permission on the org resource.
|
|
121
121
|
|
|
@@ -146,7 +146,7 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
|
|
|
146
146
|
|
|
147
147
|
### Return type
|
|
148
148
|
|
|
149
|
-
**
|
|
149
|
+
**AddEventPassChangeWebhook200Response**
|
|
150
150
|
|
|
151
151
|
### Authorization
|
|
152
152
|
|
|
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
|
|
|
166
166
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
167
167
|
|
|
168
168
|
# **getOrganizationWebhooks**
|
|
169
|
-
>
|
|
169
|
+
> GetEventPassChangeWebhooks200Response getOrganizationWebhooks()
|
|
170
170
|
|
|
171
171
|
Returns a paginated, searchable list of outbound webhook configurations registered for the current organization, matching on name, URL, or ID and supporting sorting via orderBy; requires read permission on the org resource.
|
|
172
172
|
|
|
@@ -206,7 +206,7 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
|
|
|
206
206
|
|
|
207
207
|
### Return type
|
|
208
208
|
|
|
209
|
-
**
|
|
209
|
+
**GetEventPassChangeWebhooks200Response**
|
|
210
210
|
|
|
211
211
|
### Authorization
|
|
212
212
|
|
|
@@ -226,7 +226,7 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
|
|
|
226
226
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
227
227
|
|
|
228
228
|
# **updateOrganizationWebhook**
|
|
229
|
-
>
|
|
229
|
+
> AddEventPassChangeWebhook200Response updateOrganizationWebhook(webhookUpdateInputs)
|
|
230
230
|
|
|
231
231
|
Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
232
232
|
|
|
@@ -261,7 +261,7 @@ const { status, data } = await apiInstance.updateOrganizationWebhook(
|
|
|
261
261
|
|
|
262
262
|
### Return type
|
|
263
263
|
|
|
264
|
-
**
|
|
264
|
+
**AddEventPassChangeWebhook200Response**
|
|
265
265
|
|
|
266
266
|
### Authorization
|
|
267
267
|
|
|
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.updateOrganizationWebhook(
|
|
|
281
281
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
282
282
|
|
|
283
283
|
# **verifyOrganizationWebhook**
|
|
284
|
-
>
|
|
284
|
+
> AddEventPassChangeWebhook200Response verifyOrganizationWebhook()
|
|
285
285
|
|
|
286
286
|
Sends a signed test payload to the webhook\'s URL and, if delivery succeeds, marks the webhook as verified so it can start receiving real event deliveries, requires organization read and update permissions.
|
|
287
287
|
|
|
@@ -312,7 +312,7 @@ const { status, data } = await apiInstance.verifyOrganizationWebhook(
|
|
|
312
312
|
|
|
313
313
|
### Return type
|
|
314
314
|
|
|
315
|
-
**
|
|
315
|
+
**AddEventPassChangeWebhook200Response**
|
|
316
316
|
|
|
317
317
|
### Authorization
|
|
318
318
|
|