@connectedxm/admin-sdk 11.15.0 → 11.18.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 +586 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +328 -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 +328 -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/BaseEventSponsorshipLevel.md +4 -0
- package/docs/BaseWebhook.md +2 -0
- package/docs/BaseWebhookFailure.md +42 -0
- package/docs/EventSponsorshipLevel.md +4 -0
- package/docs/EventSponsorshipLevelCreateInputs.md +4 -0
- package/docs/EventSponsorshipLevelUpdateInputs.md +4 -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.18.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1769,6 +1769,8 @@ export interface BaseEventSponsorshipLevel {
|
|
|
1769
1769
|
'name': string;
|
|
1770
1770
|
'description': string | null;
|
|
1771
1771
|
'sponsorsPerRow': number;
|
|
1772
|
+
'advertisementAllowance': number;
|
|
1773
|
+
'advertisementWeight': number;
|
|
1772
1774
|
}
|
|
1773
1775
|
export interface BaseEventTrack {
|
|
1774
1776
|
'id': string;
|
|
@@ -2869,6 +2871,23 @@ export interface BaseWebhook {
|
|
|
2869
2871
|
'url': string;
|
|
2870
2872
|
'name': string;
|
|
2871
2873
|
'verified': boolean;
|
|
2874
|
+
'status': WebhookStatus;
|
|
2875
|
+
}
|
|
2876
|
+
|
|
2877
|
+
|
|
2878
|
+
export interface BaseWebhookFailure {
|
|
2879
|
+
'id': string;
|
|
2880
|
+
'webhookId': string;
|
|
2881
|
+
'error': string;
|
|
2882
|
+
'statusCode': number | null;
|
|
2883
|
+
'source': string;
|
|
2884
|
+
'sourceId': string | null;
|
|
2885
|
+
'attempts': number;
|
|
2886
|
+
'retries': number;
|
|
2887
|
+
'lastAttemptAt': string;
|
|
2888
|
+
'lockedAt': string | null;
|
|
2889
|
+
'createdAt': string;
|
|
2890
|
+
'updatedAt': string;
|
|
2872
2891
|
}
|
|
2873
2892
|
export interface Benefit {
|
|
2874
2893
|
'id': string;
|
|
@@ -6842,6 +6861,8 @@ export interface EventSponsorshipLevel {
|
|
|
6842
6861
|
'name': string;
|
|
6843
6862
|
'description': string | null;
|
|
6844
6863
|
'sponsorsPerRow': number;
|
|
6864
|
+
'advertisementAllowance': number;
|
|
6865
|
+
'advertisementWeight': number;
|
|
6845
6866
|
'sortOrder': number;
|
|
6846
6867
|
'sponsors': Array<BaseEventSponsorship>;
|
|
6847
6868
|
'createdAt': string;
|
|
@@ -6853,6 +6874,8 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
6853
6874
|
'sponsorsPerRow'?: number;
|
|
6854
6875
|
'sortOrder'?: number;
|
|
6855
6876
|
'description'?: string | null;
|
|
6877
|
+
'advertisementAllowance'?: number;
|
|
6878
|
+
'advertisementWeight'?: number;
|
|
6856
6879
|
}
|
|
6857
6880
|
export interface EventSponsorshipLevelTranslation {
|
|
6858
6881
|
'id': number;
|
|
@@ -6872,6 +6895,8 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
6872
6895
|
'sponsorsPerRow'?: number;
|
|
6873
6896
|
'sortOrder'?: number;
|
|
6874
6897
|
'description'?: string | null;
|
|
6898
|
+
'advertisementAllowance'?: number;
|
|
6899
|
+
'advertisementWeight'?: number;
|
|
6875
6900
|
}
|
|
6876
6901
|
export interface EventSponsorshipTranslation {
|
|
6877
6902
|
'id': number;
|
|
@@ -9869,6 +9894,27 @@ export enum GetOrganizationUsers200ResponseStatusEnum {
|
|
|
9869
9894
|
Ok = 'ok'
|
|
9870
9895
|
}
|
|
9871
9896
|
|
|
9897
|
+
export interface GetOrganizationWebhookFailure200Response {
|
|
9898
|
+
'status': GetOrganizationWebhookFailure200ResponseStatusEnum;
|
|
9899
|
+
'message': string;
|
|
9900
|
+
'data': WebhookFailure;
|
|
9901
|
+
}
|
|
9902
|
+
|
|
9903
|
+
export enum GetOrganizationWebhookFailure200ResponseStatusEnum {
|
|
9904
|
+
Ok = 'ok'
|
|
9905
|
+
}
|
|
9906
|
+
|
|
9907
|
+
export interface GetOrganizationWebhookFailures200Response {
|
|
9908
|
+
'status': GetOrganizationWebhookFailures200ResponseStatusEnum;
|
|
9909
|
+
'message': string;
|
|
9910
|
+
'data': Array<BaseWebhookFailure>;
|
|
9911
|
+
'count'?: number;
|
|
9912
|
+
}
|
|
9913
|
+
|
|
9914
|
+
export enum GetOrganizationWebhookFailures200ResponseStatusEnum {
|
|
9915
|
+
Ok = 'ok'
|
|
9916
|
+
}
|
|
9917
|
+
|
|
9872
9918
|
export interface GetPayment200Response {
|
|
9873
9919
|
'status': GetPayment200ResponseStatusEnum;
|
|
9874
9920
|
'message': string;
|
|
@@ -13368,6 +13414,16 @@ export enum RequestImageDirectUpload200ResponseStatusEnum {
|
|
|
13368
13414
|
Ok = 'ok'
|
|
13369
13415
|
}
|
|
13370
13416
|
|
|
13417
|
+
export interface RetryOrganizationWebhookFailure200Response {
|
|
13418
|
+
'status': RetryOrganizationWebhookFailure200ResponseStatusEnum;
|
|
13419
|
+
'message': string;
|
|
13420
|
+
'data': WebhookFailureRetryResult;
|
|
13421
|
+
}
|
|
13422
|
+
|
|
13423
|
+
export enum RetryOrganizationWebhookFailure200ResponseStatusEnum {
|
|
13424
|
+
Ok = 'ok'
|
|
13425
|
+
}
|
|
13426
|
+
|
|
13371
13427
|
export interface Room {
|
|
13372
13428
|
'id': string;
|
|
13373
13429
|
'roomName': string;
|
|
@@ -15472,14 +15528,49 @@ export interface Webhook {
|
|
|
15472
15528
|
'url': string;
|
|
15473
15529
|
'name': string;
|
|
15474
15530
|
'verified': boolean;
|
|
15531
|
+
'status': WebhookStatus;
|
|
15532
|
+
'_count': WebhookAllOfCount;
|
|
15475
15533
|
'createdAt': string;
|
|
15476
15534
|
'updatedAt': string;
|
|
15477
15535
|
}
|
|
15536
|
+
|
|
15537
|
+
|
|
15538
|
+
export interface WebhookAllOfCount {
|
|
15539
|
+
'failures': number;
|
|
15540
|
+
}
|
|
15478
15541
|
export interface WebhookCreateInputs {
|
|
15479
15542
|
'name'?: string | null;
|
|
15480
15543
|
'url': string;
|
|
15481
15544
|
'secret': string;
|
|
15482
15545
|
}
|
|
15546
|
+
export interface WebhookFailure {
|
|
15547
|
+
'id': string;
|
|
15548
|
+
'webhookId': string;
|
|
15549
|
+
'error': string;
|
|
15550
|
+
'statusCode': number | null;
|
|
15551
|
+
'source': string;
|
|
15552
|
+
'sourceId': string | null;
|
|
15553
|
+
'attempts': number;
|
|
15554
|
+
'retries': number;
|
|
15555
|
+
'lastAttemptAt': string;
|
|
15556
|
+
'lockedAt': string | null;
|
|
15557
|
+
'createdAt': string;
|
|
15558
|
+
'updatedAt': string;
|
|
15559
|
+
'payload': { [key: string]: any; };
|
|
15560
|
+
'webhook': BaseWebhook;
|
|
15561
|
+
}
|
|
15562
|
+
export interface WebhookFailureRetryResult {
|
|
15563
|
+
'success': boolean;
|
|
15564
|
+
'failure'?: BaseWebhookFailure;
|
|
15565
|
+
}
|
|
15566
|
+
|
|
15567
|
+
export enum WebhookStatus {
|
|
15568
|
+
Unverified = 'unverified',
|
|
15569
|
+
Verified = 'verified',
|
|
15570
|
+
Failed = 'failed'
|
|
15571
|
+
}
|
|
15572
|
+
|
|
15573
|
+
|
|
15483
15574
|
export interface WebhookUpdateInputs {
|
|
15484
15575
|
'name'?: string | null;
|
|
15485
15576
|
}
|
|
@@ -130711,6 +130802,50 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130711
130802
|
options: localVarRequestOptions,
|
|
130712
130803
|
};
|
|
130713
130804
|
},
|
|
130805
|
+
/**
|
|
130806
|
+
* 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.
|
|
130807
|
+
* @summary Discard a queued webhook delivery failure
|
|
130808
|
+
* @param {string} webhookId The webhook identifier
|
|
130809
|
+
* @param {string} failureId The failure identifier
|
|
130810
|
+
* @param {*} [options] Override http request option.
|
|
130811
|
+
* @throws {RequiredError}
|
|
130812
|
+
*/
|
|
130813
|
+
deleteOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130814
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130815
|
+
assertParamExists('deleteOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
130816
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
130817
|
+
assertParamExists('deleteOrganizationWebhookFailure', 'failureId', failureId)
|
|
130818
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
|
|
130819
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
130820
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
130821
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130822
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130823
|
+
let baseOptions;
|
|
130824
|
+
if (configuration) {
|
|
130825
|
+
baseOptions = configuration.baseOptions;
|
|
130826
|
+
}
|
|
130827
|
+
|
|
130828
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
130829
|
+
const localVarHeaderParameter = {} as any;
|
|
130830
|
+
const localVarQueryParameter = {} as any;
|
|
130831
|
+
|
|
130832
|
+
// authentication ApiKeyAuth required
|
|
130833
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130834
|
+
|
|
130835
|
+
// authentication OrganizationId required
|
|
130836
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130837
|
+
|
|
130838
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130839
|
+
|
|
130840
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130841
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130842
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130843
|
+
|
|
130844
|
+
return {
|
|
130845
|
+
url: toPathString(localVarUrlObj),
|
|
130846
|
+
options: localVarRequestOptions,
|
|
130847
|
+
};
|
|
130848
|
+
},
|
|
130714
130849
|
/**
|
|
130715
130850
|
* 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
130851
|
* @summary Get an organization webhook
|
|
@@ -130751,6 +130886,110 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130751
130886
|
options: localVarRequestOptions,
|
|
130752
130887
|
};
|
|
130753
130888
|
},
|
|
130889
|
+
/**
|
|
130890
|
+
* 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.
|
|
130891
|
+
* @summary Get a queued webhook delivery failure
|
|
130892
|
+
* @param {string} webhookId The webhook identifier
|
|
130893
|
+
* @param {string} failureId The failure identifier
|
|
130894
|
+
* @param {*} [options] Override http request option.
|
|
130895
|
+
* @throws {RequiredError}
|
|
130896
|
+
*/
|
|
130897
|
+
getOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130898
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130899
|
+
assertParamExists('getOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
130900
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
130901
|
+
assertParamExists('getOrganizationWebhookFailure', 'failureId', failureId)
|
|
130902
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}`
|
|
130903
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
130904
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
130905
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130906
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130907
|
+
let baseOptions;
|
|
130908
|
+
if (configuration) {
|
|
130909
|
+
baseOptions = configuration.baseOptions;
|
|
130910
|
+
}
|
|
130911
|
+
|
|
130912
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
130913
|
+
const localVarHeaderParameter = {} as any;
|
|
130914
|
+
const localVarQueryParameter = {} as any;
|
|
130915
|
+
|
|
130916
|
+
// authentication ApiKeyAuth required
|
|
130917
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130918
|
+
|
|
130919
|
+
// authentication OrganizationId required
|
|
130920
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130921
|
+
|
|
130922
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130923
|
+
|
|
130924
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130925
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130926
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130927
|
+
|
|
130928
|
+
return {
|
|
130929
|
+
url: toPathString(localVarUrlObj),
|
|
130930
|
+
options: localVarRequestOptions,
|
|
130931
|
+
};
|
|
130932
|
+
},
|
|
130933
|
+
/**
|
|
130934
|
+
* 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.
|
|
130935
|
+
* @summary List a webhook\'s queued delivery failures
|
|
130936
|
+
* @param {string} webhookId The webhook identifier
|
|
130937
|
+
* @param {number} [page] Page number
|
|
130938
|
+
* @param {number} [pageSize] Number of items per page
|
|
130939
|
+
* @param {string} [orderBy] Field to order by
|
|
130940
|
+
* @param {string} [search] Search query
|
|
130941
|
+
* @param {*} [options] Override http request option.
|
|
130942
|
+
* @throws {RequiredError}
|
|
130943
|
+
*/
|
|
130944
|
+
getOrganizationWebhookFailures: async (webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130945
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
130946
|
+
assertParamExists('getOrganizationWebhookFailures', 'webhookId', webhookId)
|
|
130947
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures`
|
|
130948
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
130949
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130950
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130951
|
+
let baseOptions;
|
|
130952
|
+
if (configuration) {
|
|
130953
|
+
baseOptions = configuration.baseOptions;
|
|
130954
|
+
}
|
|
130955
|
+
|
|
130956
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
130957
|
+
const localVarHeaderParameter = {} as any;
|
|
130958
|
+
const localVarQueryParameter = {} as any;
|
|
130959
|
+
|
|
130960
|
+
// authentication ApiKeyAuth required
|
|
130961
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
130962
|
+
|
|
130963
|
+
// authentication OrganizationId required
|
|
130964
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
130965
|
+
|
|
130966
|
+
if (page !== undefined) {
|
|
130967
|
+
localVarQueryParameter['page'] = page;
|
|
130968
|
+
}
|
|
130969
|
+
|
|
130970
|
+
if (pageSize !== undefined) {
|
|
130971
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
130972
|
+
}
|
|
130973
|
+
|
|
130974
|
+
if (orderBy !== undefined) {
|
|
130975
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
130976
|
+
}
|
|
130977
|
+
|
|
130978
|
+
if (search !== undefined) {
|
|
130979
|
+
localVarQueryParameter['search'] = search;
|
|
130980
|
+
}
|
|
130981
|
+
|
|
130982
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130983
|
+
|
|
130984
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130985
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130986
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
130987
|
+
|
|
130988
|
+
return {
|
|
130989
|
+
url: toPathString(localVarUrlObj),
|
|
130990
|
+
options: localVarRequestOptions,
|
|
130991
|
+
};
|
|
130992
|
+
},
|
|
130754
130993
|
/**
|
|
130755
130994
|
* 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
130995
|
* @summary List an organization\'s webhooks
|
|
@@ -130807,6 +131046,90 @@ export const OrganizationWebhooksApiAxiosParamCreator = function (configuration?
|
|
|
130807
131046
|
options: localVarRequestOptions,
|
|
130808
131047
|
};
|
|
130809
131048
|
},
|
|
131049
|
+
/**
|
|
131050
|
+
* 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.
|
|
131051
|
+
* @summary Retry one queued webhook delivery
|
|
131052
|
+
* @param {string} webhookId The webhook identifier
|
|
131053
|
+
* @param {string} failureId The failure identifier
|
|
131054
|
+
* @param {*} [options] Override http request option.
|
|
131055
|
+
* @throws {RequiredError}
|
|
131056
|
+
*/
|
|
131057
|
+
retryOrganizationWebhookFailure: async (webhookId: string, failureId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131058
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
131059
|
+
assertParamExists('retryOrganizationWebhookFailure', 'webhookId', webhookId)
|
|
131060
|
+
// verify required parameter 'failureId' is not null or undefined
|
|
131061
|
+
assertParamExists('retryOrganizationWebhookFailure', 'failureId', failureId)
|
|
131062
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/{failureId}/retry`
|
|
131063
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)))
|
|
131064
|
+
.replace('{failureId}', encodeURIComponent(String(failureId)));
|
|
131065
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131066
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131067
|
+
let baseOptions;
|
|
131068
|
+
if (configuration) {
|
|
131069
|
+
baseOptions = configuration.baseOptions;
|
|
131070
|
+
}
|
|
131071
|
+
|
|
131072
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
131073
|
+
const localVarHeaderParameter = {} as any;
|
|
131074
|
+
const localVarQueryParameter = {} as any;
|
|
131075
|
+
|
|
131076
|
+
// authentication ApiKeyAuth required
|
|
131077
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
131078
|
+
|
|
131079
|
+
// authentication OrganizationId required
|
|
131080
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
131081
|
+
|
|
131082
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
131083
|
+
|
|
131084
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131085
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131086
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131087
|
+
|
|
131088
|
+
return {
|
|
131089
|
+
url: toPathString(localVarUrlObj),
|
|
131090
|
+
options: localVarRequestOptions,
|
|
131091
|
+
};
|
|
131092
|
+
},
|
|
131093
|
+
/**
|
|
131094
|
+
* 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.
|
|
131095
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131096
|
+
* @param {string} webhookId The webhook identifier
|
|
131097
|
+
* @param {*} [options] Override http request option.
|
|
131098
|
+
* @throws {RequiredError}
|
|
131099
|
+
*/
|
|
131100
|
+
retryOrganizationWebhookFailures: async (webhookId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131101
|
+
// verify required parameter 'webhookId' is not null or undefined
|
|
131102
|
+
assertParamExists('retryOrganizationWebhookFailures', 'webhookId', webhookId)
|
|
131103
|
+
const localVarPath = `/organization/webhooks/{webhookId}/failures/retry`
|
|
131104
|
+
.replace('{webhookId}', encodeURIComponent(String(webhookId)));
|
|
131105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131107
|
+
let baseOptions;
|
|
131108
|
+
if (configuration) {
|
|
131109
|
+
baseOptions = configuration.baseOptions;
|
|
131110
|
+
}
|
|
131111
|
+
|
|
131112
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
131113
|
+
const localVarHeaderParameter = {} as any;
|
|
131114
|
+
const localVarQueryParameter = {} as any;
|
|
131115
|
+
|
|
131116
|
+
// authentication ApiKeyAuth required
|
|
131117
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
131118
|
+
|
|
131119
|
+
// authentication OrganizationId required
|
|
131120
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
131121
|
+
|
|
131122
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
131123
|
+
|
|
131124
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131125
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131126
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131127
|
+
|
|
131128
|
+
return {
|
|
131129
|
+
url: toPathString(localVarUrlObj),
|
|
131130
|
+
options: localVarRequestOptions,
|
|
131131
|
+
};
|
|
131132
|
+
},
|
|
130810
131133
|
/**
|
|
130811
131134
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
130812
131135
|
* @summary Update an organization webhook
|
|
@@ -130927,6 +131250,20 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130927
131250
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.deleteOrganizationWebhook']?.[localVarOperationServerIndex]?.url;
|
|
130928
131251
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130929
131252
|
},
|
|
131253
|
+
/**
|
|
131254
|
+
* 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.
|
|
131255
|
+
* @summary Discard a queued webhook delivery failure
|
|
131256
|
+
* @param {string} webhookId The webhook identifier
|
|
131257
|
+
* @param {string} failureId The failure identifier
|
|
131258
|
+
* @param {*} [options] Override http request option.
|
|
131259
|
+
* @throws {RequiredError}
|
|
131260
|
+
*/
|
|
131261
|
+
async deleteOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
131262
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131263
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131264
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.deleteOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131265
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131266
|
+
},
|
|
130930
131267
|
/**
|
|
130931
131268
|
* 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
131269
|
* @summary Get an organization webhook
|
|
@@ -130940,6 +131277,37 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130940
131277
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhook']?.[localVarOperationServerIndex]?.url;
|
|
130941
131278
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130942
131279
|
},
|
|
131280
|
+
/**
|
|
131281
|
+
* 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.
|
|
131282
|
+
* @summary Get a queued webhook delivery failure
|
|
131283
|
+
* @param {string} webhookId The webhook identifier
|
|
131284
|
+
* @param {string} failureId The failure identifier
|
|
131285
|
+
* @param {*} [options] Override http request option.
|
|
131286
|
+
* @throws {RequiredError}
|
|
131287
|
+
*/
|
|
131288
|
+
async getOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailure200Response>> {
|
|
131289
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131290
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131291
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131292
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131293
|
+
},
|
|
131294
|
+
/**
|
|
131295
|
+
* 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.
|
|
131296
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131297
|
+
* @param {string} webhookId The webhook identifier
|
|
131298
|
+
* @param {number} [page] Page number
|
|
131299
|
+
* @param {number} [pageSize] Number of items per page
|
|
131300
|
+
* @param {string} [orderBy] Field to order by
|
|
131301
|
+
* @param {string} [search] Search query
|
|
131302
|
+
* @param {*} [options] Override http request option.
|
|
131303
|
+
* @throws {RequiredError}
|
|
131304
|
+
*/
|
|
131305
|
+
async getOrganizationWebhookFailures(webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailures200Response>> {
|
|
131306
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationWebhookFailures(webhookId, page, pageSize, orderBy, search, options);
|
|
131307
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131308
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhookFailures']?.[localVarOperationServerIndex]?.url;
|
|
131309
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131310
|
+
},
|
|
130943
131311
|
/**
|
|
130944
131312
|
* 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
131313
|
* @summary List an organization\'s webhooks
|
|
@@ -130956,6 +131324,33 @@ export const OrganizationWebhooksApiFp = function(configuration?: Configuration)
|
|
|
130956
131324
|
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.getOrganizationWebhooks']?.[localVarOperationServerIndex]?.url;
|
|
130957
131325
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
130958
131326
|
},
|
|
131327
|
+
/**
|
|
131328
|
+
* 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.
|
|
131329
|
+
* @summary Retry one queued webhook delivery
|
|
131330
|
+
* @param {string} webhookId The webhook identifier
|
|
131331
|
+
* @param {string} failureId The failure identifier
|
|
131332
|
+
* @param {*} [options] Override http request option.
|
|
131333
|
+
* @throws {RequiredError}
|
|
131334
|
+
*/
|
|
131335
|
+
async retryOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetryOrganizationWebhookFailure200Response>> {
|
|
131336
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryOrganizationWebhookFailure(webhookId, failureId, options);
|
|
131337
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131338
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailure']?.[localVarOperationServerIndex]?.url;
|
|
131339
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131340
|
+
},
|
|
131341
|
+
/**
|
|
131342
|
+
* 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.
|
|
131343
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131344
|
+
* @param {string} webhookId The webhook identifier
|
|
131345
|
+
* @param {*} [options] Override http request option.
|
|
131346
|
+
* @throws {RequiredError}
|
|
131347
|
+
*/
|
|
131348
|
+
async retryOrganizationWebhookFailures(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
131349
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryOrganizationWebhookFailures(webhookId, options);
|
|
131350
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131351
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationWebhooksApi.retryOrganizationWebhookFailures']?.[localVarOperationServerIndex]?.url;
|
|
131352
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131353
|
+
},
|
|
130959
131354
|
/**
|
|
130960
131355
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
130961
131356
|
* @summary Update an organization webhook
|
|
@@ -131012,6 +131407,16 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131012
131407
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131013
131408
|
return localVarFp.deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131014
131409
|
},
|
|
131410
|
+
/**
|
|
131411
|
+
* 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.
|
|
131412
|
+
* @summary Discard a queued webhook delivery failure
|
|
131413
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131414
|
+
* @param {*} [options] Override http request option.
|
|
131415
|
+
* @throws {RequiredError}
|
|
131416
|
+
*/
|
|
131417
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131418
|
+
return localVarFp.deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131419
|
+
},
|
|
131015
131420
|
/**
|
|
131016
131421
|
* 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
131422
|
* @summary Get an organization webhook
|
|
@@ -131022,6 +131427,26 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131022
131427
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response> {
|
|
131023
131428
|
return localVarFp.getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131024
131429
|
},
|
|
131430
|
+
/**
|
|
131431
|
+
* 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.
|
|
131432
|
+
* @summary Get a queued webhook delivery failure
|
|
131433
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131434
|
+
* @param {*} [options] Override http request option.
|
|
131435
|
+
* @throws {RequiredError}
|
|
131436
|
+
*/
|
|
131437
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailure200Response> {
|
|
131438
|
+
return localVarFp.getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131439
|
+
},
|
|
131440
|
+
/**
|
|
131441
|
+
* 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.
|
|
131442
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131443
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131444
|
+
* @param {*} [options] Override http request option.
|
|
131445
|
+
* @throws {RequiredError}
|
|
131446
|
+
*/
|
|
131447
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailures200Response> {
|
|
131448
|
+
return localVarFp.getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
131449
|
+
},
|
|
131025
131450
|
/**
|
|
131026
131451
|
* 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
131452
|
* @summary List an organization\'s webhooks
|
|
@@ -131032,6 +131457,26 @@ export const OrganizationWebhooksApiFactory = function (configuration?: Configur
|
|
|
131032
131457
|
getOrganizationWebhooks(requestParameters: OrganizationWebhooksApiGetOrganizationWebhooksRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response> {
|
|
131033
131458
|
return localVarFp.getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
131034
131459
|
},
|
|
131460
|
+
/**
|
|
131461
|
+
* 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.
|
|
131462
|
+
* @summary Retry one queued webhook delivery
|
|
131463
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131464
|
+
* @param {*} [options] Override http request option.
|
|
131465
|
+
* @throws {RequiredError}
|
|
131466
|
+
*/
|
|
131467
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryOrganizationWebhookFailure200Response> {
|
|
131468
|
+
return localVarFp.retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(axios, basePath));
|
|
131469
|
+
},
|
|
131470
|
+
/**
|
|
131471
|
+
* 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.
|
|
131472
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131473
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131474
|
+
* @param {*} [options] Override http request option.
|
|
131475
|
+
* @throws {RequiredError}
|
|
131476
|
+
*/
|
|
131477
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
131478
|
+
return localVarFp.retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
131479
|
+
},
|
|
131035
131480
|
/**
|
|
131036
131481
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
131037
131482
|
* @summary Update an organization webhook
|
|
@@ -131072,6 +131517,21 @@ export interface OrganizationWebhooksApiDeleteOrganizationWebhookRequest {
|
|
|
131072
131517
|
readonly webhookId: string
|
|
131073
131518
|
}
|
|
131074
131519
|
|
|
131520
|
+
/**
|
|
131521
|
+
* Request parameters for deleteOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131522
|
+
*/
|
|
131523
|
+
export interface OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest {
|
|
131524
|
+
/**
|
|
131525
|
+
* The webhook identifier
|
|
131526
|
+
*/
|
|
131527
|
+
readonly webhookId: string
|
|
131528
|
+
|
|
131529
|
+
/**
|
|
131530
|
+
* The failure identifier
|
|
131531
|
+
*/
|
|
131532
|
+
readonly failureId: string
|
|
131533
|
+
}
|
|
131534
|
+
|
|
131075
131535
|
/**
|
|
131076
131536
|
* Request parameters for getOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
131077
131537
|
*/
|
|
@@ -131082,6 +131542,51 @@ export interface OrganizationWebhooksApiGetOrganizationWebhookRequest {
|
|
|
131082
131542
|
readonly webhookId: string
|
|
131083
131543
|
}
|
|
131084
131544
|
|
|
131545
|
+
/**
|
|
131546
|
+
* Request parameters for getOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131547
|
+
*/
|
|
131548
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailureRequest {
|
|
131549
|
+
/**
|
|
131550
|
+
* The webhook identifier
|
|
131551
|
+
*/
|
|
131552
|
+
readonly webhookId: string
|
|
131553
|
+
|
|
131554
|
+
/**
|
|
131555
|
+
* The failure identifier
|
|
131556
|
+
*/
|
|
131557
|
+
readonly failureId: string
|
|
131558
|
+
}
|
|
131559
|
+
|
|
131560
|
+
/**
|
|
131561
|
+
* Request parameters for getOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
131562
|
+
*/
|
|
131563
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest {
|
|
131564
|
+
/**
|
|
131565
|
+
* The webhook identifier
|
|
131566
|
+
*/
|
|
131567
|
+
readonly webhookId: string
|
|
131568
|
+
|
|
131569
|
+
/**
|
|
131570
|
+
* Page number
|
|
131571
|
+
*/
|
|
131572
|
+
readonly page?: number
|
|
131573
|
+
|
|
131574
|
+
/**
|
|
131575
|
+
* Number of items per page
|
|
131576
|
+
*/
|
|
131577
|
+
readonly pageSize?: number
|
|
131578
|
+
|
|
131579
|
+
/**
|
|
131580
|
+
* Field to order by
|
|
131581
|
+
*/
|
|
131582
|
+
readonly orderBy?: string
|
|
131583
|
+
|
|
131584
|
+
/**
|
|
131585
|
+
* Search query
|
|
131586
|
+
*/
|
|
131587
|
+
readonly search?: string
|
|
131588
|
+
}
|
|
131589
|
+
|
|
131085
131590
|
/**
|
|
131086
131591
|
* Request parameters for getOrganizationWebhooks operation in OrganizationWebhooksApi.
|
|
131087
131592
|
*/
|
|
@@ -131107,6 +131612,31 @@ export interface OrganizationWebhooksApiGetOrganizationWebhooksRequest {
|
|
|
131107
131612
|
readonly search?: string
|
|
131108
131613
|
}
|
|
131109
131614
|
|
|
131615
|
+
/**
|
|
131616
|
+
* Request parameters for retryOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
131617
|
+
*/
|
|
131618
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest {
|
|
131619
|
+
/**
|
|
131620
|
+
* The webhook identifier
|
|
131621
|
+
*/
|
|
131622
|
+
readonly webhookId: string
|
|
131623
|
+
|
|
131624
|
+
/**
|
|
131625
|
+
* The failure identifier
|
|
131626
|
+
*/
|
|
131627
|
+
readonly failureId: string
|
|
131628
|
+
}
|
|
131629
|
+
|
|
131630
|
+
/**
|
|
131631
|
+
* Request parameters for retryOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
131632
|
+
*/
|
|
131633
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest {
|
|
131634
|
+
/**
|
|
131635
|
+
* The webhook identifier
|
|
131636
|
+
*/
|
|
131637
|
+
readonly webhookId: string
|
|
131638
|
+
}
|
|
131639
|
+
|
|
131110
131640
|
/**
|
|
131111
131641
|
* Request parameters for updateOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
131112
131642
|
*/
|
|
@@ -131155,6 +131685,17 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131155
131685
|
return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131156
131686
|
}
|
|
131157
131687
|
|
|
131688
|
+
/**
|
|
131689
|
+
* 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.
|
|
131690
|
+
* @summary Discard a queued webhook delivery failure
|
|
131691
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131692
|
+
* @param {*} [options] Override http request option.
|
|
131693
|
+
* @throws {RequiredError}
|
|
131694
|
+
*/
|
|
131695
|
+
public deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131696
|
+
return OrganizationWebhooksApiFp(this.configuration).deleteOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131697
|
+
}
|
|
131698
|
+
|
|
131158
131699
|
/**
|
|
131159
131700
|
* 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
131701
|
* @summary Get an organization webhook
|
|
@@ -131166,6 +131707,28 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131166
131707
|
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhook(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131167
131708
|
}
|
|
131168
131709
|
|
|
131710
|
+
/**
|
|
131711
|
+
* 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.
|
|
131712
|
+
* @summary Get a queued webhook delivery failure
|
|
131713
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131714
|
+
* @param {*} [options] Override http request option.
|
|
131715
|
+
* @throws {RequiredError}
|
|
131716
|
+
*/
|
|
131717
|
+
public getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131718
|
+
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131719
|
+
}
|
|
131720
|
+
|
|
131721
|
+
/**
|
|
131722
|
+
* 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.
|
|
131723
|
+
* @summary List a webhook\'s queued delivery failures
|
|
131724
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131725
|
+
* @param {*} [options] Override http request option.
|
|
131726
|
+
* @throws {RequiredError}
|
|
131727
|
+
*/
|
|
131728
|
+
public getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig) {
|
|
131729
|
+
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhookFailures(requestParameters.webhookId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
131730
|
+
}
|
|
131731
|
+
|
|
131169
131732
|
/**
|
|
131170
131733
|
* 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
131734
|
* @summary List an organization\'s webhooks
|
|
@@ -131177,6 +131740,28 @@ export class OrganizationWebhooksApi extends BaseAPI {
|
|
|
131177
131740
|
return OrganizationWebhooksApiFp(this.configuration).getOrganizationWebhooks(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
131178
131741
|
}
|
|
131179
131742
|
|
|
131743
|
+
/**
|
|
131744
|
+
* 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.
|
|
131745
|
+
* @summary Retry one queued webhook delivery
|
|
131746
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
131747
|
+
* @param {*} [options] Override http request option.
|
|
131748
|
+
* @throws {RequiredError}
|
|
131749
|
+
*/
|
|
131750
|
+
public retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig) {
|
|
131751
|
+
return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailure(requestParameters.webhookId, requestParameters.failureId, options).then((request) => request(this.axios, this.basePath));
|
|
131752
|
+
}
|
|
131753
|
+
|
|
131754
|
+
/**
|
|
131755
|
+
* 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.
|
|
131756
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
131757
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
131758
|
+
* @param {*} [options] Override http request option.
|
|
131759
|
+
* @throws {RequiredError}
|
|
131760
|
+
*/
|
|
131761
|
+
public retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig) {
|
|
131762
|
+
return OrganizationWebhooksApiFp(this.configuration).retryOrganizationWebhookFailures(requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
131763
|
+
}
|
|
131764
|
+
|
|
131180
131765
|
/**
|
|
131181
131766
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
131182
131767
|
* @summary Update an organization webhook
|