@connectedxm/admin-sdk 11.14.1 → 11.16.0

package/docs/BaseWebhookFailure.md

@@ -0,0 +1,42 @@
+# BaseWebhookFailure
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**webhookId** | **string** |  | [default to undefined]
+**error** | **string** |  | [default to undefined]
+**statusCode** | **number** |  | [default to undefined]
+**source** | **string** |  | [default to undefined]
+**sourceId** | **string** |  | [default to undefined]
+**attempts** | **number** |  | [default to undefined]
+**retries** | **number** |  | [default to undefined]
+**lastAttemptAt** | **string** |  | [default to undefined]
+**lockedAt** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseWebhookFailure } from '@connectedxm/admin-sdk';
+
+const instance: BaseWebhookFailure = {
+    id,
+    webhookId,
+    error,
+    statusCode,
+    source,
+    sourceId,
+    attempts,
+    retries,
+    lastAttemptAt,
+    lockedAt,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetOrganizationWebhookFailure200Response.md

@@ -0,0 +1,24 @@
+# GetOrganizationWebhookFailure200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**WebhookFailure**](WebhookFailure.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrganizationWebhookFailure200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetOrganizationWebhookFailure200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetOrganizationWebhookFailures200Response.md

@@ -0,0 +1,26 @@
+# GetOrganizationWebhookFailures200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<BaseWebhookFailure>**](BaseWebhookFailure.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrganizationWebhookFailures200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetOrganizationWebhookFailures200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrganizationWebhooksApi.md

@@ -6,8 +6,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 |------------- | ------------- | -------------|
 |[**createOrganizationWebhook**](#createorganizationwebhook) | **POST** /organization/webhooks | Create an organization webhook|
 |[**deleteOrganizationWebhook**](#deleteorganizationwebhook) | **DELETE** /organization/webhooks/{webhookId} | Delete an organization webhook|
+|[**deleteOrganizationWebhookFailure**](#deleteorganizationwebhookfailure) | **DELETE** /organization/webhooks/{webhookId}/failures/{failureId} | Discard a queued webhook delivery failure|
 |[**getOrganizationWebhook**](#getorganizationwebhook) | **GET** /organization/webhooks/{webhookId} | Get an organization webhook|
+|[**getOrganizationWebhookFailure**](#getorganizationwebhookfailure) | **GET** /organization/webhooks/{webhookId}/failures/{failureId} | Get a queued webhook delivery failure|
+|[**getOrganizationWebhookFailures**](#getorganizationwebhookfailures) | **GET** /organization/webhooks/{webhookId}/failures | List a webhook\'s queued delivery failures|
 |[**getOrganizationWebhooks**](#getorganizationwebhooks) | **GET** /organization/webhooks | List an organization\'s webhooks|
+|[**retryOrganizationWebhookFailure**](#retryorganizationwebhookfailure) | **POST** /organization/webhooks/{webhookId}/failures/{failureId}/retry | Retry one queued webhook delivery|
+|[**retryOrganizationWebhookFailures**](#retryorganizationwebhookfailures) | **POST** /organization/webhooks/{webhookId}/failures/retry | Retry all of a webhook\'s queued deliveries|
 |[**updateOrganizationWebhook**](#updateorganizationwebhook) | **PUT** /organization/webhooks/{webhookId} | Update an organization webhook|
 |[**verifyOrganizationWebhook**](#verifyorganizationwebhook) | **POST** /organization/webhooks/{webhookId}/verify | Verify an organization webhook endpoint|
 
@@ -93,6 +98,60 @@ const { status, data } = await apiInstance.deleteOrganizationWebhook(
 | **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)
+
+# **deleteOrganizationWebhookFailure**
+> CreateAccountInvitations200Response deleteOrganizationWebhookFailure()
+
+Removes a failed webhook delivery from the retry queue without re-sending it; the webhook returns to verified once its queue is empty. Requires organization read and update permissions.
+
+### Example
+
+```typescript
+import {
+    OrganizationWebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationWebhooksApi(configuration);
+
+let webhookId: string; //The webhook identifier (default to undefined)
+let failureId: string; //The failure identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteOrganizationWebhookFailure(
+    webhookId,
+    failureId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
+| **failureId** | [**string**] | The failure identifier | defaults to undefined|
+
+
 ### Return type
 
 **CreateAccountInvitations200Response**
@@ -158,6 +217,123 @@ const { status, data } = await apiInstance.getOrganizationWebhook(
  - **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)
+
+# **getOrganizationWebhookFailure**
+> GetOrganizationWebhookFailure200Response getOrganizationWebhookFailure()
+
+Retrieves one failed webhook delivery by ID, including the exact payload that was sent, the last error and HTTP status, attempt and retry counts, and the webhook it belongs to; requires read permission on the org resource.
+
+### Example
+
+```typescript
+import {
+    OrganizationWebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationWebhooksApi(configuration);
+
+let webhookId: string; //The webhook identifier (default to undefined)
+let failureId: string; //The failure identifier (default to undefined)
+
+const { status, data } = await apiInstance.getOrganizationWebhookFailure(
+    webhookId,
+    failureId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
+| **failureId** | [**string**] | The failure identifier | defaults to undefined|
+
+
+### Return type
+
+**GetOrganizationWebhookFailure200Response**
+
+### 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)
+
+# **getOrganizationWebhookFailures**
+> GetOrganizationWebhookFailures200Response getOrganizationWebhookFailures()
+
+Returns a paginated list of this webhook\'s outbound deliveries that failed and are waiting to be retried, newest first, searchable by error, source, or source id; requires read permission on the org resource.
+
+### Example
+
+```typescript
+import {
+    OrganizationWebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationWebhooksApi(configuration);
+
+let webhookId: string; //The webhook 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.getOrganizationWebhookFailures(
+    webhookId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | The webhook 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
+
+**GetOrganizationWebhookFailures200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -218,6 +394,111 @@ const { status, data } = await apiInstance.getOrganizationWebhooks(
  - **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)
+
+# **retryOrganizationWebhookFailure**
+> RetryOrganizationWebhookFailure200Response retryOrganizationWebhookFailure()
+
+Re-sends the stored payload of a failed webhook delivery once. On success the failure is removed from the queue and the webhook returns to verified when its queue is empty; on failure the row is kept with its updated error and attempt counts, returned as `data.failure`. Responds 409 while another retry of the same delivery is in flight. Requires organization read and update permissions.
+
+### Example
+
+```typescript
+import {
+    OrganizationWebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationWebhooksApi(configuration);
+
+let webhookId: string; //The webhook identifier (default to undefined)
+let failureId: string; //The failure identifier (default to undefined)
+
+const { status, data } = await apiInstance.retryOrganizationWebhookFailure(
+    webhookId,
+    failureId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | [**string**] | The webhook identifier | defaults to undefined|
+| **failureId** | [**string**] | The failure identifier | defaults to undefined|
+
+
+### Return type
+
+**RetryOrganizationWebhookFailure200Response**
+
+### 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)
+
+# **retryOrganizationWebhookFailures**
+> CreateAccountInvitations200Response retryOrganizationWebhookFailures()
+
+Queues a background job that re-sends every failed delivery of this webhook, oldest first, stopping at the first failure so a down endpoint is not hammered. The job runs after this call returns, so nothing is invalidated here. Poll the webhook and its failures on an interval, with a timeout, until `_count.failures` reaches 0 or the oldest failure\'s `attempts` / `lastAttemptAt` advance and then hold still (the drain halted on a failed re-send). An unchanged count alone does not mean the job finished; it also looks like that before the job starts. Requires organization read and update permissions.
+
+### Example
+
+```typescript
+import {
+    OrganizationWebhooksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationWebhooksApi(configuration);
+
+let webhookId: string; //The webhook identifier (default to undefined)
+
+const { status, data } = await apiInstance.retryOrganizationWebhookFailures(
+    webhookId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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 |
 |-------------|-------------|------------------|

package/docs/RetryOrganizationWebhookFailure200Response.md

@@ -0,0 +1,24 @@
+# RetryOrganizationWebhookFailure200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**WebhookFailureRetryResult**](WebhookFailureRetryResult.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RetryOrganizationWebhookFailure200Response } from '@connectedxm/admin-sdk';
+
+const instance: RetryOrganizationWebhookFailure200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Webhook.md

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **url** | **string** |  | [default to undefined]
 **name** | **string** |  | [default to undefined]
 **verified** | **boolean** |  | [default to undefined]
+**status** | [**WebhookStatus**](WebhookStatus.md) |  | [default to undefined]
+**_count** | [**WebhookAllOfCount**](WebhookAllOfCount.md) |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
@@ -22,6 +24,8 @@ const instance: Webhook = {
     url,
     name,
     verified,
+    status,
+    _count,
     createdAt,
     updatedAt,
 };

package/docs/{AnnouncementAllOfCount.md → WebhookAllOfCount.md}

@@ -1,21 +1,19 @@
-# AnnouncementAllOfCount
+# WebhookAllOfCount
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**notifications** | **number** |  | [default to undefined]
-**emailReceipt** | **number** |  | [default to undefined]
+**failures** | **number** |  | [default to undefined]
 
 ## Example
 
 ```typescript
-import { AnnouncementAllOfCount } from '@connectedxm/admin-sdk';
+import { WebhookAllOfCount } from '@connectedxm/admin-sdk';
 
-const instance: AnnouncementAllOfCount = {
-    notifications,
-    emailReceipt,
+const instance: WebhookAllOfCount = {
+    failures,
 };
 ```
 

package/docs/WebhookFailure.md

@@ -0,0 +1,46 @@
+# WebhookFailure
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**webhookId** | **string** |  | [default to undefined]
+**error** | **string** |  | [default to undefined]
+**statusCode** | **number** |  | [default to undefined]
+**source** | **string** |  | [default to undefined]
+**sourceId** | **string** |  | [default to undefined]
+**attempts** | **number** |  | [default to undefined]
+**retries** | **number** |  | [default to undefined]
+**lastAttemptAt** | **string** |  | [default to undefined]
+**lockedAt** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**payload** | **{ [key: string]: any; }** |  | [default to undefined]
+**webhook** | [**BaseWebhook**](BaseWebhook.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { WebhookFailure } from '@connectedxm/admin-sdk';
+
+const instance: WebhookFailure = {
+    id,
+    webhookId,
+    error,
+    statusCode,
+    source,
+    sourceId,
+    attempts,
+    retries,
+    lastAttemptAt,
+    lockedAt,
+    createdAt,
+    updatedAt,
+    payload,
+    webhook,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/WebhookFailureRetryResult.md

@@ -0,0 +1,22 @@
+# WebhookFailureRetryResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** |  | [default to undefined]
+**failure** | [**BaseWebhookFailure**](BaseWebhookFailure.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebhookFailureRetryResult } from '@connectedxm/admin-sdk';
+
+const instance: WebhookFailureRetryResult = {
+    success,
+    failure,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/WebhookStatus.md

@@ -0,0 +1,12 @@
+# WebhookStatus
+
+
+## Enum
+
+* `Unverified` (value: `'unverified'`)
+
+* `Verified` (value: `'verified'`)
+
+* `Failed` (value: `'failed'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

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