@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/.openapi-generator/FILES +8 -0
- package/README.md +2 -2
- package/api.ts +578 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +320 -1
- package/dist/api.js +425 -22
- 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/api.d.ts +320 -1
- package/dist/esm/api.js +404 -1
- 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/BaseWebhook.md +2 -0
- package/docs/BaseWebhookFailure.md +42 -0
- package/docs/GetOrganizationWebhookFailure200Response.md +24 -0
- package/docs/GetOrganizationWebhookFailures200Response.md +26 -0
- package/docs/OrganizationWebhooksApi.md +281 -0
- package/docs/RetryOrganizationWebhookFailure200Response.md +24 -0
- package/docs/Webhook.md +4 -0
- package/docs/WebhookAllOfCount.md +20 -0
- package/docs/WebhookFailure.md +46 -0
- package/docs/WebhookFailureRetryResult.md +22 -0
- package/docs/WebhookStatus.md +12 -0
- package/package.json +1 -1
package/api.ts
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.
|
|
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).
|
|
@@ -2869,6 +2869,23 @@ export interface BaseWebhook {
|
|
|
2869
2869
|
'url': string;
|
|
2870
2870
|
'name': string;
|
|
2871
2871
|
'verified': boolean;
|
|
2872
|
+
'status': WebhookStatus;
|
|
2873
|
+
}
|
|
2874
|
+
|
|
2875
|
+
|
|
2876
|
+
export interface BaseWebhookFailure {
|
|
2877
|
+
'id': string;
|
|
2878
|
+
'webhookId': string;
|
|
2879
|
+
'error': string;
|
|
2880
|
+
'statusCode': number | null;
|
|
2881
|
+
'source': string;
|
|
2882
|
+
'sourceId': string | null;
|
|
2883
|
+
'attempts': number;
|
|
2884
|
+
'retries': number;
|
|
2885
|
+
'lastAttemptAt': string;
|
|
2886
|
+
'lockedAt': string | null;
|
|
2887
|
+
'createdAt': string;
|
|
2888
|
+
'updatedAt': string;
|
|
2872
2889
|
}
|
|
2873
2890
|
export interface Benefit {
|
|
2874
2891
|
'id': string;
|
|
@@ -9869,6 +9886,27 @@ export enum GetOrganizationUsers200ResponseStatusEnum {
|
|
|
9869
9886
|
Ok = 'ok'
|
|
9870
9887
|
}
|
|
9871
9888
|
|
|
9889
|
+
export interface GetOrganizationWebhookFailure200Response {
|
|
9890
|
+
'status': GetOrganizationWebhookFailure200ResponseStatusEnum;
|
|
9891
|
+
'message': string;
|
|
9892
|
+
'data': WebhookFailure;
|
|
9893
|
+
}
|
|
9894
|
+
|
|
9895
|
+
export enum GetOrganizationWebhookFailure200ResponseStatusEnum {
|
|
9896
|
+
Ok = 'ok'
|
|
9897
|
+
}
|
|
9898
|
+
|
|
9899
|
+
export interface GetOrganizationWebhookFailures200Response {
|
|
9900
|
+
'status': GetOrganizationWebhookFailures200ResponseStatusEnum;
|
|
9901
|
+
'message': string;
|
|
9902
|
+
'data': Array<BaseWebhookFailure>;
|
|
9903
|
+
'count'?: number;
|
|
9904
|
+
}
|
|
9905
|
+
|
|
9906
|
+
export enum GetOrganizationWebhookFailures200ResponseStatusEnum {
|
|
9907
|
+
Ok = 'ok'
|
|
9908
|
+
}
|
|
9909
|
+
|
|
9872
9910
|
export interface GetPayment200Response {
|
|
9873
9911
|
'status': GetPayment200ResponseStatusEnum;
|
|
9874
9912
|
'message': string;
|
|
@@ -13368,6 +13406,16 @@ export enum RequestImageDirectUpload200ResponseStatusEnum {
|
|
|
13368
13406
|
Ok = 'ok'
|
|
13369
13407
|
}
|
|
13370
13408
|
|
|
13409
|
+
export interface RetryOrganizationWebhookFailure200Response {
|
|
13410
|
+
'status': RetryOrganizationWebhookFailure200ResponseStatusEnum;
|
|
13411
|
+
'message': string;
|
|
13412
|
+
'data': WebhookFailureRetryResult;
|
|
13413
|
+
}
|
|
13414
|
+
|
|
13415
|
+
export enum RetryOrganizationWebhookFailure200ResponseStatusEnum {
|
|
13416
|
+
Ok = 'ok'
|
|
13417
|
+
}
|
|
13418
|
+
|
|
13371
13419
|
export interface Room {
|
|
13372
13420
|
'id': string;
|
|
13373
13421
|
'roomName': string;
|
|
@@ -15472,14 +15520,49 @@ export interface Webhook {
|
|
|
15472
15520
|
'url': string;
|
|
15473
15521
|
'name': string;
|
|
15474
15522
|
'verified': boolean;
|
|
15523
|
+
'status': WebhookStatus;
|
|
15524
|
+
'_count': WebhookAllOfCount;
|
|
15475
15525
|
'createdAt': string;
|
|
15476
15526
|
'updatedAt': string;
|
|
15477
15527
|
}
|
|
15528
|
+
|
|
15529
|
+
|
|
15530
|
+
export interface WebhookAllOfCount {
|
|
15531
|
+
'failures': number;
|
|
15532
|
+
}
|
|
15478
15533
|
export interface WebhookCreateInputs {
|
|
15479
15534
|
'name'?: string | null;
|
|
15480
15535
|
'url': string;
|
|
15481
15536
|
'secret': string;
|
|
15482
15537
|
}
|
|
15538
|
+
export interface WebhookFailure {
|
|
15539
|
+
'id': string;
|
|
15540
|
+
'webhookId': string;
|
|
15541
|
+
'error': string;
|
|
15542
|
+
'statusCode': number | null;
|
|
15543
|
+
'source': string;
|
|
15544
|
+
'sourceId': string | null;
|
|
15545
|
+
'attempts': number;
|
|
15546
|
+
'retries': number;
|
|
15547
|
+
'lastAttemptAt': string;
|
|
15548
|
+
'lockedAt': string | null;
|
|
15549
|
+
'createdAt': string;
|
|
15550
|
+
'updatedAt': string;
|
|
15551
|
+
'payload': { [key: string]: any; };
|
|
15552
|
+
'webhook': BaseWebhook;
|
|
15553
|
+
}
|
|
15554
|
+
export interface WebhookFailureRetryResult {
|
|
15555
|
+
'success': boolean;
|
|
15556
|
+
'failure'?: BaseWebhookFailure;
|
|
15557
|
+
}
|
|
15558
|
+
|
|
15559
|
+
export enum WebhookStatus {
|
|
15560
|
+
Unverified = 'unverified',
|
|
15561
|
+
Verified = 'verified',
|
|
15562
|
+
Failed = 'failed'
|
|
15563
|
+
}
|
|
15564
|
+
|
|
15565
|
+
|
|
15483
15566
|
export interface WebhookUpdateInputs {
|
|
15484
15567
|
'name'?: string | null;
|
|
15485
15568
|
}
|
|
@@ -130711,6 +130794,50 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130711
130794
|
options: localVarRequestOptions,
|
|
130712
130795
|
};
|
|
130713
130796
|
},
|
|
130797
|
+
/**
|
|
130798
|
+
* 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.
|
|
130799
|
+
* @summary Discard a queued webhook delivery failure
|
|
130800
|
+
* @param {string} webhookId The webhook identifier
|
|
130801
|
+
* @param {string} failureId The failure identifier
|
|
130802
|
+
* @param {*} [options] Override http request option.
|
|
130803
|
+
* @throws {RequiredError}
|
|
130804
|
+
*/
|
|
130805
|
+
deleteOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130806
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130807
|
+
assertParamExists('deleteOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
130808
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
130809
|
+
assertParamExists('deleteOrganizationWebhookFailure', 'failureId', failureId)
|
|
130810
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
|
|
130811
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
130812
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
130813
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130814
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130815
|
+
let baseOptions;
|
|
130816
|
+
if (configuration) {
|
|
130817
|
+
baseOptions = configuration.baseOptions;
|
|
130818
|
+
}
|
|
130819
|
+
|
|
130820
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
130821
|
+
const localVarHeaderParameter = {} as any;
|
|
130822
|
+
const localVarQueryParameter = {} as any;
|
|
130823
|
+
|
|
130824
|
+
// authentication ApiKeyAuth required
|
|
130825
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130826
|
+
|
|
130827
|
+
// authentication OrganizationId required
|
|
130828
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130829
|
+
|
|
130830
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130831
|
+
|
|
130832
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130833
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130834
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130835
|
+
|
|
130836
|
+
return {
|
|
130837
|
+
url: toPathString(localVarUrlObj),
|
|
130838
|
+
options: localVarRequestOptions,
|
|
130839
|
+
};
|
|
130840
|
+
},
|
|
130714
130841
|
/**
|
|
130715
130842
|
* 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.
|
|
130716
130843
|
* @summary Get an organization webhook
|
|
@@ -130751,6 +130878,110 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130751
130878
|
options: localVarRequestOptions,
|
|
130752
130879
|
};
|
|
130753
130880
|
},
|
|
130881
|
+
/**
|
|
130882
|
+
* 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.
|
|
130883
|
+
* @summary Get a queued webhook delivery failure
|
|
130884
|
+
* @param {string} webhookId The webhook identifier
|
|
130885
|
+
* @param {string} failureId The failure identifier
|
|
130886
|
+
* @param {*} [options] Override http request option.
|
|
130887
|
+
* @throws {RequiredError}
|
|
130888
|
+
*/
|
|
130889
|
+
getOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130890
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130891
|
+
assertParamExists('getOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
130892
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
130893
|
+
assertParamExists('getOrganizationWebhookFailure', 'failureId', failureId)
|
|
130894
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
|
|
130895
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
130896
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
130897
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130898
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130899
|
+
let baseOptions;
|
|
130900
|
+
if (configuration) {
|
|
130901
|
+
baseOptions = configuration.baseOptions;
|
|
130902
|
+
}
|
|
130903
|
+
|
|
130904
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
130905
|
+
const localVarHeaderParameter = {} as any;
|
|
130906
|
+
const localVarQueryParameter = {} as any;
|
|
130907
|
+
|
|
130908
|
+
// authentication ApiKeyAuth required
|
|
130909
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130910
|
+
|
|
130911
|
+
// authentication OrganizationId required
|
|
130912
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130913
|
+
|
|
130914
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130915
|
+
|
|
130916
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130917
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130918
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130919
|
+
|
|
130920
|
+
return {
|
|
130921
|
+
url: toPathString(localVarUrlObj),
|
|
130922
|
+
options: localVarRequestOptions,
|
|
130923
|
+
};
|
|
130924
|
+
},
|
|
130925
|
+
/**
|
|
130926
|
+
* 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.
|
|
130927
|
+
* @summary List a webhook\'s queued delivery failures
|
|
130928
|
+
* @param {string} webhookId The webhook identifier
|
|
130929
|
+
* @param {number} [page] Page number
|
|
130930
|
+
* @param {number} [pageSize] Number of items per page
|
|
130931
|
+
* @param {string} [orderBy] Field to order by
|
|
130932
|
+
* @param {string} [search] Search query
|
|
130933
|
+
* @param {*} [options] Override http request option.
|
|
130934
|
+
* @throws {RequiredError}
|
|
130935
|
+
*/
|
|
130936
|
+
getOrganizationWebhookFailures: async (webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130937
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130938
|
+
assertParamExists('getOrganizationWebhookFailures', 'webhookId', webhookId)
|
|
130939
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures`
|
|
130940
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
130941
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130942
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130943
|
+
let baseOptions;
|
|
130944
|
+
if (configuration) {
|
|
130945
|
+
baseOptions = configuration.baseOptions;
|
|
130946
|
+
}
|
|
130947
|
+
|
|
130948
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
130949
|
+
const localVarHeaderParameter = {} as any;
|
|
130950
|
+
const localVarQueryParameter = {} as any;
|
|
130951
|
+
|
|
130952
|
+
// authentication ApiKeyAuth required
|
|
130953
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130954
|
+
|
|
130955
|
+
// authentication OrganizationId required
|
|
130956
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130957
|
+
|
|
130958
|
+
if (page !== undefined) {
|
|
130959
|
+
localVarQueryParameter['page'] = page;
|
|
130960
|
+
}
|
|
130961
|
+
|
|
130962
|
+
if (pageSize !== undefined) {
|
|
130963
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
130964
|
+
}
|
|
130965
|
+
|
|
130966
|
+
if (orderBy !== undefined) {
|
|
130967
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
130968
|
+
}
|
|
130969
|
+
|
|
130970
|
+
if (search !== undefined) {
|
|
130971
|
+
localVarQueryParameter['search'] = search;
|
|
130972
|
+
}
|
|
130973
|
+
|
|
130974
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130975
|
+
|
|
130976
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130977
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130978
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130979
|
+
|
|
130980
|
+
return {
|
|
130981
|
+
url: toPathString(localVarUrlObj),
|
|
130982
|
+
options: localVarRequestOptions,
|
|
130983
|
+
};
|
|
130984
|
+
},
|
|
130754
130985
|
/**
|
|
130755
130986
|
* 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.
|
|
130756
130987
|
* @summary List an organization\'s webhooks
|
|
@@ -130807,6 +131038,90 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130807
131038
|
options: localVarRequestOptions,
|
|
130808
131039
|
};
|
|
130809
131040
|
},
|
|
131041
|
+
/**
|
|
131042
|
+
* 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.
|
|
131043
|
+
* @summary Retry one queued webhook delivery
|
|
131044
|
+
* @param {string} webhookId The webhook identifier
|
|
131045
|
+
* @param {string} failureId The failure identifier
|
|
131046
|
+
* @param {*} [options] Override http request option.
|
|
131047
|
+
* @throws {RequiredError}
|
|
131048
|
+
*/
|
|
131049
|
+
retryOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131050
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
131051
|
+
assertParamExists('retryOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
131052
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
131053
|
+
assertParamExists('retryOrganizationWebhookFailure', 'failureId', failureId)
|
|
131054
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}/retry`
|
|
131055
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
131056
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
131057
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131058
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131059
|
+
let baseOptions;
|
|
131060
|
+
if (configuration) {
|
|
131061
|
+
baseOptions = configuration.baseOptions;
|
|
131062
|
+
}
|
|
131063
|
+
|
|
131064
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
131065
|
+
const localVarHeaderParameter = {} as any;
|
|
131066
|
+
const localVarQueryParameter = {} as any;
|
|
131067
|
+
|
|
131068
|
+
// authentication ApiKeyAuth required
|
|
131069
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
131070
|
+
|
|
131071
|
+
// authentication OrganizationId required
|
|
131072
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
131073
|
+
|
|
131074
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
131075
|
+
|
|
131076
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131077
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131078
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131079
|
+
|
|
131080
|
+
return {
|
|
131081
|
+
url: toPathString(localVarUrlObj),
|
|
131082
|
+
options: localVarRequestOptions,
|
|
131083
|
+
};
|
|
131084
|
+
},
|
|
131085
|
+
/**
|
|
131086
|
+
* 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.
|
|
131087
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131088
|
+
* @param {string} webhookId The webhook identifier
|
|
131089
|
+
* @param {*} [options] Override http request option.
|
|
131090
|
+
* @throws {RequiredError}
|
|
131091
|
+
*/
|
|
131092
|
+
retryOrganizationWebhookFailures: async (webhookId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131093
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
131094
|
+
assertParamExists('retryOrganizationWebhookFailures', 'webhookId', webhookId)
|
|
131095
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/retry`
|
|
131096
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
131097
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131098
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131099
|
+
let baseOptions;
|
|
131100
|
+
if (configuration) {
|
|
131101
|
+
baseOptions = configuration.baseOptions;
|
|
131102
|
+
}
|
|
131103
|
+
|
|
131104
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
131105
|
+
const localVarHeaderParameter = {} as any;
|
|
131106
|
+
const localVarQueryParameter = {} as any;
|
|
131107
|
+
|
|
131108
|
+
// authentication ApiKeyAuth required
|
|
131109
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
131110
|
+
|
|
131111
|
+
// authentication OrganizationId required
|
|
131112
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
131113
|
+
|
|
131114
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
131115
|
+
|
|
131116
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131117
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131118
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131119
|
+
|
|
131120
|
+
return {
|
|
131121
|
+
url: toPathString(localVarUrlObj),
|
|
131122
|
+
options: localVarRequestOptions,
|
|
131123
|
+
};
|
|
131124
|
+
},
|
|
130810
131125
|
/**
|
|
130811
131126
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
130812
131127
|
* @summary Update an organization webhook
|
|
@@ -130927,6 +131242,20 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130927
131242
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.deleteOrganizationWebhook']?.[localVarOperationServerIndex]?.url;
|
|
130928
131243
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130929
131244
|
},
|
|
131245
|
+
/**
|
|
131246
|
+
* 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.
|
|
131247
|
+
* @summary Discard a queued webhook delivery failure
|
|
131248
|
+
* @param {string} webhookId The webhook identifier
|
|
131249
|
+
* @param {string} failureId The failure identifier
|
|
131250
|
+
* @param {*} [options] Override http request option.
|
|
131251
|
+
* @throws {RequiredError}
|
|
131252
|
+
*/
|
|
131253
|
+
async deleteOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
131254
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131255
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131256
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.deleteOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131257
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131258
|
+
},
|
|
130930
131259
|
/**
|
|
130931
131260
|
* 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.
|
|
130932
131261
|
* @summary Get an organization webhook
|
|
@@ -130940,6 +131269,37 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130940
131269
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhook']?.[localVarOperationServerIndex]?.url;
|
|
130941
131270
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130942
131271
|
},
|
|
131272
|
+
/**
|
|
131273
|
+
* 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.
|
|
131274
|
+
* @summary Get a queued webhook delivery failure
|
|
131275
|
+
* @param {string} webhookId The webhook identifier
|
|
131276
|
+
* @param {string} failureId The failure identifier
|
|
131277
|
+
* @param {*} [options] Override http request option.
|
|
131278
|
+
* @throws {RequiredError}
|
|
131279
|
+
*/
|
|
131280
|
+
async getOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailure200Response>> {
|
|
131281
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131282
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131283
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131284
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131285
|
+
},
|
|
131286
|
+
/**
|
|
131287
|
+
* 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.
|
|
131288
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131289
|
+
* @param {string} webhookId The webhook identifier
|
|
131290
|
+
* @param {number} [page] Page number
|
|
131291
|
+
* @param {number} [pageSize] Number of items per page
|
|
131292
|
+
* @param {string} [orderBy] Field to order by
|
|
131293
|
+
* @param {string} [search] Search query
|
|
131294
|
+
* @param {*} [options] Override http request option.
|
|
131295
|
+
* @throws {RequiredError}
|
|
131296
|
+
*/
|
|
131297
|
+
async getOrganizationWebhookFailures(webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailures200Response>> {
|
|
131298
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationWebhookFailures(webhookId, page, pageSize, orderBy, search, options);
|
|
131299
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131300
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailures']?.[localVarOperationServerIndex]?.url;
|
|
131301
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131302
|
+
},
|
|
130943
131303
|
/**
|
|
130944
131304
|
* 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.
|
|
130945
131305
|
* @summary List an organization\'s webhooks
|
|
@@ -130956,6 +131316,33 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130956
131316
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhooks']?.[localVarOperationServerIndex]?.url;
|
|
130957
131317
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130958
131318
|
},
|
|
131319
|
+
/**
|
|
131320
|
+
* 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.
|
|
131321
|
+
* @summary Retry one queued webhook delivery
|
|
131322
|
+
* @param {string} webhookId The webhook identifier
|
|
131323
|
+
* @param {string} failureId The failure identifier
|
|
131324
|
+
* @param {*} [options] Override http request option.
|
|
131325
|
+
* @throws {RequiredError}
|
|
131326
|
+
*/
|
|
131327
|
+
async retryOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetryOrganizationWebhookFailure200Response>> {
|
|
131328
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131329
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131330
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131331
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131332
|
+
},
|
|
131333
|
+
/**
|
|
131334
|
+
* 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.
|
|
131335
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131336
|
+
* @param {string} webhookId The webhook identifier
|
|
131337
|
+
* @param {*} [options] Override http request option.
|
|
131338
|
+
* @throws {RequiredError}
|
|
131339
|
+
*/
|
|
131340
|
+
async retryOrganizationWebhookFailures(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
131341
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryOrganizationWebhookFailures(webhookId, options);
|
|
131342
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131343
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailures']?.[localVarOperationServerIndex]?.url;
|
|
131344
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131345
|
+
},
|
|
130959
131346
|
/**
|
|
130960
131347
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
130961
131348
|
* @summary Update an organization webhook
|
|
@@ -131012,6 +131399,16 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131012
131399
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131013
131400
|
return localVarFp.deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131014
131401
|
},
|
|
131402
|
+
/**
|
|
131403
|
+
* 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.
|
|
131404
|
+
* @summary Discard a queued webhook delivery failure
|
|
131405
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131406
|
+
* @param {*} [options] Override http request option.
|
|
131407
|
+
* @throws {RequiredError}
|
|
131408
|
+
*/
|
|
131409
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131410
|
+
return localVarFp.deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131411
|
+
},
|
|
131015
131412
|
/**
|
|
131016
131413
|
* 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.
|
|
131017
131414
|
* @summary Get an organization webhook
|
|
@@ -131022,6 +131419,26 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131022
131419
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response> {
|
|
131023
131420
|
return localVarFp.getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131024
131421
|
},
|
|
131422
|
+
/**
|
|
131423
|
+
* 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.
|
|
131424
|
+
* @summary Get a queued webhook delivery failure
|
|
131425
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131426
|
+
* @param {*} [options] Override http request option.
|
|
131427
|
+
* @throws {RequiredError}
|
|
131428
|
+
*/
|
|
131429
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailure200Response> {
|
|
131430
|
+
return localVarFp.getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131431
|
+
},
|
|
131432
|
+
/**
|
|
131433
|
+
* 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.
|
|
131434
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131435
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131436
|
+
* @param {*} [options] Override http request option.
|
|
131437
|
+
* @throws {RequiredError}
|
|
131438
|
+
*/
|
|
131439
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailures200Response> {
|
|
131440
|
+
return localVarFp.getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
131441
|
+
},
|
|
131025
131442
|
/**
|
|
131026
131443
|
* 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.
|
|
131027
131444
|
* @summary List an organization\'s webhooks
|
|
@@ -131032,6 +131449,26 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131032
131449
|
getOrganizationWebhooks(requestParameters: OrganizationWebhooksApiGetOrganizationWebhooksRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response> {
|
|
131033
131450
|
return localVarFp.getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
131034
131451
|
},
|
|
131452
|
+
/**
|
|
131453
|
+
* 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.
|
|
131454
|
+
* @summary Retry one queued webhook delivery
|
|
131455
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131456
|
+
* @param {*} [options] Override http request option.
|
|
131457
|
+
* @throws {RequiredError}
|
|
131458
|
+
*/
|
|
131459
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryOrganizationWebhookFailure200Response> {
|
|
131460
|
+
return localVarFp.retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131461
|
+
},
|
|
131462
|
+
/**
|
|
131463
|
+
* 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.
|
|
131464
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131465
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131466
|
+
* @param {*} [options] Override http request option.
|
|
131467
|
+
* @throws {RequiredError}
|
|
131468
|
+
*/
|
|
131469
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131470
|
+
return localVarFp.retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131471
|
+
},
|
|
131035
131472
|
/**
|
|
131036
131473
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
131037
131474
|
* @summary Update an organization webhook
|
|
@@ -131072,6 +131509,21 @@ export interface OrganizationWebhooksApiDeleteOrganizationWebhookRequest {
|
|
|
131072
131509
|
readonly webhookId: string
|
|
131073
131510
|
}
|
|
131074
131511
|
|
|
131512
|
+
/**
|
|
131513
|
+
* Request parameters for deleteOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131514
|
+
*/
|
|
131515
|
+
export interface OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest {
|
|
131516
|
+
/**
|
|
131517
|
+
* The webhook identifier
|
|
131518
|
+
*/
|
|
131519
|
+
readonly webhookId: string
|
|
131520
|
+
|
|
131521
|
+
/**
|
|
131522
|
+
* The failure identifier
|
|
131523
|
+
*/
|
|
131524
|
+
readonly failureId: string
|
|
131525
|
+
}
|
|
131526
|
+
|
|
131075
131527
|
/**
|
|
131076
131528
|
* Request parameters for getOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
131077
131529
|
*/
|
|
@@ -131082,6 +131534,51 @@ export interface OrganizationWebhooksApiGetOrganizationWebhookRequest {
|
|
|
131082
131534
|
readonly webhookId: string
|
|
131083
131535
|
}
|
|
131084
131536
|
|
|
131537
|
+
/**
|
|
131538
|
+
* Request parameters for getOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131539
|
+
*/
|
|
131540
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailureRequest {
|
|
131541
|
+
/**
|
|
131542
|
+
* The webhook identifier
|
|
131543
|
+
*/
|
|
131544
|
+
readonly webhookId: string
|
|
131545
|
+
|
|
131546
|
+
/**
|
|
131547
|
+
* The failure identifier
|
|
131548
|
+
*/
|
|
131549
|
+
readonly failureId: string
|
|
131550
|
+
}
|
|
131551
|
+
|
|
131552
|
+
/**
|
|
131553
|
+
* Request parameters for getOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
131554
|
+
*/
|
|
131555
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest {
|
|
131556
|
+
/**
|
|
131557
|
+
* The webhook identifier
|
|
131558
|
+
*/
|
|
131559
|
+
readonly webhookId: string
|
|
131560
|
+
|
|
131561
|
+
/**
|
|
131562
|
+
* Page number
|
|
131563
|
+
*/
|
|
131564
|
+
readonly page?: number
|
|
131565
|
+
|
|
131566
|
+
/**
|
|
131567
|
+
* Number of items per page
|
|
131568
|
+
*/
|
|
131569
|
+
readonly pageSize?: number
|
|
131570
|
+
|
|
131571
|
+
/**
|
|
131572
|
+
* Field to order by
|
|
131573
|
+
*/
|
|
131574
|
+
readonly orderBy?: string
|
|
131575
|
+
|
|
131576
|
+
/**
|
|
131577
|
+
* Search query
|
|
131578
|
+
*/
|
|
131579
|
+
readonly search?: string
|
|
131580
|
+
}
|
|
131581
|
+
|
|
131085
131582
|
/**
|
|
131086
131583
|
* Request parameters for getOrganizationWebhooks operation in OrganizationWebhooksApi.
|
|
131087
131584
|
*/
|
|
@@ -131107,6 +131604,31 @@ export interface OrganizationWebhooksApiGetOrganizationWebhooksRequest {
|
|
|
131107
131604
|
readonly search?: string
|
|
131108
131605
|
}
|
|
131109
131606
|
|
|
131607
|
+
/**
|
|
131608
|
+
* Request parameters for retryOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131609
|
+
*/
|
|
131610
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest {
|
|
131611
|
+
/**
|
|
131612
|
+
* The webhook identifier
|
|
131613
|
+
*/
|
|
131614
|
+
readonly webhookId: string
|
|
131615
|
+
|
|
131616
|
+
/**
|
|
131617
|
+
* The failure identifier
|
|
131618
|
+
*/
|
|
131619
|
+
readonly failureId: string
|
|
131620
|
+
}
|
|
131621
|
+
|
|
131622
|
+
/**
|
|
131623
|
+
* Request parameters for retryOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
131624
|
+
*/
|
|
131625
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest {
|
|
131626
|
+
/**
|
|
131627
|
+
* The webhook identifier
|
|
131628
|
+
*/
|
|
131629
|
+
readonly webhookId: string
|
|
131630
|
+
}
|
|
131631
|
+
|
|
131110
131632
|
/**
|
|
131111
131633
|
* Request parameters for updateOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
131112
131634
|
*/
|
|
@@ -131155,6 +131677,17 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131155
131677
|
return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131156
131678
|
}
|
|
131157
131679
|
|
|
131680
|
+
/**
|
|
131681
|
+
* 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.
|
|
131682
|
+
* @summary Discard a queued webhook delivery failure
|
|
131683
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131684
|
+
* @param {*} [options] Override http request option.
|
|
131685
|
+
* @throws {RequiredError}
|
|
131686
|
+
*/
|
|
131687
|
+
public deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131688
|
+
return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131689
|
+
}
|
|
131690
|
+
|
|
131158
131691
|
/**
|
|
131159
131692
|
* 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.
|
|
131160
131693
|
* @summary Get an organization webhook
|
|
@@ -131166,6 +131699,28 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131166
131699
|
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131167
131700
|
}
|
|
131168
131701
|
|
|
131702
|
+
/**
|
|
131703
|
+
* 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.
|
|
131704
|
+
* @summary Get a queued webhook delivery failure
|
|
131705
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131706
|
+
* @param {*} [options] Override http request option.
|
|
131707
|
+
* @throws {RequiredError}
|
|
131708
|
+
*/
|
|
131709
|
+
public getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131710
|
+
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131711
|
+
}
|
|
131712
|
+
|
|
131713
|
+
/**
|
|
131714
|
+
* 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.
|
|
131715
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131716
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131717
|
+
* @param {*} [options] Override http request option.
|
|
131718
|
+
* @throws {RequiredError}
|
|
131719
|
+
*/
|
|
131720
|
+
public getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig) {
|
|
131721
|
+
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
131722
|
+
}
|
|
131723
|
+
|
|
131169
131724
|
/**
|
|
131170
131725
|
* 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.
|
|
131171
131726
|
* @summary List an organization\'s webhooks
|
|
@@ -131177,6 +131732,28 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131177
131732
|
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
131178
131733
|
}
|
|
131179
131734
|
|
|
131735
|
+
/**
|
|
131736
|
+
* 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.
|
|
131737
|
+
* @summary Retry one queued webhook delivery
|
|
131738
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131739
|
+
* @param {*} [options] Override http request option.
|
|
131740
|
+
* @throws {RequiredError}
|
|
131741
|
+
*/
|
|
131742
|
+
public retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131743
|
+
return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131744
|
+
}
|
|
131745
|
+
|
|
131746
|
+
/**
|
|
131747
|
+
* 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.
|
|
131748
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131749
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131750
|
+
* @param {*} [options] Override http request option.
|
|
131751
|
+
* @throws {RequiredError}
|
|
131752
|
+
*/
|
|
131753
|
+
public retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig) {
|
|
131754
|
+
return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131755
|
+
}
|
|
131756
|
+
|
|
131180
131757
|
/**
|
|
131181
131758
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
131182
131759
|
* @summary Update an organization webhook
|