@connectedxm/admin-sdk 11.15.0 → 11.16.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/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.15.0
7
+ * The version of the OpenAPI document: 11.16.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1736,6 +1736,14 @@ export var GetOrganizationUsers200ResponseStatusEnum;
1736
1736
  (function (GetOrganizationUsers200ResponseStatusEnum) {
1737
1737
  GetOrganizationUsers200ResponseStatusEnum["Ok"] = "ok";
1738
1738
  })(GetOrganizationUsers200ResponseStatusEnum || (GetOrganizationUsers200ResponseStatusEnum = {}));
1739
+ export var GetOrganizationWebhookFailure200ResponseStatusEnum;
1740
+ (function (GetOrganizationWebhookFailure200ResponseStatusEnum) {
1741
+ GetOrganizationWebhookFailure200ResponseStatusEnum["Ok"] = "ok";
1742
+ })(GetOrganizationWebhookFailure200ResponseStatusEnum || (GetOrganizationWebhookFailure200ResponseStatusEnum = {}));
1743
+ export var GetOrganizationWebhookFailures200ResponseStatusEnum;
1744
+ (function (GetOrganizationWebhookFailures200ResponseStatusEnum) {
1745
+ GetOrganizationWebhookFailures200ResponseStatusEnum["Ok"] = "ok";
1746
+ })(GetOrganizationWebhookFailures200ResponseStatusEnum || (GetOrganizationWebhookFailures200ResponseStatusEnum = {}));
1739
1747
  export var GetPayment200ResponseStatusEnum;
1740
1748
  (function (GetPayment200ResponseStatusEnum) {
1741
1749
  GetPayment200ResponseStatusEnum["Ok"] = "ok";
@@ -2553,6 +2561,10 @@ export var RequestImageDirectUpload200ResponseStatusEnum;
2553
2561
  (function (RequestImageDirectUpload200ResponseStatusEnum) {
2554
2562
  RequestImageDirectUpload200ResponseStatusEnum["Ok"] = "ok";
2555
2563
  })(RequestImageDirectUpload200ResponseStatusEnum || (RequestImageDirectUpload200ResponseStatusEnum = {}));
2564
+ export var RetryOrganizationWebhookFailure200ResponseStatusEnum;
2565
+ (function (RetryOrganizationWebhookFailure200ResponseStatusEnum) {
2566
+ RetryOrganizationWebhookFailure200ResponseStatusEnum["Ok"] = "ok";
2567
+ })(RetryOrganizationWebhookFailure200ResponseStatusEnum || (RetryOrganizationWebhookFailure200ResponseStatusEnum = {}));
2556
2568
  export var RoundEventQuestionMatchTypeEnum;
2557
2569
  (function (RoundEventQuestionMatchTypeEnum) {
2558
2570
  RoundEventQuestionMatchTypeEnum["Include"] = "include";
@@ -2929,6 +2941,12 @@ export var VideoStatus;
2929
2941
  VideoStatus["Ready"] = "ready";
2930
2942
  VideoStatus["Error"] = "error";
2931
2943
  })(VideoStatus || (VideoStatus = {}));
2944
+ export var WebhookStatus;
2945
+ (function (WebhookStatus) {
2946
+ WebhookStatus["Unverified"] = "unverified";
2947
+ WebhookStatus["Verified"] = "verified";
2948
+ WebhookStatus["Failed"] = "failed";
2949
+ })(WebhookStatus || (WebhookStatus = {}));
2932
2950
  export var WidgetCategory;
2933
2951
  (function (WidgetCategory) {
2934
2952
  WidgetCategory["Organization"] = "organization";
@@ -90818,6 +90836,44 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration)
90818
90836
  options: localVarRequestOptions,
90819
90837
  };
90820
90838
  }),
