@orq-ai/node 4.12.0-rc.33 → 4.12.0-rc.36
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/README.md +55 -36
- package/funcs/knowledgeListDatasources.js +1 -0
- package/funcs/knowledgeListDatasources.js.map +1 -1
- package/funcs/webhooksCount.d.ts +17 -0
- package/funcs/webhooksCount.d.ts.map +1 -0
- package/funcs/webhooksCount.js +105 -0
- package/funcs/webhooksCount.js.map +1 -0
- package/funcs/webhooksCreate.d.ts +17 -0
- package/funcs/webhooksCreate.d.ts.map +1 -0
- package/funcs/webhooksCreate.js +115 -0
- package/funcs/webhooksCreate.js.map +1 -0
- package/funcs/webhooksDelete.d.ts +18 -0
- package/funcs/webhooksDelete.d.ts.map +1 -0
- package/funcs/webhooksDelete.js +121 -0
- package/funcs/webhooksDelete.js.map +1 -0
- package/funcs/webhooksGenerateSecret.d.ts +17 -0
- package/funcs/webhooksGenerateSecret.d.ts.map +1 -0
- package/funcs/webhooksGenerateSecret.js +105 -0
- package/funcs/webhooksGenerateSecret.js.map +1 -0
- package/funcs/webhooksGet.d.ts +18 -0
- package/funcs/webhooksGet.d.ts.map +1 -0
- package/funcs/webhooksGet.js +121 -0
- package/funcs/webhooksGet.js.map +1 -0
- package/funcs/webhooksList.d.ts +18 -0
- package/funcs/webhooksList.d.ts.map +1 -0
- package/funcs/webhooksList.js +126 -0
- package/funcs/webhooksList.js.map +1 -0
- package/funcs/webhooksQuery.d.ts +19 -0
- package/funcs/webhooksQuery.d.ts.map +1 -0
- package/funcs/webhooksQuery.js +117 -0
- package/funcs/webhooksQuery.js.map +1 -0
- package/funcs/webhooksUpdate.d.ts +17 -0
- package/funcs/webhooksUpdate.d.ts.map +1 -0
- package/funcs/webhooksUpdate.js +121 -0
- package/funcs/webhooksUpdate.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/countwebhooksresponse.d.ts +16 -0
- package/models/components/countwebhooksresponse.d.ts.map +1 -0
- package/models/components/countwebhooksresponse.js +50 -0
- package/models/components/countwebhooksresponse.js.map +1 -0
- package/models/components/createwebhookrequest.d.ts +62 -0
- package/models/components/createwebhookrequest.d.ts.map +1 -0
- package/models/components/createwebhookrequest.js +71 -0
- package/models/components/createwebhookrequest.js.map +1 -0
- package/models/components/deletewebhookresponse.d.ts +13 -0
- package/models/components/deletewebhookresponse.d.ts.map +1 -0
- package/models/components/deletewebhookresponse.js +50 -0
- package/models/components/deletewebhookresponse.js.map +1 -0
- package/models/components/evaluatorresponsefunction.js +2 -2
- package/models/components/evaluatorresponsehttp.js +2 -2
- package/models/components/evaluatorresponsejsonschema.js +2 -2
- package/models/components/evaluatorresponsellm.js +2 -2
- package/models/components/evaluatorresponsepython.js +2 -2
- package/models/components/evaluatorresponseragas.js +2 -2
- package/models/components/evaluatorresponsetypescript.js +2 -2
- package/models/components/generatewebhooksecretresponse.d.ts +16 -0
- package/models/components/generatewebhooksecretresponse.d.ts.map +1 -0
- package/models/components/generatewebhooksecretresponse.js +50 -0
- package/models/components/generatewebhooksecretresponse.js.map +1 -0
- package/models/components/index.d.ts +10 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +10 -0
- package/models/components/index.js.map +1 -1
- package/models/components/listwebhooksresponse.d.ts +25 -0
- package/models/components/listwebhooksresponse.d.ts.map +1 -0
- package/models/components/listwebhooksresponse.js +58 -0
- package/models/components/listwebhooksresponse.js.map +1 -0
- package/models/components/queryparamspagination.d.ts +18 -0
- package/models/components/queryparamspagination.d.ts.map +1 -0
- package/models/components/queryparamspagination.js +52 -0
- package/models/components/queryparamspagination.js.map +1 -0
- package/models/components/queryparamssort.d.ts +14 -0
- package/models/components/queryparamssort.d.ts.map +1 -0
- package/models/components/queryparamssort.js +50 -0
- package/models/components/queryparamssort.js.map +1 -0
- package/models/components/querywebhooksrequest.d.ts +38 -0
- package/models/components/querywebhooksrequest.d.ts.map +1 -0
- package/models/components/querywebhooksrequest.js +67 -0
- package/models/components/querywebhooksrequest.js.map +1 -0
- package/models/components/querywebhooksresponse.d.ts +12 -0
- package/models/components/querywebhooksresponse.d.ts.map +1 -0
- package/models/components/querywebhooksresponse.js +52 -0
- package/models/components/querywebhooksresponse.js.map +1 -0
- package/models/components/reasoningpart.js +1 -1
- package/models/components/webhook.d.ts +74 -0
- package/models/components/webhook.d.ts.map +1 -0
- package/models/components/webhook.js +81 -0
- package/models/components/webhook.js.map +1 -0
- package/models/operations/createagentrequest.d.ts +1 -1
- package/models/operations/createagentrequest.d.ts.map +1 -1
- package/models/operations/createagentrequest.js +1 -1
- package/models/operations/createagentrequest.js.map +1 -1
- package/models/operations/createdataset.js +1 -1
- package/models/operations/createdatasetitem.d.ts +121 -8
- package/models/operations/createdatasetitem.d.ts.map +1 -1
- package/models/operations/createdatasetitem.js +97 -12
- package/models/operations/createdatasetitem.js.map +1 -1
- package/models/operations/createdatasource.d.ts +42 -0
- package/models/operations/createdatasource.d.ts.map +1 -1
- package/models/operations/createdatasource.js +26 -2
- package/models/operations/createdatasource.js.map +1 -1
- package/models/operations/createrouterresponse.d.ts +34 -4
- package/models/operations/createrouterresponse.d.ts.map +1 -1
- package/models/operations/createrouterresponse.js +18 -3
- package/models/operations/createrouterresponse.js.map +1 -1
- package/models/operations/createtool.js +6 -6
- package/models/operations/getalltools.js +6 -6
- package/models/operations/getv2humanevalsets.js +2 -2
- package/models/operations/getv2humanevalsetsid.js +2 -2
- package/models/operations/index.d.ts +4 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/listagents.d.ts +1 -1
- package/models/operations/listagents.d.ts.map +1 -1
- package/models/operations/listagents.js +1 -1
- package/models/operations/listagents.js.map +1 -1
- package/models/operations/listdatasetdatapoints.d.ts +149 -36
- package/models/operations/listdatasetdatapoints.d.ts.map +1 -1
- package/models/operations/listdatasetdatapoints.js +119 -37
- package/models/operations/listdatasetdatapoints.js.map +1 -1
- package/models/operations/listdatasets.js +1 -1
- package/models/operations/listdatasources.d.ts +48 -0
- package/models/operations/listdatasources.d.ts.map +1 -1
- package/models/operations/listdatasources.js +33 -2
- package/models/operations/listdatasources.js.map +1 -1
- package/models/operations/patchv2humanevalsetsid.js +2 -2
- package/models/operations/postv2feedbackevaluation.d.ts +68 -6
- package/models/operations/postv2feedbackevaluation.d.ts.map +1 -1
- package/models/operations/postv2feedbackevaluation.js +46 -6
- package/models/operations/postv2feedbackevaluation.js.map +1 -1
- package/models/operations/postv2humanevalsets.js +2 -2
- package/models/operations/retrieveagentrequest.d.ts +1 -1
- package/models/operations/retrieveagentrequest.d.ts.map +1 -1
- package/models/operations/retrieveagentrequest.js +1 -1
- package/models/operations/retrieveagentrequest.js.map +1 -1
- package/models/operations/retrievedatapoint.d.ts +117 -4
- package/models/operations/retrievedatapoint.d.ts.map +1 -1
- package/models/operations/retrievedatapoint.js +90 -8
- package/models/operations/retrievedatapoint.js.map +1 -1
- package/models/operations/retrievedataset.js +1 -1
- package/models/operations/retrievedatasource.d.ts +33 -0
- package/models/operations/retrievedatasource.d.ts.map +1 -1
- package/models/operations/retrievedatasource.js +25 -2
- package/models/operations/retrievedatasource.js.map +1 -1
- package/models/operations/retrieveresponse.d.ts +4 -4
- package/models/operations/retrieveresponse.d.ts.map +1 -1
- package/models/operations/retrieveresponse.js +4 -4
- package/models/operations/retrieveresponse.js.map +1 -1
- package/models/operations/retrievetool.js +6 -6
- package/models/operations/runagent.js +1 -1
- package/models/operations/streamrunagent.js +1 -1
- package/models/operations/updateagent.d.ts +1 -1
- package/models/operations/updateagent.d.ts.map +1 -1
- package/models/operations/updateagent.js +1 -1
- package/models/operations/updateagent.js.map +1 -1
- package/models/operations/updatedatapoint.d.ts +117 -4
- package/models/operations/updatedatapoint.d.ts.map +1 -1
- package/models/operations/updatedatapoint.js +92 -8
- package/models/operations/updatedatapoint.js.map +1 -1
- package/models/operations/updatedataset.js +1 -1
- package/models/operations/updatedatasource.d.ts +33 -0
- package/models/operations/updatedatasource.d.ts.map +1 -1
- package/models/operations/updatedatasource.js +25 -2
- package/models/operations/updatedatasource.js.map +1 -1
- package/models/operations/updatetool.js +7 -7
- package/models/operations/webhookdelete.d.ts +12 -0
- package/models/operations/webhookdelete.d.ts.map +1 -0
- package/models/operations/webhookdelete.js +49 -0
- package/models/operations/webhookdelete.js.map +1 -0
- package/models/operations/webhookget.d.ts +12 -0
- package/models/operations/webhookget.d.ts.map +1 -0
- package/models/operations/webhookget.js +49 -0
- package/models/operations/webhookget.js.map +1 -0
- package/models/operations/webhooklist.d.ts +70 -0
- package/models/operations/webhooklist.d.ts.map +1 -0
- package/models/operations/webhooklist.js +61 -0
- package/models/operations/webhooklist.js.map +1 -0
- package/models/operations/webhookupdate.d.ts +29 -0
- package/models/operations/webhookupdate.d.ts.map +1 -0
- package/models/operations/webhookupdate.js +68 -0
- package/models/operations/webhookupdate.js.map +1 -0
- package/package.json +7 -7
- package/sdk/feedback.d.ts +4 -1
- package/sdk/feedback.d.ts.map +1 -1
- package/sdk/feedback.js +4 -1
- package/sdk/feedback.js.map +1 -1
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/webhooks.d.ts +64 -0
- package/sdk/webhooks.d.ts.map +1 -0
- package/sdk/webhooks.js +94 -0
- package/sdk/webhooks.js.map +1 -0
- package/src/funcs/knowledgeListDatasources.ts +1 -0
- package/src/funcs/webhooksCount.ts +144 -0
- package/src/funcs/webhooksCreate.ts +162 -0
- package/src/funcs/webhooksDelete.ts +168 -0
- package/src/funcs/webhooksGenerateSecret.ts +144 -0
- package/src/funcs/webhooksGet.ts +168 -0
- package/src/funcs/webhooksList.ts +175 -0
- package/src/funcs/webhooksQuery.ts +164 -0
- package/src/funcs/webhooksUpdate.ts +168 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/countwebhooksresponse.ts +37 -0
- package/src/models/components/createwebhookrequest.ts +100 -0
- package/src/models/components/deletewebhookresponse.ts +34 -0
- package/src/models/components/evaluatorresponsefunction.ts +2 -2
- package/src/models/components/evaluatorresponsehttp.ts +2 -2
- package/src/models/components/evaluatorresponsejsonschema.ts +2 -2
- package/src/models/components/evaluatorresponsellm.ts +2 -2
- package/src/models/components/evaluatorresponsepython.ts +2 -2
- package/src/models/components/evaluatorresponseragas.ts +2 -2
- package/src/models/components/evaluatorresponsetypescript.ts +2 -2
- package/src/models/components/generatewebhooksecretresponse.ts +37 -0
- package/src/models/components/index.ts +10 -0
- package/src/models/components/listwebhooksresponse.ts +53 -0
- package/src/models/components/queryparamspagination.ts +40 -0
- package/src/models/components/queryparamssort.ts +32 -0
- package/src/models/components/querywebhooksrequest.ts +85 -0
- package/src/models/components/querywebhooksresponse.ts +34 -0
- package/src/models/components/reasoningpart.ts +1 -1
- package/src/models/components/webhook.ts +116 -0
- package/src/models/operations/createagentrequest.ts +2 -2
- package/src/models/operations/createdataset.ts +1 -1
- package/src/models/operations/createdatasetitem.ts +237 -19
- package/src/models/operations/createdatasource.ts +78 -2
- package/src/models/operations/createrouterresponse.ts +41 -5
- package/src/models/operations/createtool.ts +6 -6
- package/src/models/operations/getalltools.ts +6 -6
- package/src/models/operations/getv2humanevalsets.ts +2 -2
- package/src/models/operations/getv2humanevalsetsid.ts +2 -2
- package/src/models/operations/index.ts +4 -0
- package/src/models/operations/listagents.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +313 -84
- package/src/models/operations/listdatasets.ts +1 -1
- package/src/models/operations/listdatasources.ts +99 -2
- package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
- package/src/models/operations/postv2feedbackevaluation.ts +119 -11
- package/src/models/operations/postv2humanevalsets.ts +2 -2
- package/src/models/operations/retrieveagentrequest.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +234 -9
- package/src/models/operations/retrievedataset.ts +1 -1
- package/src/models/operations/retrievedatasource.ts +72 -2
- package/src/models/operations/retrieveresponse.ts +8 -8
- package/src/models/operations/retrievetool.ts +6 -6
- package/src/models/operations/runagent.ts +1 -1
- package/src/models/operations/streamrunagent.ts +1 -1
- package/src/models/operations/updateagent.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +229 -9
- package/src/models/operations/updatedataset.ts +1 -1
- package/src/models/operations/updatedatasource.ts +72 -2
- package/src/models/operations/updatetool.ts +7 -7
- package/src/models/operations/webhookdelete.ts +31 -0
- package/src/models/operations/webhookget.ts +31 -0
- package/src/models/operations/webhooklist.ts +101 -0
- package/src/models/operations/webhookupdate.ts +84 -0
- package/src/sdk/feedback.ts +4 -1
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/webhooks.ts +152 -0
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
2
|
+
import * as components from "../models/components/index.js";
|
|
3
|
+
import * as operations from "../models/operations/index.js";
|
|
4
|
+
export declare class Webhooks extends ClientSDK {
|
|
5
|
+
/**
|
|
6
|
+
* List webhooks
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Returns a page of webhooks in the current workspace. By default, the first 20 matching webhooks are ordered by creation time, newest first. Supplied filters are combined, `count` reports the total number of matches before pagination, and `has_more` indicates whether another page is available.
|
|
10
|
+
*/
|
|
11
|
+
list(request?: operations.WebhookListRequest | undefined, options?: RequestOptions): Promise<components.ListWebhooksResponse>;
|
|
12
|
+
/**
|
|
13
|
+
* Create a webhook
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`.
|
|
17
|
+
*/
|
|
18
|
+
create(request: components.CreateWebhookRequest, options?: RequestOptions): Promise<components.Webhook>;
|
|
19
|
+
/**
|
|
20
|
+
* Count webhooks
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* Returns the total number of enabled and disabled webhooks in the current workspace.
|
|
24
|
+
*/
|
|
25
|
+
count(options?: RequestOptions): Promise<components.CountWebhooksResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Query webhooks
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* **Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting.
|
|
31
|
+
*
|
|
32
|
+
* @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
33
|
+
*/
|
|
34
|
+
query(request: components.QueryWebhooksRequest, options?: RequestOptions): Promise<components.QueryWebhooksResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* Generate a webhook secret
|
|
37
|
+
*
|
|
38
|
+
* @remarks
|
|
39
|
+
* Generates a signing secret for verifying webhook deliveries. The secret is not persisted until it is used to create or update a webhook; store it securely.
|
|
40
|
+
*/
|
|
41
|
+
generateSecret(options?: RequestOptions): Promise<components.GenerateWebhookSecretResponse>;
|
|
42
|
+
/**
|
|
43
|
+
* Retrieve a webhook
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive.
|
|
47
|
+
*/
|
|
48
|
+
get(request: operations.WebhookGetRequest, options?: RequestOptions): Promise<components.Webhook>;
|
|
49
|
+
/**
|
|
50
|
+
* Delete a webhook
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* Deletes a webhook in the current workspace and returns the deleted webhook ID.
|
|
54
|
+
*/
|
|
55
|
+
delete(request: operations.WebhookDeleteRequest, options?: RequestOptions): Promise<components.DeleteWebhookResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* Update a webhook
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* Updates the supplied fields on a webhook in the current workspace. Omitted fields are unchanged. The response contains the applied fields rather than the complete webhook.
|
|
61
|
+
*/
|
|
62
|
+
update(request: operations.WebhookUpdateRequest, options?: RequestOptions): Promise<operations.WebhookUpdateResponseBody>;
|
|
63
|
+
}
|
|
64
|
+
//# sourceMappingURL=webhooks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/sdk/webhooks.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,QAAS,SAAQ,SAAS;IACrC;;;;;OAKG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,UAAU,CAAC,kBAAkB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;IAQ9B;;;;;OAKG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAO5C;;;;;;;OAOG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;OAKG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAOpD;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;IAQ9B;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAOjD"}
|
package/sdk/webhooks.js
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Webhooks = void 0;
|
|
7
|
+
const webhooksCount_js_1 = require("../funcs/webhooksCount.js");
|
|
8
|
+
const webhooksCreate_js_1 = require("../funcs/webhooksCreate.js");
|
|
9
|
+
const webhooksDelete_js_1 = require("../funcs/webhooksDelete.js");
|
|
10
|
+
const webhooksGenerateSecret_js_1 = require("../funcs/webhooksGenerateSecret.js");
|
|
11
|
+
const webhooksGet_js_1 = require("../funcs/webhooksGet.js");
|
|
12
|
+
const webhooksList_js_1 = require("../funcs/webhooksList.js");
|
|
13
|
+
const webhooksQuery_js_1 = require("../funcs/webhooksQuery.js");
|
|
14
|
+
const webhooksUpdate_js_1 = require("../funcs/webhooksUpdate.js");
|
|
15
|
+
const sdks_js_1 = require("../lib/sdks.js");
|
|
16
|
+
const fp_js_1 = require("../types/fp.js");
|
|
17
|
+
class Webhooks extends sdks_js_1.ClientSDK {
|
|
18
|
+
/**
|
|
19
|
+
* List webhooks
|
|
20
|
+
*
|
|
21
|
+
* @remarks
|
|
22
|
+
* Returns a page of webhooks in the current workspace. By default, the first 20 matching webhooks are ordered by creation time, newest first. Supplied filters are combined, `count` reports the total number of matches before pagination, and `has_more` indicates whether another page is available.
|
|
23
|
+
*/
|
|
24
|
+
async list(request, options) {
|
|
25
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksList_js_1.webhooksList)(this, request, options));
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Create a webhook
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`.
|
|
32
|
+
*/
|
|
33
|
+
async create(request, options) {
|
|
34
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksCreate_js_1.webhooksCreate)(this, request, options));
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Count webhooks
|
|
38
|
+
*
|
|
39
|
+
* @remarks
|
|
40
|
+
* Returns the total number of enabled and disabled webhooks in the current workspace.
|
|
41
|
+
*/
|
|
42
|
+
async count(options) {
|
|
43
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksCount_js_1.webhooksCount)(this, options));
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Query webhooks
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* **Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting.
|
|
50
|
+
*
|
|
51
|
+
* @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
52
|
+
*/
|
|
53
|
+
async query(request, options) {
|
|
54
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksQuery_js_1.webhooksQuery)(this, request, options));
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Generate a webhook secret
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* Generates a signing secret for verifying webhook deliveries. The secret is not persisted until it is used to create or update a webhook; store it securely.
|
|
61
|
+
*/
|
|
62
|
+
async generateSecret(options) {
|
|
63
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksGenerateSecret_js_1.webhooksGenerateSecret)(this, options));
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Retrieve a webhook
|
|
67
|
+
*
|
|
68
|
+
* @remarks
|
|
69
|
+
* Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive.
|
|
70
|
+
*/
|
|
71
|
+
async get(request, options) {
|
|
72
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksGet_js_1.webhooksGet)(this, request, options));
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Delete a webhook
|
|
76
|
+
*
|
|
77
|
+
* @remarks
|
|
78
|
+
* Deletes a webhook in the current workspace and returns the deleted webhook ID.
|
|
79
|
+
*/
|
|
80
|
+
async delete(request, options) {
|
|
81
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksDelete_js_1.webhooksDelete)(this, request, options));
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Update a webhook
|
|
85
|
+
*
|
|
86
|
+
* @remarks
|
|
87
|
+
* Updates the supplied fields on a webhook in the current workspace. Omitted fields are unchanged. The response contains the applied fields rather than the complete webhook.
|
|
88
|
+
*/
|
|
89
|
+
async update(request, options) {
|
|
90
|
+
return (0, fp_js_1.unwrapAsync)((0, webhooksUpdate_js_1.webhooksUpdate)(this, request, options));
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
exports.Webhooks = Webhooks;
|
|
94
|
+
//# sourceMappingURL=webhooks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/sdk/webhooks.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gEAA0D;AAC1D,kEAA4D;AAC5D,kEAA4D;AAC5D,kFAA4E;AAC5E,4DAAsD;AACtD,8DAAwD;AACxD,gEAA0D;AAC1D,kEAA4D;AAC5D,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,QAAS,SAAQ,mBAAS;IACrC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gCAAa,EAC9B,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CACT,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gCAAa,EAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,OAAqC,EACrC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4BAAW,EAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAtID,4BAsIC"}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { OrqCore } from "../core.js";
|
|
6
|
+
import { matchStatusCode } from "../lib/http.js";
|
|
7
|
+
import * as M from "../lib/matchers.js";
|
|
8
|
+
import { compactMap } from "../lib/primitives.js";
|
|
9
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
10
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
11
|
+
import { pathToFunc } from "../lib/url.js";
|
|
12
|
+
import * as components from "../models/components/index.js";
|
|
13
|
+
import {
|
|
14
|
+
ConnectionError,
|
|
15
|
+
InvalidRequestError,
|
|
16
|
+
RequestAbortedError,
|
|
17
|
+
RequestTimeoutError,
|
|
18
|
+
UnexpectedClientError,
|
|
19
|
+
} from "../models/errors/httpclienterrors.js";
|
|
20
|
+
import { OrqError } from "../models/errors/orqerror.js";
|
|
21
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
22
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
23
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
24
|
+
import { Result } from "../types/fp.js";
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Count webhooks
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Returns the total number of enabled and disabled webhooks in the current workspace.
|
|
31
|
+
*/
|
|
32
|
+
export function webhooksCount(
|
|
33
|
+
client: OrqCore,
|
|
34
|
+
options?: RequestOptions,
|
|
35
|
+
): APIPromise<
|
|
36
|
+
Result<
|
|
37
|
+
components.CountWebhooksResponse,
|
|
38
|
+
| OrqError
|
|
39
|
+
| ResponseValidationError
|
|
40
|
+
| ConnectionError
|
|
41
|
+
| RequestAbortedError
|
|
42
|
+
| RequestTimeoutError
|
|
43
|
+
| InvalidRequestError
|
|
44
|
+
| UnexpectedClientError
|
|
45
|
+
| SDKValidationError
|
|
46
|
+
>
|
|
47
|
+
> {
|
|
48
|
+
return new APIPromise($do(
|
|
49
|
+
client,
|
|
50
|
+
options,
|
|
51
|
+
));
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
async function $do(
|
|
55
|
+
client: OrqCore,
|
|
56
|
+
options?: RequestOptions,
|
|
57
|
+
): Promise<
|
|
58
|
+
[
|
|
59
|
+
Result<
|
|
60
|
+
components.CountWebhooksResponse,
|
|
61
|
+
| OrqError
|
|
62
|
+
| ResponseValidationError
|
|
63
|
+
| ConnectionError
|
|
64
|
+
| RequestAbortedError
|
|
65
|
+
| RequestTimeoutError
|
|
66
|
+
| InvalidRequestError
|
|
67
|
+
| UnexpectedClientError
|
|
68
|
+
| SDKValidationError
|
|
69
|
+
>,
|
|
70
|
+
APICall,
|
|
71
|
+
]
|
|
72
|
+
> {
|
|
73
|
+
const path = pathToFunc("/v2/webhooks/count")();
|
|
74
|
+
|
|
75
|
+
const headers = new Headers(compactMap({
|
|
76
|
+
Accept: "application/json",
|
|
77
|
+
}));
|
|
78
|
+
|
|
79
|
+
const secConfig = await extractSecurity(client._options.apiKey);
|
|
80
|
+
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
81
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
82
|
+
|
|
83
|
+
const context = {
|
|
84
|
+
options: client._options,
|
|
85
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
86
|
+
operationID: "WebhookCount",
|
|
87
|
+
oAuth2Scopes: null,
|
|
88
|
+
|
|
89
|
+
resolvedSecurity: requestSecurity,
|
|
90
|
+
|
|
91
|
+
securitySource: client._options.apiKey,
|
|
92
|
+
retryConfig: options?.retries
|
|
93
|
+
|| client._options.retryConfig
|
|
94
|
+
|| { strategy: "none" },
|
|
95
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
const requestRes = client._createRequest(context, {
|
|
99
|
+
security: requestSecurity,
|
|
100
|
+
method: "GET",
|
|
101
|
+
baseURL: options?.serverURL,
|
|
102
|
+
path: path,
|
|
103
|
+
headers: headers,
|
|
104
|
+
userAgent: client._options.userAgent,
|
|
105
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
|
|
106
|
+
}, options);
|
|
107
|
+
if (!requestRes.ok) {
|
|
108
|
+
return [requestRes, { status: "invalid" }];
|
|
109
|
+
}
|
|
110
|
+
const req = requestRes.value;
|
|
111
|
+
|
|
112
|
+
const doResult = await client._do(req, {
|
|
113
|
+
context,
|
|
114
|
+
isErrorStatusCode: (statusCode: number) =>
|
|
115
|
+
matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
|
|
116
|
+
retryConfig: context.retryConfig,
|
|
117
|
+
retryCodes: context.retryCodes,
|
|
118
|
+
});
|
|
119
|
+
if (!doResult.ok) {
|
|
120
|
+
return [doResult, { status: "request-error", request: req }];
|
|
121
|
+
}
|
|
122
|
+
const response = doResult.value;
|
|
123
|
+
|
|
124
|
+
const [result] = await M.match<
|
|
125
|
+
components.CountWebhooksResponse,
|
|
126
|
+
| OrqError
|
|
127
|
+
| ResponseValidationError
|
|
128
|
+
| ConnectionError
|
|
129
|
+
| RequestAbortedError
|
|
130
|
+
| RequestTimeoutError
|
|
131
|
+
| InvalidRequestError
|
|
132
|
+
| UnexpectedClientError
|
|
133
|
+
| SDKValidationError
|
|
134
|
+
>(
|
|
135
|
+
M.json(200, components.CountWebhooksResponse$inboundSchema),
|
|
136
|
+
M.fail("4XX"),
|
|
137
|
+
M.fail("5XX"),
|
|
138
|
+
)(response, req);
|
|
139
|
+
if (!result.ok) {
|
|
140
|
+
return [result, { status: "complete", request: req, response }];
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
return [result, { status: "complete", request: req, response }];
|
|
144
|
+
}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { OrqCore } from "../core.js";
|
|
6
|
+
import { encodeJSON } from "../lib/encodings.js";
|
|
7
|
+
import { matchStatusCode } from "../lib/http.js";
|
|
8
|
+
import * as M from "../lib/matchers.js";
|
|
9
|
+
import { compactMap } from "../lib/primitives.js";
|
|
10
|
+
import { safeParse } from "../lib/schemas.js";
|
|
11
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
12
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
13
|
+
import { pathToFunc } from "../lib/url.js";
|
|
14
|
+
import * as components from "../models/components/index.js";
|
|
15
|
+
import {
|
|
16
|
+
ConnectionError,
|
|
17
|
+
InvalidRequestError,
|
|
18
|
+
RequestAbortedError,
|
|
19
|
+
RequestTimeoutError,
|
|
20
|
+
UnexpectedClientError,
|
|
21
|
+
} from "../models/errors/httpclienterrors.js";
|
|
22
|
+
import { OrqError } from "../models/errors/orqerror.js";
|
|
23
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
24
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
25
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
26
|
+
import { Result } from "../types/fp.js";
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Create a webhook
|
|
30
|
+
*
|
|
31
|
+
* @remarks
|
|
32
|
+
* Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`.
|
|
33
|
+
*/
|
|
34
|
+
export function webhooksCreate(
|
|
35
|
+
client: OrqCore,
|
|
36
|
+
request: components.CreateWebhookRequest,
|
|
37
|
+
options?: RequestOptions,
|
|
38
|
+
): APIPromise<
|
|
39
|
+
Result<
|
|
40
|
+
components.Webhook,
|
|
41
|
+
| OrqError
|
|
42
|
+
| ResponseValidationError
|
|
43
|
+
| ConnectionError
|
|
44
|
+
| RequestAbortedError
|
|
45
|
+
| RequestTimeoutError
|
|
46
|
+
| InvalidRequestError
|
|
47
|
+
| UnexpectedClientError
|
|
48
|
+
| SDKValidationError
|
|
49
|
+
>
|
|
50
|
+
> {
|
|
51
|
+
return new APIPromise($do(
|
|
52
|
+
client,
|
|
53
|
+
request,
|
|
54
|
+
options,
|
|
55
|
+
));
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
async function $do(
|
|
59
|
+
client: OrqCore,
|
|
60
|
+
request: components.CreateWebhookRequest,
|
|
61
|
+
options?: RequestOptions,
|
|
62
|
+
): Promise<
|
|
63
|
+
[
|
|
64
|
+
Result<
|
|
65
|
+
components.Webhook,
|
|
66
|
+
| OrqError
|
|
67
|
+
| ResponseValidationError
|
|
68
|
+
| ConnectionError
|
|
69
|
+
| RequestAbortedError
|
|
70
|
+
| RequestTimeoutError
|
|
71
|
+
| InvalidRequestError
|
|
72
|
+
| UnexpectedClientError
|
|
73
|
+
| SDKValidationError
|
|
74
|
+
>,
|
|
75
|
+
APICall,
|
|
76
|
+
]
|
|
77
|
+
> {
|
|
78
|
+
const parsed = safeParse(
|
|
79
|
+
request,
|
|
80
|
+
(value) => components.CreateWebhookRequest$outboundSchema.parse(value),
|
|
81
|
+
"Input validation failed",
|
|
82
|
+
);
|
|
83
|
+
if (!parsed.ok) {
|
|
84
|
+
return [parsed, { status: "invalid" }];
|
|
85
|
+
}
|
|
86
|
+
const payload = parsed.value;
|
|
87
|
+
const body = encodeJSON("body", payload, { explode: true });
|
|
88
|
+
|
|
89
|
+
const path = pathToFunc("/v2/webhooks")();
|
|
90
|
+
|
|
91
|
+
const headers = new Headers(compactMap({
|
|
92
|
+
"Content-Type": "application/json",
|
|
93
|
+
Accept: "application/json",
|
|
94
|
+
}));
|
|
95
|
+
|
|
96
|
+
const secConfig = await extractSecurity(client._options.apiKey);
|
|
97
|
+
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
98
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
99
|
+
|
|
100
|
+
const context = {
|
|
101
|
+
options: client._options,
|
|
102
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
103
|
+
operationID: "WebhookCreate",
|
|
104
|
+
oAuth2Scopes: null,
|
|
105
|
+
|
|
106
|
+
resolvedSecurity: requestSecurity,
|
|
107
|
+
|
|
108
|
+
securitySource: client._options.apiKey,
|
|
109
|
+
retryConfig: options?.retries
|
|
110
|
+
|| client._options.retryConfig
|
|
111
|
+
|| { strategy: "none" },
|
|
112
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
const requestRes = client._createRequest(context, {
|
|
116
|
+
security: requestSecurity,
|
|
117
|
+
method: "POST",
|
|
118
|
+
baseURL: options?.serverURL,
|
|
119
|
+
path: path,
|
|
120
|
+
headers: headers,
|
|
121
|
+
body: body,
|
|
122
|
+
userAgent: client._options.userAgent,
|
|
123
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
|
|
124
|
+
}, options);
|
|
125
|
+
if (!requestRes.ok) {
|
|
126
|
+
return [requestRes, { status: "invalid" }];
|
|
127
|
+
}
|
|
128
|
+
const req = requestRes.value;
|
|
129
|
+
|
|
130
|
+
const doResult = await client._do(req, {
|
|
131
|
+
context,
|
|
132
|
+
isErrorStatusCode: (statusCode: number) =>
|
|
133
|
+
matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
|
|
134
|
+
retryConfig: context.retryConfig,
|
|
135
|
+
retryCodes: context.retryCodes,
|
|
136
|
+
});
|
|
137
|
+
if (!doResult.ok) {
|
|
138
|
+
return [doResult, { status: "request-error", request: req }];
|
|
139
|
+
}
|
|
140
|
+
const response = doResult.value;
|
|
141
|
+
|
|
142
|
+
const [result] = await M.match<
|
|
143
|
+
components.Webhook,
|
|
144
|
+
| OrqError
|
|
145
|
+
| ResponseValidationError
|
|
146
|
+
| ConnectionError
|
|
147
|
+
| RequestAbortedError
|
|
148
|
+
| RequestTimeoutError
|
|
149
|
+
| InvalidRequestError
|
|
150
|
+
| UnexpectedClientError
|
|
151
|
+
| SDKValidationError
|
|
152
|
+
>(
|
|
153
|
+
M.json(200, components.Webhook$inboundSchema),
|
|
154
|
+
M.fail("4XX"),
|
|
155
|
+
M.fail("5XX"),
|
|
156
|
+
)(response, req);
|
|
157
|
+
if (!result.ok) {
|
|
158
|
+
return [result, { status: "complete", request: req, response }];
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
return [result, { status: "complete", request: req, response }];
|
|
162
|
+
}
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { OrqCore } from "../core.js";
|
|
6
|
+
import { encodeSimple } from "../lib/encodings.js";
|
|
7
|
+
import { matchStatusCode } from "../lib/http.js";
|
|
8
|
+
import * as M from "../lib/matchers.js";
|
|
9
|
+
import { compactMap } from "../lib/primitives.js";
|
|
10
|
+
import { safeParse } from "../lib/schemas.js";
|
|
11
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
12
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
13
|
+
import { pathToFunc } from "../lib/url.js";
|
|
14
|
+
import * as components from "../models/components/index.js";
|
|
15
|
+
import {
|
|
16
|
+
ConnectionError,
|
|
17
|
+
InvalidRequestError,
|
|
18
|
+
RequestAbortedError,
|
|
19
|
+
RequestTimeoutError,
|
|
20
|
+
UnexpectedClientError,
|
|
21
|
+
} from "../models/errors/httpclienterrors.js";
|
|
22
|
+
import { OrqError } from "../models/errors/orqerror.js";
|
|
23
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
24
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
25
|
+
import * as operations from "../models/operations/index.js";
|
|
26
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
27
|
+
import { Result } from "../types/fp.js";
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Delete a webhook
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Deletes a webhook in the current workspace and returns the deleted webhook ID.
|
|
34
|
+
*/
|
|
35
|
+
export function webhooksDelete(
|
|
36
|
+
client: OrqCore,
|
|
37
|
+
request: operations.WebhookDeleteRequest,
|
|
38
|
+
options?: RequestOptions,
|
|
39
|
+
): APIPromise<
|
|
40
|
+
Result<
|
|
41
|
+
components.DeleteWebhookResponse,
|
|
42
|
+
| OrqError
|
|
43
|
+
| ResponseValidationError
|
|
44
|
+
| ConnectionError
|
|
45
|
+
| RequestAbortedError
|
|
46
|
+
| RequestTimeoutError
|
|
47
|
+
| InvalidRequestError
|
|
48
|
+
| UnexpectedClientError
|
|
49
|
+
| SDKValidationError
|
|
50
|
+
>
|
|
51
|
+
> {
|
|
52
|
+
return new APIPromise($do(
|
|
53
|
+
client,
|
|
54
|
+
request,
|
|
55
|
+
options,
|
|
56
|
+
));
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
async function $do(
|
|
60
|
+
client: OrqCore,
|
|
61
|
+
request: operations.WebhookDeleteRequest,
|
|
62
|
+
options?: RequestOptions,
|
|
63
|
+
): Promise<
|
|
64
|
+
[
|
|
65
|
+
Result<
|
|
66
|
+
components.DeleteWebhookResponse,
|
|
67
|
+
| OrqError
|
|
68
|
+
| ResponseValidationError
|
|
69
|
+
| ConnectionError
|
|
70
|
+
| RequestAbortedError
|
|
71
|
+
| RequestTimeoutError
|
|
72
|
+
| InvalidRequestError
|
|
73
|
+
| UnexpectedClientError
|
|
74
|
+
| SDKValidationError
|
|
75
|
+
>,
|
|
76
|
+
APICall,
|
|
77
|
+
]
|
|
78
|
+
> {
|
|
79
|
+
const parsed = safeParse(
|
|
80
|
+
request,
|
|
81
|
+
(value) => operations.WebhookDeleteRequest$outboundSchema.parse(value),
|
|
82
|
+
"Input validation failed",
|
|
83
|
+
);
|
|
84
|
+
if (!parsed.ok) {
|
|
85
|
+
return [parsed, { status: "invalid" }];
|
|
86
|
+
}
|
|
87
|
+
const payload = parsed.value;
|
|
88
|
+
const body = null;
|
|
89
|
+
|
|
90
|
+
const pathParams = {
|
|
91
|
+
id: encodeSimple("id", payload.id, {
|
|
92
|
+
explode: false,
|
|
93
|
+
charEncoding: "percent",
|
|
94
|
+
}),
|
|
95
|
+
};
|
|
96
|
+
const path = pathToFunc("/v2/webhooks/{id}")(pathParams);
|
|
97
|
+
|
|
98
|
+
const headers = new Headers(compactMap({
|
|
99
|
+
Accept: "application/json",
|
|
100
|
+
}));
|
|
101
|
+
|
|
102
|
+
const secConfig = await extractSecurity(client._options.apiKey);
|
|
103
|
+
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
104
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
105
|
+
|
|
106
|
+
const context = {
|
|
107
|
+
options: client._options,
|
|
108
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
109
|
+
operationID: "WebhookDelete",
|
|
110
|
+
oAuth2Scopes: null,
|
|
111
|
+
|
|
112
|
+
resolvedSecurity: requestSecurity,
|
|
113
|
+
|
|
114
|
+
securitySource: client._options.apiKey,
|
|
115
|
+
retryConfig: options?.retries
|
|
116
|
+
|| client._options.retryConfig
|
|
117
|
+
|| { strategy: "none" },
|
|
118
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
const requestRes = client._createRequest(context, {
|
|
122
|
+
security: requestSecurity,
|
|
123
|
+
method: "DELETE",
|
|
124
|
+
baseURL: options?.serverURL,
|
|
125
|
+
path: path,
|
|
126
|
+
headers: headers,
|
|
127
|
+
body: body,
|
|
128
|
+
userAgent: client._options.userAgent,
|
|
129
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
|
|
130
|
+
}, options);
|
|
131
|
+
if (!requestRes.ok) {
|
|
132
|
+
return [requestRes, { status: "invalid" }];
|
|
133
|
+
}
|
|
134
|
+
const req = requestRes.value;
|
|
135
|
+
|
|
136
|
+
const doResult = await client._do(req, {
|
|
137
|
+
context,
|
|
138
|
+
isErrorStatusCode: (statusCode: number) =>
|
|
139
|
+
matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
|
|
140
|
+
retryConfig: context.retryConfig,
|
|
141
|
+
retryCodes: context.retryCodes,
|
|
142
|
+
});
|
|
143
|
+
if (!doResult.ok) {
|
|
144
|
+
return [doResult, { status: "request-error", request: req }];
|
|
145
|
+
}
|
|
146
|
+
const response = doResult.value;
|
|
147
|
+
|
|
148
|
+
const [result] = await M.match<
|
|
149
|
+
components.DeleteWebhookResponse,
|
|
150
|
+
| OrqError
|
|
151
|
+
| ResponseValidationError
|
|
152
|
+
| ConnectionError
|
|
153
|
+
| RequestAbortedError
|
|
154
|
+
| RequestTimeoutError
|
|
155
|
+
| InvalidRequestError
|
|
156
|
+
| UnexpectedClientError
|
|
157
|
+
| SDKValidationError
|
|
158
|
+
>(
|
|
159
|
+
M.json(200, components.DeleteWebhookResponse$inboundSchema),
|
|
160
|
+
M.fail("4XX"),
|
|
161
|
+
M.fail("5XX"),
|
|
162
|
+
)(response, req);
|
|
163
|
+
if (!result.ok) {
|
|
164
|
+
return [result, { status: "complete", request: req, response }];
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
return [result, { status: "complete", request: req, response }];
|
|
168
|
+
}
|