@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,84 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
8
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
|
+
|
|
11
|
+
export type WebhookUpdateRequestBody = {};
|
|
12
|
+
|
|
13
|
+
export type WebhookUpdateRequest = {
|
|
14
|
+
id: string;
|
|
15
|
+
requestBody: WebhookUpdateRequestBody;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* OK
|
|
20
|
+
*/
|
|
21
|
+
export type WebhookUpdateResponseBody = {};
|
|
22
|
+
|
|
23
|
+
/** @internal */
|
|
24
|
+
export type WebhookUpdateRequestBody$Outbound = {};
|
|
25
|
+
|
|
26
|
+
/** @internal */
|
|
27
|
+
export const WebhookUpdateRequestBody$outboundSchema: z.ZodType<
|
|
28
|
+
WebhookUpdateRequestBody$Outbound,
|
|
29
|
+
z.ZodTypeDef,
|
|
30
|
+
WebhookUpdateRequestBody
|
|
31
|
+
> = z.object({});
|
|
32
|
+
|
|
33
|
+
export function webhookUpdateRequestBodyToJSON(
|
|
34
|
+
webhookUpdateRequestBody: WebhookUpdateRequestBody,
|
|
35
|
+
): string {
|
|
36
|
+
return JSON.stringify(
|
|
37
|
+
WebhookUpdateRequestBody$outboundSchema.parse(webhookUpdateRequestBody),
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** @internal */
|
|
42
|
+
export type WebhookUpdateRequest$Outbound = {
|
|
43
|
+
id: string;
|
|
44
|
+
RequestBody: WebhookUpdateRequestBody$Outbound;
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
/** @internal */
|
|
48
|
+
export const WebhookUpdateRequest$outboundSchema: z.ZodType<
|
|
49
|
+
WebhookUpdateRequest$Outbound,
|
|
50
|
+
z.ZodTypeDef,
|
|
51
|
+
WebhookUpdateRequest
|
|
52
|
+
> = z.object({
|
|
53
|
+
id: z.string(),
|
|
54
|
+
requestBody: z.lazy(() => WebhookUpdateRequestBody$outboundSchema),
|
|
55
|
+
}).transform((v) => {
|
|
56
|
+
return remap$(v, {
|
|
57
|
+
requestBody: "RequestBody",
|
|
58
|
+
});
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
export function webhookUpdateRequestToJSON(
|
|
62
|
+
webhookUpdateRequest: WebhookUpdateRequest,
|
|
63
|
+
): string {
|
|
64
|
+
return JSON.stringify(
|
|
65
|
+
WebhookUpdateRequest$outboundSchema.parse(webhookUpdateRequest),
|
|
66
|
+
);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** @internal */
|
|
70
|
+
export const WebhookUpdateResponseBody$inboundSchema: z.ZodType<
|
|
71
|
+
WebhookUpdateResponseBody,
|
|
72
|
+
z.ZodTypeDef,
|
|
73
|
+
unknown
|
|
74
|
+
> = z.object({});
|
|
75
|
+
|
|
76
|
+
export function webhookUpdateResponseBodyFromJSON(
|
|
77
|
+
jsonString: string,
|
|
78
|
+
): SafeParseResult<WebhookUpdateResponseBody, SDKValidationError> {
|
|
79
|
+
return safeParse(
|
|
80
|
+
jsonString,
|
|
81
|
+
(x) => WebhookUpdateResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
82
|
+
`Failed to parse 'WebhookUpdateResponseBody' from JSON`,
|
|
83
|
+
);
|
|
84
|
+
}
|
package/src/sdk/feedback.ts
CHANGED
|
@@ -45,7 +45,10 @@ export class Feedback extends ClientSDK {
|
|
|
45
45
|
}
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* Create
|
|
48
|
+
* Create a new management key
|
|
49
|
+
*
|
|
50
|
+
* @remarks
|
|
51
|
+
* Mints a new opaque management key (`sk-orq-<key_id>-<secret>`) in the workspace. The raw secret is returned ONCE in the response and is never retrievable afterwards. The stored record retains only `token_prefix` and a SHA-256 `token_hash`.
|
|
49
52
|
*/
|
|
50
53
|
async create(
|
|
51
54
|
request?: operations.PostV2FeedbackRequestBody | undefined,
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -34,6 +34,7 @@ import { Skills } from "./skills.js";
|
|
|
34
34
|
import { Telemetry } from "./telemetry.js";
|
|
35
35
|
import { Tools } from "./tools.js";
|
|
36
36
|
import { Traces } from "./traces.js";
|
|
37
|
+
import { Webhooks } from "./webhooks.js";
|
|
37
38
|
|
|
38
39
|
export class Orq extends ClientSDK {
|
|
39
40
|
private _evals?: Evals;
|
|
@@ -166,6 +167,11 @@ export class Orq extends ClientSDK {
|
|
|
166
167
|
return (this._skills ??= new Skills(this._options));
|
|
167
168
|
}
|
|
168
169
|
|
|
170
|
+
private _webhooks?: Webhooks;
|
|
171
|
+
get webhooks(): Webhooks {
|
|
172
|
+
return (this._webhooks ??= new Webhooks(this._options));
|
|
173
|
+
}
|
|
174
|
+
|
|
169
175
|
private _schedules?: Schedules;
|
|
170
176
|
get schedules(): Schedules {
|
|
171
177
|
return (this._schedules ??= new Schedules(this._options));
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { webhooksCount } from "../funcs/webhooksCount.js";
|
|
6
|
+
import { webhooksCreate } from "../funcs/webhooksCreate.js";
|
|
7
|
+
import { webhooksDelete } from "../funcs/webhooksDelete.js";
|
|
8
|
+
import { webhooksGenerateSecret } from "../funcs/webhooksGenerateSecret.js";
|
|
9
|
+
import { webhooksGet } from "../funcs/webhooksGet.js";
|
|
10
|
+
import { webhooksList } from "../funcs/webhooksList.js";
|
|
11
|
+
import { webhooksQuery } from "../funcs/webhooksQuery.js";
|
|
12
|
+
import { webhooksUpdate } from "../funcs/webhooksUpdate.js";
|
|
13
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
14
|
+
import * as components from "../models/components/index.js";
|
|
15
|
+
import * as operations from "../models/operations/index.js";
|
|
16
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
17
|
+
|
|
18
|
+
export class Webhooks extends ClientSDK {
|
|
19
|
+
/**
|
|
20
|
+
* List webhooks
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* 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.
|
|
24
|
+
*/
|
|
25
|
+
async list(
|
|
26
|
+
request?: operations.WebhookListRequest | undefined,
|
|
27
|
+
options?: RequestOptions,
|
|
28
|
+
): Promise<components.ListWebhooksResponse> {
|
|
29
|
+
return unwrapAsync(webhooksList(
|
|
30
|
+
this,
|
|
31
|
+
request,
|
|
32
|
+
options,
|
|
33
|
+
));
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Create a webhook
|
|
38
|
+
*
|
|
39
|
+
* @remarks
|
|
40
|
+
* Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`.
|
|
41
|
+
*/
|
|
42
|
+
async create(
|
|
43
|
+
request: components.CreateWebhookRequest,
|
|
44
|
+
options?: RequestOptions,
|
|
45
|
+
): Promise<components.Webhook> {
|
|
46
|
+
return unwrapAsync(webhooksCreate(
|
|
47
|
+
this,
|
|
48
|
+
request,
|
|
49
|
+
options,
|
|
50
|
+
));
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Count webhooks
|
|
55
|
+
*
|
|
56
|
+
* @remarks
|
|
57
|
+
* Returns the total number of enabled and disabled webhooks in the current workspace.
|
|
58
|
+
*/
|
|
59
|
+
async count(
|
|
60
|
+
options?: RequestOptions,
|
|
61
|
+
): Promise<components.CountWebhooksResponse> {
|
|
62
|
+
return unwrapAsync(webhooksCount(
|
|
63
|
+
this,
|
|
64
|
+
options,
|
|
65
|
+
));
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Query webhooks
|
|
70
|
+
*
|
|
71
|
+
* @remarks
|
|
72
|
+
* **Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting.
|
|
73
|
+
*
|
|
74
|
+
* @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
75
|
+
*/
|
|
76
|
+
async query(
|
|
77
|
+
request: components.QueryWebhooksRequest,
|
|
78
|
+
options?: RequestOptions,
|
|
79
|
+
): Promise<components.QueryWebhooksResponse> {
|
|
80
|
+
return unwrapAsync(webhooksQuery(
|
|
81
|
+
this,
|
|
82
|
+
request,
|
|
83
|
+
options,
|
|
84
|
+
));
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Generate a webhook secret
|
|
89
|
+
*
|
|
90
|
+
* @remarks
|
|
91
|
+
* 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.
|
|
92
|
+
*/
|
|
93
|
+
async generateSecret(
|
|
94
|
+
options?: RequestOptions,
|
|
95
|
+
): Promise<components.GenerateWebhookSecretResponse> {
|
|
96
|
+
return unwrapAsync(webhooksGenerateSecret(
|
|
97
|
+
this,
|
|
98
|
+
options,
|
|
99
|
+
));
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Retrieve a webhook
|
|
104
|
+
*
|
|
105
|
+
* @remarks
|
|
106
|
+
* Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive.
|
|
107
|
+
*/
|
|
108
|
+
async get(
|
|
109
|
+
request: operations.WebhookGetRequest,
|
|
110
|
+
options?: RequestOptions,
|
|
111
|
+
): Promise<components.Webhook> {
|
|
112
|
+
return unwrapAsync(webhooksGet(
|
|
113
|
+
this,
|
|
114
|
+
request,
|
|
115
|
+
options,
|
|
116
|
+
));
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Delete a webhook
|
|
121
|
+
*
|
|
122
|
+
* @remarks
|
|
123
|
+
* Deletes a webhook in the current workspace and returns the deleted webhook ID.
|
|
124
|
+
*/
|
|
125
|
+
async delete(
|
|
126
|
+
request: operations.WebhookDeleteRequest,
|
|
127
|
+
options?: RequestOptions,
|
|
128
|
+
): Promise<components.DeleteWebhookResponse> {
|
|
129
|
+
return unwrapAsync(webhooksDelete(
|
|
130
|
+
this,
|
|
131
|
+
request,
|
|
132
|
+
options,
|
|
133
|
+
));
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Update a webhook
|
|
138
|
+
*
|
|
139
|
+
* @remarks
|
|
140
|
+
* 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.
|
|
141
|
+
*/
|
|
142
|
+
async update(
|
|
143
|
+
request: operations.WebhookUpdateRequest,
|
|
144
|
+
options?: RequestOptions,
|
|
145
|
+
): Promise<operations.WebhookUpdateResponseBody> {
|
|
146
|
+
return unwrapAsync(webhooksUpdate(
|
|
147
|
+
this,
|
|
148
|
+
request,
|
|
149
|
+
options,
|
|
150
|
+
));
|
|
151
|
+
}
|
|
152
|
+
}
|