90839
+ /**
90840
+ * 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.
90841
+ * @summary Discard a queued webhook delivery failure
90842
+ * @param {string} webhookId The webhook identifier
90843
+ * @param {string} failureId The failure identifier
90844
+ * @param {*} [options] Override http request option.
90845
+ * @throws {RequiredError}
90846
+ */
90847
+ deleteOrganizationWebhookFailure: (webhookId_1, failureId_1, ...args_1) => __awaiter(this, [webhookId_1, failureId_1, ...args_1], void 0, function* (webhookId, failureId, options = {}) {
90848
+ // verify required parameter 'webhookId' is not null or undefined
90849
+ assertParamExists('deleteOrganizationWebhookFailure', 'webhookId', webhookId);
90850
+ // verify required parameter 'failureId' is not null or undefined
90851
+ assertParamExists('deleteOrganizationWebhookFailure', 'failureId', failureId);
90852
+ const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
90853
+ .replace('{webhookId}', encodeURIComponent(String(webhookId)))
90854
+ .replace('{failureId}', encodeURIComponent(String(failureId)));
90855
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
90856
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90857
+ let baseOptions;
90858
+ if (configuration) {
90859
+ baseOptions = configuration.baseOptions;
90860
+ }
90861
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
90862
+ const localVarHeaderParameter = {};
90863
+ const localVarQueryParameter = {};
90864
+ // authentication ApiKeyAuth required
90865
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
90866
+ // authentication OrganizationId required
90867
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
90868
+ localVarHeaderParameter['Accept'] = 'application/json';
90869
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
90870
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
90871
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
90872
+ return {
90873
+ url: toPathString(localVarUrlObj),
90874
+ options: localVarRequestOptions,
90875
+ };
90876
+ }),
90821
90877
  /**
90822
90878
  * 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.
90823
90879
  * @summary Get an organization webhook
@@ -90852,6 +90908,94 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration)
90852
90908
  options: localVarRequestOptions,
90853
90909
  };
90854
90910
  }),
90911
+ /**
90912
+ * 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.
90913
+ * @summary Get a queued webhook delivery failure
90914
+ * @param {string} webhookId The webhook identifier
90915
+ * @param {string} failureId The failure identifier
90916
+ * @param {*} [options] Override http request option.
90917
+ * @throws {RequiredError}
90918
+ */
90919
+ getOrganizationWebhookFailure: (webhookId_1, failureId_1, ...args_1) => __awaiter(this, [webhookId_1, failureId_1, ...args_1], void 0, function* (webhookId, failureId, options = {}) {
90920
+ // verify required parameter 'webhookId' is not null or undefined
90921
+ assertParamExists('getOrganizationWebhookFailure', 'webhookId', webhookId);
90922
+ // verify required parameter 'failureId' is not null or undefined
90923
+ assertParamExists('getOrganizationWebhookFailure', 'failureId', failureId);
90924
+ const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
90925
+ .replace('{webhookId}', encodeURIComponent(String(webhookId)))
90926
+ .replace('{failureId}', encodeURIComponent(String(failureId)));
90927
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
90928
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90929
+ let baseOptions;
90930
+ if (configuration) {
90931
+ baseOptions = configuration.baseOptions;
90932
+ }
90933
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
90934
+ const localVarHeaderParameter = {};
90935
+ const localVarQueryParameter = {};
90936
+ // authentication ApiKeyAuth required
90937
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
90938
+ // authentication OrganizationId required
90939
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
90940
+ localVarHeaderParameter['Accept'] = 'application/json';
90941
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
90942
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
90943
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
90944
+ return {
90945
+ url: toPathString(localVarUrlObj),
90946
+ options: localVarRequestOptions,
90947
+ };
90948
+ }),
90949
+ /**
90950
+ * 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.
90951
+ * @summary List a webhook\'s queued delivery failures
90952
+ * @param {string} webhookId The webhook identifier
90953
+ * @param {number} [page] Page number
90954
+ * @param {number} [pageSize] Number of items per page
90955
+ * @param {string} [orderBy] Field to order by
90956
+ * @param {string} [search] Search query
90957
+ * @param {*} [options] Override http request option.
90958
+ * @throws {RequiredError}
90959
+ */
90960
+ getOrganizationWebhookFailures: (webhookId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [webhookId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (webhookId, page, pageSize, orderBy, search, options = {}) {
90961
+ // verify required parameter 'webhookId' is not null or undefined
90962
+ assertParamExists('getOrganizationWebhookFailures', 'webhookId', webhookId);
90963
+ const localVarPath = `/organization/webhooks/{webhookId}/failures`
90964
+ .replace('{webhookId}', encodeURIComponent(String(webhookId)));
90965
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
90966
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90967
+ let baseOptions;
90968
+ if (configuration) {
90969
+ baseOptions = configuration.baseOptions;
90970
+ }
90971
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
90972
+ const localVarHeaderParameter = {};
90973
+ const localVarQueryParameter = {};
90974
+ // authentication ApiKeyAuth required
90975
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
90976
+ // authentication OrganizationId required
90977
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
90978
+ if (page !== undefined) {
90979
+ localVarQueryParameter['page'] = page;
90980
+ }
90981
+ if (pageSize !== undefined) {
90982
+ localVarQueryParameter['pageSize'] = pageSize;
90983
+ }
90984
+ if (orderBy !== undefined) {
90985
+ localVarQueryParameter['orderBy'] = orderBy;
90986
+ }
90987
+ if (search !== undefined) {
90988
+ localVarQueryParameter['search'] = search;
90989
+ }
90990
+ localVarHeaderParameter['Accept'] = 'application/json';
90991
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
90992
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
90993
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
90994
+ return {
90995
+ url: toPathString(localVarUrlObj),
90996
+ options: localVarRequestOptions,
90997
+ };
90998
+ }),
90855
90999
  /**
90856
91000
  * 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.
90857
91001
  * @summary List an organization\'s webhooks
@@ -90898,6 +91042,78 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration)
90898
91042
  options: localVarRequestOptions,
90899
91043
  };
90900
91044
  }),
91045
+ /**
91046
+ * 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.
91047
+ * @summary Retry one queued webhook delivery
91048
+ * @param {string} webhookId The webhook identifier
91049
+ * @param {string} failureId The failure identifier
91050
+ * @param {*} [options] Override http request option.
91051
+ * @throws {RequiredError}
91052
+ */
91053
+ retryOrganizationWebhookFailure: (webhookId_1, failureId_1, ...args_1) => __awaiter(this, [webhookId_1, failureId_1, ...args_1], void 0, function* (webhookId, failureId, options = {}) {
91054
+ // verify required parameter 'webhookId' is not null or undefined
91055
+ assertParamExists('retryOrganizationWebhookFailure', 'webhookId', webhookId);
91056
+ // verify required parameter 'failureId' is not null or undefined
91057
+ assertParamExists('retryOrganizationWebhookFailure', 'failureId', failureId);
91058
+ const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}/retry`
91059
+ .replace('{webhookId}', encodeURIComponent(String(webhookId)))
91060
+ .replace('{failureId}', encodeURIComponent(String(failureId)));
91061
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
91062
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
91063
+ let baseOptions;
91064
+ if (configuration) {
91065
+ baseOptions = configuration.baseOptions;
91066
+ }
91067
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
91068
+ const localVarHeaderParameter = {};
91069
+ const localVarQueryParameter = {};
91070
+ // authentication ApiKeyAuth required
91071
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
91072
+ // authentication OrganizationId required
91073
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
91074
+ localVarHeaderParameter['Accept'] = 'application/json';
91075
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
91076
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
91077
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
91078
+ return {
91079
+ url: toPathString(localVarUrlObj),
91080
+ options: localVarRequestOptions,
91081
+ };
91082
+ }),
91083
+ /**
91084
+ * 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.
91085
+ * @summary Retry all of a webhook\'s queued deliveries
91086
+ * @param {string} webhookId The webhook identifier
91087
+ * @param {*} [options] Override http request option.
91088
+ * @throws {RequiredError}
91089
+ */
91090
+ retryOrganizationWebhookFailures: (webhookId_1, ...args_1) => __awaiter(this, [webhookId_1, ...args_1], void 0, function* (webhookId, options = {}) {
91091
+ // verify required parameter 'webhookId' is not null or undefined
91092
+ assertParamExists('retryOrganizationWebhookFailures', 'webhookId', webhookId);
91093
+ const localVarPath = `/organization/webhooks/{webhookId}/failures/retry`
91094
+ .replace('{webhookId}', encodeURIComponent(String(webhookId)));
91095
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
91096
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
91097
+ let baseOptions;
91098
+ if (configuration) {
91099
+ baseOptions = configuration.baseOptions;
91100
+ }
91101
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
91102
+ const localVarHeaderParameter = {};
91103
+ const localVarQueryParameter = {};
91104
+ // authentication ApiKeyAuth required
91105
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
91106
+ // authentication OrganizationId required
91107
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
91108
+ localVarHeaderParameter['Accept'] = 'application/json';
91109
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
91110
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
91111
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
91112
+ return {
91113
+ url: toPathString(localVarUrlObj),
91114
+ options: localVarRequestOptions,
91115
+ };
91116
+ }),
90901
91117
  /**
90902
91118
  * Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
90903
91119
  * @summary Update an organization webhook
@@ -91011,6 +91227,23 @@ export const OrganizationWebhooksApiFp = function (configuration) {
91011
91227
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91012
91228
  });
91013
91229
  },
91230
+ /**
91231
+ * 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.
91232
+ * @summary Discard a queued webhook delivery failure
91233
+ * @param {string} webhookId The webhook identifier
91234
+ * @param {string} failureId The failure identifier
91235
+ * @param {*} [options] Override http request option.
91236
+ * @throws {RequiredError}
91237
+ */
91238
+ deleteOrganizationWebhookFailure(webhookId, failureId, options) {
91239
+ return __awaiter(this, void 0, void 0, function* () {
91240
+ var _a, _b, _c;
91241
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationWebhookFailure(webhookId, failureId, options);
91242
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91243
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationWebhooksApi.deleteOrganizationWebhookFailure']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
91244
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91245
+ });
91246
+ },
91014
91247
  /**
91015
91248
  * 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.
91016
91249
  * @summary Get an organization webhook
@@ -91027,6 +91260,43 @@ export const OrganizationWebhooksApiFp = function (configuration) {
91027
91260
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91028
91261
  });
91029
91262
  },
91263
+ /**
91264
+ * 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.
91265
+ * @summary Get a queued webhook delivery failure
91266
+ * @param {string} webhookId The webhook identifier
91267
+ * @param {string} failureId The failure identifier
91268
+ * @param {*} [options] Override http request option.
91269
+ * @throws {RequiredError}
91270
+ */
91271
+ getOrganizationWebhookFailure(webhookId, failureId, options) {
91272
+ return __awaiter(this, void 0, void 0, function* () {
91273
+ var _a, _b, _c;
91274
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationWebhookFailure(webhookId, failureId, options);
91275
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91276
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailure']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
91277
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91278
+ });
91279
+ },
91280
+ /**
91281
+ * 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.
91282
+ * @summary List a webhook\'s queued delivery failures
91283
+ * @param {string} webhookId The webhook identifier
91284
+ * @param {number} [page] Page number
91285
+ * @param {number} [pageSize] Number of items per page
91286
+ * @param {string} [orderBy] Field to order by
91287
+ * @param {string} [search] Search query
91288
+ * @param {*} [options] Override http request option.
91289
+ * @throws {RequiredError}
91290
+ */
91291
+ getOrganizationWebhookFailures(webhookId, page, pageSize, orderBy, search, options) {
91292
+ return __awaiter(this, void 0, void 0, function* () {
91293
+ var _a, _b, _c;
91294
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationWebhookFailures(webhookId, page, pageSize, orderBy, search, options);
91295
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91296
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailures']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
91297
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91298
+ });
91299
+ },
91030
91300
  /**
91031
91301
  * 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.
91032
91302
  * @summary List an organization\'s webhooks
@@ -91046,6 +91316,39 @@ export const OrganizationWebhooksApiFp = function (configuration) {
91046
91316
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91047
91317
  });
91048
91318
  },
91319
+ /**
91320
+ * 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.
91321
+ * @summary Retry one queued webhook delivery
91322
+ * @param {string} webhookId The webhook identifier
91323
+ * @param {string} failureId The failure identifier
91324
+ * @param {*} [options] Override http request option.
91325
+ * @throws {RequiredError}
91326
+ */
91327
+ retryOrganizationWebhookFailure(webhookId, failureId, options) {
91328
+ return __awaiter(this, void 0, void 0, function* () {
91329
+ var _a, _b, _c;
91330
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.retryOrganizationWebhookFailure(webhookId, failureId, options);
91331
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91332
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailure']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
91333
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91334
+ });
91335
+ },
91336
+ /**
91337
+ * 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.
91338
+ * @summary Retry all of a webhook\'s queued deliveries
91339
+ * @param {string} webhookId The webhook identifier
91340
+ * @param {*} [options] Override http request option.
91341
+ * @throws {RequiredError}
91342
+ */
91343
+ retryOrganizationWebhookFailures(webhookId, options) {
91344
+ return __awaiter(this, void 0, void 0, function* () {
91345
+ var _a, _b, _c;
91346
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.retryOrganizationWebhookFailures(webhookId, options);
91347
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
91348
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailures']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
91349
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
91350
+ });
91351
+ },
91049
91352
  /**
91050
91353
  * Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
91051
91354
  * @summary Update an organization webhook
@@ -91107,6 +91410,16 @@ export const OrganizationWebhooksApiFactory = function (configuration, basePath,
91107
91410
  deleteOrganizationWebhook(requestParameters, options) {
91108
91411
  return localVarFp.deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
91109
91412
  },
91413
+ /**
91414
+ * 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.
91415
+ * @summary Discard a queued webhook delivery failure
91416
+ * @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
91417
+ * @param {*} [options] Override http request option.
91418
+ * @throws {RequiredError}
91419
+ */
91420
+ deleteOrganizationWebhookFailure(requestParameters, options) {
91421
+ return localVarFp.deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
91422
+ },
91110
91423
  /**
91111
91424
  * 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.
91112
91425
  * @summary Get an organization webhook
@@ -91117,6 +91430,26 @@ export const OrganizationWebhooksApiFactory = function (configuration, basePath,
91117
91430
  getOrganizationWebhook(requestParameters, options) {
91118
91431
  return localVarFp.getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
91119
91432
  },
91433
+ /**
91434
+ * 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.
91435
+ * @summary Get a queued webhook delivery failure
91436
+ * @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
91437
+ * @param {*} [options] Override http request option.
91438
+ * @throws {RequiredError}
91439
+ */
91440
+ getOrganizationWebhookFailure(requestParameters, options) {
91441
+ return localVarFp.getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
91442
+ },
91443
+ /**
91444
+ * 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.
91445
+ * @summary List a webhook\'s queued delivery failures
91446
+ * @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
91447
+ * @param {*} [options] Override http request option.
91448
+ * @throws {RequiredError}
91449
+ */
91450
+ getOrganizationWebhookFailures(requestParameters, options) {
91451
+ return localVarFp.getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
91452
+ },
91120
91453
  /**
91121
91454
  * 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.
91122
91455
  * @summary List an organization\'s webhooks
@@ -91127,6 +91460,26 @@ export const OrganizationWebhooksApiFactory = function (configuration, basePath,
91127
91460
  getOrganizationWebhooks(requestParameters = {}, options) {
91128
91461
  return localVarFp.getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
91129
91462
  },
91463
+ /**
91464
+ * 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.
91465
+ * @summary Retry one queued webhook delivery
91466
+ * @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
91467
+ * @param {*} [options] Override http request option.
91468
+ * @throws {RequiredError}
91469
+ */
91470
+ retryOrganizationWebhookFailure(requestParameters, options) {
91471
+ return localVarFp.retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
91472
+ },
91473
+ /**
91474
+ * 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.
91475
+ * @summary Retry all of a webhook\'s queued deliveries
91476
+ * @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
91477
+ * @param {*} [options] Override http request option.
91478
+ * @throws {RequiredError}
91479
+ */
91480
+ retryOrganizationWebhookFailures(requestParameters, options) {
91481
+ return localVarFp.retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(axios, basePath));
91482
+ },
91130
91483
  /**
91131
91484
  * Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
91132
91485
  * @summary Update an organization webhook
@@ -91173,6 +91526,16 @@ export class OrganizationWebhooksApi extends BaseAPI {
91173
91526
  deleteOrganizationWebhook(requestParameters, options) {
91174
91527
  return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
91175
91528
  }
91529
+ /**
91530
+ * 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.
91531
+ * @summary Discard a queued webhook delivery failure
91532
+ * @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
91533
+ * @param {*} [options] Override http request option.
91534
+ * @throws {RequiredError}
91535
+ */
91536
+ deleteOrganizationWebhookFailure(requestParameters, options) {
91537
+ return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
91538
+ }
91176
91539
  /**
91177
91540
  * 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.
91178
91541
  * @summary Get an organization webhook
@@ -91183,6 +91546,26 @@ export class OrganizationWebhooksApi extends BaseAPI {
91183
91546
  getOrganizationWebhook(requestParameters, options) {
91184
91547
  return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
91185
91548
  }
91549
+ /**
91550
+ * 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.
91551
+ * @summary Get a queued webhook delivery failure
91552
+ * @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
91553
+ * @param {*} [options] Override http request option.
91554
+ * @throws {RequiredError}
91555
+ */
91556
+ getOrganizationWebhookFailure(requestParameters, options) {
91557
+ return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
91558
+ }
91559
+ /**
91560
+ * 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.
91561
+ * @summary List a webhook\'s queued delivery failures
91562
+ * @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
91563
+ * @param {*} [options] Override http request option.
91564
+ * @throws {RequiredError}
91565
+ */
91566
+ getOrganizationWebhookFailures(requestParameters, options) {
91567
+ return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
91568
+ }
91186
91569
  /**
91187
91570
  * 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.
91188
91571
  * @summary List an organization\'s webhooks
@@ -91193,6 +91576,26 @@ export class OrganizationWebhooksApi extends BaseAPI {
91193
91576
  getOrganizationWebhooks(requestParameters = {}, options) {
91194
91577
  return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
91195
91578
  }
91579
+ /**
91580
+ * 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.
91581
+ * @summary Retry one queued webhook delivery
91582
+ * @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
91583
+ * @param {*} [options] Override http request option.
91584
+ * @throws {RequiredError}
91585
+ */
91586
+ retryOrganizationWebhookFailure(requestParameters, options) {
91587
+ return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
91588
+ }
91589
+ /**
91590
+ * 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.
91591
+ * @summary Retry all of a webhook\'s queued deliveries
91592
+ * @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
91593
+ * @param {*} [options] Override http request option.
91594
+ * @throws {RequiredError}
91595
+ */
91596
+ retryOrganizationWebhookFailures(requestParameters, options) {
91597
+ return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
91598
+ }
91196
91599
  /**
91197
91600
  * Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
91198
91601
  * @summary Update an organization webhook
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.15.0
5
+ * The version of the OpenAPI document: 11.16.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.15.0
7
+ * The version of the OpenAPI document: 11.16.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.15.0
5
+ * The version of the OpenAPI document: 11.16.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.15.0
7
+ * The version of the OpenAPI document: 11.16.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.15.0
5
+ * The version of the OpenAPI document: 11.16.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 11.15.0
6
+ * The version of the OpenAPI document: 11.16.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **url** | **string** | | [default to undefined]
10
10
  **name** | **string** | | [default to undefined]
11
11
  **verified** | **boolean** | | [default to undefined]
12
+ **status** | [**WebhookStatus**](WebhookStatus.md) | | [default to undefined]
12
13
 
13
14
  ## Example
14
15
 
@@ -20,6 +21,7 @@ const instance: BaseWebhook = {
20
21
  url,
21
22
  name,
22
23
  verified,
24
+ status,
23
25
  };
24
26
  ```
25
27
 
@@ -0,0 +1,42 @@
1
+ # BaseWebhookFailure
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **webhookId** | **string** | | [default to undefined]
10
+ **error** | **string** | | [default to undefined]
11
+ **statusCode** | **number** | | [default to undefined]
12
+ **source** | **string** | | [default to undefined]
13
+ **sourceId** | **string** | | [default to undefined]
14
+ **attempts** | **number** | | [default to undefined]
15
+ **retries** | **number** | | [default to undefined]
16
+ **lastAttemptAt** | **string** | | [default to undefined]
17
+ **lockedAt** | **string** | | [default to undefined]
18
+ **createdAt** | **string** | | [default to undefined]
19
+ **updatedAt** | **string** | | [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { BaseWebhookFailure } from '@connectedxm/admin-sdk';
25
+
26
+ const instance: BaseWebhookFailure = {
27
+ id,
28
+ webhookId,
29
+ error,
30
+ statusCode,
31
+ source,
32
+ sourceId,
33
+ attempts,
34
+ retries,
35
+ lastAttemptAt,
36
+ lockedAt,
37
+ createdAt,
38
+ updatedAt,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)