@connectedxm/admin-sdk 11.14.1 → 11.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +8 -1
- package/README.md +2 -2
- package/api.ts +578 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +320 -6
- package/dist/api.js +425 -22
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +320 -6
- 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/Announcement.md +0 -2
- package/docs/BaseWebhook.md +2 -0
- package/docs/BaseWebhookFailure.md +42 -0
- package/docs/GetOrganizationWebhookFailure200Response.md +24 -0
- package/docs/GetOrganizationWebhookFailures200Response.md +26 -0
- package/docs/OrganizationWebhooksApi.md +281 -0
- package/docs/RetryOrganizationWebhookFailure200Response.md +24 -0
- package/docs/Webhook.md +4 -0
- package/docs/{AnnouncementAllOfCount.md → WebhookAllOfCount.md} +5 -7
- 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.16.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.16.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.16.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.16.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.16.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.16.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.16.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -588,7 +588,6 @@ export interface Announcement {
|
|
|
588
588
|
'userId': string | null;
|
|
589
589
|
'schedule': BaseSchedule;
|
|
590
590
|
'createdAt': string;
|
|
591
|
-
'_count': AnnouncementAllOfCount;
|
|
592
591
|
'verifiedAccounts': boolean;
|
|
593
592
|
'account': BaseAccount | null;
|
|
594
593
|
'creator': BaseAccount | null;
|
|
@@ -604,10 +603,6 @@ export interface Announcement {
|
|
|
604
603
|
'filters': EventAnnouncementFilters | null;
|
|
605
604
|
'updatedAt': string;
|
|
606
605
|
}
|
|
607
|
-
export interface AnnouncementAllOfCount {
|
|
608
|
-
'notifications': number;
|
|
609
|
-
'emailReceipt': number;
|
|
610
|
-
}
|
|
611
606
|
export interface AnnouncementCreateInputs {
|
|
612
607
|
'title': string | null;
|
|
613
608
|
'html'?: string | null;
|
|
@@ -2672,6 +2667,21 @@ export interface BaseWebhook {
|
|
|
2672
2667
|
'url': string;
|
|
2673
2668
|
'name': string;
|
|
2674
2669
|
'verified': boolean;
|
|
2670
|
+
'status': WebhookStatus;
|
|
2671
|
+
}
|
|
2672
|
+
export interface BaseWebhookFailure {
|
|
2673
|
+
'id': string;
|
|
2674
|
+
'webhookId': string;
|
|
2675
|
+
'error': string;
|
|
2676
|
+
'statusCode': number | null;
|
|
2677
|
+
'source': string;
|
|
2678
|
+
'sourceId': string | null;
|
|
2679
|
+
'attempts': number;
|
|
2680
|
+
'retries': number;
|
|
2681
|
+
'lastAttemptAt': string;
|
|
2682
|
+
'lockedAt': string | null;
|
|
2683
|
+
'createdAt': string;
|
|
2684
|
+
'updatedAt': string;
|
|
2675
2685
|
}
|
|
2676
2686
|
export interface Benefit {
|
|
2677
2687
|
'id': string;
|
|
@@ -8780,6 +8790,23 @@ export interface GetOrganizationUsers200Response {
|
|
|
8780
8790
|
export declare enum GetOrganizationUsers200ResponseStatusEnum {
|
|
8781
8791
|
Ok = "ok"
|
|
8782
8792
|
}
|
|
8793
|
+
export interface GetOrganizationWebhookFailure200Response {
|
|
8794
|
+
'status': GetOrganizationWebhookFailure200ResponseStatusEnum;
|
|
8795
|
+
'message': string;
|
|
8796
|
+
'data': WebhookFailure;
|
|
8797
|
+
}
|
|
8798
|
+
export declare enum GetOrganizationWebhookFailure200ResponseStatusEnum {
|
|
8799
|
+
Ok = "ok"
|
|
8800
|
+
}
|
|
8801
|
+
export interface GetOrganizationWebhookFailures200Response {
|
|
8802
|
+
'status': GetOrganizationWebhookFailures200ResponseStatusEnum;
|
|
8803
|
+
'message': string;
|
|
8804
|
+
'data': Array<BaseWebhookFailure>;
|
|
8805
|
+
'count'?: number;
|
|
8806
|
+
}
|
|
8807
|
+
export declare enum GetOrganizationWebhookFailures200ResponseStatusEnum {
|
|
8808
|
+
Ok = "ok"
|
|
8809
|
+
}
|
|
8783
8810
|
export interface GetPayment200Response {
|
|
8784
8811
|
'status': GetPayment200ResponseStatusEnum;
|
|
8785
8812
|
'message': string;
|
|
@@ -11883,6 +11910,14 @@ export interface RequestImageDirectUpload200Response {
|
|
|
11883
11910
|
export declare enum RequestImageDirectUpload200ResponseStatusEnum {
|
|
11884
11911
|
Ok = "ok"
|
|
11885
11912
|
}
|
|
11913
|
+
export interface RetryOrganizationWebhookFailure200Response {
|
|
11914
|
+
'status': RetryOrganizationWebhookFailure200ResponseStatusEnum;
|
|
11915
|
+
'message': string;
|
|
11916
|
+
'data': WebhookFailureRetryResult;
|
|
11917
|
+
}
|
|
11918
|
+
export declare enum RetryOrganizationWebhookFailure200ResponseStatusEnum {
|
|
11919
|
+
Ok = "ok"
|
|
11920
|
+
}
|
|
11886
11921
|
export interface Room {
|
|
11887
11922
|
'id': string;
|
|
11888
11923
|
'roomName': string;
|
|
@@ -13803,14 +13838,46 @@ export interface Webhook {
|
|
|
13803
13838
|
'url': string;
|
|
13804
13839
|
'name': string;
|
|
13805
13840
|
'verified': boolean;
|
|
13841
|
+
'status': WebhookStatus;
|
|
13842
|
+
'_count': WebhookAllOfCount;
|
|
13806
13843
|
'createdAt': string;
|
|
13807
13844
|
'updatedAt': string;
|
|
13808
13845
|
}
|
|
13846
|
+
export interface WebhookAllOfCount {
|
|
13847
|
+
'failures': number;
|
|
13848
|
+
}
|
|
13809
13849
|
export interface WebhookCreateInputs {
|
|
13810
13850
|
'name'?: string | null;
|
|
13811
13851
|
'url': string;
|
|
13812
13852
|
'secret': string;
|
|
13813
13853
|
}
|
|
13854
|
+
export interface WebhookFailure {
|
|
13855
|
+
'id': string;
|
|
13856
|
+
'webhookId': string;
|
|
13857
|
+
'error': string;
|
|
13858
|
+
'statusCode': number | null;
|
|
13859
|
+
'source': string;
|
|
13860
|
+
'sourceId': string | null;
|
|
13861
|
+
'attempts': number;
|
|
13862
|
+
'retries': number;
|
|
13863
|
+
'lastAttemptAt': string;
|
|
13864
|
+
'lockedAt': string | null;
|
|
13865
|
+
'createdAt': string;
|
|
13866
|
+
'updatedAt': string;
|
|
13867
|
+
'payload': {
|
|
13868
|
+
[key: string]: any;
|
|
13869
|
+
};
|
|
13870
|
+
'webhook': BaseWebhook;
|
|
13871
|
+
}
|
|
13872
|
+
export interface WebhookFailureRetryResult {
|
|
13873
|
+
'success': boolean;
|
|
13874
|
+
'failure'?: BaseWebhookFailure;
|
|
13875
|
+
}
|
|
13876
|
+
export declare enum WebhookStatus {
|
|
13877
|
+
Unverified = "unverified",
|
|
13878
|
+
Verified = "verified",
|
|
13879
|
+
Failed = "failed"
|
|
13880
|
+
}
|
|
13814
13881
|
export interface WebhookUpdateInputs {
|
|
13815
13882
|
'name'?: string | null;
|
|
13816
13883
|
}
|
|
@@ -72113,6 +72180,15 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72113
72180
|
* @throws {RequiredError}
|
|
72114
72181
|
*/
|
|
72115
72182
|
deleteOrganizationWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72183
|
+
/**
|
|
72184
|
+
* 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.
|
|
72185
|
+
* @summary Discard a queued webhook delivery failure
|
|
72186
|
+
* @param {string} webhookId The webhook identifier
|
|
72187
|
+
* @param {string} failureId The failure identifier
|
|
72188
|
+
* @param {*} [options] Override http request option.
|
|
72189
|
+
* @throws {RequiredError}
|
|
72190
|
+
*/
|
|
72191
|
+
deleteOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72116
72192
|
/**
|
|
72117
72193
|
* 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.
|
|
72118
72194
|
* @summary Get an organization webhook
|
|
@@ -72121,6 +72197,27 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72121
72197
|
* @throws {RequiredError}
|
|
72122
72198
|
*/
|
|
72123
72199
|
getOrganizationWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72200
|
+
/**
|
|
72201
|
+
* 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.
|
|
72202
|
+
* @summary Get a queued webhook delivery failure
|
|
72203
|
+
* @param {string} webhookId The webhook identifier
|
|
72204
|
+
* @param {string} failureId The failure identifier
|
|
72205
|
+
* @param {*} [options] Override http request option.
|
|
72206
|
+
* @throws {RequiredError}
|
|
72207
|
+
*/
|
|
72208
|
+
getOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72209
|
+
/**
|
|
72210
|
+
* 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.
|
|
72211
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72212
|
+
* @param {string} webhookId The webhook identifier
|
|
72213
|
+
* @param {number} [page] Page number
|
|
72214
|
+
* @param {number} [pageSize] Number of items per page
|
|
72215
|
+
* @param {string} [orderBy] Field to order by
|
|
72216
|
+
* @param {string} [search] Search query
|
|
72217
|
+
* @param {*} [options] Override http request option.
|
|
72218
|
+
* @throws {RequiredError}
|
|
72219
|
+
*/
|
|
72220
|
+
getOrganizationWebhookFailures: (webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72124
72221
|
/**
|
|
72125
72222
|
* 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.
|
|
72126
72223
|
* @summary List an organization\'s webhooks
|
|
@@ -72132,6 +72229,23 @@ export declare const OrganizationWebhooksApiAxiosParamCreator: (configuration?:
|
|
|
72132
72229
|
* @throws {RequiredError}
|
|
72133
72230
|
*/
|
|
72134
72231
|
getOrganizationWebhooks: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72232
|
+
/**
|
|
72233
|
+
* 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.
|
|
72234
|
+
* @summary Retry one queued webhook delivery
|
|
72235
|
+
* @param {string} webhookId The webhook identifier
|
|
72236
|
+
* @param {string} failureId The failure identifier
|
|
72237
|
+
* @param {*} [options] Override http request option.
|
|
72238
|
+
* @throws {RequiredError}
|
|
72239
|
+
*/
|
|
72240
|
+
retryOrganizationWebhookFailure: (webhookId: string, failureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72241
|
+
/**
|
|
72242
|
+
* 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.
|
|
72243
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72244
|
+
* @param {string} webhookId The webhook identifier
|
|
72245
|
+
* @param {*} [options] Override http request option.
|
|
72246
|
+
* @throws {RequiredError}
|
|
72247
|
+
*/
|
|
72248
|
+
retryOrganizationWebhookFailures: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72135
72249
|
/**
|
|
72136
72250
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72137
72251
|
* @summary Update an organization webhook
|
|
@@ -72170,6 +72284,15 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72170
72284
|
* @throws {RequiredError}
|
|
72171
72285
|
*/
|
|
72172
72286
|
deleteOrganizationWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72287
|
+
/**
|
|
72288
|
+
* 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.
|
|
72289
|
+
* @summary Discard a queued webhook delivery failure
|
|
72290
|
+
* @param {string} webhookId The webhook identifier
|
|
72291
|
+
* @param {string} failureId The failure identifier
|
|
72292
|
+
* @param {*} [options] Override http request option.
|
|
72293
|
+
* @throws {RequiredError}
|
|
72294
|
+
*/
|
|
72295
|
+
deleteOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72173
72296
|
/**
|
|
72174
72297
|
* 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.
|
|
72175
72298
|
* @summary Get an organization webhook
|
|
@@ -72178,6 +72301,27 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72178
72301
|
* @throws {RequiredError}
|
|
72179
72302
|
*/
|
|
72180
72303
|
getOrganizationWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddEventPassChangeWebhook200Response>>;
|
|
72304
|
+
/**
|
|
72305
|
+
* 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.
|
|
72306
|
+
* @summary Get a queued webhook delivery failure
|
|
72307
|
+
* @param {string} webhookId The webhook identifier
|
|
72308
|
+
* @param {string} failureId The failure identifier
|
|
72309
|
+
* @param {*} [options] Override http request option.
|
|
72310
|
+
* @throws {RequiredError}
|
|
72311
|
+
*/
|
|
72312
|
+
getOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailure200Response>>;
|
|
72313
|
+
/**
|
|
72314
|
+
* 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.
|
|
72315
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72316
|
+
* @param {string} webhookId The webhook identifier
|
|
72317
|
+
* @param {number} [page] Page number
|
|
72318
|
+
* @param {number} [pageSize] Number of items per page
|
|
72319
|
+
* @param {string} [orderBy] Field to order by
|
|
72320
|
+
* @param {string} [search] Search query
|
|
72321
|
+
* @param {*} [options] Override http request option.
|
|
72322
|
+
* @throws {RequiredError}
|
|
72323
|
+
*/
|
|
72324
|
+
getOrganizationWebhookFailures(webhookId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationWebhookFailures200Response>>;
|
|
72181
72325
|
/**
|
|
72182
72326
|
* 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.
|
|
72183
72327
|
* @summary List an organization\'s webhooks
|
|
@@ -72189,6 +72333,23 @@ export declare const OrganizationWebhooksApiFp: (configuration?: Configuration)
|
|
|
72189
72333
|
* @throws {RequiredError}
|
|
72190
72334
|
*/
|
|
72191
72335
|
getOrganizationWebhooks(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassChangeWebhooks200Response>>;
|
|
72336
|
+
/**
|
|
72337
|
+
* 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.
|
|
72338
|
+
* @summary Retry one queued webhook delivery
|
|
72339
|
+
* @param {string} webhookId The webhook identifier
|
|
72340
|
+
* @param {string} failureId The failure identifier
|
|
72341
|
+
* @param {*} [options] Override http request option.
|
|
72342
|
+
* @throws {RequiredError}
|
|
72343
|
+
*/
|
|
72344
|
+
retryOrganizationWebhookFailure(webhookId: string, failureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetryOrganizationWebhookFailure200Response>>;
|
|
72345
|
+
/**
|
|
72346
|
+
* 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.
|
|
72347
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72348
|
+
* @param {string} webhookId The webhook identifier
|
|
72349
|
+
* @param {*} [options] Override http request option.
|
|
72350
|
+
* @throws {RequiredError}
|
|
72351
|
+
*/
|
|
72352
|
+
retryOrganizationWebhookFailures(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
72192
72353
|
/**
|
|
72193
72354
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72194
72355
|
* @summary Update an organization webhook
|
|
@@ -72227,6 +72388,14 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72227
72388
|
* @throws {RequiredError}
|
|
72228
72389
|
*/
|
|
72229
72390
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72391
|
+
/**
|
|
72392
|
+
* 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.
|
|
72393
|
+
* @summary Discard a queued webhook delivery failure
|
|
72394
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72395
|
+
* @param {*} [options] Override http request option.
|
|
72396
|
+
* @throws {RequiredError}
|
|
72397
|
+
*/
|
|
72398
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72230
72399
|
/**
|
|
72231
72400
|
* 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.
|
|
72232
72401
|
* @summary Get an organization webhook
|
|
@@ -72235,6 +72404,22 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72235
72404
|
* @throws {RequiredError}
|
|
72236
72405
|
*/
|
|
72237
72406
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddEventPassChangeWebhook200Response>;
|
|
72407
|
+
/**
|
|
72408
|
+
* 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.
|
|
72409
|
+
* @summary Get a queued webhook delivery failure
|
|
72410
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72411
|
+
* @param {*} [options] Override http request option.
|
|
72412
|
+
* @throws {RequiredError}
|
|
72413
|
+
*/
|
|
72414
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailure200Response>;
|
|
72415
|
+
/**
|
|
72416
|
+
* 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.
|
|
72417
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72418
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72419
|
+
* @param {*} [options] Override http request option.
|
|
72420
|
+
* @throws {RequiredError}
|
|
72421
|
+
*/
|
|
72422
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationWebhookFailures200Response>;
|
|
72238
72423
|
/**
|
|
72239
72424
|
* 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.
|
|
72240
72425
|
* @summary List an organization\'s webhooks
|
|
@@ -72243,6 +72428,22 @@ export declare const OrganizationWebhooksApiFactory: (configuration?: Configurat
|
|
|
72243
72428
|
* @throws {RequiredError}
|
|
72244
72429
|
*/
|
|
72245
72430
|
getOrganizationWebhooks(requestParameters?: OrganizationWebhooksApiGetOrganizationWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassChangeWebhooks200Response>;
|
|
72431
|
+
/**
|
|
72432
|
+
* 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.
|
|
72433
|
+
* @summary Retry one queued webhook delivery
|
|
72434
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72435
|
+
* @param {*} [options] Override http request option.
|
|
72436
|
+
* @throws {RequiredError}
|
|
72437
|
+
*/
|
|
72438
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryOrganizationWebhookFailure200Response>;
|
|
72439
|
+
/**
|
|
72440
|
+
* 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.
|
|
72441
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72442
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72443
|
+
* @param {*} [options] Override http request option.
|
|
72444
|
+
* @throws {RequiredError}
|
|
72445
|
+
*/
|
|
72446
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
72246
72447
|
/**
|
|
72247
72448
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72248
72449
|
* @summary Update an organization webhook
|
|
@@ -72275,6 +72476,19 @@ export interface OrganizationWebhooksApiDeleteOrganizationWebhookRequest {
|
|
|
72275
72476
|
*/
|
|
72276
72477
|
readonly webhookId: string;
|
|
72277
72478
|
}
|
|
72479
|
+
/**
|
|
72480
|
+
* Request parameters for deleteOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72481
|
+
*/
|
|
72482
|
+
export interface OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest {
|
|
72483
|
+
/**
|
|
72484
|
+
* The webhook identifier
|
|
72485
|
+
*/
|
|
72486
|
+
readonly webhookId: string;
|
|
72487
|
+
/**
|
|
72488
|
+
* The failure identifier
|
|
72489
|
+
*/
|
|
72490
|
+
readonly failureId: string;
|
|
72491
|
+
}
|
|
72278
72492
|
/**
|
|
72279
72493
|
* Request parameters for getOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
72280
72494
|
*/
|
|
@@ -72284,6 +72498,44 @@ export interface OrganizationWebhooksApiGetOrganizationWebhookRequest {
|
|
|
72284
72498
|
*/
|
|
72285
72499
|
readonly webhookId: string;
|
|
72286
72500
|
}
|
|
72501
|
+
/**
|
|
72502
|
+
* Request parameters for getOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72503
|
+
*/
|
|
72504
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailureRequest {
|
|
72505
|
+
/**
|
|
72506
|
+
* The webhook identifier
|
|
72507
|
+
*/
|
|
72508
|
+
readonly webhookId: string;
|
|
72509
|
+
/**
|
|
72510
|
+
* The failure identifier
|
|
72511
|
+
*/
|
|
72512
|
+
readonly failureId: string;
|
|
72513
|
+
}
|
|
72514
|
+
/**
|
|
72515
|
+
* Request parameters for getOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
72516
|
+
*/
|
|
72517
|
+
export interface OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest {
|
|
72518
|
+
/**
|
|
72519
|
+
* The webhook identifier
|
|
72520
|
+
*/
|
|
72521
|
+
readonly webhookId: string;
|
|
72522
|
+
/**
|
|
72523
|
+
* Page number
|
|
72524
|
+
*/
|
|
72525
|
+
readonly page?: number;
|
|
72526
|
+
/**
|
|
72527
|
+
* Number of items per page
|
|
72528
|
+
*/
|
|
72529
|
+
readonly pageSize?: number;
|
|
72530
|
+
/**
|
|
72531
|
+
* Field to order by
|
|
72532
|
+
*/
|
|
72533
|
+
readonly orderBy?: string;
|
|
72534
|
+
/**
|
|
72535
|
+
* Search query
|
|
72536
|
+
*/
|
|
72537
|
+
readonly search?: string;
|
|
72538
|
+
}
|
|
72287
72539
|
/**
|
|
72288
72540
|
* Request parameters for getOrganizationWebhooks operation in OrganizationWebhooksApi.
|
|
72289
72541
|
*/
|
|
@@ -72305,6 +72557,28 @@ export interface OrganizationWebhooksApiGetOrganizationWebhooksRequest {
|
|
|
72305
72557
|
*/
|
|
72306
72558
|
readonly search?: string;
|
|
72307
72559
|
}
|
|
72560
|
+
/**
|
|
72561
|
+
* Request parameters for retryOrganizationWebhookFailure operation in OrganizationWebhooksApi.
|
|
72562
|
+
*/
|
|
72563
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest {
|
|
72564
|
+
/**
|
|
72565
|
+
* The webhook identifier
|
|
72566
|
+
*/
|
|
72567
|
+
readonly webhookId: string;
|
|
72568
|
+
/**
|
|
72569
|
+
* The failure identifier
|
|
72570
|
+
*/
|
|
72571
|
+
readonly failureId: string;
|
|
72572
|
+
}
|
|
72573
|
+
/**
|
|
72574
|
+
* Request parameters for retryOrganizationWebhookFailures operation in OrganizationWebhooksApi.
|
|
72575
|
+
*/
|
|
72576
|
+
export interface OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest {
|
|
72577
|
+
/**
|
|
72578
|
+
* The webhook identifier
|
|
72579
|
+
*/
|
|
72580
|
+
readonly webhookId: string;
|
|
72581
|
+
}
|
|
72308
72582
|
/**
|
|
72309
72583
|
* Request parameters for updateOrganizationWebhook operation in OrganizationWebhooksApi.
|
|
72310
72584
|
*/
|
|
@@ -72344,6 +72618,14 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72344
72618
|
* @throws {RequiredError}
|
|
72345
72619
|
*/
|
|
72346
72620
|
deleteOrganizationWebhook(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72621
|
+
/**
|
|
72622
|
+
* 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.
|
|
72623
|
+
* @summary Discard a queued webhook delivery failure
|
|
72624
|
+
* @param {OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72625
|
+
* @param {*} [options] Override http request option.
|
|
72626
|
+
* @throws {RequiredError}
|
|
72627
|
+
*/
|
|
72628
|
+
deleteOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiDeleteOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72347
72629
|
/**
|
|
72348
72630
|
* 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.
|
|
72349
72631
|
* @summary Get an organization webhook
|
|
@@ -72352,6 +72634,22 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72352
72634
|
* @throws {RequiredError}
|
|
72353
72635
|
*/
|
|
72354
72636
|
getOrganizationWebhook(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddEventPassChangeWebhook200Response, any, {}, any>>;
|
|
72637
|
+
/**
|
|
72638
|
+
* 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.
|
|
72639
|
+
* @summary Get a queued webhook delivery failure
|
|
72640
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72641
|
+
* @param {*} [options] Override http request option.
|
|
72642
|
+
* @throws {RequiredError}
|
|
72643
|
+
*/
|
|
72644
|
+
getOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationWebhookFailure200Response, any, {}, any>>;
|
|
72645
|
+
/**
|
|
72646
|
+
* 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.
|
|
72647
|
+
* @summary List a webhook\'s queued delivery failures
|
|
72648
|
+
* @param {OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72649
|
+
* @param {*} [options] Override http request option.
|
|
72650
|
+
* @throws {RequiredError}
|
|
72651
|
+
*/
|
|
72652
|
+
getOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiGetOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationWebhookFailures200Response, any, {}, any>>;
|
|
72355
72653
|
/**
|
|
72356
72654
|
* 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.
|
|
72357
72655
|
* @summary List an organization\'s webhooks
|
|
@@ -72360,6 +72658,22 @@ export declare class OrganizationWebhooksApi extends BaseAPI {
|
|
|
72360
72658
|
* @throws {RequiredError}
|
|
72361
72659
|
*/
|
|
72362
72660
|
getOrganizationWebhooks(requestParameters?: OrganizationWebhooksApiGetOrganizationWebhooksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassChangeWebhooks200Response, any, {}, any>>;
|
|
72661
|
+
/**
|
|
72662
|
+
* 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.
|
|
72663
|
+
* @summary Retry one queued webhook delivery
|
|
72664
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest} requestParameters Request parameters.
|
|
72665
|
+
* @param {*} [options] Override http request option.
|
|
72666
|
+
* @throws {RequiredError}
|
|
72667
|
+
*/
|
|
72668
|
+
retryOrganizationWebhookFailure(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailureRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetryOrganizationWebhookFailure200Response, any, {}, any>>;
|
|
72669
|
+
/**
|
|
72670
|
+
* 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.
|
|
72671
|
+
* @summary Retry all of a webhook\'s queued deliveries
|
|
72672
|
+
* @param {OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest} requestParameters Request parameters.
|
|
72673
|
+
* @param {*} [options] Override http request option.
|
|
72674
|
+
* @throws {RequiredError}
|
|
72675
|
+
*/
|
|
72676
|
+
retryOrganizationWebhookFailures(requestParameters: OrganizationWebhooksApiRetryOrganizationWebhookFailuresRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
72363
72677
|
/**
|
|
72364
72678
|
* Modifies an existing webhook\'s name, URL, secret, or other settings for the organization, requires organization read and update permissions.
|
|
72365
72679
|
* @summary Update an organization webhook
|