@unified-api/typescript-sdk 2.9.15 → 2.9.17

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 (152) hide show
  1. package/README.md +12 -0
  2. package/docs/sdks/comment/README.md +501 -0
  3. package/docs/sdks/task/README.md +494 -0
  4. package/funcs/commentCreateTaskComment.d.ts +13 -0
  5. package/funcs/commentCreateTaskComment.d.ts.map +1 -0
  6. package/funcs/commentCreateTaskComment.js +103 -0
  7. package/funcs/commentCreateTaskComment.js.map +1 -0
  8. package/funcs/commentGetTaskComment.d.ts +13 -0
  9. package/funcs/commentGetTaskComment.d.ts.map +1 -0
  10. package/funcs/commentGetTaskComment.js +106 -0
  11. package/funcs/commentGetTaskComment.js.map +1 -0
  12. package/funcs/commentListTaskComments.d.ts +13 -0
  13. package/funcs/commentListTaskComments.d.ts.map +1 -0
  14. package/funcs/commentListTaskComments.js +110 -0
  15. package/funcs/commentListTaskComments.js.map +1 -0
  16. package/funcs/commentPatchTaskComment.d.ts +13 -0
  17. package/funcs/commentPatchTaskComment.d.ts.map +1 -0
  18. package/funcs/commentPatchTaskComment.js +107 -0
  19. package/funcs/commentPatchTaskComment.js.map +1 -0
  20. package/funcs/commentRemoveTaskComment.d.ts +12 -0
  21. package/funcs/commentRemoveTaskComment.d.ts.map +1 -0
  22. package/funcs/commentRemoveTaskComment.js +104 -0
  23. package/funcs/commentRemoveTaskComment.js.map +1 -0
  24. package/funcs/commentUpdateTaskComment.d.ts +13 -0
  25. package/funcs/commentUpdateTaskComment.d.ts.map +1 -0
  26. package/funcs/commentUpdateTaskComment.js +107 -0
  27. package/funcs/commentUpdateTaskComment.js.map +1 -0
  28. package/funcs/taskCreateTaskComment.d.ts +13 -0
  29. package/funcs/taskCreateTaskComment.d.ts.map +1 -0
  30. package/funcs/taskCreateTaskComment.js +103 -0
  31. package/funcs/taskCreateTaskComment.js.map +1 -0
  32. package/funcs/taskGetTaskComment.d.ts +13 -0
  33. package/funcs/taskGetTaskComment.d.ts.map +1 -0
  34. package/funcs/taskGetTaskComment.js +106 -0
  35. package/funcs/taskGetTaskComment.js.map +1 -0
  36. package/funcs/taskListTaskComments.d.ts +13 -0
  37. package/funcs/taskListTaskComments.d.ts.map +1 -0
  38. package/funcs/taskListTaskComments.js +110 -0
  39. package/funcs/taskListTaskComments.js.map +1 -0
  40. package/funcs/taskPatchTaskComment.d.ts +13 -0
  41. package/funcs/taskPatchTaskComment.d.ts.map +1 -0
  42. package/funcs/taskPatchTaskComment.js +107 -0
  43. package/funcs/taskPatchTaskComment.js.map +1 -0
  44. package/funcs/taskRemoveTaskComment.d.ts +12 -0
  45. package/funcs/taskRemoveTaskComment.d.ts.map +1 -0
  46. package/funcs/taskRemoveTaskComment.js +104 -0
  47. package/funcs/taskRemoveTaskComment.js.map +1 -0
  48. package/funcs/taskUpdateTaskComment.d.ts +13 -0
  49. package/funcs/taskUpdateTaskComment.d.ts.map +1 -0
  50. package/funcs/taskUpdateTaskComment.js +107 -0
  51. package/funcs/taskUpdateTaskComment.js.map +1 -0
  52. package/lib/config.d.ts +3 -3
  53. package/lib/config.js +3 -3
  54. package/package.json +1 -1
  55. package/sdk/comment.d.ts +30 -0
  56. package/sdk/comment.d.ts.map +1 -0
  57. package/sdk/comment.js +54 -0
  58. package/sdk/comment.js.map +1 -0
  59. package/sdk/models/operations/createtaskcomment.d.ts +40 -0
  60. package/sdk/models/operations/createtaskcomment.d.ts.map +1 -0
  61. package/sdk/models/operations/createtaskcomment.js +75 -0
  62. package/sdk/models/operations/createtaskcomment.js.map +1 -0
  63. package/sdk/models/operations/gettaskcomment.d.ts +42 -0
  64. package/sdk/models/operations/gettaskcomment.d.ts.map +1 -0
  65. package/sdk/models/operations/gettaskcomment.js +72 -0
  66. package/sdk/models/operations/gettaskcomment.js.map +1 -0
  67. package/sdk/models/operations/getunifiedintegrationauth.d.ts +6 -0
  68. package/sdk/models/operations/getunifiedintegrationauth.d.ts.map +1 -1
  69. package/sdk/models/operations/getunifiedintegrationauth.js +2 -0
  70. package/sdk/models/operations/getunifiedintegrationauth.js.map +1 -1
  71. package/sdk/models/operations/index.d.ts +6 -0
  72. package/sdk/models/operations/index.d.ts.map +1 -1
  73. package/sdk/models/operations/index.js +6 -0
  74. package/sdk/models/operations/index.js.map +1 -1
  75. package/sdk/models/operations/listtaskcomments.d.ts +57 -0
  76. package/sdk/models/operations/listtaskcomments.d.ts.map +1 -0
  77. package/sdk/models/operations/listtaskcomments.js +89 -0
  78. package/sdk/models/operations/listtaskcomments.js.map +1 -0
  79. package/sdk/models/operations/patchtaskcomment.d.ts +45 -0
  80. package/sdk/models/operations/patchtaskcomment.d.ts.map +1 -0
  81. package/sdk/models/operations/patchtaskcomment.js +77 -0
  82. package/sdk/models/operations/patchtaskcomment.js.map +1 -0
  83. package/sdk/models/operations/removetaskcomment.d.ts +66 -0
  84. package/sdk/models/operations/removetaskcomment.d.ts.map +1 -0
  85. package/sdk/models/operations/removetaskcomment.js +105 -0
  86. package/sdk/models/operations/removetaskcomment.js.map +1 -0
  87. package/sdk/models/operations/updatetaskcomment.d.ts +45 -0
  88. package/sdk/models/operations/updatetaskcomment.d.ts.map +1 -0
  89. package/sdk/models/operations/updatetaskcomment.js +77 -0
  90. package/sdk/models/operations/updatetaskcomment.js.map +1 -0
  91. package/sdk/models/shared/index.d.ts +1 -0
  92. package/sdk/models/shared/index.d.ts.map +1 -1
  93. package/sdk/models/shared/index.js +1 -0
  94. package/sdk/models/shared/index.js.map +1 -1
  95. package/sdk/models/shared/kmspage.d.ts +2 -2
  96. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  97. package/sdk/models/shared/kmspage.js +2 -2
  98. package/sdk/models/shared/kmspage.js.map +1 -1
  99. package/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -0
  100. package/sdk/models/shared/propertyconnectionpermissions.d.ts.map +1 -1
  101. package/sdk/models/shared/propertyconnectionpermissions.js +2 -0
  102. package/sdk/models/shared/propertyconnectionpermissions.js.map +1 -1
  103. package/sdk/models/shared/taskcomment.d.ts +47 -0
  104. package/sdk/models/shared/taskcomment.d.ts.map +1 -0
  105. package/sdk/models/shared/taskcomment.js +92 -0
  106. package/sdk/models/shared/taskcomment.js.map +1 -0
  107. package/sdk/models/shared/tasktask.d.ts +5 -0
  108. package/sdk/models/shared/tasktask.d.ts.map +1 -1
  109. package/sdk/models/shared/tasktask.js +4 -0
  110. package/sdk/models/shared/tasktask.js.map +1 -1
  111. package/sdk/models/shared/webhook.d.ts +3 -0
  112. package/sdk/models/shared/webhook.d.ts.map +1 -1
  113. package/sdk/models/shared/webhook.js +1 -0
  114. package/sdk/models/shared/webhook.js.map +1 -1
  115. package/sdk/sdk.d.ts +3 -0
  116. package/sdk/sdk.d.ts.map +1 -1
  117. package/sdk/sdk.js +4 -0
  118. package/sdk/sdk.js.map +1 -1
  119. package/sdk/task.d.ts +24 -0
  120. package/sdk/task.d.ts.map +1 -1
  121. package/sdk/task.js +42 -0
  122. package/sdk/task.js.map +1 -1
  123. package/src/funcs/commentCreateTaskComment.ts +133 -0
  124. package/src/funcs/commentGetTaskComment.ts +136 -0
  125. package/src/funcs/commentListTaskComments.ts +140 -0
  126. package/src/funcs/commentPatchTaskComment.ts +137 -0
  127. package/src/funcs/commentRemoveTaskComment.ts +139 -0
  128. package/src/funcs/commentUpdateTaskComment.ts +137 -0
  129. package/src/funcs/taskCreateTaskComment.ts +133 -0
  130. package/src/funcs/taskGetTaskComment.ts +136 -0
  131. package/src/funcs/taskListTaskComments.ts +140 -0
  132. package/src/funcs/taskPatchTaskComment.ts +137 -0
  133. package/src/funcs/taskRemoveTaskComment.ts +139 -0
  134. package/src/funcs/taskUpdateTaskComment.ts +137 -0
  135. package/src/lib/config.ts +3 -3
  136. package/src/sdk/comment.ts +100 -0
  137. package/src/sdk/models/operations/createtaskcomment.ts +92 -0
  138. package/src/sdk/models/operations/gettaskcomment.ts +92 -0
  139. package/src/sdk/models/operations/getunifiedintegrationauth.ts +2 -0
  140. package/src/sdk/models/operations/index.ts +6 -0
  141. package/src/sdk/models/operations/listtaskcomments.ts +124 -0
  142. package/src/sdk/models/operations/patchtaskcomment.ts +99 -0
  143. package/src/sdk/models/operations/removetaskcomment.ts +151 -0
  144. package/src/sdk/models/operations/updatetaskcomment.ts +99 -0
  145. package/src/sdk/models/shared/index.ts +1 -0
  146. package/src/sdk/models/shared/kmspage.ts +4 -4
  147. package/src/sdk/models/shared/propertyconnectionpermissions.ts +2 -0
  148. package/src/sdk/models/shared/taskcomment.ts +109 -0
  149. package/src/sdk/models/shared/tasktask.ts +9 -0
  150. package/src/sdk/models/shared/webhook.ts +1 -0
  151. package/src/sdk/sdk.ts +6 -0
  152. package/src/sdk/task.ts +90 -0
