@connectedxm/admin-sdk 11.0.2 → 11.2.0

package/docs/EventsPasschangewebhooksApi.md

@@ -0,0 +1,181 @@
+# EventsPasschangewebhooksApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/passChangeWebhooks/{webhookId} | Connect a webhook to an event\'s pass change log|
+|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/passChangeWebhooks | List an event\'s pass change log webhooks|
+|[**removeEventPassChangeWebhook**](#removeeventpasschangewebhook) | **DELETE** /events/{eventId}/passChangeWebhooks/{webhookId} | Disconnect a webhook from an event\'s pass change log|
+
+# **addEventPassChangeWebhook**
+> AddEventPassChangeWebhook200Response addEventPassChangeWebhook()
+
+Connects the specified webhook so it receives the event\'s pass change log rows, and requires update permission on events; the webhook must be verified.
+
+### Example
+
+```typescript
+import {
+    EventsPasschangewebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasschangewebhooksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let webhookId: string; //The webhook identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventPassChangeWebhook(
+    eventId,
+    webhookId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
+
+
+### Return type
+
+**AddEventPassChangeWebhook200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getEventPassChangeWebhooks**
+> GetEventPassChangeWebhooks200Response getEventPassChangeWebhooks()
+
+Returns a paginated list of the webhooks connected to the given event\'s pass change log; requires \"read\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasschangewebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasschangewebhooksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getEventPassChangeWebhooks(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetEventPassChangeWebhooks200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **removeEventPassChangeWebhook**
+> CreateAccountInvitations200Response removeEventPassChangeWebhook()
+
+Disconnects the specified webhook from the given event\'s pass change log and requires update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasschangewebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasschangewebhooksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let webhookId: string; //The webhook identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventPassChangeWebhook(
+    eventId,
+    webhookId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/{GetOrganizationWebhooks200Response.md → GetEventPassChangeWebhooks200Response.md}

@@ -1,4 +1,4 @@
-# GetOrganizationWebhooks200Response
+# GetEventPassChangeWebhooks200Response
 
 
 ## Properties
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GetOrganizationWebhooks200Response } from '@connectedxm/admin-sdk';
+import { GetEventPassChangeWebhooks200Response } from '@connectedxm/admin-sdk';
 
-const instance: GetOrganizationWebhooks200Response = {
+const instance: GetEventPassChangeWebhooks200Response = {
     status,
     message,
     data,

package/docs/OrganizationWebhooksApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**verifyOrganizationWebhook**](#verifyorganizationwebhook) | **POST** /organization/webhooks/{webhookId}/verify | Verify an organization webhook endpoint|
 
 # **createOrganizationWebhook**
-> CreateOrganizationWebhook200Response createOrganizationWebhook(webhookCreateInputs)
+> AddEventPassChangeWebhook200Response createOrganizationWebhook(webhookCreateInputs)
 
 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.
 
@@ -44,7 +44,7 @@ const { status, data } = await apiInstance.createOrganizationWebhook(
 
 ### Return type
 
-**CreateOrganizationWebhook200Response**
+**AddEventPassChangeWebhook200Response**
 
 ### Authorization
 
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.deleteOrganizationWebhook(
 [[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)
 
 # **getOrganizationWebhook**
-> CreateOrganizationWebhook200Response getOrganizationWebhook()
+> AddEventPassChangeWebhook200Response getOrganizationWebhook()
 
 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.
 
@@ -146,7 +146,7 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
 
 ### Return type
 
-**CreateOrganizationWebhook200Response**
+**AddEventPassChangeWebhook200Response**
 
 ### Authorization
 
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
 [[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)
 
 # **getOrganizationWebhooks**
-> GetOrganizationWebhooks200Response getOrganizationWebhooks()
+> GetEventPassChangeWebhooks200Response getOrganizationWebhooks()
 
 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.
 
@@ -206,7 +206,7 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
 
 ### Return type
 
-**GetOrganizationWebhooks200Response**
+**GetEventPassChangeWebhooks200Response**
 
 ### Authorization
 
@@ -226,7 +226,7 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
 [[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)
 
 # **updateOrganizationWebhook**
-> CreateOrganizationWebhook200Response updateOrganizationWebhook(webhookUpdateInputs)
+> AddEventPassChangeWebhook200Response updateOrganizationWebhook(webhookUpdateInputs)
 
 Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
 
@@ -261,7 +261,7 @@ const { status, data } = await apiInstance.updateOrganizationWebhook(
 
 ### Return type
 
-**CreateOrganizationWebhook200Response**
+**AddEventPassChangeWebhook200Response**
 
 ### Authorization
 
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.updateOrganizationWebhook(
 [[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)
 
 # **verifyOrganizationWebhook**
-> CreateOrganizationWebhook200Response verifyOrganizationWebhook()
+> AddEventPassChangeWebhook200Response verifyOrganizationWebhook()
 
 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.
 
@@ -312,7 +312,7 @@ const { status, data } = await apiInstance.verifyOrganizationWebhook(
 
 ### Return type
 
-**CreateOrganizationWebhook200Response**
+**AddEventPassChangeWebhook200Response**
 
 ### Authorization
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.0.2",
+  "version": "11.2.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {