@unified-api/typescript-sdk 2.80.0 → 2.80.1

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 (120) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/package.json +1 -1
  6. package/sdk/models/shared/kmspage.d.ts +2 -0
  7. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  8. package/sdk/models/shared/kmspage.js +4 -0
  9. package/sdk/models/shared/kmspage.js.map +1 -1
  10. package/src/lib/config.ts +3 -3
  11. package/src/sdk/models/shared/kmspage.ts +6 -0
  12. package/docs/sdks/account/README.md +0 -489
  13. package/docs/sdks/accounting/README.md +0 -7221
  14. package/docs/sdks/activity/README.md +0 -489
  15. package/docs/sdks/apicall/README.md +0 -159
  16. package/docs/sdks/application/README.md +0 -489
  17. package/docs/sdks/applicationstatus/README.md +0 -85
  18. package/docs/sdks/ats/README.md +0 -3953
  19. package/docs/sdks/auth/README.md +0 -167
  20. package/docs/sdks/balancesheet/README.md +0 -165
  21. package/docs/sdks/bill/README.md +0 -489
  22. package/docs/sdks/branch/README.md +0 -507
  23. package/docs/sdks/busy/README.md +0 -85
  24. package/docs/sdks/calendar/README.md +0 -1713
  25. package/docs/sdks/call/README.md +0 -85
  26. package/docs/sdks/candidate/README.md +0 -489
  27. package/docs/sdks/cashflow/README.md +0 -165
  28. package/docs/sdks/category/README.md +0 -971
  29. package/docs/sdks/change/README.md +0 -165
  30. package/docs/sdks/channel/README.md +0 -165
  31. package/docs/sdks/class/README.md +0 -507
  32. package/docs/sdks/collection/README.md +0 -501
  33. package/docs/sdks/comment/README.md +0 -1495
  34. package/docs/sdks/commerce/README.md +0 -2465
  35. package/docs/sdks/commit/README.md +0 -501
  36. package/docs/sdks/company/README.md +0 -1543
  37. package/docs/sdks/connection/README.md +0 -513
  38. package/docs/sdks/contact/README.md +0 -1453
  39. package/docs/sdks/course/README.md +0 -501
  40. package/docs/sdks/creditmemo/README.md +0 -489
  41. package/docs/sdks/crm/README.md +0 -2899
  42. package/docs/sdks/customer/README.md +0 -489
  43. package/docs/sdks/deal/README.md +0 -489
  44. package/docs/sdks/device/README.md +0 -501
  45. package/docs/sdks/document/README.md +0 -489
  46. package/docs/sdks/embedding/README.md +0 -87
  47. package/docs/sdks/employee/README.md +0 -489
  48. package/docs/sdks/enrich/README.md +0 -163
  49. package/docs/sdks/event/README.md +0 -971
  50. package/docs/sdks/expense/README.md +0 -489
  51. package/docs/sdks/file/README.md +0 -489
  52. package/docs/sdks/genai/README.md +0 -325
  53. package/docs/sdks/group/README.md +0 -983
  54. package/docs/sdks/hris/README.md +0 -3251
  55. package/docs/sdks/instructor/README.md +0 -489
  56. package/docs/sdks/integration/README.md +0 -239
  57. package/docs/sdks/interview/README.md +0 -489
  58. package/docs/sdks/inventory/README.md +0 -501
  59. package/docs/sdks/invoice/README.md +0 -489
  60. package/docs/sdks/issue/README.md +0 -159
  61. package/docs/sdks/item/README.md +0 -489
  62. package/docs/sdks/job/README.md +0 -489
  63. package/docs/sdks/journal/README.md +0 -489
  64. package/docs/sdks/kms/README.md +0 -1495
  65. package/docs/sdks/lead/README.md +0 -489
  66. package/docs/sdks/link/README.md +0 -983
  67. package/docs/sdks/list/README.md +0 -489
  68. package/docs/sdks/lms/README.md +0 -1965
  69. package/docs/sdks/location/README.md +0 -983
  70. package/docs/sdks/login/README.md +0 -87
  71. package/docs/sdks/martech/README.md +0 -971
  72. package/docs/sdks/member/README.md +0 -489
  73. package/docs/sdks/message/README.md +0 -489
  74. package/docs/sdks/messaging/README.md +0 -647
  75. package/docs/sdks/metadata/README.md +0 -507
  76. package/docs/sdks/model/README.md +0 -165
  77. package/docs/sdks/note/README.md +0 -489
  78. package/docs/sdks/order/README.md +0 -489
  79. package/docs/sdks/organization/README.md +0 -647
  80. package/docs/sdks/package/README.md +0 -165
  81. package/docs/sdks/page/README.md +0 -507
  82. package/docs/sdks/passthrough/README.md +0 -647
  83. package/docs/sdks/payment/README.md +0 -1769
  84. package/docs/sdks/payout/README.md +0 -165
  85. package/docs/sdks/payslip/README.md +0 -165
  86. package/docs/sdks/person/README.md +0 -85
  87. package/docs/sdks/pipeline/README.md +0 -489
  88. package/docs/sdks/profitloss/README.md +0 -165
  89. package/docs/sdks/project/README.md +0 -489
  90. package/docs/sdks/prompt/README.md +0 -87
  91. package/docs/sdks/pullrequest/README.md +0 -489
  92. package/docs/sdks/purchaseorder/README.md +0 -489
  93. package/docs/sdks/recording/README.md +0 -647
  94. package/docs/sdks/refund/README.md +0 -165
  95. package/docs/sdks/repo/README.md +0 -2459
  96. package/docs/sdks/report/README.md +0 -165
  97. package/docs/sdks/repository/README.md +0 -501
  98. package/docs/sdks/request/README.md +0 -489
  99. package/docs/sdks/review/README.md +0 -501
  100. package/docs/sdks/salesorder/README.md +0 -489
  101. package/docs/sdks/scim/README.md +0 -983
  102. package/docs/sdks/scorecard/README.md +0 -489
  103. package/docs/sdks/space/README.md +0 -501
  104. package/docs/sdks/storage/README.md +0 -489
  105. package/docs/sdks/student/README.md +0 -489
  106. package/docs/sdks/subscription/README.md +0 -489
  107. package/docs/sdks/task/README.md +0 -1629
  108. package/docs/sdks/taxrate/README.md +0 -489
  109. package/docs/sdks/ticket/README.md +0 -489
  110. package/docs/sdks/ticketing/README.md +0 -1935
  111. package/docs/sdks/timeoff/README.md +0 -165
  112. package/docs/sdks/timeshift/README.md +0 -513
  113. package/docs/sdks/transaction/README.md +0 -489
  114. package/docs/sdks/trialbalance/README.md +0 -165
  115. package/docs/sdks/uc/README.md +0 -1543
  116. package/docs/sdks/unified/README.md +0 -1697
  117. package/docs/sdks/user/README.md +0 -489
  118. package/docs/sdks/verification/README.md +0 -647
  119. package/docs/sdks/webhook/README.md +0 -655
  120. package/examples/README.md +0 -31