@@ -18,6 +18,10 @@ export type TaskTaskStatus = ClosedEnum<typeof TaskTaskStatus>;
18
18
 
19
19
  export type TaskTask = {
20
20
  assignedUserIds?: Array<string> | undefined;
21
+ /**
22
+ * Array of attachment IDs retrieved from StorageFile.Get endpoint
23
+ */
24
+ attachmentIds?: Array<string> | undefined;
21
25
  completedAt?: Date | undefined;
22
26
  createdAt?: Date | undefined;
23
27
  creatorUserId?: string | undefined;
@@ -65,6 +69,7 @@ export const TaskTask$inboundSchema: z.ZodType<
65
69
  unknown
66
70
  > = z.object({
67
71
  assigned_user_ids: z.array(z.string()).optional(),
72
+ attachment_ids: z.array(z.string()).optional(),
68
73
  completed_at: z.string().datetime({ offset: true }).transform(v =>
69
74
  new Date(v)
70
75
  ).optional(),
@@ -90,6 +95,7 @@ export const TaskTask$inboundSchema: z.ZodType<
90
95
  }).transform((v) => {
91
96
  return remap$(v, {
92
97
  "assigned_user_ids": "assignedUserIds",
98
+ "attachment_ids": "attachmentIds",
93
99
  "completed_at": "completedAt",
94
100
  "created_at": "createdAt",
95
101
  "creator_user_id": "creatorUserId",
@@ -105,6 +111,7 @@ export const TaskTask$inboundSchema: z.ZodType<
105
111
  /** @internal */
106
112
  export type TaskTask$Outbound = {
107
113
  assigned_user_ids?: Array<string> | undefined;
114
+ attachment_ids?: Array<string> | undefined;
108
115
  completed_at?: string | undefined;
109
116
  created_at?: string | undefined;
110
117
  creator_user_id?: string | undefined;
@@ -131,6 +138,7 @@ export const TaskTask$outboundSchema: z.ZodType<
131
138
  TaskTask
132
139
  > = z.object({
133
140
  assignedUserIds: z.array(z.string()).optional(),
141
+ attachmentIds: z.array(z.string()).optional(),
134
142
  completedAt: z.date().transform(v => v.toISOString()).optional(),
135
143
  createdAt: z.date().transform(v => v.toISOString()).optional(),
136
144
  creatorUserId: z.string().optional(),
@@ -151,6 +159,7 @@ export const TaskTask$outboundSchema: z.ZodType<
151
159
  }).transform((v) => {
152
160
  return remap$(v, {
153
161
  assignedUserIds: "assigned_user_ids",
162
+ attachmentIds: "attachment_ids",
154
163
  completedAt: "completed_at",
155
164
  createdAt: "created_at",
156
165
  creatorUserId: "creator_user_id",
@@ -74,6 +74,7 @@ export const ObjectType = {
74
74
  KmsPage: "kms_page",
75
75
  TaskProject: "task_project",
76
76
  TaskTask: "task_task",
77
+ TaskComment: "task_comment",
77
78
  ScimUsers: "scim_users",
78
79
  ScimGroups: "scim_groups",
79
80
  LmsCourse: "lms_course",
package/src/sdk/sdk.ts CHANGED
@@ -17,6 +17,7 @@ import { Candidate } from "./candidate.js";
17
17
  import { Channel } from "./channel.js";
18
18
  import { Class } from "./class.js";
19
19
  import { Collection } from "./collection.js";
20
+ import { Comment } from "./comment.js";
20
21
  import { Commerce } from "./commerce.js";
21
22
  import { Commit } from "./commit.js";
22
23
  import { Company } from "./company.js";
@@ -440,6 +441,11 @@ export class UnifiedTo extends ClientSDK {
440
441
  return (this._task ??= new Task(this._options));
441
442
  }
442
443
 
444
+ private _comment?: Comment;
445
+ get comment(): Comment {
446
+ return (this._comment ??= new Comment(this._options));
447
+ }
448
+
443
449
  private _project?: Project;
444
450
  get project(): Project {
445
451
  return (this._project ??= new Project(this._options));
package/src/sdk/task.ts CHANGED
@@ -2,16 +2,22 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
+ import { taskCreateTaskComment } from "../funcs/taskCreateTaskComment.js";
5
6
  import { taskCreateTaskProject } from "../funcs/taskCreateTaskProject.js";
6
7
  import { taskCreateTaskTask } from "../funcs/taskCreateTaskTask.js";
8
+ import { taskGetTaskComment } from "../funcs/taskGetTaskComment.js";
7
9
  import { taskGetTaskProject } from "../funcs/taskGetTaskProject.js";
8
10
  import { taskGetTaskTask } from "../funcs/taskGetTaskTask.js";
11
+ import { taskListTaskComments } from "../funcs/taskListTaskComments.js";
9
12
  import { taskListTaskProjects } from "../funcs/taskListTaskProjects.js";
10
13
  import { taskListTaskTasks } from "../funcs/taskListTaskTasks.js";
14
+ import { taskPatchTaskComment } from "../funcs/taskPatchTaskComment.js";
11
15
  import { taskPatchTaskProject } from "../funcs/taskPatchTaskProject.js";
12
16
  import { taskPatchTaskTask } from "../funcs/taskPatchTaskTask.js";
17
+ import { taskRemoveTaskComment } from "../funcs/taskRemoveTaskComment.js";
13
18
  import { taskRemoveTaskProject } from "../funcs/taskRemoveTaskProject.js";
14
19
  import { taskRemoveTaskTask } from "../funcs/taskRemoveTaskTask.js";
20
+ import { taskUpdateTaskComment } from "../funcs/taskUpdateTaskComment.js";
15
21
  import { taskUpdateTaskProject } from "../funcs/taskUpdateTaskProject.js";
16
22
  import { taskUpdateTaskTask } from "../funcs/taskUpdateTaskTask.js";
17
23
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -20,6 +26,20 @@ import * as shared from "./models/shared/index.js";
20
26
  import { unwrapAsync } from "./types/fp.js";
21
27
 
22
28
  export class Task extends ClientSDK {
29
+ /**
30
+ * Create a comment
31
+ */
32
+ async createTaskComment(
33
+ request: operations.CreateTaskCommentRequest,
34
+ options?: RequestOptions,
35
+ ): Promise<shared.TaskComment> {
36
+ return unwrapAsync(taskCreateTaskComment(
37
+ this,
38
+ request,
39
+ options,
40
+ ));
41
+ }
42
+
23
43
  /**
24
44
  * Create a project
25
45
  */
@@ -48,6 +68,20 @@ export class Task extends ClientSDK {
48
68
  ));
49
69
  }
50
70
 
71
+ /**
72
+ * Retrieve a comment
73
+ */
74
+ async getTaskComment(
75
+ request: operations.GetTaskCommentRequest,
76
+ options?: RequestOptions,
77
+ ): Promise<shared.TaskComment> {
78
+ return unwrapAsync(taskGetTaskComment(
79
+ this,
80
+ request,
81
+ options,
82
+ ));
83
+ }
84
+
51
85
  /**
52
86
  * Retrieve a project
53
87
  */
@@ -76,6 +110,20 @@ export class Task extends ClientSDK {
76
110
  ));
77
111
  }
78
112
 
113
+ /**
114
+ * List all comments
115
+ */
116
+ async listTaskComments(
117
+ request: operations.ListTaskCommentsRequest,
118
+ options?: RequestOptions,
119
+ ): Promise<Array<shared.TaskComment>> {
120
+ return unwrapAsync(taskListTaskComments(
121
+ this,
122
+ request,
123
+ options,
124
+ ));
125
+ }
126
+
79
127
  /**
80
128
  * List all projects
81
129
  */
@@ -104,6 +152,20 @@ export class Task extends ClientSDK {
104
152
  ));
105
153
  }
106
154
 
155
+ /**
156
+ * Update a comment
157
+ */
158
+ async patchTaskComment(
159
+ request: operations.PatchTaskCommentRequest,
160
+ options?: RequestOptions,
161
+ ): Promise<shared.TaskComment> {
162
+ return unwrapAsync(taskPatchTaskComment(
163
+ this,
164
+ request,
165
+ options,
166
+ ));
167
+ }
168
+
107
169
  /**
108
170
  * Update a project
109
171
  */
@@ -132,6 +194,20 @@ export class Task extends ClientSDK {
132
194
  ));
133
195
  }
134
196
 
197
+ /**
198
+ * Remove a comment
199
+ */
200
+ async removeTaskComment(
201
+ request: operations.RemoveTaskCommentRequest,
202
+ options?: RequestOptions,
203
+ ): Promise<operations.RemoveTaskCommentResponse | undefined> {
204
+ return unwrapAsync(taskRemoveTaskComment(
205
+ this,
206
+ request,
207
+ options,
208
+ ));
209
+ }
210
+
135
211
  /**
136
212
  * Remove a project
137
213
  */
@@ -160,6 +236,20 @@ export class Task extends ClientSDK {
160
236
  ));
161
237
  }
162
238
 
239
+ /**
240
+ * Update a comment
241
+ */
242
+ async updateTaskComment(
243
+ request: operations.UpdateTaskCommentRequest,
244
+ options?: RequestOptions,
245
+ ): Promise<shared.TaskComment> {
246
+ return unwrapAsync(taskUpdateTaskComment(
247
+ this,
248
+ request,
249
+ options,
250
+ ));
251
+ }
252
+
163
253
  /**
164
254
  * Update a project
165
255
  */