@unified-api/typescript-sdk 2.9.4 → 2.9.6

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.
Files changed (137) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/crmcontact.d.ts +2 -0
  97. package/sdk/models/shared/crmcontact.d.ts.map +1 -1
  98. package/sdk/models/shared/crmcontact.js +4 -0
  99. package/sdk/models/shared/crmcontact.js.map +1 -1
  100. package/sdk/models/shared/crmlead.d.ts +2 -0
  101. package/sdk/models/shared/crmlead.d.ts.map +1 -1
  102. package/sdk/models/shared/crmlead.js +4 -0
  103. package/sdk/models/shared/crmlead.js.map +1 -1
  104. package/sdk/models/shared/index.d.ts +1 -0
  105. package/sdk/models/shared/index.d.ts.map +1 -1
  106. package/sdk/models/shared/index.js +1 -0
  107. package/sdk/models/shared/index.js.map +1 -1
  108. package/sdk/models/shared/kmspage.d.ts +5 -0
  109. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  110. package/sdk/models/shared/kmspage.js +7 -0
  111. package/sdk/models/shared/kmspage.js.map +1 -1
  112. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  113. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  114. package/sdk/models/shared/kmspagemetadata.js +63 -0
  115. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  116. package/sdk/models/shared/kmsspace.d.ts +2 -0
  117. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  118. package/sdk/models/shared/kmsspace.js +4 -0
  119. package/sdk/models/shared/kmsspace.js.map +1 -1
  120. package/sdk/models/shared/security.d.ts +2 -2
  121. package/sdk/models/shared/security.d.ts.map +1 -1
  122. package/sdk/models/shared/security.js +2 -2
  123. package/sdk/models/shared/security.js.map +1 -1
  124. package/sdk/types/operations.d.ts +5 -3
  125. package/sdk/types/operations.d.ts.map +1 -1
  126. package/sdk/types/operations.js +3 -0
  127. package/sdk/types/operations.js.map +1 -1
  128. package/src/lib/config.ts +3 -3
  129. package/src/lib/primitives.ts +62 -0
  130. package/src/sdk/models/shared/crmcontact.ts +6 -0
  131. package/src/sdk/models/shared/crmlead.ts +6 -0
  132. package/src/sdk/models/shared/index.ts +1 -0
  133. package/src/sdk/models/shared/kmspage.ts +16 -0
  134. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  135. package/src/sdk/models/shared/kmsspace.ts +6 -0
  136. package/src/sdk/models/shared/security.ts +4 -4
  137. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,647 @@
