extend-ai 1.2.0 → 1.4.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/BaseClient.js +2 -2
- package/Client.d.ts +72 -8
- package/Client.js +80 -12
- package/api/client/requests/ClassifyRequest.d.ts +16 -1
- package/api/client/requests/EditRequest.d.ts +7 -1
- package/api/client/requests/ExtractRequest.d.ts +20 -1
- package/api/client/requests/ParseRequest.d.ts +2 -1
- package/api/client/requests/SplitRequest.d.ts +18 -1
- package/api/resources/batchProcessorRun/client/Client.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/Client.d.ts +2 -1
- package/api/resources/classifierVersions/client/Client.js +2 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +2 -1
- package/api/resources/classifiers/client/Client.d.ts +19 -2
- package/api/resources/classifiers/client/Client.js +19 -2
- package/api/resources/classifiers/client/requests/ClassifiersCreateRequest.d.ts +16 -1
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +3 -1
- package/api/resources/classifyRuns/client/Client.d.ts +4 -1
- package/api/resources/classifyRuns/client/Client.js +4 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCreateRequest.d.ts +4 -1
- package/api/resources/editRuns/client/Client.d.ts +7 -1
- package/api/resources/editRuns/client/Client.js +7 -1
- package/api/resources/editRuns/client/requests/EditRunsCreateRequest.d.ts +7 -1
- package/api/resources/evaluationSetItems/client/Client.d.ts +16 -4
- package/api/resources/evaluationSetItems/client/Client.js +16 -4
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +8 -2
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +7 -1
- package/api/resources/evaluationSets/client/Client.d.ts +4 -3
- package/api/resources/evaluationSets/client/Client.js +4 -3
- package/api/resources/evaluationSets/client/requests/EvaluationSetsCreateRequest.d.ts +3 -2
- package/api/resources/extractRuns/client/Client.d.ts +4 -1
- package/api/resources/extractRuns/client/Client.js +4 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +4 -1
- package/api/resources/extractorVersions/client/Client.d.ts +2 -1
- package/api/resources/extractorVersions/client/Client.js +2 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +2 -1
- package/api/resources/extractors/client/Client.d.ts +23 -2
- package/api/resources/extractors/client/Client.js +23 -2
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +20 -1
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +3 -1
- package/api/resources/files/client/Client.d.ts +1 -1
- package/api/resources/files/client/Client.js +1 -1
- package/api/resources/index.d.ts +6 -0
- package/api/resources/index.js +7 -1
- package/api/resources/parseRuns/client/Client.d.ts +2 -1
- package/api/resources/parseRuns/client/Client.js +2 -1
- package/api/resources/parseRuns/client/requests/ParseRunsCreateRequest.d.ts +2 -1
- package/api/resources/processorRun/client/Client.d.ts +3 -3
- package/api/resources/processorRun/client/Client.js +3 -3
- package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/Client.d.ts +4 -1
- package/api/resources/splitRuns/client/Client.js +4 -1
- package/api/resources/splitRuns/client/requests/SplitRunsCreateRequest.d.ts +4 -1
- package/api/resources/splitterVersions/client/Client.d.ts +2 -1
- package/api/resources/splitterVersions/client/Client.js +2 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +2 -1
- package/api/resources/splitters/client/Client.d.ts +21 -2
- package/api/resources/splitters/client/Client.js +21 -2
- package/api/resources/splitters/client/requests/SplittersCreateRequest.d.ts +18 -1
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +3 -1
- package/api/resources/webhookEndpoints/client/Client.d.ts +133 -0
- package/api/resources/webhookEndpoints/client/Client.js +440 -0
- package/api/resources/webhookEndpoints/client/index.d.ts +1 -0
- package/api/resources/webhookEndpoints/client/index.js +17 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.d.ts +21 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +14 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +15 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.d.ts +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.js +2 -0
- package/api/resources/webhookEndpoints/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/index.js +18 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.d.ts +6 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/types/index.js +18 -0
- package/api/resources/webhookSubscriptions/client/Client.d.ts +133 -0
- package/api/resources/webhookSubscriptions/client/Client.js +444 -0
- package/api/resources/webhookSubscriptions/client/index.d.ts +1 -0
- package/api/resources/webhookSubscriptions/client/index.js +17 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.d.ts +19 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +16 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +11 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.d.ts +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.js +2 -0
- package/api/resources/webhookSubscriptions/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/index.js +18 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.d.ts +6 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/types/index.js +18 -0
- package/api/resources/workflowRuns/client/Client.d.ts +22 -6
- package/api/resources/workflowRuns/client/Client.js +22 -6
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +12 -2
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +3 -3
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +7 -1
- package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
- package/api/types/EditConfigAdvancedOptions.d.ts +4 -0
- package/api/types/EditJson.d.ts +2 -0
- package/api/types/ExtractAdvancedOptions.d.ts +1 -1
- package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/ExtractConfigJson.d.ts +1 -1
- package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
- package/api/types/ExtractOverrideConfigJson.d.ts +1 -1
- package/api/types/ExtractRun.d.ts +10 -2
- package/api/types/ExtractorVersion.d.ts +6 -1
- package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
- package/api/types/LegacyClassificationConfig.d.ts +2 -2
- package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
- package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/LegacyExtractionConfig.d.ts +3 -3
- package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
- package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
- package/api/types/LegacySplitterAdvancedOptions.d.ts +6 -2
- package/api/types/LegacySplitterAdvancedOptionsSplitMethod.d.ts +5 -1
- package/api/types/LegacySplitterAdvancedOptionsSplitMethod.js +5 -1
- package/api/types/LegacySplitterConfig.d.ts +2 -2
- package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
- package/api/types/ParseConfig.d.ts +1 -1
- package/api/types/ParseConfigTarget.d.ts +1 -1
- package/api/types/ParseConfigTarget.js +1 -1
- package/api/types/SplitAdvancedOptions.d.ts +10 -2
- package/api/types/SplitAdvancedOptionsSplitMethod.d.ts +5 -1
- package/api/types/SplitAdvancedOptionsSplitMethod.js +5 -1
- package/api/types/SplitClassification.d.ts +19 -0
- package/api/types/SplitClassification.js +3 -0
- package/api/types/SplitClassifications.d.ts +5 -0
- package/api/types/SplitClassifications.js +3 -0
- package/api/types/SplitConfig.d.ts +1 -1
- package/api/types/SplitOverrideConfig.d.ts +1 -1
- package/api/types/WebhookAdvancedOptions.d.ts +9 -0
- package/api/types/WebhookAdvancedOptions.js +3 -0
- package/api/types/WebhookEndpoint.d.ts +18 -0
- package/api/types/WebhookEndpoint.js +3 -0
- package/api/types/WebhookEndpointCreate.d.ts +27 -0
- package/api/types/WebhookEndpointCreate.js +3 -0
- package/api/types/WebhookEndpointEventType.d.ts +32 -0
- package/api/types/WebhookEndpointEventType.js +35 -0
- package/api/types/WebhookEndpointStatus.d.ts +6 -0
- package/api/types/WebhookEndpointStatus.js +9 -0
- package/api/types/WebhookPayloadFormat.d.ts +11 -0
- package/api/types/WebhookPayloadFormat.js +14 -0
- package/api/types/WebhookPayloadOptions.d.ts +9 -0
- package/api/types/WebhookPayloadOptions.js +3 -0
- package/api/types/WebhookSubscription.d.ts +15 -0
- package/api/types/WebhookSubscription.js +3 -0
- package/api/types/WebhookSubscriptionEventType.d.ts +23 -0
- package/api/types/WebhookSubscriptionEventType.js +26 -0
- package/api/types/WebhookSubscriptionResourceType.d.ts +8 -0
- package/api/types/WebhookSubscriptionResourceType.js +11 -0
- package/api/types/index.d.ts +12 -0
- package/api/types/index.js +12 -0
- package/package.json +1 -1
- package/reference.md +901 -40
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -51,7 +51,24 @@ export declare class SplittersClient {
|
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
53
|
* await client.splitters.create({
|
|
54
|
-
* name: "
|
|
54
|
+
* name: "Document Splitter",
|
|
55
|
+
* config: {
|
|
56
|
+
* splitClassifications: [{
|
|
57
|
+
* id: "invoice",
|
|
58
|
+
* type: "invoice",
|
|
59
|
+
* description: "An invoice or bill for goods or services",
|
|
60
|
+
* identifierKey: "invoice number from the document header"
|
|
61
|
+
* }, {
|
|
62
|
+
* id: "receipt",
|
|
63
|
+
* type: "receipt",
|
|
64
|
+
* description: "A receipt confirming payment",
|
|
65
|
+
* identifierKey: "receipt number"
|
|
66
|
+
* }, {
|
|
67
|
+
* id: "other",
|
|
68
|
+
* type: "other",
|
|
69
|
+
* description: "Any other document type"
|
|
70
|
+
* }]
|
|
71
|
+
* }
|
|
55
72
|
* })
|
|
56
73
|
*/
|
|
57
74
|
create(request: Extend.SplittersCreateRequest, requestOptions?: SplittersClient.RequestOptions): core.HttpResponsePromise<Extend.Splitter>;
|
|
@@ -97,7 +114,9 @@ export declare class SplittersClient {
|
|
|
97
114
|
* @throws {@link Extend.InternalServerError}
|
|
98
115
|
*
|
|
99
116
|
* @example
|
|
100
|
-
* await client.splitters.update("splitter_id_here"
|
|
117
|
+
* await client.splitters.update("splitter_id_here", {
|
|
118
|
+
* name: "Document Splitter v2"
|
|
119
|
+
* })
|
|
101
120
|
*/
|
|
102
121
|
update(id: string, request?: Extend.SplittersUpdateRequest, requestOptions?: SplittersClient.RequestOptions): core.HttpResponsePromise<Extend.Splitter>;
|
|
103
122
|
private __update;
|
|
@@ -152,7 +152,24 @@ class SplittersClient {
|
|
|
152
152
|
*
|
|
153
153
|
* @example
|
|
154
154
|
* await client.splitters.create({
|
|
155
|
-
* name: "
|
|
155
|
+
* name: "Document Splitter",
|
|
156
|
+
* config: {
|
|
157
|
+
* splitClassifications: [{
|
|
158
|
+
* id: "invoice",
|
|
159
|
+
* type: "invoice",
|
|
160
|
+
* description: "An invoice or bill for goods or services",
|
|
161
|
+
* identifierKey: "invoice number from the document header"
|
|
162
|
+
* }, {
|
|
163
|
+
* id: "receipt",
|
|
164
|
+
* type: "receipt",
|
|
165
|
+
* description: "A receipt confirming payment",
|
|
166
|
+
* identifierKey: "receipt number"
|
|
167
|
+
* }, {
|
|
168
|
+
* id: "other",
|
|
169
|
+
* type: "other",
|
|
170
|
+
* description: "Any other document type"
|
|
171
|
+
* }]
|
|
172
|
+
* }
|
|
156
173
|
* })
|
|
157
174
|
*/
|
|
158
175
|
create(request, requestOptions) {
|
|
@@ -299,7 +316,9 @@ class SplittersClient {
|
|
|
299
316
|
* @throws {@link Extend.InternalServerError}
|
|
300
317
|
*
|
|
301
318
|
* @example
|
|
302
|
-
* await client.splitters.update("splitter_id_here"
|
|
319
|
+
* await client.splitters.update("splitter_id_here", {
|
|
320
|
+
* name: "Document Splitter v2"
|
|
321
|
+
* })
|
|
303
322
|
*/
|
|
304
323
|
update(id, request = {}, requestOptions) {
|
|
305
324
|
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
|
|
@@ -2,7 +2,24 @@ import type * as Extend from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* name: "
|
|
5
|
+
* name: "Document Splitter",
|
|
6
|
+
* config: {
|
|
7
|
+
* splitClassifications: [{
|
|
8
|
+
* id: "invoice",
|
|
9
|
+
* type: "invoice",
|
|
10
|
+
* description: "An invoice or bill for goods or services",
|
|
11
|
+
* identifierKey: "invoice number from the document header"
|
|
12
|
+
* }, {
|
|
13
|
+
* id: "receipt",
|
|
14
|
+
* type: "receipt",
|
|
15
|
+
* description: "A receipt confirming payment",
|
|
16
|
+
* identifierKey: "receipt number"
|
|
17
|
+
* }, {
|
|
18
|
+
* id: "other",
|
|
19
|
+
* type: "other",
|
|
20
|
+
* description: "Any other document type"
|
|
21
|
+
* }]
|
|
22
|
+
* }
|
|
6
23
|
* }
|
|
7
24
|
*/
|
|
8
25
|
export interface SplittersCreateRequest {
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
import * as Extend from "../../../index";
|
|
5
|
+
export declare namespace WebhookEndpointsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class WebhookEndpointsClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<WebhookEndpointsClient.Options>;
|
|
12
|
+
constructor(options: WebhookEndpointsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* List all webhook endpoints.
|
|
15
|
+
*
|
|
16
|
+
* @param {Extend.WebhookEndpointsListRequest} request
|
|
17
|
+
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
|
+
*
|
|
19
|
+
* @throws {@link Extend.BadRequestError}
|
|
20
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
21
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
22
|
+
* @throws {@link Extend.ForbiddenError}
|
|
23
|
+
* @throws {@link Extend.NotFoundError}
|
|
24
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
25
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
26
|
+
* @throws {@link Extend.InternalServerError}
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* await client.webhookEndpoints.list({
|
|
30
|
+
* nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
31
|
+
* })
|
|
32
|
+
*/
|
|
33
|
+
list(request?: Extend.WebhookEndpointsListRequest, requestOptions?: WebhookEndpointsClient.RequestOptions): core.HttpResponsePromise<Extend.WebhookEndpointsListResponse>;
|
|
34
|
+
private __list;
|
|
35
|
+
/**
|
|
36
|
+
* Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
37
|
+
*
|
|
38
|
+
* The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/developers/api-reference/webhook-events) reference to see available event types.
|
|
39
|
+
*
|
|
40
|
+
* To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/webhook/create-webhook-subscription) after creating the endpoint.
|
|
41
|
+
*
|
|
42
|
+
* @param {Extend.WebhookEndpointsCreateRequest} request
|
|
43
|
+
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link Extend.BadRequestError}
|
|
46
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
47
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
48
|
+
* @throws {@link Extend.ForbiddenError}
|
|
49
|
+
* @throws {@link Extend.NotFoundError}
|
|
50
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
51
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
52
|
+
* @throws {@link Extend.InternalServerError}
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* await client.webhookEndpoints.create({
|
|
56
|
+
* url: "https://example.com/webhooks",
|
|
57
|
+
* name: "Production webhook",
|
|
58
|
+
* enabledEvents: ["extract_run.processed", "workflow.created"],
|
|
59
|
+
* apiVersion: "2026-02-09"
|
|
60
|
+
* })
|
|
61
|
+
*/
|
|
62
|
+
create(request: Extend.WebhookEndpointsCreateRequest, requestOptions?: WebhookEndpointsClient.RequestOptions): core.HttpResponsePromise<Extend.WebhookEndpointCreate>;
|
|
63
|
+
private __create;
|
|
64
|
+
/**
|
|
65
|
+
* Retrieve a webhook endpoint by ID.
|
|
66
|
+
*
|
|
67
|
+
* @param {string} id - The ID of the webhook endpoint.
|
|
68
|
+
*
|
|
69
|
+
* Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
70
|
+
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link Extend.BadRequestError}
|
|
73
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
74
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
75
|
+
* @throws {@link Extend.ForbiddenError}
|
|
76
|
+
* @throws {@link Extend.NotFoundError}
|
|
77
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
78
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
79
|
+
* @throws {@link Extend.InternalServerError}
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* await client.webhookEndpoints.retrieve("webhook_endpoint_id_here")
|
|
83
|
+
*/
|
|
84
|
+
retrieve(id: string, requestOptions?: WebhookEndpointsClient.RequestOptions): core.HttpResponsePromise<Extend.WebhookEndpoint>;
|
|
85
|
+
private __retrieve;
|
|
86
|
+
/**
|
|
87
|
+
* Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.
|
|
88
|
+
*
|
|
89
|
+
* The `apiVersion` of a webhook endpoint cannot be changed after creation.
|
|
90
|
+
*
|
|
91
|
+
* @param {string} id - The ID of the webhook endpoint to update.
|
|
92
|
+
*
|
|
93
|
+
* Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
94
|
+
* @param {Extend.WebhookEndpointsUpdateRequest} request
|
|
95
|
+
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link Extend.BadRequestError}
|
|
98
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
99
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
100
|
+
* @throws {@link Extend.ForbiddenError}
|
|
101
|
+
* @throws {@link Extend.NotFoundError}
|
|
102
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
103
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
104
|
+
* @throws {@link Extend.InternalServerError}
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* await client.webhookEndpoints.update("webhook_endpoint_id_here")
|
|
108
|
+
*/
|
|
109
|
+
update(id: string, request?: Extend.WebhookEndpointsUpdateRequest, requestOptions?: WebhookEndpointsClient.RequestOptions): core.HttpResponsePromise<Extend.WebhookEndpoint>;
|
|
110
|
+
private __update;
|
|
111
|
+
/**
|
|
112
|
+
* Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.
|
|
113
|
+
*
|
|
114
|
+
* @param {string} id - The ID of the webhook endpoint to delete.
|
|
115
|
+
*
|
|
116
|
+
* Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
117
|
+
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link Extend.BadRequestError}
|
|
120
|
+
* @throws {@link Extend.UnauthorizedError}
|
|
121
|
+
* @throws {@link Extend.PaymentRequiredError}
|
|
122
|
+
* @throws {@link Extend.ForbiddenError}
|
|
123
|
+
* @throws {@link Extend.NotFoundError}
|
|
124
|
+
* @throws {@link Extend.UnprocessableEntityError}
|
|
125
|
+
* @throws {@link Extend.TooManyRequestsError}
|
|
126
|
+
* @throws {@link Extend.InternalServerError}
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* await client.webhookEndpoints.delete("webhook_endpoint_id_here")
|
|
130
|
+
*/
|
|
131
|
+
delete(id: string, requestOptions?: WebhookEndpointsClient.RequestOptions): core.HttpResponsePromise<Extend.WebhookEndpointsDeleteResponse>;
|
|
132
|
+
private __delete;
|
|
133
|
+
}
|