@@ -1,1629 +0,0 @@
1
- # Task
2
- (*task*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createTaskComment](#createtaskcomment) - Create a comment
9
- * [createTaskProject](#createtaskproject) - Create a project
10
- * [createTaskTask](#createtasktask) - Create a task
11
- * [getTaskChange](#gettaskchange) - Retrieve a change
12
- * [getTaskComment](#gettaskcomment) - Retrieve a comment
13
- * [getTaskProject](#gettaskproject) - Retrieve a project
14
- * [getTaskTask](#gettasktask) - Retrieve a task
15
- * [listTaskChanges](#listtaskchanges) - List all changes
16
- * [listTaskComments](#listtaskcomments) - List all comments
17
- * [listTaskProjects](#listtaskprojects) - List all projects
18
- * [listTaskTasks](#listtasktasks) - List all tasks
19
- * [patchTaskComment](#patchtaskcomment) - Update a comment
20
- * [patchTaskProject](#patchtaskproject) - Update a project
21
- * [patchTaskTask](#patchtasktask) - Update a task
22
- * [removeTaskComment](#removetaskcomment) - Remove a comment
23
- * [removeTaskProject](#removetaskproject) - Remove a project
24
- * [removeTaskTask](#removetasktask) - Remove a task
25
- * [updateTaskComment](#updatetaskcomment) - Update a comment
26
- * [updateTaskProject](#updatetaskproject) - Update a project
27
- * [updateTaskTask](#updatetasktask) - Update a task
28
-
29
- ## createTaskComment
30
-
31
- Create a comment
32
-
33
- ### Example Usage
34
-
35
- <!-- UsageSnippet language="typescript" operationID="createTaskComment" method="post" path="/task/{connection_id}/comment" -->
36
- ```typescript
37
- import { UnifiedTo } from "@unified-api/typescript-sdk";
38
-
39
- const unifiedTo = new UnifiedTo({
40
- security: {
41
- jwt: "<YOUR_API_KEY_HERE>",
42
- },
43
- });
44
-
45
- async function run() {
46
- const result = await unifiedTo.task.createTaskComment({
47
- taskComment: {
48
- taskId: "<id>",
49
- text: "<value>",
50
- },
51
- connectionId: "<id>",
52
- });
53
-
54
- console.log(result);
55
- }
56
-
57
- run();
58
- ```
59
-
60
- ### Standalone function
61
-
62
- The standalone function version of this method:
63
-
64
- ```typescript
65
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
66
- import { commentCreateTaskComment } from "@unified-api/typescript-sdk/funcs/commentCreateTaskComment.js";
67
-
68
- // Use `UnifiedToCore` for best tree-shaking performance.
69
- // You can create one instance of it to use across an application.
70
- const unifiedTo = new UnifiedToCore({
71
- security: {
72
- jwt: "<YOUR_API_KEY_HERE>",
73
- },
74
- });
75
-
76
- async function run() {
77
- const res = await commentCreateTaskComment(unifiedTo, {
78
- taskComment: {
79
- taskId: "<id>",
80
- text: "<value>",
81
- },
82
- connectionId: "<id>",
83
- });
84
- if (res.ok) {
85
- const { value: result } = res;
86
- console.log(result);
87
- } else {
88
- console.log("commentCreateTaskComment failed:", res.error);
89
- }
90
- }
91
-
92
- run();
93
- ```
94
-
95
- ### Parameters
96
-
97
- | Parameter | Type | Required | Description |
98
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
99
- | `request` | [operations.CreateTaskCommentRequest](../../sdk/models/operations/createtaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
100
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
101
- | `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. |
102
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
103
-
104
- ### Response
105
-
106
- **Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
107
-
108
- ### Errors
109
-
110
- | Error Type | Status Code | Content Type |
111
- | --------------- | --------------- | --------------- |
112
- | errors.SDKError | 4XX, 5XX | \*/\* |
113
-
114
- ## createTaskProject
115
-
116
- Create a project
117
-
118
- ### Example Usage
119
-
120
- <!-- UsageSnippet language="typescript" operationID="createTaskProject" method="post" path="/task/{connection_id}/project" -->
121
- ```typescript
122
- import { UnifiedTo } from "@unified-api/typescript-sdk";
123
-
124
- const unifiedTo = new UnifiedTo({
125
- security: {
126
- jwt: "<YOUR_API_KEY_HERE>",
127
- },
128
- });
129
-
130
- async function run() {
131
- const result = await unifiedTo.task.createTaskProject({
132
- taskProject: {},
133
- connectionId: "<id>",
134
- });
135
-
136
- console.log(result);
137
- }
138
-
139
- run();
140
- ```
141
-
142
- ### Standalone function
143
-
144
- The standalone function version of this method:
145
-
146
- ```typescript
147
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
148
- import { taskCreateTaskProject } from "@unified-api/typescript-sdk/funcs/taskCreateTaskProject.js";
149
-
150
- // Use `UnifiedToCore` for best tree-shaking performance.
151
- // You can create one instance of it to use across an application.
152
- const unifiedTo = new UnifiedToCore({
153
- security: {
154
- jwt: "<YOUR_API_KEY_HERE>",
155
- },
156
- });
157
-
158
- async function run() {
159
- const res = await taskCreateTaskProject(unifiedTo, {
160
- taskProject: {},
161
- connectionId: "<id>",
162
- });
163
- if (res.ok) {
164
- const { value: result } = res;
165
- console.log(result);
166
- } else {
167
- console.log("taskCreateTaskProject failed:", res.error);
168
- }
169
- }
170
-
171
- run();
172
- ```
173
-
174
- ### Parameters
175
-
176
- | Parameter | Type | Required | Description |
177
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
178
- | `request` | [operations.CreateTaskProjectRequest](../../sdk/models/operations/createtaskprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
179
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
180
- | `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. |
181
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
182
-
183
- ### Response
184
-
185
- **Promise\<[shared.TaskProject](../../sdk/models/shared/taskproject.md)\>**
186
-
187
- ### Errors
188
-
189
- | Error Type | Status Code | Content Type |
190
- | --------------- | --------------- | --------------- |
191
- | errors.SDKError | 4XX, 5XX | \*/\* |
192
-
193
- ## createTaskTask
194
-
195
- Create a task
196
-
197
- ### Example Usage
198
-
199
- <!-- UsageSnippet language="typescript" operationID="createTaskTask" method="post" path="/task/{connection_id}/task" -->
200
- ```typescript
201
- import { UnifiedTo } from "@unified-api/typescript-sdk";
202
-
203
- const unifiedTo = new UnifiedTo({
204
- security: {
205
- jwt: "<YOUR_API_KEY_HERE>",
206
- },
207
- });
208
-
209
- async function run() {
210
- const result = await unifiedTo.task.createTaskTask({
211
- taskTask: {},
212
- connectionId: "<id>",
213
- });
214
-
215
- console.log(result);
216
- }
217
-
218
- run();
219
- ```
220
-
221
- ### Standalone function
222
-
223
- The standalone function version of this method:
224
-
225
- ```typescript
226
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
227
- import { taskCreateTaskTask } from "@unified-api/typescript-sdk/funcs/taskCreateTaskTask.js";
228
-
229
- // Use `UnifiedToCore` for best tree-shaking performance.
230
- // You can create one instance of it to use across an application.
231
- const unifiedTo = new UnifiedToCore({
232
- security: {
233
- jwt: "<YOUR_API_KEY_HERE>",
234
- },
235
- });
236
-
237
- async function run() {
238
- const res = await taskCreateTaskTask(unifiedTo, {
239
- taskTask: {},
240
- connectionId: "<id>",
241
- });
242
- if (res.ok) {
243
- const { value: result } = res;
244
- console.log(result);
245
- } else {
246
- console.log("taskCreateTaskTask failed:", res.error);
247
- }
248
- }
249
-
250
- run();
251
- ```
252
-
253
- ### Parameters
254
-
255
- | Parameter | Type | Required | Description |
256
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
257
- | `request` | [operations.CreateTaskTaskRequest](../../sdk/models/operations/createtasktaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
258
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
259
- | `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. |
260
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
261
-
262
- ### Response
263
-
264
- **Promise\<[shared.TaskTask](../../sdk/models/shared/tasktask.md)\>**
265
-
266
- ### Errors
267
-
268
- | Error Type | Status Code | Content Type |
269
- | --------------- | --------------- | --------------- |
270
- | errors.SDKError | 4XX, 5XX | \*/\* |
271
-
272
- ## getTaskChange
273
-
274
- Retrieve a change
275
-
276
- ### Example Usage
277
-
278
- <!-- UsageSnippet language="typescript" operationID="getTaskChange" method="get" path="/task/{connection_id}/change/{id}" -->
279
- ```typescript
280
- import { UnifiedTo } from "@unified-api/typescript-sdk";
281
-
282
- const unifiedTo = new UnifiedTo({
283
- security: {
284
- jwt: "<YOUR_API_KEY_HERE>",
285
- },
286
- });
287
-
288
- async function run() {
289
- const result = await unifiedTo.task.getTaskChange({
290
- connectionId: "<id>",
291
- id: "<id>",
292
- });
293
-
294
- console.log(result);
295
- }
296
-
297
- run();
298
- ```
299
-
300
- ### Standalone function
301
-
302
- The standalone function version of this method:
303
-
304
- ```typescript
305
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
306
- import { taskGetTaskChange } from "@unified-api/typescript-sdk/funcs/taskGetTaskChange.js";
307
-
308
- // Use `UnifiedToCore` for best tree-shaking performance.
309
- // You can create one instance of it to use across an application.
310
- const unifiedTo = new UnifiedToCore({
311
- security: {
312
- jwt: "<YOUR_API_KEY_HERE>",
313
- },
314
- });
315
-
316
- async function run() {
317
- const res = await taskGetTaskChange(unifiedTo, {
318
- connectionId: "<id>",
319
- id: "<id>",
320
- });
321
- if (res.ok) {
322
- const { value: result } = res;
323
- console.log(result);
324
- } else {
325
- console.log("taskGetTaskChange failed:", res.error);
326
- }
327
- }
328
-
329
- run();
330
- ```
331
-
332
- ### Parameters
333
-
334
- | Parameter | Type | Required | Description |
335
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
336
- | `request` | [operations.GetTaskChangeRequest](../../sdk/models/operations/gettaskchangerequest.md) | :heavy_check_mark: | The request object to use for the request. |
337
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
338
- | `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. |
339
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
340
-
341
- ### Response
342
-
343
- **Promise\<[shared.TaskChange](../../sdk/models/shared/taskchange.md)\>**
344
-
345
- ### Errors
346
-
347
- | Error Type | Status Code | Content Type |
348
- | --------------- | --------------- | --------------- |
349
- | errors.SDKError | 4XX, 5XX | \*/\* |
350
-
351
- ## getTaskComment
352
-
353
- Retrieve a comment
354
-
355
- ### Example Usage
356
-
357
- <!-- UsageSnippet language="typescript" operationID="getTaskComment" method="get" path="/task/{connection_id}/comment/{id}" -->
358
- ```typescript
359
- import { UnifiedTo } from "@unified-api/typescript-sdk";
360
-
361
- const unifiedTo = new UnifiedTo({
362
- security: {
363
- jwt: "<YOUR_API_KEY_HERE>",
364
- },
365
- });
366
-
367
- async function run() {
368
- const result = await unifiedTo.task.getTaskComment({
369
- connectionId: "<id>",
370
- id: "<id>",
371
- });
372
-
373
- console.log(result);
374
- }
375
-
376
- run();
377
- ```
378
-
379
- ### Standalone function
380
-
381
- The standalone function version of this method:
382
-
383
- ```typescript
384
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
385
- import { commentGetTaskComment } from "@unified-api/typescript-sdk/funcs/commentGetTaskComment.js";
386
-
387
- // Use `UnifiedToCore` for best tree-shaking performance.
388
- // You can create one instance of it to use across an application.
389
- const unifiedTo = new UnifiedToCore({
390
- security: {
391
- jwt: "<YOUR_API_KEY_HERE>",
392
- },
393
- });
394
-
395
- async function run() {
396
- const res = await commentGetTaskComment(unifiedTo, {
397
- connectionId: "<id>",
398
- id: "<id>",
399
- });
400
- if (res.ok) {
401
- const { value: result } = res;
402
- console.log(result);
403
- } else {
404
- console.log("commentGetTaskComment failed:", res.error);
405
- }
406
- }
407
-
408
- run();
409
- ```
410
-
411
- ### Parameters
412
-
413
- | Parameter | Type | Required | Description |
414
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
415
- | `request` | [operations.GetTaskCommentRequest](../../sdk/models/operations/gettaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
416
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
417
- | `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. |
418
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
419
-
420
- ### Response
421
-
422
- **Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
423
-
424
- ### Errors
425
-
426
- | Error Type | Status Code | Content Type |
427
- | --------------- | --------------- | --------------- |
428
- | errors.SDKError | 4XX, 5XX | \*/\* |
429
-
430
- ## getTaskProject
431
-
432
- Retrieve a project
433
-
434
- ### Example Usage
435
-
436
- <!-- UsageSnippet language="typescript" operationID="getTaskProject" method="get" path="/task/{connection_id}/project/{id}" -->
437
- ```typescript
438
- import { UnifiedTo } from "@unified-api/typescript-sdk";
439
-
440
- const unifiedTo = new UnifiedTo({
441
- security: {
442
- jwt: "<YOUR_API_KEY_HERE>",
443
- },
444
- });
445
-
446
- async function run() {
447
- const result = await unifiedTo.task.getTaskProject({
448
- connectionId: "<id>",
449
- id: "<id>",
450
- });
451
-
452
- console.log(result);
453
- }
454
-
455
- run();
456
- ```
457
-
458
- ### Standalone function
459
-
460
- The standalone function version of this method:
461
-
462
- ```typescript
463
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
464
- import { taskGetTaskProject } from "@unified-api/typescript-sdk/funcs/taskGetTaskProject.js";
465
-
466
- // Use `UnifiedToCore` for best tree-shaking performance.
467
- // You can create one instance of it to use across an application.
468
- const unifiedTo = new UnifiedToCore({
469
- security: {
470
- jwt: "<YOUR_API_KEY_HERE>",
471
- },
472
- });
473
-
474
- async function run() {
475
- const res = await taskGetTaskProject(unifiedTo, {
476
- connectionId: "<id>",
477
- id: "<id>",
478
- });
479
- if (res.ok) {
480
- const { value: result } = res;
481
- console.log(result);
482
- } else {
483
- console.log("taskGetTaskProject failed:", res.error);
484
- }
485
- }
486
-
487
- run();
488
- ```
489
-
490
- ### Parameters
491
-
492
- | Parameter | Type | Required | Description |
493
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
494
- | `request` | [operations.GetTaskProjectRequest](../../sdk/models/operations/gettaskprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
495
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
496
- | `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. |
497
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
498
-
499
- ### Response
500
-
501
- **Promise\<[shared.TaskProject](../../sdk/models/shared/taskproject.md)\>**
502
-
503
- ### Errors
504
-
505
- | Error Type | Status Code | Content Type |
506
- | --------------- | --------------- | --------------- |
507
- | errors.SDKError | 4XX, 5XX | \*/\* |
508
-
509
- ## getTaskTask
510
-
511
- Retrieve a task
512
-
513
- ### Example Usage
514
-
515
- <!-- UsageSnippet language="typescript" operationID="getTaskTask" method="get" path="/task/{connection_id}/task/{id}" -->
516
- ```typescript
517
- import { UnifiedTo } from "@unified-api/typescript-sdk";
518
-
519
- const unifiedTo = new UnifiedTo({
520
- security: {
521
- jwt: "<YOUR_API_KEY_HERE>",
522
- },
523
- });
524
-
525
- async function run() {
526
- const result = await unifiedTo.task.getTaskTask({
527
- connectionId: "<id>",
528
- id: "<id>",
529
- });
530
-
531
- console.log(result);
532
- }
533
-
534
- run();
535
- ```
536
-
537
- ### Standalone function
538
-
539
- The standalone function version of this method:
540
-
541
- ```typescript
542
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
543
- import { taskGetTaskTask } from "@unified-api/typescript-sdk/funcs/taskGetTaskTask.js";
544
-
545
- // Use `UnifiedToCore` for best tree-shaking performance.
546
- // You can create one instance of it to use across an application.
547
- const unifiedTo = new UnifiedToCore({
548
- security: {
549
- jwt: "<YOUR_API_KEY_HERE>",
550
- },
551
- });
552
-
553
- async function run() {
554
- const res = await taskGetTaskTask(unifiedTo, {
555
- connectionId: "<id>",
556
- id: "<id>",
557
- });
558
- if (res.ok) {
559
- const { value: result } = res;
560
- console.log(result);
561
- } else {
562
- console.log("taskGetTaskTask failed:", res.error);
563
- }
564
- }
565
-
566
- run();
567
- ```
568
-
569
- ### Parameters
570
-
571
- | Parameter | Type | Required | Description |
572
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
573
- | `request` | [operations.GetTaskTaskRequest](../../sdk/models/operations/gettasktaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
574
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
575
- | `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. |
576
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
577
-
578
- ### Response
579
-
580
- **Promise\<[shared.TaskTask](../../sdk/models/shared/tasktask.md)\>**
581
-
582
- ### Errors
583
-
584
- | Error Type | Status Code | Content Type |
585
- | --------------- | --------------- | --------------- |
586
- | errors.SDKError | 4XX, 5XX | \*/\* |
587
-
588
- ## listTaskChanges
589
-
590
- List all changes
591
-
592
- ### Example Usage
593
-
594
- <!-- UsageSnippet language="typescript" operationID="listTaskChanges" method="get" path="/task/{connection_id}/change" -->
595
- ```typescript
596
- import { UnifiedTo } from "@unified-api/typescript-sdk";
597
-
598
- const unifiedTo = new UnifiedTo({
599
- security: {
600
- jwt: "<YOUR_API_KEY_HERE>",
601
- },
602
- });
603
-
604
- async function run() {
605
- const result = await unifiedTo.task.listTaskChanges({
606
- connectionId: "<id>",
607
- });
608
-
609
- console.log(result);
610
- }
611
-
612
- run();
613
- ```
614
-
615
- ### Standalone function
616
-
617
- The standalone function version of this method:
618
-
619
- ```typescript
620
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
621
- import { taskListTaskChanges } from "@unified-api/typescript-sdk/funcs/taskListTaskChanges.js";
622
-
623
- // Use `UnifiedToCore` for best tree-shaking performance.
624
- // You can create one instance of it to use across an application.
625
- const unifiedTo = new UnifiedToCore({
626
- security: {
627
- jwt: "<YOUR_API_KEY_HERE>",
628
- },
629
- });
630
-
631
- async function run() {
632
- const res = await taskListTaskChanges(unifiedTo, {
633
- connectionId: "<id>",
634
- });
635
- if (res.ok) {
636
- const { value: result } = res;
637
- console.log(result);
638
- } else {
639
- console.log("taskListTaskChanges failed:", res.error);
640
- }
641
- }
642
-
643
- run();
644
- ```
645
-
646
- ### Parameters
647
-
648
- | Parameter | Type | Required | Description |
649
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
650
- | `request` | [operations.ListTaskChangesRequest](../../sdk/models/operations/listtaskchangesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
651
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
652
- | `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. |
653
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
654
-
655
- ### Response
656
-
657
- **Promise\<[shared.TaskChange[]](../../models/.md)\>**
658
-
659
- ### Errors
660
-
661
- | Error Type | Status Code | Content Type |
662
- | --------------- | --------------- | --------------- |
663
- | errors.SDKError | 4XX, 5XX | \*/\* |
664
-
665
- ## listTaskComments
666
-
667
- List all comments
668
-
669
- ### Example Usage
670
-
671
- <!-- UsageSnippet language="typescript" operationID="listTaskComments" method="get" path="/task/{connection_id}/comment" -->
672
- ```typescript
673
- import { UnifiedTo } from "@unified-api/typescript-sdk";
674
-
675
- const unifiedTo = new UnifiedTo({
676
- security: {
677
- jwt: "<YOUR_API_KEY_HERE>",
678
- },
679
- });
680
-
681
- async function run() {
682
- const result = await unifiedTo.task.listTaskComments({
683
- connectionId: "<id>",
684
- });
685
-
686
- console.log(result);
687
- }
688
-
689
- run();
690
- ```
691
-
692
- ### Standalone function
693
-
694
- The standalone function version of this method:
695
-
696
- ```typescript
697
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
698
- import { commentListTaskComments } from "@unified-api/typescript-sdk/funcs/commentListTaskComments.js";
699
-
700
- // Use `UnifiedToCore` for best tree-shaking performance.
701
- // You can create one instance of it to use across an application.
702
- const unifiedTo = new UnifiedToCore({
703
- security: {
704
- jwt: "<YOUR_API_KEY_HERE>",
705
- },
706
- });
707
-
708
- async function run() {
709
- const res = await commentListTaskComments(unifiedTo, {
710
- connectionId: "<id>",
711
- });
712
- if (res.ok) {
713
- const { value: result } = res;
714
- console.log(result);
715
- } else {
716
- console.log("commentListTaskComments failed:", res.error);
717
- }
718
- }
719
-
720
- run();
721
- ```
722
-
723
- ### Parameters
724
-
725
- | Parameter | Type | Required | Description |
726
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
727
- | `request` | [operations.ListTaskCommentsRequest](../../sdk/models/operations/listtaskcommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
728
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
729
- | `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. |
730
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
731
-
732
- ### Response
733
-
734
- **Promise\<[shared.TaskComment[]](../../models/.md)\>**
735
-
736
- ### Errors
737
-
738
- | Error Type | Status Code | Content Type |
739
- | --------------- | --------------- | --------------- |
740
- | errors.SDKError | 4XX, 5XX | \*/\* |
741
-
742
- ## listTaskProjects
743
-
744
- List all projects
745
-
746
- ### Example Usage
747
-
748
- <!-- UsageSnippet language="typescript" operationID="listTaskProjects" method="get" path="/task/{connection_id}/project" -->
749
- ```typescript
750
- import { UnifiedTo } from "@unified-api/typescript-sdk";
751
-
752
- const unifiedTo = new UnifiedTo({
753
- security: {
754
- jwt: "<YOUR_API_KEY_HERE>",
755
- },
756
- });
757
-
758
- async function run() {
759
- const result = await unifiedTo.task.listTaskProjects({
760
- connectionId: "<id>",
761
- });
762
-
763
- console.log(result);
764
- }
765
-
766
- run();
767
- ```
768
-
769
- ### Standalone function
770
-
771
- The standalone function version of this method:
772
-
773
- ```typescript
774
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
775
- import { taskListTaskProjects } from "@unified-api/typescript-sdk/funcs/taskListTaskProjects.js";
776
-
777
- // Use `UnifiedToCore` for best tree-shaking performance.
778
- // You can create one instance of it to use across an application.
779
- const unifiedTo = new UnifiedToCore({
780
- security: {
781
- jwt: "<YOUR_API_KEY_HERE>",
782
- },
783
- });
784
-
785
- async function run() {
786
- const res = await taskListTaskProjects(unifiedTo, {
787
- connectionId: "<id>",
788
- });
789
- if (res.ok) {
790
- const { value: result } = res;
791
- console.log(result);
792
- } else {
793
- console.log("taskListTaskProjects failed:", res.error);
794
- }
795
- }
796
-
797
- run();
798
- ```
799
-
800
- ### Parameters
801
-
802
- | Parameter | Type | Required | Description |
803
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
804
- | `request` | [operations.ListTaskProjectsRequest](../../sdk/models/operations/listtaskprojectsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
805
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
806
- | `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. |
807
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
808
-
809
- ### Response
810
-
811
- **Promise\<[shared.TaskProject[]](../../models/.md)\>**
812
-
813
- ### Errors
814
-
815
- | Error Type | Status Code | Content Type |
816
- | --------------- | --------------- | --------------- |
817
- | errors.SDKError | 4XX, 5XX | \*/\* |
818
-
819
- ## listTaskTasks
820
-
821
- List all tasks
822
-
823
- ### Example Usage
824
-
825
- <!-- UsageSnippet language="typescript" operationID="listTaskTasks" method="get" path="/task/{connection_id}/task" -->
826
- ```typescript
827
- import { UnifiedTo } from "@unified-api/typescript-sdk";
828
-
829
- const unifiedTo = new UnifiedTo({
830
- security: {
831
- jwt: "<YOUR_API_KEY_HERE>",
832
- },
833
- });
834
-
835
- async function run() {
836
- const result = await unifiedTo.task.listTaskTasks({
837
- connectionId: "<id>",
838
- });
839
-
840
- console.log(result);
841
- }
842
-
843
- run();
844
- ```
845
-
846
- ### Standalone function
847
-
848
- The standalone function version of this method:
849
-
850
- ```typescript
851
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
852
- import { taskListTaskTasks } from "@unified-api/typescript-sdk/funcs/taskListTaskTasks.js";
853
-
854
- // Use `UnifiedToCore` for best tree-shaking performance.
855
- // You can create one instance of it to use across an application.
856
- const unifiedTo = new UnifiedToCore({
857
- security: {
858
- jwt: "<YOUR_API_KEY_HERE>",
859
- },
860
- });
861
-
862
- async function run() {
863
- const res = await taskListTaskTasks(unifiedTo, {
864
- connectionId: "<id>",
865
- });
866
- if (res.ok) {
867
- const { value: result } = res;
868
- console.log(result);
869
- } else {
870
- console.log("taskListTaskTasks failed:", res.error);
871
- }
872
- }
873
-
874
- run();
875
- ```
876
-
877
- ### Parameters
878
-
879
- | Parameter | Type | Required | Description |
880
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
881
- | `request` | [operations.ListTaskTasksRequest](../../sdk/models/operations/listtasktasksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
882
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
883
- | `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. |
884
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
885
-
886
- ### Response
887
-
888
- **Promise\<[shared.TaskTask[]](../../models/.md)\>**
889
-
890
- ### Errors
891
-
892
- | Error Type | Status Code | Content Type |
893
- | --------------- | --------------- | --------------- |
894
- | errors.SDKError | 4XX, 5XX | \*/\* |
895
-
896
- ## patchTaskComment
897
-
898
- Update a comment
899
-
900
- ### Example Usage
901
-
902
- <!-- UsageSnippet language="typescript" operationID="patchTaskComment" method="patch" path="/task/{connection_id}/comment/{id}" -->
903
- ```typescript
904
- import { UnifiedTo } from "@unified-api/typescript-sdk";
905
-
906
- const unifiedTo = new UnifiedTo({
907
- security: {
908
- jwt: "<YOUR_API_KEY_HERE>",
909
- },
910
- });
911
-
912
- async function run() {
913
- const result = await unifiedTo.task.patchTaskComment({
914
- taskComment: {
915
- taskId: "<id>",
916
- text: "<value>",
917
- },
918
- connectionId: "<id>",
919
- id: "<id>",
920
- });
921
-
922
- console.log(result);
923
- }
924
-
925
- run();
926
- ```
927
-
928
- ### Standalone function
929
-
930
- The standalone function version of this method:
931
-
932
- ```typescript
933
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
934
- import { commentPatchTaskComment } from "@unified-api/typescript-sdk/funcs/commentPatchTaskComment.js";
935
-
936
- // Use `UnifiedToCore` for best tree-shaking performance.
937
- // You can create one instance of it to use across an application.
938
- const unifiedTo = new UnifiedToCore({
939
- security: {
940
- jwt: "<YOUR_API_KEY_HERE>",
941
- },
942
- });
943
-
944
- async function run() {
945
- const res = await commentPatchTaskComment(unifiedTo, {
946
- taskComment: {
947
- taskId: "<id>",
948
- text: "<value>",
949
- },
950
- connectionId: "<id>",
951
- id: "<id>",
952
- });
953
- if (res.ok) {
954
- const { value: result } = res;
955
- console.log(result);
956
- } else {
957
- console.log("commentPatchTaskComment failed:", res.error);
958
- }
959
- }
960
-
961
- run();
962
- ```
963
-
964
- ### Parameters
965
-
966
- | Parameter | Type | Required | Description |
967
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
968
- | `request` | [operations.PatchTaskCommentRequest](../../sdk/models/operations/patchtaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
969
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
970
- | `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. |
971
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
972
-
973
- ### Response
974
-
975
- **Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
976
-
977
- ### Errors
978
-
979
- | Error Type | Status Code | Content Type |
980
- | --------------- | --------------- | --------------- |
981
- | errors.SDKError | 4XX, 5XX | \*/\* |
982
-
983
- ## patchTaskProject
984
-
985
- Update a project
986
-
987
- ### Example Usage
988
-
989
- <!-- UsageSnippet language="typescript" operationID="patchTaskProject" method="patch" path="/task/{connection_id}/project/{id}" -->
990
- ```typescript
991
- import { UnifiedTo } from "@unified-api/typescript-sdk";
992
-
993
- const unifiedTo = new UnifiedTo({
994
- security: {
995
- jwt: "<YOUR_API_KEY_HERE>",
996
- },
997
- });
998
-
999
- async function run() {
1000
- const result = await unifiedTo.task.patchTaskProject({
1001
- taskProject: {},
1002
- connectionId: "<id>",
1003
- id: "<id>",
1004
- });
1005
-
1006
- console.log(result);
1007
- }
1008
-
1009
- run();
1010
- ```
1011
-
1012
- ### Standalone function
1013
-
1014
- The standalone function version of this method:
1015
-
1016
- ```typescript
1017
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1018
- import { taskPatchTaskProject } from "@unified-api/typescript-sdk/funcs/taskPatchTaskProject.js";
1019
-
1020
- // Use `UnifiedToCore` for best tree-shaking performance.
1021
- // You can create one instance of it to use across an application.
1022
- const unifiedTo = new UnifiedToCore({
1023
- security: {
1024
- jwt: "<YOUR_API_KEY_HERE>",
1025
- },
1026
- });
1027
-
1028
- async function run() {
1029
- const res = await taskPatchTaskProject(unifiedTo, {
1030
- taskProject: {},
1031
- connectionId: "<id>",
1032
- id: "<id>",
1033
- });
1034
- if (res.ok) {
1035
- const { value: result } = res;
1036
- console.log(result);
1037
- } else {
1038
- console.log("taskPatchTaskProject failed:", res.error);
1039
- }
1040
- }
1041
-
1042
- run();
1043
- ```
1044
-
1045
- ### Parameters
1046
-
1047
- | Parameter | Type | Required | Description |
1048
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1049
- | `request` | [operations.PatchTaskProjectRequest](../../sdk/models/operations/patchtaskprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1050
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1051
- | `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. |
1052
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1053
-
1054
- ### Response
1055
-
1056
- **Promise\<[shared.TaskProject](../../sdk/models/shared/taskproject.md)\>**
1057
-
1058
- ### Errors
1059
-
1060
- | Error Type | Status Code | Content Type |
1061
- | --------------- | --------------- | --------------- |
1062
- | errors.SDKError | 4XX, 5XX | \*/\* |
1063
-
1064
- ## patchTaskTask
1065
-
1066
- Update a task
1067
-
1068
- ### Example Usage
1069
-
1070
- <!-- UsageSnippet language="typescript" operationID="patchTaskTask" method="patch" path="/task/{connection_id}/task/{id}" -->
1071
- ```typescript
1072
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1073
-
1074
- const unifiedTo = new UnifiedTo({
1075
- security: {
1076
- jwt: "<YOUR_API_KEY_HERE>",
1077
- },
1078
- });
1079
-
1080
- async function run() {
1081
- const result = await unifiedTo.task.patchTaskTask({
1082
- taskTask: {},
1083
- connectionId: "<id>",
1084
- id: "<id>",
1085
- });
1086
-
1087
- console.log(result);
1088
- }
1089
-
1090
- run();
1091
- ```
1092
-
1093
- ### Standalone function
1094
-
1095
- The standalone function version of this method:
1096
-
1097
- ```typescript
1098
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1099
- import { taskPatchTaskTask } from "@unified-api/typescript-sdk/funcs/taskPatchTaskTask.js";
1100
-
1101
- // Use `UnifiedToCore` for best tree-shaking performance.
1102
- // You can create one instance of it to use across an application.
1103
- const unifiedTo = new UnifiedToCore({
1104
- security: {
1105
- jwt: "<YOUR_API_KEY_HERE>",
1106
- },
1107
- });
1108
-
1109
- async function run() {
1110
- const res = await taskPatchTaskTask(unifiedTo, {
1111
- taskTask: {},
1112
- connectionId: "<id>",
1113
- id: "<id>",
1114
- });
1115
- if (res.ok) {
1116
- const { value: result } = res;
1117
- console.log(result);
1118
- } else {
1119
- console.log("taskPatchTaskTask failed:", res.error);
1120
- }
1121
- }
1122
-
1123
- run();
1124
- ```
1125
-
1126
- ### Parameters
1127
-
1128
- | Parameter | Type | Required | Description |
1129
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1130
- | `request` | [operations.PatchTaskTaskRequest](../../sdk/models/operations/patchtasktaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1131
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1132
- | `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. |
1133
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1134
-
1135
- ### Response
1136
-
1137
- **Promise\<[shared.TaskTask](../../sdk/models/shared/tasktask.md)\>**
1138
-
1139
- ### Errors
1140
-
1141
- | Error Type | Status Code | Content Type |
1142
- | --------------- | --------------- | --------------- |
1143
- | errors.SDKError | 4XX, 5XX | \*/\* |
1144
-
1145
- ## removeTaskComment
1146
-
1147
- Remove a comment
1148
-
1149
- ### Example Usage
1150
-
1151
- <!-- UsageSnippet language="typescript" operationID="removeTaskComment" method="delete" path="/task/{connection_id}/comment/{id}" -->
1152
- ```typescript
1153
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1154
-
1155
- const unifiedTo = new UnifiedTo({
1156
- security: {
1157
- jwt: "<YOUR_API_KEY_HERE>",
1158
- },
1159
- });
1160
-
1161
- async function run() {
1162
- const result = await unifiedTo.task.removeTaskComment({
1163
- connectionId: "<id>",
1164
- id: "<id>",
1165
- });
1166
-
1167
- console.log(result);
1168
- }
1169
-
1170
- run();
1171
- ```
1172
-
1173
- ### Standalone function
1174
-
1175
- The standalone function version of this method:
1176
-
1177
- ```typescript
1178
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1179
- import { commentRemoveTaskComment } from "@unified-api/typescript-sdk/funcs/commentRemoveTaskComment.js";
1180
-
1181
- // Use `UnifiedToCore` for best tree-shaking performance.
1182
- // You can create one instance of it to use across an application.
1183
- const unifiedTo = new UnifiedToCore({
1184
- security: {
1185
- jwt: "<YOUR_API_KEY_HERE>",
1186
- },
1187
- });
1188
-
1189
- async function run() {
1190
- const res = await commentRemoveTaskComment(unifiedTo, {
1191
- connectionId: "<id>",
1192
- id: "<id>",
1193
- });
1194
- if (res.ok) {
1195
- const { value: result } = res;
1196
- console.log(result);
1197
- } else {
1198
- console.log("commentRemoveTaskComment failed:", res.error);
1199
- }
1200
- }
1201
-
1202
- run();
1203
- ```
1204
-
1205
- ### Parameters
1206
-
1207
- | Parameter | Type | Required | Description |
1208
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1209
- | `request` | [operations.RemoveTaskCommentRequest](../../sdk/models/operations/removetaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1210
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1211
- | `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. |
1212
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1213
-
1214
- ### Response
1215
-
1216
- **Promise\<[operations.RemoveTaskCommentResponse](../../sdk/models/operations/removetaskcommentresponse.md)\>**
1217
-
1218
- ### Errors
1219
-
1220
- | Error Type | Status Code | Content Type |
1221
- | --------------- | --------------- | --------------- |
1222
- | errors.SDKError | 4XX, 5XX | \*/\* |
1223
-
1224
- ## removeTaskProject
1225
-
1226
- Remove a project
1227
-
1228
- ### Example Usage
1229
-
1230
- <!-- UsageSnippet language="typescript" operationID="removeTaskProject" method="delete" path="/task/{connection_id}/project/{id}" -->
1231
- ```typescript
1232
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1233
-
1234
- const unifiedTo = new UnifiedTo({
1235
- security: {
1236
- jwt: "<YOUR_API_KEY_HERE>",
1237
- },
1238
- });
1239
-
1240
- async function run() {
1241
- const result = await unifiedTo.task.removeTaskProject({
1242
- connectionId: "<id>",
1243
- id: "<id>",
1244
- });
1245
-
1246
- console.log(result);
1247
- }
1248
-
1249
- run();
1250
- ```
1251
-
1252
- ### Standalone function
1253
-
1254
- The standalone function version of this method:
1255
-
1256
- ```typescript
1257
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1258
- import { taskRemoveTaskProject } from "@unified-api/typescript-sdk/funcs/taskRemoveTaskProject.js";
1259
-
1260
- // Use `UnifiedToCore` for best tree-shaking performance.
1261
- // You can create one instance of it to use across an application.
1262
- const unifiedTo = new UnifiedToCore({
1263
- security: {
1264
- jwt: "<YOUR_API_KEY_HERE>",
1265
- },
1266
- });
1267
-
1268
- async function run() {
1269
- const res = await taskRemoveTaskProject(unifiedTo, {
1270
- connectionId: "<id>",
1271
- id: "<id>",
1272
- });
1273
- if (res.ok) {
1274
- const { value: result } = res;
1275
- console.log(result);
1276
- } else {
1277
- console.log("taskRemoveTaskProject failed:", res.error);
1278
- }
1279
- }
1280
-
1281
- run();
1282
- ```
1283
-
1284
- ### Parameters
1285
-
1286
- | Parameter | Type | Required | Description |
1287
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1288
- | `request` | [operations.RemoveTaskProjectRequest](../../sdk/models/operations/removetaskprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1289
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1290
- | `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. |
1291
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1292
-
1293
- ### Response
1294
-
1295
- **Promise\<[operations.RemoveTaskProjectResponse](../../sdk/models/operations/removetaskprojectresponse.md)\>**
1296
-
1297
- ### Errors
1298
-
1299
- | Error Type | Status Code | Content Type |
1300
- | --------------- | --------------- | --------------- |
1301
- | errors.SDKError | 4XX, 5XX | \*/\* |
1302
-
1303
- ## removeTaskTask
1304
-
1305
- Remove a task
1306
-
1307
- ### Example Usage
1308
-
1309
- <!-- UsageSnippet language="typescript" operationID="removeTaskTask" method="delete" path="/task/{connection_id}/task/{id}" -->
1310
- ```typescript
1311
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1312
-
1313
- const unifiedTo = new UnifiedTo({
1314
- security: {
1315
- jwt: "<YOUR_API_KEY_HERE>",
1316
- },
1317
- });
1318
-
1319
- async function run() {
1320
- const result = await unifiedTo.task.removeTaskTask({
1321
- connectionId: "<id>",
1322
- id: "<id>",
1323
- });
1324
-
1325
- console.log(result);
1326
- }
1327
-
1328
- run();
1329
- ```
1330
-
1331
- ### Standalone function
1332
-
1333
- The standalone function version of this method:
1334
-
1335
- ```typescript
1336
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1337
- import { taskRemoveTaskTask } from "@unified-api/typescript-sdk/funcs/taskRemoveTaskTask.js";
1338
-
1339
- // Use `UnifiedToCore` for best tree-shaking performance.
1340
- // You can create one instance of it to use across an application.
1341
- const unifiedTo = new UnifiedToCore({
1342
- security: {
1343
- jwt: "<YOUR_API_KEY_HERE>",
1344
- },
1345
- });
1346
-
1347
- async function run() {
1348
- const res = await taskRemoveTaskTask(unifiedTo, {
1349
- connectionId: "<id>",
1350
- id: "<id>",
1351
- });
1352
- if (res.ok) {
1353
- const { value: result } = res;
1354
- console.log(result);
1355
- } else {
1356
- console.log("taskRemoveTaskTask failed:", res.error);
1357
- }
1358
- }
1359
-
1360
- run();
1361
- ```
1362
-
1363
- ### Parameters
1364
-
1365
- | Parameter | Type | Required | Description |
1366
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1367
- | `request` | [operations.RemoveTaskTaskRequest](../../sdk/models/operations/removetasktaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1368
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1369
- | `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. |
1370
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1371
-
1372
- ### Response
1373
-
1374
- **Promise\<[operations.RemoveTaskTaskResponse](../../sdk/models/operations/removetasktaskresponse.md)\>**
1375
-
1376
- ### Errors
1377
-
1378
- | Error Type | Status Code | Content Type |
1379
- | --------------- | --------------- | --------------- |
1380
- | errors.SDKError | 4XX, 5XX | \*/\* |
1381
-
1382
- ## updateTaskComment
1383
-
1384
- Update a comment
1385
-
1386
- ### Example Usage
1387
-
1388
- <!-- UsageSnippet language="typescript" operationID="updateTaskComment" method="put" path="/task/{connection_id}/comment/{id}" -->
1389
- ```typescript
1390
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1391
-
1392
- const unifiedTo = new UnifiedTo({
1393
- security: {
1394
- jwt: "<YOUR_API_KEY_HERE>",
1395
- },
1396
- });
1397
-
1398
- async function run() {
1399
- const result = await unifiedTo.task.updateTaskComment({
1400
- taskComment: {
1401
- taskId: "<id>",
1402
- text: "<value>",
1403
- },
1404
- connectionId: "<id>",
1405
- id: "<id>",
1406
- });
1407
-
1408
- console.log(result);
1409
- }
1410
-
1411
- run();
1412
- ```
1413
-
1414
- ### Standalone function
1415
-
1416
- The standalone function version of this method:
1417
-
1418
- ```typescript
1419
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1420
- import { commentUpdateTaskComment } from "@unified-api/typescript-sdk/funcs/commentUpdateTaskComment.js";
1421
-
1422
- // Use `UnifiedToCore` for best tree-shaking performance.
1423
- // You can create one instance of it to use across an application.
1424
- const unifiedTo = new UnifiedToCore({
1425
- security: {
1426
- jwt: "<YOUR_API_KEY_HERE>",
1427
- },
1428
- });
1429
-
1430
- async function run() {
1431
- const res = await commentUpdateTaskComment(unifiedTo, {
1432
- taskComment: {
1433
- taskId: "<id>",
1434
- text: "<value>",
1435
- },
1436
- connectionId: "<id>",
1437
- id: "<id>",
1438
- });
1439
- if (res.ok) {
1440
- const { value: result } = res;
1441
- console.log(result);
1442
- } else {
1443
- console.log("commentUpdateTaskComment failed:", res.error);
1444
- }
1445
- }
1446
-
1447
- run();
1448
- ```
1449
-
1450
- ### Parameters
1451
-
1452
- | Parameter | Type | Required | Description |
1453
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1454
- | `request` | [operations.UpdateTaskCommentRequest](../../sdk/models/operations/updatetaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1455
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1456
- | `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. |
1457
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1458
-
1459
- ### Response
1460
-
1461
- **Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
1462
-
1463
- ### Errors
1464
-
1465
- | Error Type | Status Code | Content Type |
1466
- | --------------- | --------------- | --------------- |
1467
- | errors.SDKError | 4XX, 5XX | \*/\* |
1468
-
1469
- ## updateTaskProject
1470
-
1471
- Update a project
1472
-
1473
- ### Example Usage
1474
-
1475
- <!-- UsageSnippet language="typescript" operationID="updateTaskProject" method="put" path="/task/{connection_id}/project/{id}" -->
1476
- ```typescript
1477
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1478
-
1479
- const unifiedTo = new UnifiedTo({
1480
- security: {
1481
- jwt: "<YOUR_API_KEY_HERE>",
1482
- },
1483
- });
1484
-
1485
- async function run() {
1486
- const result = await unifiedTo.task.updateTaskProject({
1487
- taskProject: {},
1488
- connectionId: "<id>",
1489
- id: "<id>",
1490
- });
1491
-
1492
- console.log(result);
1493
- }
1494
-
1495
- run();
1496
- ```
1497
-
1498
- ### Standalone function
1499
-
1500
- The standalone function version of this method:
1501
-
1502
- ```typescript
1503
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1504
- import { taskUpdateTaskProject } from "@unified-api/typescript-sdk/funcs/taskUpdateTaskProject.js";
1505
-
1506
- // Use `UnifiedToCore` for best tree-shaking performance.
1507
- // You can create one instance of it to use across an application.
1508
- const unifiedTo = new UnifiedToCore({
1509
- security: {
1510
- jwt: "<YOUR_API_KEY_HERE>",
1511
- },
1512
- });
1513
-
1514
- async function run() {
1515
- const res = await taskUpdateTaskProject(unifiedTo, {
1516
- taskProject: {},
1517
- connectionId: "<id>",
1518
- id: "<id>",
1519
- });
1520
- if (res.ok) {
1521
- const { value: result } = res;
1522
- console.log(result);
1523
- } else {
1524
- console.log("taskUpdateTaskProject failed:", res.error);
1525
- }
1526
- }
1527
-
1528
- run();
1529
- ```
1530
-
1531
- ### Parameters
1532
-
1533
- | Parameter | Type | Required | Description |
1534
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1535
- | `request` | [operations.UpdateTaskProjectRequest](../../sdk/models/operations/updatetaskprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1536
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1537
- | `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. |
1538
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1539
-
1540
- ### Response
1541
-
1542
- **Promise\<[shared.TaskProject](../../sdk/models/shared/taskproject.md)\>**
1543
-
1544
- ### Errors
1545
-
1546
- | Error Type | Status Code | Content Type |
1547
- | --------------- | --------------- | --------------- |
1548
- | errors.SDKError | 4XX, 5XX | \*/\* |
1549
-
1550
- ## updateTaskTask
1551
-
1552
- Update a task
1553
-
1554
- ### Example Usage
1555
-
1556
- <!-- UsageSnippet language="typescript" operationID="updateTaskTask" method="put" path="/task/{connection_id}/task/{id}" -->
1557
- ```typescript
1558
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1559
-
1560
- const unifiedTo = new UnifiedTo({
1561
- security: {
1562
- jwt: "<YOUR_API_KEY_HERE>",
1563
- },
1564
- });
1565
-
1566
- async function run() {
1567
- const result = await unifiedTo.task.updateTaskTask({
1568
- taskTask: {},
1569
- connectionId: "<id>",
1570
- id: "<id>",
1571
- });
1572
-
1573
- console.log(result);
1574
- }
1575
-
1576
- run();
1577
- ```
1578
-
1579
- ### Standalone function
1580
-
1581
- The standalone function version of this method:
1582
-
1583
- ```typescript
1584
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1585
- import { taskUpdateTaskTask } from "@unified-api/typescript-sdk/funcs/taskUpdateTaskTask.js";
1586
-
1587
- // Use `UnifiedToCore` for best tree-shaking performance.
1588
- // You can create one instance of it to use across an application.
1589
- const unifiedTo = new UnifiedToCore({
1590
- security: {
1591
- jwt: "<YOUR_API_KEY_HERE>",
1592
- },
1593
- });
1594
-
1595
- async function run() {
1596
- const res = await taskUpdateTaskTask(unifiedTo, {
1597
- taskTask: {},
1598
- connectionId: "<id>",
1599
- id: "<id>",
1600
- });
1601
- if (res.ok) {
1602
- const { value: result } = res;
1603
- console.log(result);
1604
- } else {
1605
- console.log("taskUpdateTaskTask failed:", res.error);
1606
- }
1607
- }
1608
-
1609
- run();
1610
- ```
1611
-
1612
- ### Parameters
1613
-
1614
- | Parameter | Type | Required | Description |
1615
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1616
- | `request` | [operations.UpdateTaskTaskRequest](../../sdk/models/operations/updatetasktaskrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1617
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1618
- | `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. |
1619
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1620
-
1621
- ### Response
1622
-
1623
- **Promise\<[shared.TaskTask](../../sdk/models/shared/tasktask.md)\>**
1624
-
1625
- ### Errors
1626
-
1627
- | Error Type | Status Code | Content Type |
1628
- | --------------- | --------------- | --------------- |
1629
- | errors.SDKError | 4XX, 5XX | \*/\* |