1
+ # Webhook
2
+ (*webhook*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createUnifiedWebhook](#createunifiedwebhook) - Create webhook subscription
9
+ * [getUnifiedWebhook](#getunifiedwebhook) - Retrieve webhook by its ID
10
+ * [listUnifiedWebhooks](#listunifiedwebhooks) - Returns all registered webhooks
11
+ * [patchUnifiedWebhook](#patchunifiedwebhook) - Update webhook subscription
12
+ * [patchUnifiedWebhookTrigger](#patchunifiedwebhooktrigger) - Trigger webhook
13
+ * [removeUnifiedWebhook](#removeunifiedwebhook) - Remove webhook subscription
14
+ * [updateUnifiedWebhook](#updateunifiedwebhook) - Update webhook subscription
15
+ * [updateUnifiedWebhookTrigger](#updateunifiedwebhooktrigger) - Trigger webhook
16
+
17
+ ## createUnifiedWebhook
18
+
19
+ The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
25
+
26
+ const unifiedTo = new UnifiedTo({
27
+ security: {
28
+ jwt: "<YOUR_API_KEY_HERE>",
29
+ },
30
+ });
31
+
32
+ async function run() {
33
+ const result = await unifiedTo.webhook.createUnifiedWebhook({});
34
+
35
+ // Handle the result
36
+ console.log(result);
37
+ }
38
+
39
+ run();
40
+ ```
41
+
42
+ ### Standalone function
43
+
44
+ The standalone function version of this method:
45
+
46
+ ```typescript
47
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
48
+ import { webhookCreateUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/webhookCreateUnifiedWebhook.js";
49
+
50
+ // Use `UnifiedToCore` for best tree-shaking performance.
51
+ // You can create one instance of it to use across an application.
52
+ const unifiedTo = new UnifiedToCore({
53
+ security: {
54
+ jwt: "<YOUR_API_KEY_HERE>",
55
+ },
56
+ });
57
+
58
+ async function run() {
59
+ const res = await webhookCreateUnifiedWebhook(unifiedTo, {});
60
+
61
+ if (!res.ok) {
62
+ throw res.error;
63
+ }
64
+
65
+ const { value: result } = res;
66
+
67
+ // Handle the result
68
+ console.log(result);
69
+ }
70
+
71
+ run();
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Parameter | Type | Required | Description |
77
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
+ | `request` | [operations.CreateUnifiedWebhookRequest](../../sdk/models/operations/createunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
79
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
80
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
81
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
82
+
83
+ ### Response
84
+
85
+ **Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
86
+
87
+ ### Errors
88
+
89
+ | Error Type | Status Code | Content Type |
90
+ | --------------- | --------------- | --------------- |
91
+ | errors.SDKError | 4XX, 5XX | \*/\* |
92
+
93
+ ## getUnifiedWebhook
94
+
95
+ Retrieve webhook by its ID
96
+
97
+ ### Example Usage
98
+
99
+ ```typescript
100
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
101
+
102
+ const unifiedTo = new UnifiedTo({
103
+ security: {
104
+ jwt: "<YOUR_API_KEY_HERE>",
105
+ },
106
+ });
107
+
108
+ async function run() {
109
+ const result = await unifiedTo.webhook.getUnifiedWebhook({
110
+ id: "<id>",
111
+ });
112
+
113
+ // Handle the result
114
+ console.log(result);
115
+ }
116
+
117
+ run();
118
+ ```
119
+
120
+ ### Standalone function
121
+
122
+ The standalone function version of this method:
123
+
124
+ ```typescript
125
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
126
+ import { webhookGetUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/webhookGetUnifiedWebhook.js";
127
+
128
+ // Use `UnifiedToCore` for best tree-shaking performance.
129
+ // You can create one instance of it to use across an application.
130
+ const unifiedTo = new UnifiedToCore({
131
+ security: {
132
+ jwt: "<YOUR_API_KEY_HERE>",
133
+ },
134
+ });
135
+
136
+ async function run() {
137
+ const res = await webhookGetUnifiedWebhook(unifiedTo, {
138
+ id: "<id>",
139
+ });
140
+
141
+ if (!res.ok) {
142
+ throw res.error;
143
+ }
144
+
145
+ const { value: result } = res;
146
+
147
+ // Handle the result
148
+ console.log(result);
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Parameter | Type | Required | Description |
157
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
+ | `request` | [operations.GetUnifiedWebhookRequest](../../sdk/models/operations/getunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
159
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
161
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
+
163
+ ### Response
164
+
165
+ **Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
166
+
167
+ ### Errors
168
+
169
+ | Error Type | Status Code | Content Type |
170
+ | --------------- | --------------- | --------------- |
171
+ | errors.SDKError | 4XX, 5XX | \*/\* |
172
+
173
+ ## listUnifiedWebhooks
174
+
175
+ Returns all registered webhooks
176
+
177
+ ### Example Usage
178
+
179
+ ```typescript
180
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
181
+
182
+ const unifiedTo = new UnifiedTo({
183
+ security: {
184
+ jwt: "<YOUR_API_KEY_HERE>",
185
+ },
186
+ });
187
+
188
+ async function run() {
189
+ const result = await unifiedTo.webhook.listUnifiedWebhooks({});
190
+
191
+ // Handle the result
192
+ console.log(result);
193
+ }
194
+
195
+ run();
196
+ ```
197
+
198
+ ### Standalone function
199
+
200
+ The standalone function version of this method:
201
+
202
+ ```typescript
203
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
204
+ import { webhookListUnifiedWebhooks } from "@unified-api/typescript-sdk/funcs/webhookListUnifiedWebhooks.js";
205
+
206
+ // Use `UnifiedToCore` for best tree-shaking performance.
207
+ // You can create one instance of it to use across an application.
208
+ const unifiedTo = new UnifiedToCore({
209
+ security: {
210
+ jwt: "<YOUR_API_KEY_HERE>",
211
+ },
212
+ });
213
+
214
+ async function run() {
215
+ const res = await webhookListUnifiedWebhooks(unifiedTo, {});
216
+
217
+ if (!res.ok) {
218
+ throw res.error;
219
+ }
220
+
221
+ const { value: result } = res;
222
+
223
+ // Handle the result
224
+ console.log(result);
225
+ }
226
+
227
+ run();
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+ | Parameter | Type | Required | Description |
233
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
234
+ | `request` | [operations.ListUnifiedWebhooksRequest](../../sdk/models/operations/listunifiedwebhooksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
235
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
236
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
237
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
238
+
239
+ ### Response
240
+
241
+ **Promise\<[shared.Webhook[]](../../models/.md)\>**
242
+
243
+ ### Errors
244
+
245
+ | Error Type | Status Code | Content Type |
246
+ | --------------- | --------------- | --------------- |
247
+ | errors.SDKError | 4XX, 5XX | \*/\* |
248
+
249
+ ## patchUnifiedWebhook
250
+
251
+ Update webhook subscription
252
+
253
+ ### Example Usage
254
+
255
+ ```typescript
256
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
257
+
258
+ const unifiedTo = new UnifiedTo({
259
+ security: {
260
+ jwt: "<YOUR_API_KEY_HERE>",
261
+ },
262
+ });
263
+
264
+ async function run() {
265
+ const result = await unifiedTo.webhook.patchUnifiedWebhook({
266
+ id: "<id>",
267
+ });
268
+
269
+ // Handle the result
270
+ console.log(result);
271
+ }
272
+
273
+ run();
274
+ ```
275
+
276
+ ### Standalone function
277
+
278
+ The standalone function version of this method:
279
+
280
+ ```typescript
281
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
282
+ import { webhookPatchUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/webhookPatchUnifiedWebhook.js";
283
+
284
+ // Use `UnifiedToCore` for best tree-shaking performance.
285
+ // You can create one instance of it to use across an application.
286
+ const unifiedTo = new UnifiedToCore({
287
+ security: {
288
+ jwt: "<YOUR_API_KEY_HERE>",
289
+ },
290
+ });
291
+
292
+ async function run() {
293
+ const res = await webhookPatchUnifiedWebhook(unifiedTo, {
294
+ id: "<id>",
295
+ });
296
+
297
+ if (!res.ok) {
298
+ throw res.error;
299
+ }
300
+
301
+ const { value: result } = res;
302
+
303
+ // Handle the result
304
+ console.log(result);
305
+ }
306
+
307
+ run();
308
+ ```
309
+
310
+ ### Parameters
311
+
312
+ | Parameter | Type | Required | Description |
313
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
314
+ | `request` | [operations.PatchUnifiedWebhookRequest](../../sdk/models/operations/patchunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
315
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
316
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
317
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
318
+
319
+ ### Response
320
+
321
+ **Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
322
+
323
+ ### Errors
324
+
325
+ | Error Type | Status Code | Content Type |
326
+ | --------------- | --------------- | --------------- |
327
+ | errors.SDKError | 4XX, 5XX | \*/\* |
328
+
329
+ ## patchUnifiedWebhookTrigger
330
+
331
+ Trigger webhook
332
+
333
+ ### Example Usage
334
+
335
+ ```typescript
336
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
337
+
338
+ const unifiedTo = new UnifiedTo({
339
+ security: {
340
+ jwt: "<YOUR_API_KEY_HERE>",
341
+ },
342
+ });
343
+
344
+ async function run() {
345
+ const result = await unifiedTo.webhook.patchUnifiedWebhookTrigger({
346
+ id: "<id>",
347
+ });
348
+
349
+ // Handle the result
350
+ console.log(result);
351
+ }
352
+
353
+ run();
354
+ ```
355
+
356
+ ### Standalone function
357
+
358
+ The standalone function version of this method:
359
+
360
+ ```typescript
361
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
362
+ import { webhookPatchUnifiedWebhookTrigger } from "@unified-api/typescript-sdk/funcs/webhookPatchUnifiedWebhookTrigger.js";
363
+
364
+ // Use `UnifiedToCore` for best tree-shaking performance.
365
+ // You can create one instance of it to use across an application.
366
+ const unifiedTo = new UnifiedToCore({
367
+ security: {
368
+ jwt: "<YOUR_API_KEY_HERE>",
369
+ },
370
+ });
371
+
372
+ async function run() {
373
+ const res = await webhookPatchUnifiedWebhookTrigger(unifiedTo, {
374
+ id: "<id>",
375
+ });
376
+
377
+ if (!res.ok) {
378
+ throw res.error;
379
+ }
380
+
381
+ const { value: result } = res;
382
+
383
+ // Handle the result
384
+ console.log(result);
385
+ }
386
+
387
+ run();
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ | Parameter | Type | Required | Description |
393
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
394
+ | `request` | [operations.PatchUnifiedWebhookTriggerRequest](../../sdk/models/operations/patchunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
395
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
396
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
397
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
398
+
399
+ ### Response
400
+
401
+ **Promise\<[operations.PatchUnifiedWebhookTriggerResponse](../../sdk/models/operations/patchunifiedwebhooktriggerresponse.md)\>**
402
+
403
+ ### Errors
404
+
405
+ | Error Type | Status Code | Content Type |
406
+ | --------------- | --------------- | --------------- |
407
+ | errors.SDKError | 4XX, 5XX | \*/\* |
408
+
409
+ ## removeUnifiedWebhook
410
+
411
+ Remove webhook subscription
412
+
413
+ ### Example Usage
414
+
415
+ ```typescript
416
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
417
+
418
+ const unifiedTo = new UnifiedTo({
419
+ security: {
420
+ jwt: "<YOUR_API_KEY_HERE>",
421
+ },
422
+ });
423
+
424
+ async function run() {
425
+ const result = await unifiedTo.webhook.removeUnifiedWebhook({
426
+ id: "<id>",
427
+ });
428
+
429
+ // Handle the result
430
+ console.log(result);
431
+ }
432
+
433
+ run();
434
+ ```
435
+
436
+ ### Standalone function
437
+
438
+ The standalone function version of this method:
439
+
440
+ ```typescript
441
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
442
+ import { webhookRemoveUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/webhookRemoveUnifiedWebhook.js";
443
+
444
+ // Use `UnifiedToCore` for best tree-shaking performance.
445
+ // You can create one instance of it to use across an application.
446
+ const unifiedTo = new UnifiedToCore({
447
+ security: {
448
+ jwt: "<YOUR_API_KEY_HERE>",
449
+ },
450
+ });
451
+
452
+ async function run() {
453
+ const res = await webhookRemoveUnifiedWebhook(unifiedTo, {
454
+ id: "<id>",
455
+ });
456
+
457
+ if (!res.ok) {
458
+ throw res.error;
459
+ }
460
+
461
+ const { value: result } = res;
462
+
463
+ // Handle the result
464
+ console.log(result);
465
+ }
466
+
467
+ run();
468
+ ```
469
+
470
+ ### Parameters
471
+
472
+ | Parameter | Type | Required | Description |
473
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
474
+ | `request` | [operations.RemoveUnifiedWebhookRequest](../../sdk/models/operations/removeunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
475
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
476
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
477
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
478
+
479
+ ### Response
480
+
481
+ **Promise\<[operations.RemoveUnifiedWebhookResponse](../../sdk/models/operations/removeunifiedwebhookresponse.md)\>**
482
+
483
+ ### Errors
484
+
485
+ | Error Type | Status Code | Content Type |
486
+ | --------------- | --------------- | --------------- |
487
+ | errors.SDKError | 4XX, 5XX | \*/\* |
488
+
489
+ ## updateUnifiedWebhook
490
+
491
+ Update webhook subscription
492
+
493
+ ### Example Usage
494
+
495
+ ```typescript
496
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
497
+
498
+ const unifiedTo = new UnifiedTo({
499
+ security: {
500
+ jwt: "<YOUR_API_KEY_HERE>",
501
+ },
502
+ });
503
+
504
+ async function run() {
505
+ const result = await unifiedTo.webhook.updateUnifiedWebhook({
506
+ id: "<id>",
507
+ });
508
+
509
+ // Handle the result
510
+ console.log(result);
511
+ }
512
+
513
+ run();
514
+ ```
515
+
516
+ ### Standalone function
517
+
518
+ The standalone function version of this method:
519
+
520
+ ```typescript
521
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
522
+ import { webhookUpdateUnifiedWebhook } from "@unified-api/typescript-sdk/funcs/webhookUpdateUnifiedWebhook.js";
523
+
524
+ // Use `UnifiedToCore` for best tree-shaking performance.
525
+ // You can create one instance of it to use across an application.
526
+ const unifiedTo = new UnifiedToCore({
527
+ security: {
528
+ jwt: "<YOUR_API_KEY_HERE>",
529
+ },
530
+ });
531
+
532
+ async function run() {
533
+ const res = await webhookUpdateUnifiedWebhook(unifiedTo, {
534
+ id: "<id>",
535
+ });
536
+
537
+ if (!res.ok) {
538
+ throw res.error;
539
+ }
540
+
541
+ const { value: result } = res;
542
+
543
+ // Handle the result
544
+ console.log(result);
545
+ }
546
+
547
+ run();
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ | Parameter | Type | Required | Description |
553
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
554
+ | `request` | [operations.UpdateUnifiedWebhookRequest](../../sdk/models/operations/updateunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
555
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
556
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
557
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
558
+
559
+ ### Response
560
+
561
+ **Promise\<[shared.Webhook](../../sdk/models/shared/webhook.md)\>**
562
+
563
+ ### Errors
564
+
565
+ | Error Type | Status Code | Content Type |
566
+ | --------------- | --------------- | --------------- |
567
+ | errors.SDKError | 4XX, 5XX | \*/\* |
568
+
569
+ ## updateUnifiedWebhookTrigger
570
+
571
+ Trigger webhook
572
+
573
+ ### Example Usage
574
+
575
+ ```typescript
576
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
577
+
578
+ const unifiedTo = new UnifiedTo({
579
+ security: {
580
+ jwt: "<YOUR_API_KEY_HERE>",
581
+ },
582
+ });
583
+
584
+ async function run() {
585
+ const result = await unifiedTo.webhook.updateUnifiedWebhookTrigger({
586
+ id: "<id>",
587
+ });
588
+
589
+ // Handle the result
590
+ console.log(result);
591
+ }
592
+
593
+ run();
594
+ ```
595
+
596
+ ### Standalone function
597
+
598
+ The standalone function version of this method:
599
+
600
+ ```typescript
601
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
602
+ import { webhookUpdateUnifiedWebhookTrigger } from "@unified-api/typescript-sdk/funcs/webhookUpdateUnifiedWebhookTrigger.js";
603
+
604
+ // Use `UnifiedToCore` for best tree-shaking performance.
605
+ // You can create one instance of it to use across an application.
606
+ const unifiedTo = new UnifiedToCore({
607
+ security: {
608
+ jwt: "<YOUR_API_KEY_HERE>",
609
+ },
610
+ });
611
+
612
+ async function run() {
613
+ const res = await webhookUpdateUnifiedWebhookTrigger(unifiedTo, {
614
+ id: "<id>",
615
+ });
616
+
617
+ if (!res.ok) {
618
+ throw res.error;
619
+ }
620
+
621
+ const { value: result } = res;
622
+
623
+ // Handle the result
624
+ console.log(result);
625
+ }
626
+
627
+ run();
628
+ ```
629
+
630
+ ### Parameters
631
+
632
+ | Parameter | Type | Required | Description |
633
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
634
+ | `request` | [operations.UpdateUnifiedWebhookTriggerRequest](../../sdk/models/operations/updateunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
635
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
636
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
637
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
638
+
639
+ ### Response
640
+
641
+ **Promise\<[operations.UpdateUnifiedWebhookTriggerResponse](../../sdk/models/operations/updateunifiedwebhooktriggerresponse.md)\>**
642
+
643
+ ### Errors
644
+
645
+ | Error Type | Status Code | Content Type |
646
+ | --------------- | --------------- | --------------- |
647
+ | errors.SDKError | 4XX, 5XX | \*/\* |