@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/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.18.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 11.
|
|
8
|
+
* The version of the OpenAPI document: 11.18.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.18.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 11.
|
|
8
|
+
* The version of the OpenAPI document: 11.18.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.18.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
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).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.18.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1637,6 +1637,8 @@ export interface BaseEventSponsorshipLevel {
|
|
|
1637
1637
|
'name': string;
|
|
1638
1638
|
'description': string | null;
|
|
1639
1639
|
'sponsorsPerRow': number;
|
|
1640
|
+
'advertisementAllowance': number;
|
|
1641
|
+
'advertisementWeight': number;
|
|
1640
1642
|
}
|
|
1641
1643
|
export interface BaseEventTrack {
|
|
1642
1644
|
'id': string;
|
|
@@ -2667,6 +2669,21 @@ export interface BaseWebhook {
|
|
|
2667
2669
|
'url': string;
|
|
2668
2670
|
'name': string;
|
|
2669
2671
|
'verified': boolean;
|
|
2672
|
+
'status': WebhookStatus;
|
|
2673
|
+
}
|
|
2674
|
+
export interface BaseWebhookFailure {
|
|
2675
|
+
'id': string;
|
|
2676
|
+
'webhookId': string;
|
|
2677
|
+
'error': string;
|
|
2678
|
+
'statusCode': number | null;
|
|
2679
|
+
'source': string;
|
|
2680
|
+
'sourceId': string | null;
|
|
2681
|
+
'attempts': number;
|
|
2682
|
+
'retries': number;
|
|
2683
|
+
'lastAttemptAt': string;
|
|
2684
|
+
'lockedAt': string | null;
|
|
2685
|
+
'createdAt': string;
|
|
2686
|
+
'updatedAt': string;
|
|
2670
2687
|
}
|
|
2671
2688
|
export interface Benefit {
|
|
2672
2689
|
'id': string;
|
|
@@ -6282,6 +6299,8 @@ export interface EventSponsorshipLevel {
|
|
|
6282
6299
|
'name': string;
|
|
6283
6300
|
'description': string | null;
|
|
6284
6301
|
'sponsorsPerRow': number;
|
|
6302
|
+
'advertisementAllowance': number;
|
|
6303
|
+
'advertisementWeight': number;
|
|
6285
6304
|
'sortOrder': number;
|
|
6286
6305
|
'sponsors': Array<BaseEventSponsorship>;
|
|
6287
6306
|
'createdAt': string;
|
|
@@ -6293,6 +6312,8 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
6293
6312
|
'sponsorsPerRow'?: number;
|
|
6294
6313
|
'sortOrder'?: number;
|
|
6295
6314
|
'description'?: string | null;
|
|
6315
|
+
'advertisementAllowance'?: number;
|
|
6316
|
+
'advertisementWeight'?: number;
|
|
6296
6317
|
}
|
|
6297
6318
|
export interface EventSponsorshipLevelTranslation {
|
|
6298
6319
|
'id': number;
|
|
@@ -6312,6 +6333,8 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
6312
6333
|
'sponsorsPerRow'?: number;
|
|
6313
6334
|
'sortOrder'?: number;
|
|
6314
6335
|
'description'?: string | null;
|
|
6336
|
+
'advertisementAllowance'?: number;
|
|
6337
|
+
'advertisementWeight'?: number;
|
|
6315
6338
|
}
|
|
6316
6339
|
export interface EventSponsorshipTranslation {
|
|
6317
6340
|
'id': number;
|
|
@@ -8775,6 +8798,23 @@ export interface GetOrganizationUsers200Response {
|
|
|
8775
8798
|
export declare enum GetOrganizationUsers200ResponseStatusEnum {
|
|
8776
8799
|
Ok = "ok"
|
|
8777
8800
|
}
|
|
8801
|
+
export interface GetOrganizationWebhookFailure200Response {
|
|
8802
|
+
'status': GetOrganizationWebhookFailure200ResponseStatusEnum;
|
|
8803
|
+
'message': string;
|
|
8804
|
+
'data': WebhookFailure;
|
|
8805
|
+
}
|
|
8806
|
+
export declare enum GetOrganizationWebhookFailure200ResponseStatusEnum {
|
|
8807
|
+
Ok = "ok"
|
|
8808
|
+
}
|
|
8809
|
+
export interface GetOrganizationWebhookFailures200Response {
|
|
8810
|
+
'status': GetOrganizationWebhookFailures200ResponseStatusEnum;
|
|
8811
|
+
'message': string;
|
|
8812
|
+
'data': Array<BaseWebhookFailure>;
|
|
8813
|
+
'count'?: number;
|
|
8814
|
+
}
|
|
8815
|
+
export declare enum GetOrganizationWebhookFailures200ResponseStatusEnum {
|
|
8816
|
+
Ok = "ok"
|
|
8817
|
+
}
|
|
8778
8818
|
export interface GetPayment200Response {
|
|
8779
8819
|
'status': GetPayment200ResponseStatusEnum;
|
|
8780
8820
|
'message': string;
|
|
@@ -11878,6 +11918,14 @@ export interface RequestImageDirectUpload200Response {
|
|
|
11878
11918
|
export declare enum RequestImageDirectUpload200ResponseStatusEnum {
|
|
11879
11919
|
Ok = "ok"
|
|
11880
11920
|
}
|
|
11921
|
+
export interface RetryOrganizationWebhookFailure200Response {
|
|
11922
|
+
'status': RetryOrganizationWebhookFailure200ResponseStatusEnum;
|
|
11923
|
+
'message': string;
|
|
11924
|
+
'data': WebhookFailureRetryResult;
|
|
11925
|
+
}
|
|
11926
|
+
export declare enum RetryOrganizationWebhookFailure200ResponseStatusEnum {
|
|
11927
|
+
Ok = "ok"
|
|
11928
|
+
}
|
|
11881
11929
|
export interface Room {
|
|
11882
11930
|
'id': string;
|
|
11883
11931
|
'roomName': string;
|
|
@@ -13798,14 +13846,46 @@ export interface Webhook {
|
|
|
13798
13846
|
'url': string;
|
|
13799
13847
|
'name': string;
|
|
13800
13848
|
'verified': boolean;
|
|
13849
|
+
'status': WebhookStatus;
|
|
13850
|
+
'_count': WebhookAllOfCount;
|
|
13801
13851
|
'createdAt': string;
|
|
13802
13852
|
'updatedAt': string;
|
|
13803
13853
|
}
|
|
13854
|
+
export interface WebhookAllOfCount {
|
|
13855
|
+
'failures': number;
|
|
13856
|
+
}
|
|
13804
13857
|
export interface WebhookCreateInputs {
|
|
13805
13858
|
'name'?: string | null;
|
|
13806
13859
|
'url': string;
|
|
13807
13860
|
'secret': string;
|
|
13808
13861
|
}
|
|
13862
|
+
export interface WebhookFailure {
|
|
13863
|
+
'id': string;
|
|
13864
|
+
'webhookId': string;
|
|
13865
|
+
'error': string;
|
|
13866
|
+
'statusCode': number | null;
|
|
13867
|
+
'source': string;
|
|
13868
|
+
'sourceId': string | null;
|
|
13869
|
+
'attempts': number;
|
|
13870
|
+
'retries': number;
|
|
13871
|
+
'lastAttemptAt': string;
|
|
13872
|
+
'lockedAt': string | null;
|
|
13873
|
+
'createdAt': string;
|
|
13874
|
+
'updatedAt': string;
|
|
13875
|
+
'payload': {
|
|
13876
|
+
[key: string]: any;
|
|
13877
|
+
};
|
|
13878
|
+
'webhook': BaseWebhook;
|
|
13879
|
+
}
|
|
13880
|
+
export interface WebhookFailureRetryResult {
|
|
13881
|
+
'success': boolean;
|
|
13882
|
+
'failure'?: BaseWebhookFailure;
|
|
13883
|
+
}
|
|
13884
|
+
export declare enum WebhookStatus {
|
|
13885
|
+
Unverified = "unverified",
|
|
13886
|
+
Verified = "verified",
|
|
13887
|
+
Failed = "failed"
|
|
13888
|
+
}
|
|
13809
13889
|
export interface WebhookUpdateInputs {
|
|
13810
13890
|
'name'?: string | null;
|
|
13811
13891
|
}
|
|
@@ -72108,6 +72188,15 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72108
72188
|
* @throws {RequiredError}
|
|
72109
72189
|
*/
|
|
72110
72190
|
deleteOrganizationWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72191
|
+
/**
|
|
72192
|
+
* 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.
|
|
72193
|
+
* @summary Discard a queued webhook delivery failure
|
|
72194
|
+
* @param {string} webhookId The webhook identifier
|
|
72195
|
+
* @param {string} failureId The failure identifier
|
|
72196
|
+
* @param {*} [options] Override http request option.
|
|
72197
|
+
* @throws {RequiredError}
|
|
72198
|
+
*/
|
|
72199
|
+
deleteOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72111
72200
|
/**
|
|
72112
72201
|
* 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.
|
|
72113
72202
|
* @summary Get an organization webhook
|
|
@@ -72116,6 +72205,27 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72116
72205
|
* @throws {RequiredError}
|
|
72117
72206
|
*/
|
|
72118
72207
|
getOrganizationWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72208
|
+
/**
|
|
72209
|
+
* 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.
|
|
72210
|
+
* @summary Get a queued webhook delivery failure
|
|
72211
|
+
* @param {string} webhookId The webhook identifier
|
|
72212
|
+
* @param {string} failureId The failure identifier
|
|
72213
|
+
* @param {*} [options] Override http request option.
|
|
72214
|
+
* @throws {RequiredError}
|
|
72215
|
+
*/
|
|
72216
|
+
getOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72217
|
+
/**
|
|
72218
|
+
* 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.
|
|
72219
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72220
|
+
* @param {string} webhookId The webhook identifier
|
|
72221
|
+
* @param {number} [page] Page number
|
|
72222
|
+
* @param {number} [pageSize] Number of items per page
|
|
72223
|
+
* @param {string} [orderBy] Field to order by
|
|
72224
|
+
* @param {string} [search] Search query
|
|
72225
|
+
* @param {*} [options] Override http request option.
|
|
72226
|
+
* @throws {RequiredError}
|
|
72227
|
+
*/
|
|
72228
|
+
getOrganizationWebhookFailures: (webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72119
72229
|
/**
|
|
72120
72230
|
* 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.
|
|
72121
72231
|
* @summary List an organization\'s webhooks
|
|
@@ -72127,6 +72237,23 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72127
72237
|
* @throws {RequiredError}
|
|
72128
72238
|
*/
|
|
72129
72239
|
getOrganizationWebhooks: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72240
|
+
/**
|
|
72241
|
+
* 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.
|
|
72242
|
+
* @summary Retry one queued webhook delivery
|
|
72243
|
+
* @param {string} webhookId The webhook identifier
|
|
72244
|
+
* @param {string} failureId The failure identifier
|
|
72245
|
+
* @param {*} [options] Override http request option.
|
|
72246
|
+
* @throws {RequiredError}
|
|
72247
|
+
*/
|
|
72248
|
+
retryOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72249
|
+
/**
|
|
72250
|
+
* 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.
|
|
72251
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72252
|
+
* @param {string} webhookId The webhook identifier
|
|
72253
|
+
* @param {*} [options] Override http request option.
|
|
72254
|
+
* @throws {RequiredError}
|
|
72255
|
+
*/
|
|
72256
|
+
retryOrganizationWebhookFailures: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72130
72257
|
/**
|
|
72131
72258
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72132
72259
|
* @summary Update an organization webhook
|
|
@@ -72165,6 +72292,15 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72165
72292
|
* @throws {RequiredError}
|
|
72166
72293
|
*/
|
|
72167
72294
|
deleteOrganizationWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72295
|
+
/**
|
|
72296
|
+
* 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.
|
|
72297
|
+
* @summary Discard a queued webhook delivery failure
|
|
72298
|
+
* @param {string} webhookId The webhook identifier
|
|
72299
|
+
* @param {string} failureId The failure identifier
|
|
72300
|
+
* @param {*} [options] Override http request option.
|
|
72301
|
+
* @throws {RequiredError}
|
|
72302
|
+
*/
|
|
72303
|
+
deleteOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72168
72304
|
/**
|
|
72169
72305
|
* 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.
|
|
72170
72306
|
* @summary Get an organization webhook
|
|
@@ -72173,6 +72309,27 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72173
72309
|
* @throws {RequiredError}
|
|
72174
72310
|
*/
|
|
72175
72311
|
getOrganizationWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddEventPassChangeWebhook200Response>>;
|
|
72312
|
+
/**
|
|
72313
|
+
* 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.
|
|
72314
|
+
* @summary Get a queued webhook delivery failure
|
|
72315
|
+
* @param {string} webhookId The webhook identifier
|
|
72316
|
+
* @param {string} failureId The failure identifier
|
|
72317
|
+
* @param {*} [options] Override http request option.
|
|
72318
|
+
* @throws {RequiredError}
|
|
72319
|
+
*/
|
|
72320
|
+
getOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailure200Response>>;
|
|
72321
|
+
/**
|
|
72322
|
+
* 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.
|
|
72323
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72324
|
+
* @param {string} webhookId The webhook identifier
|
|
72325
|
+
* @param {number} [page] Page number
|
|
72326
|
+
* @param {number} [pageSize] Number of items per page
|
|
72327
|
+
* @param {string} [orderBy] Field to order by
|
|
72328
|
+
* @param {string} [search] Search query
|
|
72329
|
+
* @param {*} [options] Override http request option.
|
|
72330
|
+
* @throws {RequiredError}
|
|
72331
|
+
*/
|
|
72332
|
+
getOrganizationWebhookFailures(webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailures200Response>>;
|
|
72176
72333
|
/**
|
|
72177
72334
|
* 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.
|
|
72178
72335
|
* @summary List an organization\'s webhooks
|
|
@@ -72184,6 +72341,23 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72184
72341
|
* @throws {RequiredError}
|
|
72185
72342
|
*/
|
|
72186
72343
|
getOrganizationWebhooks(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassChangeWebhooks200Response>>;
|
|
72344
|
+
/**
|
|
72345
|
+
* 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.
|
|
72346
|
+
* @summary Retry one queued webhook delivery
|
|
72347
|
+
* @param {string} webhookId The webhook identifier
|
|
72348
|
+
* @param {string} failureId The failure identifier
|
|
72349
|
+
* @param {*} [options] Override http request option.
|
|
72350
|
+
* @throws {RequiredError}
|
|
72351
|
+
*/
|
|
72352
|
+
retryOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetryOrganizationWebhookFailure200Response>>;
|
|
72353
|
+
/**
|
|
72354
|
+
* 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.
|
|
72355
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72356
|
+
* @param {string} webhookId The webhook identifier
|
|
72357
|
+
* @param {*} [options] Override http request option.
|
|
72358
|
+
* @throws {RequiredError}
|
|
72359
|
+
*/
|
|
72360
|
+
retryOrganizationWebhookFailures(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72187
72361
|
/**
|
|
72188
72362
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72189
72363
|
* @summary Update an organization webhook
|
|
@@ -72222,6 +72396,14 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72222
72396
|
* @throws {RequiredError}
|
|
72223
72397
|
*/
|
|
72224
72398
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72399
|
+
/**
|
|
72400
|
+
* 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.
|
|
72401
|
+
* @summary Discard a queued webhook delivery failure
|
|
72402
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72403
|
+
* @param {*} [options] Override http request option.
|
|
72404
|
+
* @throws {RequiredError}
|
|
72405
|
+
*/
|
|
72406
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72225
72407
|
/**
|
|
72226
72408
|
* 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.
|
|
72227
72409
|
* @summary Get an organization webhook
|
|
@@ -72230,6 +72412,22 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72230
72412
|
* @throws {RequiredError}
|
|
72231
72413
|
*/
|
|
72232
72414
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response>;
|
|
72415
|
+
/**
|
|
72416
|
+
* 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.
|
|
72417
|
+
* @summary Get a queued webhook delivery failure
|
|
72418
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72419
|
+
* @param {*} [options] Override http request option.
|
|
72420
|
+
* @throws {RequiredError}
|
|
72421
|
+
*/
|
|
72422
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailure200Response>;
|
|
72423
|
+
/**
|
|
72424
|
+
* 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.
|
|
72425
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72426
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72427
|
+
* @param {*} [options] Override http request option.
|
|
72428
|
+
* @throws {RequiredError}
|
|
72429
|
+
*/
|
|
72430
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailures200Response>;
|
|
72233
72431
|
/**
|
|
72234
72432
|
* 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.
|
|
72235
72433
|
* @summary List an organization\'s webhooks
|
|
@@ -72238,6 +72436,22 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72238
72436
|
* @throws {RequiredError}
|
|
72239
72437
|
*/
|
|
72240
72438
|
getOrganizationWebhooks(requestParameters?: OrganizationWebhooksApiGetOrganizationWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response>;
|
|
72439
|
+
/**
|
|
72440
|
+
* 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.
|
|
72441
|
+
* @summary Retry one queued webhook delivery
|
|
72442
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72443
|
+
* @param {*} [options] Override http request option.
|
|
72444
|
+
* @throws {RequiredError}
|
|
72445
|
+
*/
|
|
72446
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryOrganizationWebhookFailure200Response>;
|
|
72447
|
+
/**
|
|
72448
|
+
* 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.
|
|
72449
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72450
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72451
|
+
* @param {*} [options] Override http request option.
|
|
72452
|
+
* @throws {RequiredError}
|
|
72453
|
+
*/
|
|
72454
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72241
72455
|
/**
|
|
72242
72456
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72243
72457
|
* @summary Update an organization webhook
|
|
@@ -72270,6 +72484,19 @@ export interface OrganizationWebhooksApiDeleteOrganizationWebhookRequest {
|
|
|
72270
72484
|
*/
|
|
72271
72485
|
readonly webhookId: string;
|
|
72272
72486
|
}
|
|
72487
|
+
/**
|
|
72488
|
+
* Request parameters for deleteOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72489
|
+
*/
|
|
72490
|
+
export interface OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest {
|
|
72491
|
+
/**
|
|
72492
|
+
* The webhook identifier
|
|
72493
|
+
*/
|
|
72494
|
+
readonly webhookId: string;
|
|
72495
|
+
/**
|
|
72496
|
+
* The failure identifier
|
|
72497
|
+
*/
|
|
72498
|
+
readonly failureId: string;
|
|
72499
|
+
}
|
|
72273
72500
|
/**
|
|
72274
72501
|
* Request parameters for getOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
72275
72502
|
*/
|
|
@@ -72279,6 +72506,44 @@ export interface OrganizationWebhooksApiGetOrganizationWebhookRequest {
|
|
|
72279
72506
|
*/
|
|
72280
72507
|
readonly webhookId: string;
|
|
72281
72508
|
}
|
|
72509
|
+
/**
|
|
72510
|
+
* Request parameters for getOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72511
|
+
*/
|
|
72512
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailureRequest {
|
|
72513
|
+
/**
|
|
72514
|
+
* The webhook identifier
|
|
72515
|
+
*/
|
|
72516
|
+
readonly webhookId: string;
|
|
72517
|
+
/**
|
|
72518
|
+
* The failure identifier
|
|
72519
|
+
*/
|
|
72520
|
+
readonly failureId: string;
|
|
72521
|
+
}
|
|
72522
|
+
/**
|
|
72523
|
+
* Request parameters for getOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
72524
|
+
*/
|
|
72525
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest {
|
|
72526
|
+
/**
|
|
72527
|
+
* The webhook identifier
|
|
72528
|
+
*/
|
|
72529
|
+
readonly webhookId: string;
|
|
72530
|
+
/**
|
|
72531
|
+
* Page number
|
|
72532
|
+
*/
|
|
72533
|
+
readonly page?: number;
|
|
72534
|
+
/**
|
|
72535
|
+
* Number of items per page
|
|
72536
|
+
*/
|
|
72537
|
+
readonly pageSize?: number;
|
|
72538
|
+
/**
|
|
72539
|
+
* Field to order by
|
|
72540
|
+
*/
|
|
72541
|
+
readonly orderBy?: string;
|
|
72542
|
+
/**
|
|
72543
|
+
* Search query
|
|
72544
|
+
*/
|
|
72545
|
+
readonly search?: string;
|
|
72546
|
+
}
|
|
72282
72547
|
/**
|
|
72283
72548
|
* Request parameters for getOrganizationWebhooks operation in OrganizationWebhooksApi.
|
|
72284
72549
|
*/
|
|
@@ -72300,6 +72565,28 @@ export interface OrganizationWebhooksApiGetOrganizationWebhooksRequest {
|
|
|
72300
72565
|
*/
|
|
72301
72566
|
readonly search?: string;
|
|
72302
72567
|
}
|
|
72568
|
+
/**
|
|
72569
|
+
* Request parameters for retryOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72570
|
+
*/
|
|
72571
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest {
|
|
72572
|
+
/**
|
|
72573
|
+
* The webhook identifier
|
|
72574
|
+
*/
|
|
72575
|
+
readonly webhookId: string;
|
|
72576
|
+
/**
|
|
72577
|
+
* The failure identifier
|
|
72578
|
+
*/
|
|
72579
|
+
readonly failureId: string;
|
|
72580
|
+
}
|
|
72581
|
+
/**
|
|
72582
|
+
* Request parameters for retryOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
72583
|
+
*/
|
|
72584
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest {
|
|
72585
|
+
/**
|
|
72586
|
+
* The webhook identifier
|
|
72587
|
+
*/
|
|
72588
|
+
readonly webhookId: string;
|
|
72589
|
+
}
|
|
72303
72590
|
/**
|
|
72304
72591
|
* Request parameters for updateOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
72305
72592
|
*/
|
|
@@ -72339,6 +72626,14 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72339
72626
|
* @throws {RequiredError}
|
|
72340
72627
|
*/
|
|
72341
72628
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72629
|
+
/**
|
|
72630
|
+
* 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.
|
|
72631
|
+
* @summary Discard a queued webhook delivery failure
|
|
72632
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72633
|
+
* @param {*} [options] Override http request option.
|
|
72634
|
+
* @throws {RequiredError}
|
|
72635
|
+
*/
|
|
72636
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72342
72637
|
/**
|
|
72343
72638
|
* 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.
|
|
72344
72639
|
* @summary Get an organization webhook
|
|
@@ -72347,6 +72642,22 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72347
72642
|
* @throws {RequiredError}
|
|
72348
72643
|
*/
|
|
72349
72644
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddEventPassChangeWebhook200Response, any, {}, any>>;
|
|
72645
|
+
/**
|
|
72646
|
+
* 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.
|
|
72647
|
+
* @summary Get a queued webhook delivery failure
|
|
72648
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72649
|
+
* @param {*} [options] Override http request option.
|
|
72650
|
+
* @throws {RequiredError}
|
|
72651
|
+
*/
|
|
72652
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationWebhookFailure200Response, any, {}, any>>;
|
|
72653
|
+
/**
|
|
72654
|
+
* 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.
|
|
72655
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72656
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72657
|
+
* @param {*} [options] Override http request option.
|
|
72658
|
+
* @throws {RequiredError}
|
|
72659
|
+
*/
|
|
72660
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationWebhookFailures200Response, any, {}, any>>;
|
|
72350
72661
|
/**
|
|
72351
72662
|
* 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.
|
|
72352
72663
|
* @summary List an organization\'s webhooks
|
|
@@ -72355,6 +72666,22 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72355
72666
|
* @throws {RequiredError}
|
|
72356
72667
|
*/
|
|
72357
72668
|
getOrganizationWebhooks(requestParameters?: OrganizationWebhooksApiGetOrganizationWebhooksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassChangeWebhooks200Response, any, {}, any>>;
|
|
72669
|
+
/**
|
|
72670
|
+
* 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.
|
|
72671
|
+
* @summary Retry one queued webhook delivery
|
|
72672
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72673
|
+
* @param {*} [options] Override http request option.
|
|
72674
|
+
* @throws {RequiredError}
|
|
72675
|
+
*/
|
|
72676
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetryOrganizationWebhookFailure200Response, any, {}, any>>;
|
|
72677
|
+
/**
|
|
72678
|
+
* 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.
|
|
72679
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72680
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72681
|
+
* @param {*} [options] Override http request option.
|
|
72682
|
+
* @throws {RequiredError}
|
|
72683
|
+
*/
|
|
72684
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72358
72685
|
/**
|
|
72359
72686
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72360
72687
|
* @summary Update an organization webhook
|