@shortcut/client 1.1.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +32 -39
- package/lib/ShortcutClient.d.mts +10 -0
- package/lib/ShortcutClient.d.ts +8 -3
- package/lib/ShortcutClient.js +2177 -13
- package/lib/ShortcutClient.mjs +2141 -0
- package/lib/generated/Api.d.mts +1415 -0
- package/lib/generated/Api.d.ts +511 -138
- package/lib/generated/Api.js +2163 -1030
- package/lib/generated/Api.mjs +2128 -0
- package/lib/generated/data-contracts.d.mts +5860 -0
- package/lib/generated/data-contracts.d.ts +1024 -462
- package/lib/generated/data-contracts.js +17 -11
- package/lib/generated/data-contracts.mjs +0 -0
- package/lib/generated/http-client.d.mts +48 -0
- package/lib/generated/http-client.d.ts +11 -8
- package/lib/generated/http-client.js +131 -92
- package/lib/generated/http-client.mjs +101 -0
- package/lib/index.d.mts +5 -0
- package/lib/index.d.ts +5 -3
- package/lib/index.js +2176 -18
- package/lib/index.mjs +2142 -0
- package/package.json +63 -43
|
@@ -1,16 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
/** Request parameters for specifying how to pre-populate a task through a template. */
|
|
2
|
+
interface BaseTaskParams {
|
|
3
|
+
/**
|
|
4
|
+
* The Task description.
|
|
5
|
+
* @minLength 1
|
|
6
|
+
* @maxLength 2048
|
|
7
|
+
*/
|
|
8
|
+
description: string;
|
|
9
|
+
/** True/false boolean indicating whether the Task is completed. Defaults to false. */
|
|
10
|
+
complete?: boolean;
|
|
11
|
+
/** An array of UUIDs for any members you want to add as Owners on this new Task. */
|
|
12
|
+
owner_ids?: string[];
|
|
13
|
+
/**
|
|
14
|
+
* This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.
|
|
15
|
+
* @maxLength 128
|
|
16
|
+
*/
|
|
17
|
+
external_id?: string;
|
|
18
|
+
}
|
|
19
|
+
interface BasicWorkspaceInfo {
|
|
20
|
+
/** @format uuid */
|
|
21
|
+
id: string;
|
|
22
|
+
/** @format date-time */
|
|
23
|
+
created_at: string;
|
|
24
|
+
/** @format int64 */
|
|
25
|
+
default_workflow_id: number;
|
|
3
26
|
estimate_scale: number[];
|
|
27
|
+
name: string;
|
|
28
|
+
url_slug: string;
|
|
29
|
+
utc_offset: string;
|
|
4
30
|
}
|
|
5
31
|
/** Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories. */
|
|
6
|
-
|
|
32
|
+
interface Branch {
|
|
7
33
|
/** A string description of this resource. */
|
|
8
34
|
entity_type: string;
|
|
9
35
|
/** A true/false boolean indicating if the Branch has been deleted. */
|
|
10
36
|
deleted: boolean;
|
|
11
37
|
/** The name of the Branch. */
|
|
12
38
|
name: string;
|
|
13
|
-
/**
|
|
39
|
+
/** This field is deprecated, and will always be false. */
|
|
14
40
|
persistent: boolean;
|
|
15
41
|
/**
|
|
16
42
|
* The time/date the Branch was updated.
|
|
@@ -39,8 +65,8 @@ export interface Branch {
|
|
|
39
65
|
*/
|
|
40
66
|
created_at?: string | null;
|
|
41
67
|
}
|
|
42
|
-
/** A Category can be used to associate
|
|
43
|
-
|
|
68
|
+
/** A Category can be used to associate Objectives. */
|
|
69
|
+
interface Category {
|
|
44
70
|
/** A true/false boolean indicating if the Category has been archived. */
|
|
45
71
|
archived: boolean;
|
|
46
72
|
/** A string description of this resource. */
|
|
@@ -56,7 +82,7 @@ export interface Category {
|
|
|
56
82
|
name: string;
|
|
57
83
|
/** The Global ID of the Category. */
|
|
58
84
|
global_id: string;
|
|
59
|
-
/** The type of entity this Category is associated with; currently Milestone is the only type of Category. */
|
|
85
|
+
/** The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category. */
|
|
60
86
|
type: string;
|
|
61
87
|
/**
|
|
62
88
|
* The time/date that the Category was updated.
|
|
@@ -77,7 +103,7 @@ export interface Category {
|
|
|
77
103
|
created_at: string;
|
|
78
104
|
}
|
|
79
105
|
/** Commit refers to a VCS commit and all associated details. */
|
|
80
|
-
|
|
106
|
+
interface Commit {
|
|
81
107
|
/** A string description of this resource. */
|
|
82
108
|
entity_type: string;
|
|
83
109
|
/**
|
|
@@ -121,10 +147,11 @@ export interface Commit {
|
|
|
121
147
|
/** The Commit message. */
|
|
122
148
|
message: string;
|
|
123
149
|
}
|
|
124
|
-
|
|
150
|
+
interface CreateCategory {
|
|
125
151
|
/**
|
|
126
152
|
* The name of the new Category.
|
|
127
153
|
* @minLength 1
|
|
154
|
+
* @maxLength 128
|
|
128
155
|
*/
|
|
129
156
|
name: string;
|
|
130
157
|
/**
|
|
@@ -137,16 +164,18 @@ export interface CreateCategory {
|
|
|
137
164
|
/**
|
|
138
165
|
* This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.
|
|
139
166
|
* @minLength 1
|
|
167
|
+
* @maxLength 128
|
|
140
168
|
*/
|
|
141
169
|
external_id?: string;
|
|
142
|
-
/** The type of entity this Category is associated with; currently Milestone is the only type of Category. */
|
|
143
|
-
type
|
|
170
|
+
/** The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category. */
|
|
171
|
+
type?: any;
|
|
144
172
|
}
|
|
145
|
-
/** Request parameters for creating a Category with a
|
|
146
|
-
|
|
173
|
+
/** Request parameters for creating a Category with a Objective. */
|
|
174
|
+
interface CreateCategoryParams {
|
|
147
175
|
/**
|
|
148
176
|
* The name of the new Category.
|
|
149
177
|
* @minLength 1
|
|
178
|
+
* @maxLength 128
|
|
150
179
|
*/
|
|
151
180
|
name: string;
|
|
152
181
|
/**
|
|
@@ -159,10 +188,11 @@ export interface CreateCategoryParams {
|
|
|
159
188
|
/**
|
|
160
189
|
* This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.
|
|
161
190
|
* @minLength 1
|
|
191
|
+
* @maxLength 128
|
|
162
192
|
*/
|
|
163
193
|
external_id?: string;
|
|
164
194
|
}
|
|
165
|
-
|
|
195
|
+
interface CreateCommentComment {
|
|
166
196
|
/**
|
|
167
197
|
* The comment text.
|
|
168
198
|
* @minLength 1
|
|
@@ -184,14 +214,18 @@ export interface CreateCommentComment {
|
|
|
184
214
|
* @format date-time
|
|
185
215
|
*/
|
|
186
216
|
updated_at?: string;
|
|
187
|
-
/**
|
|
217
|
+
/**
|
|
218
|
+
* This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
|
|
219
|
+
* @maxLength 128
|
|
220
|
+
*/
|
|
188
221
|
external_id?: string;
|
|
189
222
|
}
|
|
190
|
-
/** Request
|
|
191
|
-
|
|
223
|
+
/** Request parameters for creating an entirely new entity template. */
|
|
224
|
+
interface CreateEntityTemplate {
|
|
192
225
|
/**
|
|
193
226
|
* The name of the new entity template
|
|
194
227
|
* @minLength 1
|
|
228
|
+
* @maxLength 128
|
|
195
229
|
*/
|
|
196
230
|
name: string;
|
|
197
231
|
/**
|
|
@@ -202,7 +236,7 @@ export interface CreateEntityTemplate {
|
|
|
202
236
|
/** A map of story attributes this template populates. */
|
|
203
237
|
story_contents: CreateStoryContents;
|
|
204
238
|
}
|
|
205
|
-
|
|
239
|
+
interface CreateEpic {
|
|
206
240
|
/**
|
|
207
241
|
* The Epic's description.
|
|
208
242
|
* @maxLength 100000
|
|
@@ -215,6 +249,8 @@ export interface CreateEpic {
|
|
|
215
249
|
* @format date-time
|
|
216
250
|
*/
|
|
217
251
|
completed_at_override?: string;
|
|
252
|
+
/** An array of IDs for Objectives to which this Epic is related. */
|
|
253
|
+
objective_ids?: number[];
|
|
218
254
|
/**
|
|
219
255
|
* The Epic's name.
|
|
220
256
|
* @minLength 1
|
|
@@ -227,9 +263,9 @@ export interface CreateEpic {
|
|
|
227
263
|
*/
|
|
228
264
|
planned_start_date?: string | null;
|
|
229
265
|
/** `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. */
|
|
230
|
-
state?:
|
|
266
|
+
state?: "in progress" | "to do" | "done";
|
|
231
267
|
/**
|
|
232
|
-
* The ID of the Milestone this Epic is related to.
|
|
268
|
+
* `Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.
|
|
233
269
|
* @format int64
|
|
234
270
|
*/
|
|
235
271
|
milestone_id?: number | null;
|
|
@@ -249,7 +285,7 @@ export interface CreateEpic {
|
|
|
249
285
|
*/
|
|
250
286
|
started_at_override?: string;
|
|
251
287
|
/**
|
|
252
|
-
* The ID of the group to associate with the epic.
|
|
288
|
+
* `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
|
|
253
289
|
* @format uuid
|
|
254
290
|
*/
|
|
255
291
|
group_id?: string | null;
|
|
@@ -260,9 +296,19 @@ export interface CreateEpic {
|
|
|
260
296
|
updated_at?: string;
|
|
261
297
|
/** An array of UUIDs for any Members you want to add as Followers on this new Epic. */
|
|
262
298
|
follower_ids?: string[];
|
|
299
|
+
/** An array of UUIDS for Groups to which this Epic is related. */
|
|
300
|
+
group_ids?: string[];
|
|
301
|
+
/**
|
|
302
|
+
* The ID of the Story that was converted to an Epic.
|
|
303
|
+
* @format int64
|
|
304
|
+
*/
|
|
305
|
+
converted_from_story_id?: number | null;
|
|
263
306
|
/** An array of UUIDs for any members you want to add as Owners on this new Epic. */
|
|
264
307
|
owner_ids?: string[];
|
|
265
|
-
/**
|
|
308
|
+
/**
|
|
309
|
+
* This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
|
|
310
|
+
* @maxLength 128
|
|
311
|
+
*/
|
|
266
312
|
external_id?: string;
|
|
267
313
|
/**
|
|
268
314
|
* The Epic's deadline.
|
|
@@ -275,7 +321,7 @@ export interface CreateEpic {
|
|
|
275
321
|
*/
|
|
276
322
|
created_at?: string;
|
|
277
323
|
}
|
|
278
|
-
|
|
324
|
+
interface CreateEpicComment {
|
|
279
325
|
/**
|
|
280
326
|
* The comment text.
|
|
281
327
|
* @minLength 1
|
|
@@ -297,11 +343,35 @@ export interface CreateEpicComment {
|
|
|
297
343
|
* @format date-time
|
|
298
344
|
*/
|
|
299
345
|
updated_at?: string;
|
|
300
|
-
/**
|
|
346
|
+
/**
|
|
347
|
+
* This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
|
|
348
|
+
* @maxLength 128
|
|
349
|
+
*/
|
|
301
350
|
external_id?: string;
|
|
302
351
|
}
|
|
303
|
-
|
|
304
|
-
/** The
|
|
352
|
+
interface CreateEpicHealth {
|
|
353
|
+
/** The health status of the Epic. */
|
|
354
|
+
status: "At Risk" | "On Track" | "Off Track" | "No Health";
|
|
355
|
+
/** The description of the Health status. */
|
|
356
|
+
text?: string;
|
|
357
|
+
}
|
|
358
|
+
interface CreateGenericIntegration {
|
|
359
|
+
/**
|
|
360
|
+
* @maxLength 2048
|
|
361
|
+
* @pattern ^https?://.+$
|
|
362
|
+
*/
|
|
363
|
+
webhook_url: string;
|
|
364
|
+
/**
|
|
365
|
+
* @minLength 1
|
|
366
|
+
* @maxLength 128
|
|
367
|
+
*/
|
|
368
|
+
secret?: string;
|
|
369
|
+
}
|
|
370
|
+
interface CreateGroup {
|
|
371
|
+
/**
|
|
372
|
+
* The description of the Group.
|
|
373
|
+
* @maxLength 4096
|
|
374
|
+
*/
|
|
305
375
|
description?: string;
|
|
306
376
|
/**
|
|
307
377
|
* The Member ids to add to this Group.
|
|
@@ -330,14 +400,14 @@ export interface CreateGroup {
|
|
|
330
400
|
*/
|
|
331
401
|
color?: string;
|
|
332
402
|
/** The color key you wish to use for the Group in the system. */
|
|
333
|
-
color_key?:
|
|
403
|
+
color_key?: "blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise";
|
|
334
404
|
/**
|
|
335
405
|
* The Icon id for the avatar of this Group.
|
|
336
406
|
* @format uuid
|
|
337
407
|
*/
|
|
338
408
|
display_icon_id?: string;
|
|
339
409
|
}
|
|
340
|
-
|
|
410
|
+
interface CreateIteration {
|
|
341
411
|
/** An array of UUIDs for any Members you want to add as Followers. */
|
|
342
412
|
follower_ids?: string[];
|
|
343
413
|
/** An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. */
|
|
@@ -367,14 +437,17 @@ export interface CreateIteration {
|
|
|
367
437
|
end_date: string;
|
|
368
438
|
}
|
|
369
439
|
/** Request parameters for creating a Label on a Shortcut Story. */
|
|
370
|
-
|
|
440
|
+
interface CreateLabelParams {
|
|
371
441
|
/**
|
|
372
442
|
* The name of the new Label.
|
|
373
443
|
* @minLength 1
|
|
374
444
|
* @maxLength 128
|
|
375
445
|
*/
|
|
376
446
|
name: string;
|
|
377
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* The description of the new Label.
|
|
449
|
+
* @maxLength 1024
|
|
450
|
+
*/
|
|
378
451
|
description?: string;
|
|
379
452
|
/**
|
|
380
453
|
* The hex color to be displayed with the Label (for example, "#ff0000").
|
|
@@ -386,11 +459,15 @@ export interface CreateLabelParams {
|
|
|
386
459
|
/**
|
|
387
460
|
* This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.
|
|
388
461
|
* @minLength 1
|
|
462
|
+
* @maxLength 128
|
|
389
463
|
*/
|
|
390
464
|
external_id?: string;
|
|
391
465
|
}
|
|
392
|
-
|
|
393
|
-
/**
|
|
466
|
+
interface CreateLinkedFile {
|
|
467
|
+
/**
|
|
468
|
+
* The description of the file.
|
|
469
|
+
* @maxLength 512
|
|
470
|
+
*/
|
|
394
471
|
description?: string;
|
|
395
472
|
/**
|
|
396
473
|
* The ID of the linked story.
|
|
@@ -410,7 +487,7 @@ export interface CreateLinkedFile {
|
|
|
410
487
|
*/
|
|
411
488
|
thumbnail_url?: string;
|
|
412
489
|
/** The integration type of the file (e.g. google, dropbox, box). */
|
|
413
|
-
type:
|
|
490
|
+
type: "google" | "url" | "dropbox" | "box" | "onedrive";
|
|
414
491
|
/**
|
|
415
492
|
* The filesize, if the integration provided it.
|
|
416
493
|
* @format int64
|
|
@@ -421,7 +498,10 @@ export interface CreateLinkedFile {
|
|
|
421
498
|
* @format uuid
|
|
422
499
|
*/
|
|
423
500
|
uploader_id?: string;
|
|
424
|
-
/**
|
|
501
|
+
/**
|
|
502
|
+
* The content type of the image (e.g. txt/plain).
|
|
503
|
+
* @maxLength 128
|
|
504
|
+
*/
|
|
425
505
|
content_type?: string;
|
|
426
506
|
/**
|
|
427
507
|
* The URL of linked file.
|
|
@@ -430,7 +510,7 @@ export interface CreateLinkedFile {
|
|
|
430
510
|
*/
|
|
431
511
|
url: string;
|
|
432
512
|
}
|
|
433
|
-
|
|
513
|
+
interface CreateMilestone {
|
|
434
514
|
/**
|
|
435
515
|
* The name of the Milestone.
|
|
436
516
|
* @minLength 1
|
|
@@ -443,7 +523,7 @@ export interface CreateMilestone {
|
|
|
443
523
|
*/
|
|
444
524
|
description?: string;
|
|
445
525
|
/** The workflow state that the Milestone is in. */
|
|
446
|
-
state?:
|
|
526
|
+
state?: "in progress" | "to do" | "done";
|
|
447
527
|
/**
|
|
448
528
|
* A manual override for the time/date the Milestone was started.
|
|
449
529
|
* @format date-time
|
|
@@ -457,11 +537,38 @@ export interface CreateMilestone {
|
|
|
457
537
|
/** An array of IDs of Categories attached to the Milestone. */
|
|
458
538
|
categories?: CreateCategoryParams[];
|
|
459
539
|
}
|
|
460
|
-
|
|
540
|
+
interface CreateObjective {
|
|
541
|
+
/**
|
|
542
|
+
* The name of the Objective.
|
|
543
|
+
* @minLength 1
|
|
544
|
+
* @maxLength 256
|
|
545
|
+
*/
|
|
546
|
+
name: string;
|
|
547
|
+
/**
|
|
548
|
+
* The Objective's description.
|
|
549
|
+
* @maxLength 100000
|
|
550
|
+
*/
|
|
551
|
+
description?: string;
|
|
552
|
+
/** The workflow state that the Objective is in. */
|
|
553
|
+
state?: "in progress" | "to do" | "done";
|
|
554
|
+
/**
|
|
555
|
+
* A manual override for the time/date the Objective was started.
|
|
556
|
+
* @format date-time
|
|
557
|
+
*/
|
|
558
|
+
started_at_override?: string;
|
|
559
|
+
/**
|
|
560
|
+
* A manual override for the time/date the Objective was completed.
|
|
561
|
+
* @format date-time
|
|
562
|
+
*/
|
|
563
|
+
completed_at_override?: string;
|
|
564
|
+
/** An array of IDs of Categories attached to the Objective. */
|
|
565
|
+
categories?: CreateCategoryParams[];
|
|
566
|
+
}
|
|
567
|
+
interface CreateOrDeleteStoryReaction {
|
|
461
568
|
/** The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. */
|
|
462
569
|
emoji: string;
|
|
463
570
|
}
|
|
464
|
-
|
|
571
|
+
interface CreateProject {
|
|
465
572
|
/**
|
|
466
573
|
* The Project description.
|
|
467
574
|
* @maxLength 100000
|
|
@@ -492,7 +599,10 @@ export interface CreateProject {
|
|
|
492
599
|
updated_at?: string;
|
|
493
600
|
/** An array of UUIDs for any members you want to add as Owners on this new Epic. */
|
|
494
601
|
follower_ids?: string[];
|
|
495
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here.
|
|
604
|
+
* @maxLength 128
|
|
605
|
+
*/
|
|
496
606
|
external_id?: string;
|
|
497
607
|
/**
|
|
498
608
|
* The ID of the team the project belongs to.
|
|
@@ -504,7 +614,10 @@ export interface CreateProject {
|
|
|
504
614
|
* @format int64
|
|
505
615
|
*/
|
|
506
616
|
iteration_length?: number;
|
|
507
|
-
/**
|
|
617
|
+
/**
|
|
618
|
+
* The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
|
|
619
|
+
* @maxLength 63
|
|
620
|
+
*/
|
|
508
621
|
abbreviation?: string;
|
|
509
622
|
/**
|
|
510
623
|
* Defaults to the time/date it is created but can be set to reflect another date.
|
|
@@ -512,45 +625,44 @@ export interface CreateProject {
|
|
|
512
625
|
*/
|
|
513
626
|
created_at?: string;
|
|
514
627
|
}
|
|
515
|
-
|
|
628
|
+
interface CreateStories {
|
|
516
629
|
/** An array of stories to be created. */
|
|
517
630
|
stories: CreateStoryParams[];
|
|
518
631
|
}
|
|
519
|
-
|
|
632
|
+
interface CreateStoryComment {
|
|
633
|
+
/**
|
|
634
|
+
* The comment text.
|
|
635
|
+
* @maxLength 100000
|
|
636
|
+
*/
|
|
637
|
+
text: string;
|
|
520
638
|
/**
|
|
521
639
|
* The Member ID of the Comment's author. Defaults to the user identified by the API token.
|
|
522
640
|
* @format uuid
|
|
523
641
|
*/
|
|
524
642
|
author_id?: string;
|
|
525
|
-
/**
|
|
526
|
-
|
|
643
|
+
/**
|
|
644
|
+
* Defaults to the time/date the comment is created, but can be set to reflect another date.
|
|
645
|
+
* @format date-time
|
|
646
|
+
*/
|
|
647
|
+
created_at?: string;
|
|
527
648
|
/**
|
|
528
649
|
* Defaults to the time/date the comment is last updated, but can be set to reflect another date.
|
|
529
650
|
* @format date-time
|
|
530
651
|
*/
|
|
531
652
|
updated_at?: string;
|
|
532
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
|
|
655
|
+
* @maxLength 1024
|
|
656
|
+
*/
|
|
533
657
|
external_id?: string;
|
|
534
658
|
/**
|
|
535
659
|
* The ID of the Comment that this comment is threaded under.
|
|
536
660
|
* @format int64
|
|
537
661
|
*/
|
|
538
662
|
parent_id?: number | null;
|
|
539
|
-
/** Marks the comment as an unblocker to its blocker parent. Can only be set on a threaded comment who has a parent with `blocker` set. */
|
|
540
|
-
unblocks_parent?: boolean;
|
|
541
|
-
/**
|
|
542
|
-
* Defaults to the time/date the comment is created, but can be set to reflect another date.
|
|
543
|
-
* @format date-time
|
|
544
|
-
*/
|
|
545
|
-
created_at?: string;
|
|
546
|
-
/**
|
|
547
|
-
* The comment text.
|
|
548
|
-
* @maxLength 100000
|
|
549
|
-
*/
|
|
550
|
-
text: string;
|
|
551
663
|
}
|
|
552
664
|
/** Request parameters for creating a Comment on a Shortcut Story. */
|
|
553
|
-
|
|
665
|
+
interface CreateStoryCommentParams {
|
|
554
666
|
/**
|
|
555
667
|
* The comment text.
|
|
556
668
|
* @maxLength 100000
|
|
@@ -571,43 +683,36 @@ export interface CreateStoryCommentParams {
|
|
|
571
683
|
* @format date-time
|
|
572
684
|
*/
|
|
573
685
|
updated_at?: string;
|
|
574
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
|
|
688
|
+
* @maxLength 1024
|
|
689
|
+
*/
|
|
575
690
|
external_id?: string;
|
|
576
691
|
/**
|
|
577
692
|
* The ID of the Comment that this comment is threaded under.
|
|
578
693
|
* @format int64
|
|
579
694
|
*/
|
|
580
695
|
parent_id?: number | null;
|
|
581
|
-
/** Marks the comment as a blocker that can be surfaced to permissions or teams mentioned in the comment. Can only be used on a top-level comment. */
|
|
582
|
-
blocker?: boolean;
|
|
583
|
-
/** Marks the comment as an unblocker to its blocker parent. Can only be set on a threaded comment who has a parent with `blocker` set. */
|
|
584
|
-
unblocks_parent?: boolean;
|
|
585
696
|
}
|
|
586
697
|
/** A map of story attributes this template populates. */
|
|
587
|
-
|
|
698
|
+
interface CreateStoryContents {
|
|
588
699
|
/** The description of the story. */
|
|
589
700
|
description?: string;
|
|
590
|
-
/** A string description of this resource. */
|
|
591
|
-
entity_type?: string;
|
|
592
701
|
/** An array of labels to be populated by the template. */
|
|
593
702
|
labels?: CreateLabelParams[];
|
|
594
703
|
/** The type of story (feature, bug, chore). */
|
|
595
704
|
story_type?: string;
|
|
596
705
|
/** An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. */
|
|
597
706
|
custom_fields?: CustomFieldValueParams[];
|
|
598
|
-
/** An array of linked files attached to the story. */
|
|
599
|
-
linked_files?: LinkedFile[];
|
|
600
707
|
/**
|
|
601
708
|
* An array of the attached file IDs to be populated.
|
|
602
709
|
* @uniqueItems true
|
|
603
710
|
*/
|
|
604
711
|
file_ids?: number[];
|
|
605
712
|
/**
|
|
606
|
-
* The
|
|
607
|
-
* @
|
|
713
|
+
* The name of the story.
|
|
714
|
+
* @maxLength 512
|
|
608
715
|
*/
|
|
609
|
-
workflow_id?: number | null;
|
|
610
|
-
/** The name of the story. */
|
|
611
716
|
name?: string;
|
|
612
717
|
/**
|
|
613
718
|
* The ID of the epic the to be populated.
|
|
@@ -616,25 +721,25 @@ export interface CreateStoryContents {
|
|
|
616
721
|
epic_id?: number | null;
|
|
617
722
|
/** An array of external links to be populated. */
|
|
618
723
|
external_links?: string[];
|
|
724
|
+
/** An array of sub-tasks connected to the story */
|
|
725
|
+
sub_tasks?: CreateSubTaskParams[];
|
|
619
726
|
/**
|
|
620
727
|
* The ID of the iteration the to be populated.
|
|
621
728
|
* @format int64
|
|
622
729
|
*/
|
|
623
730
|
iteration_id?: number | null;
|
|
624
731
|
/** An array of tasks to be populated by the template. */
|
|
625
|
-
tasks?:
|
|
626
|
-
/** An array of label ids attached to the story. */
|
|
627
|
-
label_ids?: number[];
|
|
732
|
+
tasks?: BaseTaskParams[];
|
|
628
733
|
/**
|
|
629
734
|
* The ID of the group to be populated.
|
|
630
735
|
* @format uuid
|
|
631
736
|
*/
|
|
632
737
|
group_id?: string | null;
|
|
633
738
|
/**
|
|
634
|
-
* The ID of the workflow state
|
|
739
|
+
* The ID of the workflow state to be populated.
|
|
635
740
|
* @format int64
|
|
636
741
|
*/
|
|
637
|
-
workflow_state_id?: number;
|
|
742
|
+
workflow_state_id?: number | null;
|
|
638
743
|
/** An array of UUIDs for any Members listed as Followers. */
|
|
639
744
|
follower_ids?: string[];
|
|
640
745
|
/** An array of UUIDs of the owners of this story. */
|
|
@@ -644,8 +749,6 @@ export interface CreateStoryContents {
|
|
|
644
749
|
* @format int64
|
|
645
750
|
*/
|
|
646
751
|
estimate?: number | null;
|
|
647
|
-
/** An array of files attached to the story. */
|
|
648
|
-
files?: UploadedFile[];
|
|
649
752
|
/**
|
|
650
753
|
* The ID of the project the story belongs to.
|
|
651
754
|
* @format int64
|
|
@@ -662,9 +765,208 @@ export interface CreateStoryContents {
|
|
|
662
765
|
*/
|
|
663
766
|
deadline?: string | null;
|
|
664
767
|
}
|
|
665
|
-
|
|
768
|
+
/** Request parameters for creating a story from a story template. These parameters are merged with the values derived from the template. */
|
|
769
|
+
interface CreateStoryFromTemplateParams {
|
|
770
|
+
/**
|
|
771
|
+
* The description of the story.
|
|
772
|
+
* @maxLength 100000
|
|
773
|
+
*/
|
|
774
|
+
description?: string;
|
|
775
|
+
/** Controls the story's archived state. */
|
|
776
|
+
archived?: boolean;
|
|
777
|
+
/** An array of story links attached to the story. */
|
|
778
|
+
story_links?: CreateStoryLinkParams[];
|
|
779
|
+
/** An array of labels attached to the story. */
|
|
780
|
+
labels?: CreateLabelParams[];
|
|
781
|
+
/**
|
|
782
|
+
* An array of External Links associated with this story. These will be added to any links provided by the template. Cannot be used in conjunction with `external_links`.
|
|
783
|
+
* @uniqueItems true
|
|
784
|
+
*/
|
|
785
|
+
external_links_add?: string[];
|
|
786
|
+
/** The type of story (feature, bug, chore). */
|
|
787
|
+
story_type?: "feature" | "chore" | "bug";
|
|
788
|
+
/** A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. */
|
|
789
|
+
custom_fields?: CustomFieldValueParams[];
|
|
790
|
+
/** One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. */
|
|
791
|
+
move_to?: "last" | "first";
|
|
792
|
+
/**
|
|
793
|
+
* An array of IDs of files attached to the story.
|
|
794
|
+
* @uniqueItems true
|
|
795
|
+
*/
|
|
796
|
+
file_ids?: number[];
|
|
797
|
+
/**
|
|
798
|
+
* Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
|
|
799
|
+
* @format int64
|
|
800
|
+
*/
|
|
801
|
+
source_task_id?: number | null;
|
|
802
|
+
/**
|
|
803
|
+
* A manual override for the time/date the Story was completed.
|
|
804
|
+
* @format date-time
|
|
805
|
+
*/
|
|
806
|
+
completed_at_override?: string;
|
|
807
|
+
/**
|
|
808
|
+
* The name of the story. Must be provided if the template does not provide a name.
|
|
809
|
+
* @minLength 1
|
|
810
|
+
* @maxLength 512
|
|
811
|
+
*/
|
|
812
|
+
name?: string;
|
|
813
|
+
/**
|
|
814
|
+
* An array of IDs of files attached to the story in addition to files from the template. Cannot be used in conjunction with `file_ids`.
|
|
815
|
+
* @uniqueItems true
|
|
816
|
+
*/
|
|
817
|
+
file_ids_add?: number[];
|
|
818
|
+
/**
|
|
819
|
+
* An array of IDs of files removed from files from the template. Cannot be used in conjunction with `file_ids`.
|
|
820
|
+
* @uniqueItems true
|
|
821
|
+
*/
|
|
822
|
+
file_ids_remove?: number[];
|
|
823
|
+
/** An array of comments to add to the story. */
|
|
824
|
+
comments?: CreateStoryCommentParams[];
|
|
825
|
+
/**
|
|
826
|
+
* The UUIDs of the new followers to be added in addition to followers from the template. Cannot be used in conjunction with `follower_ids.`
|
|
827
|
+
* @uniqueItems true
|
|
828
|
+
*/
|
|
829
|
+
follower_ids_add?: string[];
|
|
830
|
+
/**
|
|
831
|
+
* The ID of the epic the story belongs to.
|
|
832
|
+
* @format int64
|
|
833
|
+
*/
|
|
834
|
+
epic_id?: number | null;
|
|
835
|
+
/**
|
|
836
|
+
* The id of the story template used to create this story.
|
|
837
|
+
* @format uuid
|
|
838
|
+
*/
|
|
839
|
+
story_template_id: string;
|
|
840
|
+
/** An array of External Links associated with this story. */
|
|
841
|
+
external_links?: string[];
|
|
842
|
+
/**
|
|
843
|
+
* The UUIDs of the new followers to be removed from followers from the template. Cannot be used in conjunction with `follower_ids`.
|
|
844
|
+
* @uniqueItems true
|
|
845
|
+
*/
|
|
846
|
+
follower_ids_remove?: string[];
|
|
847
|
+
/** A list of either params to create a new sub-task or link an existing story as a sub-task */
|
|
848
|
+
sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
|
|
849
|
+
/**
|
|
850
|
+
* An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`
|
|
851
|
+
* @uniqueItems true
|
|
852
|
+
*/
|
|
853
|
+
linked_file_ids_remove?: number[];
|
|
854
|
+
/**
|
|
855
|
+
* The ID of the member that requested the story.
|
|
856
|
+
* @format uuid
|
|
857
|
+
*/
|
|
858
|
+
requested_by_id?: string;
|
|
859
|
+
/**
|
|
860
|
+
* The ID of the iteration the story belongs to.
|
|
861
|
+
* @format int64
|
|
862
|
+
*/
|
|
863
|
+
iteration_id?: number | null;
|
|
864
|
+
/**
|
|
865
|
+
* A map specifying a CustomField ID. These will be removed from any fields provided by the template. Cannot be used in conjunction with `custom_fields`.
|
|
866
|
+
* @uniqueItems true
|
|
867
|
+
*/
|
|
868
|
+
custom_fields_remove?: RemoveCustomFieldParams[];
|
|
869
|
+
/** An array of tasks connected to the story. */
|
|
870
|
+
tasks?: CreateTaskParams[];
|
|
871
|
+
/**
|
|
872
|
+
* A manual override for the time/date the Story was started.
|
|
873
|
+
* @format date-time
|
|
874
|
+
*/
|
|
875
|
+
started_at_override?: string;
|
|
876
|
+
/**
|
|
877
|
+
* An array of labels attached to the story in addition to the labels provided by the template. Cannot be used in conjunction with `labels`.
|
|
878
|
+
* @uniqueItems true
|
|
879
|
+
*/
|
|
880
|
+
labels_add?: CreateLabelParams[];
|
|
881
|
+
/**
|
|
882
|
+
* The id of the group to associate with this story.
|
|
883
|
+
* @format uuid
|
|
884
|
+
*/
|
|
885
|
+
group_id?: string | null;
|
|
886
|
+
/**
|
|
887
|
+
* The ID of the workflow state the story will be in.
|
|
888
|
+
* @format int64
|
|
889
|
+
*/
|
|
890
|
+
workflow_state_id?: number;
|
|
891
|
+
/**
|
|
892
|
+
* The time/date the Story was updated.
|
|
893
|
+
* @format date-time
|
|
894
|
+
*/
|
|
895
|
+
updated_at?: string;
|
|
896
|
+
/**
|
|
897
|
+
* An array of UUIDs of the followers of this story.
|
|
898
|
+
* @uniqueItems true
|
|
899
|
+
*/
|
|
900
|
+
follower_ids?: string[];
|
|
901
|
+
/**
|
|
902
|
+
* An array of UUIDs of the owners of this story.
|
|
903
|
+
* @uniqueItems true
|
|
904
|
+
*/
|
|
905
|
+
owner_ids?: string[];
|
|
906
|
+
/**
|
|
907
|
+
* This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
|
|
908
|
+
* @maxLength 1024
|
|
909
|
+
*/
|
|
910
|
+
external_id?: string;
|
|
911
|
+
/**
|
|
912
|
+
* The numeric point estimate of the story. Can also be null, which means unestimated.
|
|
913
|
+
* @format int64
|
|
914
|
+
*/
|
|
915
|
+
estimate?: number | null;
|
|
916
|
+
/**
|
|
917
|
+
* The UUIDs of the new owners to be removed from owners from the template. Cannot be used in conjunction with `owners`.
|
|
918
|
+
* @uniqueItems true
|
|
919
|
+
*/
|
|
920
|
+
owner_ids_remove?: string[];
|
|
921
|
+
/**
|
|
922
|
+
* A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. These will be added to any fields provided by the template. Cannot be used in conjunction with `custom_fields`.
|
|
923
|
+
* @uniqueItems true
|
|
924
|
+
*/
|
|
925
|
+
custom_fields_add?: CustomFieldValueParams[];
|
|
926
|
+
/**
|
|
927
|
+
* The ID of the project the story belongs to.
|
|
928
|
+
* @format int64
|
|
929
|
+
*/
|
|
930
|
+
project_id?: number | null;
|
|
931
|
+
/**
|
|
932
|
+
* An array of IDs of linked files attached to the story in addition to files from the template. Cannot be used in conjunction with `linked_files`.
|
|
933
|
+
* @uniqueItems true
|
|
934
|
+
*/
|
|
935
|
+
linked_file_ids_add?: number[];
|
|
936
|
+
/**
|
|
937
|
+
* An array of IDs of linked files attached to the story.
|
|
938
|
+
* @uniqueItems true
|
|
939
|
+
*/
|
|
940
|
+
linked_file_ids?: number[];
|
|
941
|
+
/**
|
|
942
|
+
* An array of labels to remove from the labels provided by the template. Cannot be used in conjunction with `labels`.
|
|
943
|
+
* @uniqueItems true
|
|
944
|
+
*/
|
|
945
|
+
labels_remove?: RemoveLabelParams[];
|
|
946
|
+
/**
|
|
947
|
+
* The due date of the story.
|
|
948
|
+
* @format date-time
|
|
949
|
+
*/
|
|
950
|
+
deadline?: string | null;
|
|
951
|
+
/**
|
|
952
|
+
* The UUIDs of the new owners to be added in addition to owners from the template. Cannot be used in conjunction with `owners`.
|
|
953
|
+
* @uniqueItems true
|
|
954
|
+
*/
|
|
955
|
+
owner_ids_add?: string[];
|
|
956
|
+
/**
|
|
957
|
+
* The time/date the Story was created.
|
|
958
|
+
* @format date-time
|
|
959
|
+
*/
|
|
960
|
+
created_at?: string;
|
|
961
|
+
/**
|
|
962
|
+
* An array of External Links associated with this story. These will be removed from any links provided by the template. Cannot be used in conjunction with `external_links`.
|
|
963
|
+
* @uniqueItems true
|
|
964
|
+
*/
|
|
965
|
+
external_links_remove?: string[];
|
|
966
|
+
}
|
|
967
|
+
interface CreateStoryLink {
|
|
666
968
|
/** The type of link. */
|
|
667
|
-
verb:
|
|
969
|
+
verb: "blocks" | "duplicates" | "relates to";
|
|
668
970
|
/**
|
|
669
971
|
* The ID of the subject Story.
|
|
670
972
|
* @format int64
|
|
@@ -677,14 +979,14 @@ export interface CreateStoryLink {
|
|
|
677
979
|
object_id: number;
|
|
678
980
|
}
|
|
679
981
|
/** Request parameters for creating a Story Link within a Story. */
|
|
680
|
-
|
|
982
|
+
interface CreateStoryLinkParams {
|
|
681
983
|
/**
|
|
682
984
|
* The unique ID of the Story defined as subject.
|
|
683
985
|
* @format int64
|
|
684
986
|
*/
|
|
685
987
|
subject_id?: number;
|
|
686
988
|
/** How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to". */
|
|
687
|
-
verb:
|
|
989
|
+
verb: "blocks" | "duplicates" | "relates to";
|
|
688
990
|
/**
|
|
689
991
|
* The unique ID of the Story defined as object.
|
|
690
992
|
* @format int64
|
|
@@ -692,7 +994,7 @@ export interface CreateStoryLinkParams {
|
|
|
692
994
|
object_id?: number;
|
|
693
995
|
}
|
|
694
996
|
/** Request parameters for creating a story. */
|
|
695
|
-
|
|
997
|
+
interface CreateStoryParams {
|
|
696
998
|
/**
|
|
697
999
|
* The description of the story.
|
|
698
1000
|
* @maxLength 100000
|
|
@@ -705,16 +1007,21 @@ export interface CreateStoryParams {
|
|
|
705
1007
|
/** An array of labels attached to the story. */
|
|
706
1008
|
labels?: CreateLabelParams[];
|
|
707
1009
|
/** The type of story (feature, bug, chore). */
|
|
708
|
-
story_type?:
|
|
1010
|
+
story_type?: "feature" | "chore" | "bug";
|
|
709
1011
|
/** A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. */
|
|
710
1012
|
custom_fields?: CustomFieldValueParams[];
|
|
711
1013
|
/** One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. */
|
|
712
|
-
move_to?:
|
|
1014
|
+
move_to?: "last" | "first";
|
|
713
1015
|
/**
|
|
714
1016
|
* An array of IDs of files attached to the story.
|
|
715
1017
|
* @uniqueItems true
|
|
716
1018
|
*/
|
|
717
1019
|
file_ids?: number[];
|
|
1020
|
+
/**
|
|
1021
|
+
* Given this story was converted from a task in another story, this is the original task ID that was converted to this story.
|
|
1022
|
+
* @format int64
|
|
1023
|
+
*/
|
|
1024
|
+
source_task_id?: number | null;
|
|
718
1025
|
/**
|
|
719
1026
|
* A manual override for the time/date the Story was completed.
|
|
720
1027
|
* @format date-time
|
|
@@ -740,6 +1047,8 @@ export interface CreateStoryParams {
|
|
|
740
1047
|
story_template_id?: string | null;
|
|
741
1048
|
/** An array of External Links associated with this story. */
|
|
742
1049
|
external_links?: string[];
|
|
1050
|
+
/** A list of either params to create a new sub-task or link an existing story as a sub-task */
|
|
1051
|
+
sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
|
|
743
1052
|
/**
|
|
744
1053
|
* The ID of the member that requested the story.
|
|
745
1054
|
* @format uuid
|
|
@@ -782,7 +1091,10 @@ export interface CreateStoryParams {
|
|
|
782
1091
|
* @uniqueItems true
|
|
783
1092
|
*/
|
|
784
1093
|
owner_ids?: string[];
|
|
785
|
-
/**
|
|
1094
|
+
/**
|
|
1095
|
+
* This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
|
|
1096
|
+
* @maxLength 1024
|
|
1097
|
+
*/
|
|
786
1098
|
external_id?: string;
|
|
787
1099
|
/**
|
|
788
1100
|
* The numeric point estimate of the story. Can also be null, which means unestimated.
|
|
@@ -810,7 +1122,25 @@ export interface CreateStoryParams {
|
|
|
810
1122
|
*/
|
|
811
1123
|
created_at?: string;
|
|
812
1124
|
}
|
|
813
|
-
|
|
1125
|
+
interface CreateSubTaskParams {
|
|
1126
|
+
/**
|
|
1127
|
+
* The name of the SubTask.
|
|
1128
|
+
* @minLength 1
|
|
1129
|
+
* @maxLength 512
|
|
1130
|
+
*/
|
|
1131
|
+
name: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* An array of UUIDs of the owners of this story.
|
|
1134
|
+
* @uniqueItems true
|
|
1135
|
+
*/
|
|
1136
|
+
owner_ids?: string[];
|
|
1137
|
+
/**
|
|
1138
|
+
* The ID of the workflow state the story will be in.
|
|
1139
|
+
* @format int64
|
|
1140
|
+
*/
|
|
1141
|
+
workflow_state_id?: number;
|
|
1142
|
+
}
|
|
1143
|
+
interface CreateTask {
|
|
814
1144
|
/**
|
|
815
1145
|
* The Task description.
|
|
816
1146
|
* @minLength 1
|
|
@@ -821,6 +1151,11 @@ export interface CreateTask {
|
|
|
821
1151
|
complete?: boolean;
|
|
822
1152
|
/** An array of UUIDs for any members you want to add as Owners on this new Task. */
|
|
823
1153
|
owner_ids?: string[];
|
|
1154
|
+
/**
|
|
1155
|
+
* This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.
|
|
1156
|
+
* @maxLength 128
|
|
1157
|
+
*/
|
|
1158
|
+
external_id?: string;
|
|
824
1159
|
/**
|
|
825
1160
|
* Defaults to the time/date the Task is created but can be set to reflect another creation time/date.
|
|
826
1161
|
* @format date-time
|
|
@@ -831,11 +1166,9 @@ export interface CreateTask {
|
|
|
831
1166
|
* @format date-time
|
|
832
1167
|
*/
|
|
833
1168
|
updated_at?: string;
|
|
834
|
-
/** This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
835
|
-
external_id?: string;
|
|
836
1169
|
}
|
|
837
1170
|
/** Request parameters for creating a Task on a Story. */
|
|
838
|
-
|
|
1171
|
+
interface CreateTaskParams {
|
|
839
1172
|
/**
|
|
840
1173
|
* The Task description.
|
|
841
1174
|
* @minLength 1
|
|
@@ -846,6 +1179,11 @@ export interface CreateTaskParams {
|
|
|
846
1179
|
complete?: boolean;
|
|
847
1180
|
/** An array of UUIDs for any members you want to add as Owners on this new Task. */
|
|
848
1181
|
owner_ids?: string[];
|
|
1182
|
+
/**
|
|
1183
|
+
* This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here.
|
|
1184
|
+
* @maxLength 128
|
|
1185
|
+
*/
|
|
1186
|
+
external_id?: string;
|
|
849
1187
|
/**
|
|
850
1188
|
* Defaults to the time/date the Task is created but can be set to reflect another creation time/date.
|
|
851
1189
|
* @format date-time
|
|
@@ -856,10 +1194,8 @@ export interface CreateTaskParams {
|
|
|
856
1194
|
* @format date-time
|
|
857
1195
|
*/
|
|
858
1196
|
updated_at?: string;
|
|
859
|
-
/** This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
860
|
-
external_id?: string;
|
|
861
1197
|
}
|
|
862
|
-
|
|
1198
|
+
interface CustomField {
|
|
863
1199
|
/**
|
|
864
1200
|
* A string description of the CustomField
|
|
865
1201
|
* @minLength 1
|
|
@@ -873,7 +1209,7 @@ export interface CustomField {
|
|
|
873
1209
|
*/
|
|
874
1210
|
icon_set_identifier?: string;
|
|
875
1211
|
/** A string description of this resource. */
|
|
876
|
-
entity_type:
|
|
1212
|
+
entity_type: "custom-field";
|
|
877
1213
|
/** The types of stories this CustomField is scoped to. */
|
|
878
1214
|
story_types?: string[];
|
|
879
1215
|
/**
|
|
@@ -897,7 +1233,7 @@ export interface CustomField {
|
|
|
897
1233
|
/** A collection of legal values for a CustomField. */
|
|
898
1234
|
values?: CustomFieldEnumValue[];
|
|
899
1235
|
/** The type of Custom Field, eg. 'enum'. */
|
|
900
|
-
field_type:
|
|
1236
|
+
field_type: "enum";
|
|
901
1237
|
/**
|
|
902
1238
|
* An integer indicating the position of this Custom Field with respect to the other CustomField
|
|
903
1239
|
* @format int64
|
|
@@ -913,7 +1249,7 @@ export interface CustomField {
|
|
|
913
1249
|
*/
|
|
914
1250
|
created_at: string;
|
|
915
1251
|
}
|
|
916
|
-
|
|
1252
|
+
interface CustomFieldEnumValue {
|
|
917
1253
|
/**
|
|
918
1254
|
* The unique public ID for the Custom Field.
|
|
919
1255
|
* @format uuid
|
|
@@ -933,11 +1269,11 @@ export interface CustomFieldEnumValue {
|
|
|
933
1269
|
/** A color key associated with this CustomFieldEnumValue. */
|
|
934
1270
|
color_key?: string | null;
|
|
935
1271
|
/** A string description of this resource. */
|
|
936
|
-
entity_type:
|
|
1272
|
+
entity_type: "custom-field-enum-value";
|
|
937
1273
|
/** When true, the CustomFieldEnumValue can be selected for the CustomField. */
|
|
938
1274
|
enabled: boolean;
|
|
939
1275
|
}
|
|
940
|
-
|
|
1276
|
+
interface CustomFieldValueParams {
|
|
941
1277
|
/**
|
|
942
1278
|
* The unique public ID for the CustomField.
|
|
943
1279
|
* @format uuid
|
|
@@ -952,12 +1288,12 @@ export interface CustomFieldValueParams {
|
|
|
952
1288
|
value?: string;
|
|
953
1289
|
}
|
|
954
1290
|
/** Error returned when Datomic tx fails due to Datomc :db.error/cas-failed error */
|
|
955
|
-
|
|
956
|
-
error:
|
|
1291
|
+
interface DataConflictError {
|
|
1292
|
+
error: "data-conflict-error";
|
|
957
1293
|
/** An explanatory message: "The update failed due to a data conflict. Please refresh and try again." */
|
|
958
1294
|
message: string;
|
|
959
1295
|
}
|
|
960
|
-
|
|
1296
|
+
interface DeleteStories {
|
|
961
1297
|
/**
|
|
962
1298
|
* An array of IDs of Stories to delete.
|
|
963
1299
|
* @uniqueItems true
|
|
@@ -965,7 +1301,7 @@ export interface DeleteStories {
|
|
|
965
1301
|
story_ids: number[];
|
|
966
1302
|
}
|
|
967
1303
|
/** An entity template can be used to prefill various fields when creating new stories. */
|
|
968
|
-
|
|
1304
|
+
interface EntityTemplate {
|
|
969
1305
|
/** A string description of this resource. */
|
|
970
1306
|
entity_type: string;
|
|
971
1307
|
/**
|
|
@@ -998,23 +1334,8 @@ export interface EntityTemplate {
|
|
|
998
1334
|
/** A container entity for the attributes this template should populate. */
|
|
999
1335
|
story_contents: StoryContents;
|
|
1000
1336
|
}
|
|
1001
|
-
/**
|
|
1002
|
-
|
|
1003
|
-
/**
|
|
1004
|
-
* The Task description.
|
|
1005
|
-
* @minLength 1
|
|
1006
|
-
* @maxLength 2048
|
|
1007
|
-
*/
|
|
1008
|
-
description: string;
|
|
1009
|
-
/** True/false boolean indicating whether the Task is completed. Defaults to false. */
|
|
1010
|
-
complete?: boolean;
|
|
1011
|
-
/** An array of UUIDs for any members you want to add as Owners on this new Task. */
|
|
1012
|
-
owner_ids?: string[];
|
|
1013
|
-
/** This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
1014
|
-
external_id?: string;
|
|
1015
|
-
}
|
|
1016
|
-
/** An Epic is a collection of stories that together might make up a release, a milestone, or some other large initiative that you are working on. */
|
|
1017
|
-
export interface Epic {
|
|
1337
|
+
/** An Epic is a collection of stories that together might make up a release, a objective, or some other large initiative that you are working on. */
|
|
1338
|
+
interface Epic {
|
|
1018
1339
|
/** The Shortcut application url for the Epic. */
|
|
1019
1340
|
app_url: string;
|
|
1020
1341
|
/** The Epic's description. */
|
|
@@ -1027,7 +1348,7 @@ export interface Epic {
|
|
|
1027
1348
|
entity_type: string;
|
|
1028
1349
|
/** An array of Labels attached to the Epic. */
|
|
1029
1350
|
labels: LabelSlim[];
|
|
1030
|
-
/** Deprecated
|
|
1351
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
1031
1352
|
mention_ids: string[];
|
|
1032
1353
|
/** An array of Member IDs that have been mentioned in the Epic description. */
|
|
1033
1354
|
member_mention_ids: string[];
|
|
@@ -1060,6 +1381,8 @@ export interface Epic {
|
|
|
1060
1381
|
* @format date-time
|
|
1061
1382
|
*/
|
|
1062
1383
|
completed_at?: string | null;
|
|
1384
|
+
/** An array of IDs for Objectives to which this epic is related. */
|
|
1385
|
+
objective_ids: number[];
|
|
1063
1386
|
/** The name of the Epic. */
|
|
1064
1387
|
name: string;
|
|
1065
1388
|
global_id: string;
|
|
@@ -1077,7 +1400,7 @@ export interface Epic {
|
|
|
1077
1400
|
/** `Deprecated` The workflow state that the Epic is in. */
|
|
1078
1401
|
state: string;
|
|
1079
1402
|
/**
|
|
1080
|
-
* The ID of the
|
|
1403
|
+
* `Deprecated` The ID of the Objective this Epic is related to. Use `objective_ids`.
|
|
1081
1404
|
* @format int64
|
|
1082
1405
|
*/
|
|
1083
1406
|
milestone_id?: number | null;
|
|
@@ -1098,7 +1421,10 @@ export interface Epic {
|
|
|
1098
1421
|
* @format date-time
|
|
1099
1422
|
*/
|
|
1100
1423
|
started_at_override?: string | null;
|
|
1101
|
-
/**
|
|
1424
|
+
/**
|
|
1425
|
+
* `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
|
|
1426
|
+
* @format uuid
|
|
1427
|
+
*/
|
|
1102
1428
|
group_id?: string | null;
|
|
1103
1429
|
/**
|
|
1104
1430
|
* The time/date the Epic was updated.
|
|
@@ -1114,6 +1440,8 @@ export interface Epic {
|
|
|
1114
1440
|
productboard_id?: string | null;
|
|
1115
1441
|
/** An array of UUIDs for any Members you want to add as Followers on this Epic. */
|
|
1116
1442
|
follower_ids: string[];
|
|
1443
|
+
/** An array of UUIDS for Groups to which this Epic is related. */
|
|
1444
|
+
group_ids: string[];
|
|
1117
1445
|
/** An array of UUIDs for any members you want to add as Owners on this new Epic. */
|
|
1118
1446
|
owner_ids: string[];
|
|
1119
1447
|
/** This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
@@ -1123,6 +1451,8 @@ export interface Epic {
|
|
|
1123
1451
|
* @format int64
|
|
1124
1452
|
*/
|
|
1125
1453
|
id: number;
|
|
1454
|
+
/** The current health status of the Epic. */
|
|
1455
|
+
health?: Health;
|
|
1126
1456
|
/**
|
|
1127
1457
|
* The Epic's relative position in the Epic workflow state.
|
|
1128
1458
|
* @format int64
|
|
@@ -1143,7 +1473,7 @@ export interface Epic {
|
|
|
1143
1473
|
*/
|
|
1144
1474
|
created_at?: string | null;
|
|
1145
1475
|
}
|
|
1146
|
-
|
|
1476
|
+
interface EpicAssociatedGroup {
|
|
1147
1477
|
/**
|
|
1148
1478
|
* The Group ID of the associated group.
|
|
1149
1479
|
* @format uuid
|
|
@@ -1155,8 +1485,23 @@ export interface EpicAssociatedGroup {
|
|
|
1155
1485
|
*/
|
|
1156
1486
|
associated_stories_count?: number;
|
|
1157
1487
|
}
|
|
1488
|
+
/** Results schema for paginated Epic listing. */
|
|
1489
|
+
interface EpicPaginatedResults {
|
|
1490
|
+
/** Array of Epic objects on the current page */
|
|
1491
|
+
data: EpicSlim[];
|
|
1492
|
+
/**
|
|
1493
|
+
* The next page number if there are more results, or null for the last page
|
|
1494
|
+
* @format int64
|
|
1495
|
+
*/
|
|
1496
|
+
next?: number | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* The total number of Epics matching the query over all pages
|
|
1499
|
+
* @format int64
|
|
1500
|
+
*/
|
|
1501
|
+
total: number;
|
|
1502
|
+
}
|
|
1158
1503
|
/** An Epic in search results. This is typed differently from Epic because the details=slim search argument will omit some fields. */
|
|
1159
|
-
|
|
1504
|
+
interface EpicSearchResult {
|
|
1160
1505
|
/** The Shortcut application url for the Epic. */
|
|
1161
1506
|
app_url: string;
|
|
1162
1507
|
/** The Epic's description. */
|
|
@@ -1169,7 +1514,7 @@ export interface EpicSearchResult {
|
|
|
1169
1514
|
entity_type: string;
|
|
1170
1515
|
/** An array of Labels attached to the Epic. */
|
|
1171
1516
|
labels: LabelSlim[];
|
|
1172
|
-
/** Deprecated
|
|
1517
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
1173
1518
|
mention_ids: string[];
|
|
1174
1519
|
/** An array of Member IDs that have been mentioned in the Epic description. */
|
|
1175
1520
|
member_mention_ids: string[];
|
|
@@ -1202,6 +1547,8 @@ export interface EpicSearchResult {
|
|
|
1202
1547
|
* @format date-time
|
|
1203
1548
|
*/
|
|
1204
1549
|
completed_at?: string | null;
|
|
1550
|
+
/** An array of IDs for Objectives to which this epic is related. */
|
|
1551
|
+
objective_ids: number[];
|
|
1205
1552
|
/** The name of the Epic. */
|
|
1206
1553
|
name: string;
|
|
1207
1554
|
global_id: string;
|
|
@@ -1219,7 +1566,7 @@ export interface EpicSearchResult {
|
|
|
1219
1566
|
/** `Deprecated` The workflow state that the Epic is in. */
|
|
1220
1567
|
state: string;
|
|
1221
1568
|
/**
|
|
1222
|
-
* The ID of the
|
|
1569
|
+
* `Deprecated` The ID of the Objective this Epic is related to. Use `objective_ids`.
|
|
1223
1570
|
* @format int64
|
|
1224
1571
|
*/
|
|
1225
1572
|
milestone_id?: number | null;
|
|
@@ -1240,7 +1587,10 @@ export interface EpicSearchResult {
|
|
|
1240
1587
|
* @format date-time
|
|
1241
1588
|
*/
|
|
1242
1589
|
started_at_override?: string | null;
|
|
1243
|
-
/**
|
|
1590
|
+
/**
|
|
1591
|
+
* `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
|
|
1592
|
+
* @format uuid
|
|
1593
|
+
*/
|
|
1244
1594
|
group_id?: string | null;
|
|
1245
1595
|
/**
|
|
1246
1596
|
* The time/date the Epic was updated.
|
|
@@ -1256,6 +1606,8 @@ export interface EpicSearchResult {
|
|
|
1256
1606
|
productboard_id?: string | null;
|
|
1257
1607
|
/** An array of UUIDs for any Members you want to add as Followers on this Epic. */
|
|
1258
1608
|
follower_ids: string[];
|
|
1609
|
+
/** An array of UUIDS for Groups to which this Epic is related. */
|
|
1610
|
+
group_ids: string[];
|
|
1259
1611
|
/** An array of UUIDs for any members you want to add as Owners on this new Epic. */
|
|
1260
1612
|
owner_ids: string[];
|
|
1261
1613
|
/** This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
@@ -1265,6 +1617,8 @@ export interface EpicSearchResult {
|
|
|
1265
1617
|
* @format int64
|
|
1266
1618
|
*/
|
|
1267
1619
|
id: number;
|
|
1620
|
+
/** The current health status of the Epic. */
|
|
1621
|
+
health?: Health;
|
|
1268
1622
|
/**
|
|
1269
1623
|
* The Epic's relative position in the Epic workflow state.
|
|
1270
1624
|
* @format int64
|
|
@@ -1286,7 +1640,7 @@ export interface EpicSearchResult {
|
|
|
1286
1640
|
created_at?: string | null;
|
|
1287
1641
|
}
|
|
1288
1642
|
/** The results of the Epic search query. */
|
|
1289
|
-
|
|
1643
|
+
interface EpicSearchResults {
|
|
1290
1644
|
/**
|
|
1291
1645
|
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
1292
1646
|
* @format int64
|
|
@@ -1296,10 +1650,9 @@ export interface EpicSearchResults {
|
|
|
1296
1650
|
data: EpicSearchResult[];
|
|
1297
1651
|
/** The URL path and query string for the next page of search results. */
|
|
1298
1652
|
next?: string | null;
|
|
1299
|
-
cursors?: string[];
|
|
1300
1653
|
}
|
|
1301
1654
|
/** EpicSlim represents the same resource as an Epic but is more light-weight, including all Epic fields except the comments array. The description string can be optionally included. Use the [Get Epic](#Get-Epic) endpoint to fetch the unabridged payload for an Epic. */
|
|
1302
|
-
|
|
1655
|
+
interface EpicSlim {
|
|
1303
1656
|
/** The Shortcut application url for the Epic. */
|
|
1304
1657
|
app_url: string;
|
|
1305
1658
|
/** The Epic's description. */
|
|
@@ -1312,7 +1665,7 @@ export interface EpicSlim {
|
|
|
1312
1665
|
entity_type: string;
|
|
1313
1666
|
/** An array of Labels attached to the Epic. */
|
|
1314
1667
|
labels: LabelSlim[];
|
|
1315
|
-
/** Deprecated
|
|
1668
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
1316
1669
|
mention_ids: string[];
|
|
1317
1670
|
/** An array of Member IDs that have been mentioned in the Epic description. */
|
|
1318
1671
|
member_mention_ids: string[];
|
|
@@ -1345,6 +1698,8 @@ export interface EpicSlim {
|
|
|
1345
1698
|
* @format date-time
|
|
1346
1699
|
*/
|
|
1347
1700
|
completed_at?: string | null;
|
|
1701
|
+
/** An array of IDs for Objectives to which this epic is related. */
|
|
1702
|
+
objective_ids: number[];
|
|
1348
1703
|
/** The name of the Epic. */
|
|
1349
1704
|
name: string;
|
|
1350
1705
|
global_id: string;
|
|
@@ -1360,7 +1715,7 @@ export interface EpicSlim {
|
|
|
1360
1715
|
/** `Deprecated` The workflow state that the Epic is in. */
|
|
1361
1716
|
state: string;
|
|
1362
1717
|
/**
|
|
1363
|
-
* The ID of the
|
|
1718
|
+
* `Deprecated` The ID of the Objective this Epic is related to. Use `objective_ids`.
|
|
1364
1719
|
* @format int64
|
|
1365
1720
|
*/
|
|
1366
1721
|
milestone_id?: number | null;
|
|
@@ -1381,7 +1736,10 @@ export interface EpicSlim {
|
|
|
1381
1736
|
* @format date-time
|
|
1382
1737
|
*/
|
|
1383
1738
|
started_at_override?: string | null;
|
|
1384
|
-
/**
|
|
1739
|
+
/**
|
|
1740
|
+
* `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
|
|
1741
|
+
* @format uuid
|
|
1742
|
+
*/
|
|
1385
1743
|
group_id?: string | null;
|
|
1386
1744
|
/**
|
|
1387
1745
|
* The time/date the Epic was updated.
|
|
@@ -1397,6 +1755,8 @@ export interface EpicSlim {
|
|
|
1397
1755
|
productboard_id?: string | null;
|
|
1398
1756
|
/** An array of UUIDs for any Members you want to add as Followers on this Epic. */
|
|
1399
1757
|
follower_ids: string[];
|
|
1758
|
+
/** An array of UUIDS for Groups to which this Epic is related. */
|
|
1759
|
+
group_ids: string[];
|
|
1400
1760
|
/** An array of UUIDs for any members you want to add as Owners on this new Epic. */
|
|
1401
1761
|
owner_ids: string[];
|
|
1402
1762
|
/** This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
@@ -1427,7 +1787,7 @@ export interface EpicSlim {
|
|
|
1427
1787
|
created_at?: string | null;
|
|
1428
1788
|
}
|
|
1429
1789
|
/** Epic State is any of the at least 3 columns. Epic States correspond to one of 3 types: Unstarted, Started, or Done. */
|
|
1430
|
-
|
|
1790
|
+
interface EpicState {
|
|
1431
1791
|
/** The description of what sort of Epics belong in that Epic State. */
|
|
1432
1792
|
description: string;
|
|
1433
1793
|
/** A string description of this resource. */
|
|
@@ -1466,7 +1826,7 @@ export interface EpicState {
|
|
|
1466
1826
|
created_at: string;
|
|
1467
1827
|
}
|
|
1468
1828
|
/** A group of calculated values for this Epic. */
|
|
1469
|
-
|
|
1829
|
+
interface EpicStats {
|
|
1470
1830
|
/**
|
|
1471
1831
|
* The total number of completed points in this Epic.
|
|
1472
1832
|
* @format int64
|
|
@@ -1477,11 +1837,6 @@ export interface EpicStats {
|
|
|
1477
1837
|
* @format int64
|
|
1478
1838
|
*/
|
|
1479
1839
|
num_related_documents: number;
|
|
1480
|
-
/**
|
|
1481
|
-
* The average cycle time (in seconds) of completed stories in this Epic.
|
|
1482
|
-
* @format int64
|
|
1483
|
-
*/
|
|
1484
|
-
average_cycle_time?: number;
|
|
1485
1840
|
/**
|
|
1486
1841
|
* The total number of unstarted Stories in this Epic.
|
|
1487
1842
|
* @format int64
|
|
@@ -1522,11 +1877,6 @@ export interface EpicStats {
|
|
|
1522
1877
|
* @format int64
|
|
1523
1878
|
*/
|
|
1524
1879
|
num_stories_backlog: number;
|
|
1525
|
-
/**
|
|
1526
|
-
* The average lead time (in seconds) of completed stories in this Epic.
|
|
1527
|
-
* @format int64
|
|
1528
|
-
*/
|
|
1529
|
-
average_lead_time?: number;
|
|
1530
1880
|
/**
|
|
1531
1881
|
* The total number of backlog points in this Epic.
|
|
1532
1882
|
* @format int64
|
|
@@ -1544,7 +1894,7 @@ export interface EpicStats {
|
|
|
1544
1894
|
num_stories_done: number;
|
|
1545
1895
|
}
|
|
1546
1896
|
/** Epic Workflow is the array of defined Epic States. Epic Workflow can be queried using the API but must be updated in the Shortcut UI. */
|
|
1547
|
-
|
|
1897
|
+
interface EpicWorkflow {
|
|
1548
1898
|
/** A string description of this resource. */
|
|
1549
1899
|
entity_type: string;
|
|
1550
1900
|
/**
|
|
@@ -1568,41 +1918,10 @@ export interface EpicWorkflow {
|
|
|
1568
1918
|
*/
|
|
1569
1919
|
default_epic_state_id: number;
|
|
1570
1920
|
/** A map of the Epic States in this Epic Workflow. */
|
|
1571
|
-
epic_states: EpicState[];
|
|
1572
|
-
}
|
|
1573
|
-
export interface GetEpicStories {
|
|
1574
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
1575
|
-
includes_description?: boolean;
|
|
1576
|
-
}
|
|
1577
|
-
export interface GetExternalLinkStoriesParams {
|
|
1578
|
-
/**
|
|
1579
|
-
* The external link associated with one or more stories.
|
|
1580
|
-
* @maxLength 2048
|
|
1581
|
-
* @pattern ^https?://.+$
|
|
1582
|
-
*/
|
|
1583
|
-
external_link: string;
|
|
1584
|
-
}
|
|
1585
|
-
export interface GetIterationStories {
|
|
1586
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
1587
|
-
includes_description?: boolean;
|
|
1588
|
-
}
|
|
1589
|
-
export interface GetLabelStories {
|
|
1590
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
1591
|
-
includes_description?: boolean;
|
|
1592
|
-
}
|
|
1593
|
-
export interface GetMember {
|
|
1594
|
-
/**
|
|
1595
|
-
* The unique ID of the Organization to limit the lookup to.
|
|
1596
|
-
* @format uuid
|
|
1597
|
-
*/
|
|
1598
|
-
'org-public-id'?: string;
|
|
1599
|
-
}
|
|
1600
|
-
export interface GetProjectStories {
|
|
1601
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
1602
|
-
includes_description?: boolean;
|
|
1921
|
+
epic_states: EpicState[];
|
|
1603
1922
|
}
|
|
1604
1923
|
/** A Group. */
|
|
1605
|
-
|
|
1924
|
+
interface Group {
|
|
1606
1925
|
/** The Shortcut application url for the Group. */
|
|
1607
1926
|
app_url: string;
|
|
1608
1927
|
/** The description of the Group. */
|
|
@@ -1633,9 +1952,9 @@ export interface Group {
|
|
|
1633
1952
|
name: string;
|
|
1634
1953
|
global_id: string;
|
|
1635
1954
|
/** The color key to be displayed with the Group. */
|
|
1636
|
-
color_key?:
|
|
1955
|
+
color_key?: "blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise" | null;
|
|
1637
1956
|
/**
|
|
1638
|
-
* The total number of stories assigned
|
|
1957
|
+
* The total number of stories assigned to the group.
|
|
1639
1958
|
* @format int64
|
|
1640
1959
|
*/
|
|
1641
1960
|
num_stories: number;
|
|
@@ -1656,13 +1975,59 @@ export interface Group {
|
|
|
1656
1975
|
id: string;
|
|
1657
1976
|
/** Icons are used to attach images to Groups, Workspaces, Members, and Loading screens in the Shortcut web application. */
|
|
1658
1977
|
display_icon: Icon | null;
|
|
1978
|
+
/**
|
|
1979
|
+
* The ID of the default workflow for stories created in this group.
|
|
1980
|
+
* @format int64
|
|
1981
|
+
*/
|
|
1982
|
+
default_workflow_id?: number | null;
|
|
1659
1983
|
/** The Member IDs contain within the Group. */
|
|
1660
1984
|
member_ids: string[];
|
|
1661
1985
|
/** The Workflow IDs contained within the Group. */
|
|
1662
1986
|
workflow_ids: number[];
|
|
1663
1987
|
}
|
|
1988
|
+
/** The current health status of the Epic. */
|
|
1989
|
+
interface Health {
|
|
1990
|
+
/** A string description of this resource. */
|
|
1991
|
+
entity_type: string;
|
|
1992
|
+
/**
|
|
1993
|
+
* The ID of the permission who created or updated the Health record.
|
|
1994
|
+
* @format uuid
|
|
1995
|
+
*/
|
|
1996
|
+
author_id?: string;
|
|
1997
|
+
/**
|
|
1998
|
+
* The ID of the Epic associated with this Health record.
|
|
1999
|
+
* @format int64
|
|
2000
|
+
*/
|
|
2001
|
+
epic_id?: number;
|
|
2002
|
+
/**
|
|
2003
|
+
* The ID of the Objective associated with this Health record.
|
|
2004
|
+
* @format int64
|
|
2005
|
+
*/
|
|
2006
|
+
objective_id?: number;
|
|
2007
|
+
/**
|
|
2008
|
+
* The time that the Health record was updated.
|
|
2009
|
+
* @format date-time
|
|
2010
|
+
*/
|
|
2011
|
+
updated_at?: string;
|
|
2012
|
+
/** The health status of the Epic or Objective. */
|
|
2013
|
+
status: "At Risk" | "On Track" | "Off Track" | "No Health";
|
|
2014
|
+
/**
|
|
2015
|
+
* The unique ID of the Health record.
|
|
2016
|
+
* @format uuid
|
|
2017
|
+
*/
|
|
2018
|
+
id?: string | null;
|
|
2019
|
+
/**
|
|
2020
|
+
* The time that the Health record was created.
|
|
2021
|
+
* @format date-time
|
|
2022
|
+
*/
|
|
2023
|
+
created_at?: string;
|
|
2024
|
+
/** The text of the Health record. */
|
|
2025
|
+
text?: string;
|
|
2026
|
+
}
|
|
1664
2027
|
/** A history item is a group of actions that represent a transactional change to a Story. */
|
|
1665
|
-
|
|
2028
|
+
interface History {
|
|
2029
|
+
/** The name of the actor that performed the action, if it can be determined. */
|
|
2030
|
+
actor_name?: string;
|
|
1666
2031
|
/** The date when the change occurred. */
|
|
1667
2032
|
changed_at: string;
|
|
1668
2033
|
/** The ID of the primary entity that has changed, if applicable. */
|
|
@@ -1684,12 +2049,17 @@ export interface History {
|
|
|
1684
2049
|
*/
|
|
1685
2050
|
id: string;
|
|
1686
2051
|
/** The version of the change format. */
|
|
1687
|
-
version:
|
|
2052
|
+
version: "v1";
|
|
1688
2053
|
/** The ID of the webhook that handled the change. */
|
|
1689
2054
|
webhook_id?: string | null;
|
|
2055
|
+
/**
|
|
2056
|
+
* The ID of the automation that performed the change.
|
|
2057
|
+
* @format uuid
|
|
2058
|
+
*/
|
|
2059
|
+
automation_id?: string;
|
|
1690
2060
|
}
|
|
1691
2061
|
/** An action representing a VCS Branch being created. */
|
|
1692
|
-
|
|
2062
|
+
interface HistoryActionBranchCreate {
|
|
1693
2063
|
/**
|
|
1694
2064
|
* The ID of the entity referenced.
|
|
1695
2065
|
* @format int64
|
|
@@ -1702,10 +2072,10 @@ export interface HistoryActionBranchCreate {
|
|
|
1702
2072
|
/** The URL from the provider of the VCS Branch that was pushed */
|
|
1703
2073
|
url: string;
|
|
1704
2074
|
/** The action of the entity referenced. */
|
|
1705
|
-
action:
|
|
2075
|
+
action: "create";
|
|
1706
2076
|
}
|
|
1707
2077
|
/** An action representing a VCS Branch being merged. */
|
|
1708
|
-
|
|
2078
|
+
interface HistoryActionBranchMerge {
|
|
1709
2079
|
/**
|
|
1710
2080
|
* The ID of the entity referenced.
|
|
1711
2081
|
* @format int64
|
|
@@ -1718,10 +2088,10 @@ export interface HistoryActionBranchMerge {
|
|
|
1718
2088
|
/** The URL from the provider of the VCS Branch that was pushed */
|
|
1719
2089
|
url: string;
|
|
1720
2090
|
/** The action of the entity referenced. */
|
|
1721
|
-
action:
|
|
2091
|
+
action: "merge";
|
|
1722
2092
|
}
|
|
1723
2093
|
/** An action representing a VCS Branch being pushed. */
|
|
1724
|
-
|
|
2094
|
+
interface HistoryActionBranchPush {
|
|
1725
2095
|
/**
|
|
1726
2096
|
* The ID of the entity referenced.
|
|
1727
2097
|
* @format int64
|
|
@@ -1734,10 +2104,10 @@ export interface HistoryActionBranchPush {
|
|
|
1734
2104
|
/** The URL from the provider of the VCS Branch that was pushed */
|
|
1735
2105
|
url: string;
|
|
1736
2106
|
/** The action of the entity referenced. */
|
|
1737
|
-
action:
|
|
2107
|
+
action: "push";
|
|
1738
2108
|
}
|
|
1739
2109
|
/** An action representing a Label being created. */
|
|
1740
|
-
|
|
2110
|
+
interface HistoryActionLabelCreate {
|
|
1741
2111
|
/**
|
|
1742
2112
|
* The ID of the entity referenced.
|
|
1743
2113
|
* @format int64
|
|
@@ -1746,7 +2116,7 @@ export interface HistoryActionLabelCreate {
|
|
|
1746
2116
|
/** The type of entity referenced. */
|
|
1747
2117
|
entity_type: string;
|
|
1748
2118
|
/** The action of the entity referenced. */
|
|
1749
|
-
action:
|
|
2119
|
+
action: "create";
|
|
1750
2120
|
/**
|
|
1751
2121
|
* The application URL of the Label.
|
|
1752
2122
|
* @maxLength 2048
|
|
@@ -1757,7 +2127,7 @@ export interface HistoryActionLabelCreate {
|
|
|
1757
2127
|
name: string;
|
|
1758
2128
|
}
|
|
1759
2129
|
/** An action representing a Label being deleted. */
|
|
1760
|
-
|
|
2130
|
+
interface HistoryActionLabelDelete {
|
|
1761
2131
|
/**
|
|
1762
2132
|
* The ID of the entity referenced.
|
|
1763
2133
|
* @format int64
|
|
@@ -1766,12 +2136,12 @@ export interface HistoryActionLabelDelete {
|
|
|
1766
2136
|
/** The type of entity referenced. */
|
|
1767
2137
|
entity_type: string;
|
|
1768
2138
|
/** The action of the entity referenced. */
|
|
1769
|
-
action:
|
|
2139
|
+
action: "delete";
|
|
1770
2140
|
/** The name of the Label. */
|
|
1771
2141
|
name: string;
|
|
1772
2142
|
}
|
|
1773
2143
|
/** An action representing a Label being updated. */
|
|
1774
|
-
|
|
2144
|
+
interface HistoryActionLabelUpdate {
|
|
1775
2145
|
/**
|
|
1776
2146
|
* The ID of the entity referenced.
|
|
1777
2147
|
* @format int64
|
|
@@ -1780,10 +2150,10 @@ export interface HistoryActionLabelUpdate {
|
|
|
1780
2150
|
/** The type of entity referenced. */
|
|
1781
2151
|
entity_type: string;
|
|
1782
2152
|
/** The action of the entity referenced. */
|
|
1783
|
-
action:
|
|
2153
|
+
action: "update";
|
|
1784
2154
|
}
|
|
1785
2155
|
/** An action representing a Project being updated. */
|
|
1786
|
-
|
|
2156
|
+
interface HistoryActionProjectUpdate {
|
|
1787
2157
|
/**
|
|
1788
2158
|
* The ID of the entity referenced.
|
|
1789
2159
|
* @format int64
|
|
@@ -1792,7 +2162,7 @@ export interface HistoryActionProjectUpdate {
|
|
|
1792
2162
|
/** The type of entity referenced. */
|
|
1793
2163
|
entity_type: string;
|
|
1794
2164
|
/** The action of the entity referenced. */
|
|
1795
|
-
action:
|
|
2165
|
+
action: "update";
|
|
1796
2166
|
/**
|
|
1797
2167
|
* The application URL of the Project.
|
|
1798
2168
|
* @maxLength 2048
|
|
@@ -1803,7 +2173,7 @@ export interface HistoryActionProjectUpdate {
|
|
|
1803
2173
|
name: string;
|
|
1804
2174
|
}
|
|
1805
2175
|
/** An action representing various operations for a Pull Request. */
|
|
1806
|
-
|
|
2176
|
+
interface HistoryActionPullRequest {
|
|
1807
2177
|
/**
|
|
1808
2178
|
* The ID of the entity referenced.
|
|
1809
2179
|
* @format int64
|
|
@@ -1812,7 +2182,7 @@ export interface HistoryActionPullRequest {
|
|
|
1812
2182
|
/** The type of entity referenced. */
|
|
1813
2183
|
entity_type: string;
|
|
1814
2184
|
/** The action of the entity referenced. */
|
|
1815
|
-
action:
|
|
2185
|
+
action: "open" | "update" | "reopen" | "close" | "sync" | "comment";
|
|
1816
2186
|
/**
|
|
1817
2187
|
* The VCS Repository-specific ID for the Pull Request.
|
|
1818
2188
|
* @format int64
|
|
@@ -1828,7 +2198,7 @@ export interface HistoryActionPullRequest {
|
|
|
1828
2198
|
url: string;
|
|
1829
2199
|
}
|
|
1830
2200
|
/** An action representing a Story Comment being created. */
|
|
1831
|
-
|
|
2201
|
+
interface HistoryActionStoryCommentCreate {
|
|
1832
2202
|
/**
|
|
1833
2203
|
* The ID of the entity referenced.
|
|
1834
2204
|
* @format int64
|
|
@@ -1837,7 +2207,7 @@ export interface HistoryActionStoryCommentCreate {
|
|
|
1837
2207
|
/** The type of entity referenced. */
|
|
1838
2208
|
entity_type: string;
|
|
1839
2209
|
/** The action of the entity referenced. */
|
|
1840
|
-
action:
|
|
2210
|
+
action: "create";
|
|
1841
2211
|
/**
|
|
1842
2212
|
* The application URL of the Story Comment.
|
|
1843
2213
|
* @maxLength 2048
|
|
@@ -1853,7 +2223,7 @@ export interface HistoryActionStoryCommentCreate {
|
|
|
1853
2223
|
author_id: string;
|
|
1854
2224
|
}
|
|
1855
2225
|
/** An action representing a Story being created. */
|
|
1856
|
-
|
|
2226
|
+
interface HistoryActionStoryCreate {
|
|
1857
2227
|
/**
|
|
1858
2228
|
* The application URL of the Story.
|
|
1859
2229
|
* @maxLength 2048
|
|
@@ -1869,7 +2239,7 @@ export interface HistoryActionStoryCreate {
|
|
|
1869
2239
|
/** An array of Task IDs on this Story. */
|
|
1870
2240
|
task_ids?: number[];
|
|
1871
2241
|
/** The type of Story; either feature, bug, or chore. */
|
|
1872
|
-
story_type:
|
|
2242
|
+
story_type: "feature" | "chore" | "bug";
|
|
1873
2243
|
/** The name of the Story. */
|
|
1874
2244
|
name: string;
|
|
1875
2245
|
/** Whether or not the Story is completed. */
|
|
@@ -1924,7 +2294,7 @@ export interface HistoryActionStoryCreate {
|
|
|
1924
2294
|
/** An array of Story IDs that are the subject of a Story Link relationship. */
|
|
1925
2295
|
subject_story_link_ids?: number[];
|
|
1926
2296
|
/** The action of the entity referenced. */
|
|
1927
|
-
action:
|
|
2297
|
+
action: "create";
|
|
1928
2298
|
/** Whether or not the Story is blocked by another Story. */
|
|
1929
2299
|
blocked?: boolean;
|
|
1930
2300
|
/**
|
|
@@ -1936,7 +2306,7 @@ export interface HistoryActionStoryCreate {
|
|
|
1936
2306
|
deadline?: string;
|
|
1937
2307
|
}
|
|
1938
2308
|
/** An action representing a Story being deleted. */
|
|
1939
|
-
|
|
2309
|
+
interface HistoryActionStoryDelete {
|
|
1940
2310
|
/**
|
|
1941
2311
|
* The ID of the entity referenced.
|
|
1942
2312
|
* @format int64
|
|
@@ -1945,14 +2315,14 @@ export interface HistoryActionStoryDelete {
|
|
|
1945
2315
|
/** The type of entity referenced. */
|
|
1946
2316
|
entity_type: string;
|
|
1947
2317
|
/** The action of the entity referenced. */
|
|
1948
|
-
action:
|
|
2318
|
+
action: "delete";
|
|
1949
2319
|
/** The name of the Story. */
|
|
1950
2320
|
name: string;
|
|
1951
2321
|
/** The type of Story; either feature, bug, or chore. */
|
|
1952
|
-
story_type:
|
|
2322
|
+
story_type: "feature" | "chore" | "bug";
|
|
1953
2323
|
}
|
|
1954
2324
|
/** An action representing a Story Link being created. */
|
|
1955
|
-
|
|
2325
|
+
interface HistoryActionStoryLinkCreate {
|
|
1956
2326
|
/**
|
|
1957
2327
|
* The ID of the entity referenced.
|
|
1958
2328
|
* @format int64
|
|
@@ -1961,9 +2331,9 @@ export interface HistoryActionStoryLinkCreate {
|
|
|
1961
2331
|
/** The type of entity referenced. */
|
|
1962
2332
|
entity_type: string;
|
|
1963
2333
|
/** The action of the entity referenced. */
|
|
1964
|
-
action:
|
|
2334
|
+
action: "create";
|
|
1965
2335
|
/** The verb describing the link's relationship. */
|
|
1966
|
-
verb:
|
|
2336
|
+
verb: "blocks" | "duplicates" | "relates to";
|
|
1967
2337
|
/**
|
|
1968
2338
|
* The Story ID of the subject Story.
|
|
1969
2339
|
* @format int64
|
|
@@ -1976,7 +2346,7 @@ export interface HistoryActionStoryLinkCreate {
|
|
|
1976
2346
|
object_id: number;
|
|
1977
2347
|
}
|
|
1978
2348
|
/** An action representing a Story Link being deleted. */
|
|
1979
|
-
|
|
2349
|
+
interface HistoryActionStoryLinkDelete {
|
|
1980
2350
|
/**
|
|
1981
2351
|
* The ID of the entity referenced.
|
|
1982
2352
|
* @format int64
|
|
@@ -1985,9 +2355,9 @@ export interface HistoryActionStoryLinkDelete {
|
|
|
1985
2355
|
/** The type of entity referenced. */
|
|
1986
2356
|
entity_type: string;
|
|
1987
2357
|
/** The action of the entity referenced. */
|
|
1988
|
-
action:
|
|
2358
|
+
action: "delete";
|
|
1989
2359
|
/** The verb describing the link's relationship. */
|
|
1990
|
-
verb:
|
|
2360
|
+
verb: "blocks" | "duplicates" | "relates to";
|
|
1991
2361
|
/**
|
|
1992
2362
|
* The Story ID of the subject Story.
|
|
1993
2363
|
* @format int64
|
|
@@ -2000,7 +2370,7 @@ export interface HistoryActionStoryLinkDelete {
|
|
|
2000
2370
|
object_id?: number | null;
|
|
2001
2371
|
}
|
|
2002
2372
|
/** An action representing a Story Link being updated. */
|
|
2003
|
-
|
|
2373
|
+
interface HistoryActionStoryLinkUpdate {
|
|
2004
2374
|
/**
|
|
2005
2375
|
* The ID of the entity referenced.
|
|
2006
2376
|
* @format int64
|
|
@@ -2009,9 +2379,9 @@ export interface HistoryActionStoryLinkUpdate {
|
|
|
2009
2379
|
/** The type of entity referenced. */
|
|
2010
2380
|
entity_type: string;
|
|
2011
2381
|
/** The action of the entity referenced. */
|
|
2012
|
-
action:
|
|
2382
|
+
action: "update";
|
|
2013
2383
|
/** The verb describing the link's relationship. */
|
|
2014
|
-
verb:
|
|
2384
|
+
verb: "blocks" | "duplicates" | "relates to";
|
|
2015
2385
|
/**
|
|
2016
2386
|
* The Story ID of the subject Story.
|
|
2017
2387
|
* @format int64
|
|
@@ -2026,7 +2396,7 @@ export interface HistoryActionStoryLinkUpdate {
|
|
|
2026
2396
|
changes: HistoryChangesStoryLink;
|
|
2027
2397
|
}
|
|
2028
2398
|
/** An action representing a Story being updated. */
|
|
2029
|
-
|
|
2399
|
+
interface HistoryActionStoryUpdate {
|
|
2030
2400
|
/**
|
|
2031
2401
|
* The ID of the entity referenced.
|
|
2032
2402
|
* @format int64
|
|
@@ -2035,7 +2405,7 @@ export interface HistoryActionStoryUpdate {
|
|
|
2035
2405
|
/** The type of entity referenced. */
|
|
2036
2406
|
entity_type: string;
|
|
2037
2407
|
/** The action of the entity referenced. */
|
|
2038
|
-
action:
|
|
2408
|
+
action: "update";
|
|
2039
2409
|
/**
|
|
2040
2410
|
* The application URL of the Story.
|
|
2041
2411
|
* @maxLength 2048
|
|
@@ -2047,10 +2417,10 @@ export interface HistoryActionStoryUpdate {
|
|
|
2047
2417
|
/** The name of the Story. */
|
|
2048
2418
|
name: string;
|
|
2049
2419
|
/** The type of Story; either feature, bug, or chore. */
|
|
2050
|
-
story_type:
|
|
2420
|
+
story_type: "feature" | "chore" | "bug";
|
|
2051
2421
|
}
|
|
2052
2422
|
/** An action representing a Task being created. */
|
|
2053
|
-
|
|
2423
|
+
interface HistoryActionTaskCreate {
|
|
2054
2424
|
/** The description of the Task. */
|
|
2055
2425
|
description: string;
|
|
2056
2426
|
/** The type of entity referenced. */
|
|
@@ -2067,14 +2437,14 @@ export interface HistoryActionTaskCreate {
|
|
|
2067
2437
|
*/
|
|
2068
2438
|
id: number;
|
|
2069
2439
|
/** The action of the entity referenced. */
|
|
2070
|
-
action:
|
|
2440
|
+
action: "create";
|
|
2071
2441
|
/** Whether or not the Task is complete. */
|
|
2072
2442
|
complete: boolean;
|
|
2073
2443
|
/** A timestamp that represent's the Task's deadline. */
|
|
2074
2444
|
deadline?: string;
|
|
2075
2445
|
}
|
|
2076
2446
|
/** An action representing a Task being deleted. */
|
|
2077
|
-
|
|
2447
|
+
interface HistoryActionTaskDelete {
|
|
2078
2448
|
/**
|
|
2079
2449
|
* The ID of the entity referenced.
|
|
2080
2450
|
* @format int64
|
|
@@ -2083,12 +2453,12 @@ export interface HistoryActionTaskDelete {
|
|
|
2083
2453
|
/** The type of entity referenced. */
|
|
2084
2454
|
entity_type: string;
|
|
2085
2455
|
/** The action of the entity referenced. */
|
|
2086
|
-
action:
|
|
2456
|
+
action: "delete";
|
|
2087
2457
|
/** The description of the Task being deleted. */
|
|
2088
2458
|
description: string;
|
|
2089
2459
|
}
|
|
2090
2460
|
/** An action representing a Task being updated. */
|
|
2091
|
-
|
|
2461
|
+
interface HistoryActionTaskUpdate {
|
|
2092
2462
|
/**
|
|
2093
2463
|
* The ID of the entity referenced.
|
|
2094
2464
|
* @format int64
|
|
@@ -2097,7 +2467,7 @@ export interface HistoryActionTaskUpdate {
|
|
|
2097
2467
|
/** The type of entity referenced. */
|
|
2098
2468
|
entity_type: string;
|
|
2099
2469
|
/** The action of the entity referenced. */
|
|
2100
|
-
action:
|
|
2470
|
+
action: "update";
|
|
2101
2471
|
/** The changes that have occurred as a result of the action. */
|
|
2102
2472
|
changes: HistoryChangesTask;
|
|
2103
2473
|
/** Whether or not the Task is complete. */
|
|
@@ -2111,7 +2481,7 @@ export interface HistoryActionTaskUpdate {
|
|
|
2111
2481
|
story_id: number;
|
|
2112
2482
|
}
|
|
2113
2483
|
/** An action representing a bulk operation within a workspace2. */
|
|
2114
|
-
|
|
2484
|
+
interface HistoryActionWorkspace2BulkUpdate {
|
|
2115
2485
|
/**
|
|
2116
2486
|
* The ID of the entity referenced.
|
|
2117
2487
|
* @format uuid
|
|
@@ -2120,12 +2490,12 @@ export interface HistoryActionWorkspace2BulkUpdate {
|
|
|
2120
2490
|
/** The type of entity referenced. */
|
|
2121
2491
|
entity_type: string;
|
|
2122
2492
|
/** The action of the entity referenced. */
|
|
2123
|
-
action:
|
|
2493
|
+
action: "bulk-update";
|
|
2124
2494
|
/** The name of the workspace2 in which the BulkUpdate occurred. */
|
|
2125
2495
|
name: string;
|
|
2126
2496
|
}
|
|
2127
2497
|
/** The changes that have occurred as a result of the action. */
|
|
2128
|
-
|
|
2498
|
+
interface HistoryChangesStory {
|
|
2129
2499
|
/** A timestamp that represents the Story's deadline. */
|
|
2130
2500
|
description?: StoryHistoryChangeOldNewStr;
|
|
2131
2501
|
/** True if the Story has archived, otherwise false. */
|
|
@@ -2180,7 +2550,7 @@ export interface HistoryChangesStory {
|
|
|
2180
2550
|
deadline?: StoryHistoryChangeOldNewStr;
|
|
2181
2551
|
}
|
|
2182
2552
|
/** The changes that have occurred as a result of the action. */
|
|
2183
|
-
|
|
2553
|
+
interface HistoryChangesStoryLink {
|
|
2184
2554
|
/** A timestamp that represents the Story's deadline. */
|
|
2185
2555
|
verb?: StoryHistoryChangeOldNewStr;
|
|
2186
2556
|
/** The estimate value for the Story */
|
|
@@ -2189,7 +2559,7 @@ export interface HistoryChangesStoryLink {
|
|
|
2189
2559
|
subject_id?: StoryHistoryChangeOldNewInt;
|
|
2190
2560
|
}
|
|
2191
2561
|
/** The changes that have occurred as a result of the action. */
|
|
2192
|
-
|
|
2562
|
+
interface HistoryChangesTask {
|
|
2193
2563
|
/** True if the Story has archived, otherwise false. */
|
|
2194
2564
|
complete?: StoryHistoryChangeOldNewBool;
|
|
2195
2565
|
/** A timestamp that represents the Story's deadline. */
|
|
@@ -2200,7 +2570,7 @@ export interface HistoryChangesTask {
|
|
|
2200
2570
|
owner_ids?: StoryHistoryChangeAddsRemovesUuid;
|
|
2201
2571
|
}
|
|
2202
2572
|
/** A reference to a VCS Branch. */
|
|
2203
|
-
|
|
2573
|
+
interface HistoryReferenceBranch {
|
|
2204
2574
|
/** The ID of the entity referenced. */
|
|
2205
2575
|
id: number | string;
|
|
2206
2576
|
/** The type of entity referenced. */
|
|
@@ -2215,7 +2585,7 @@ export interface HistoryReferenceBranch {
|
|
|
2215
2585
|
url: string;
|
|
2216
2586
|
}
|
|
2217
2587
|
/** A reference to a VCS Commit. */
|
|
2218
|
-
|
|
2588
|
+
interface HistoryReferenceCommit {
|
|
2219
2589
|
/** The ID of the entity referenced. */
|
|
2220
2590
|
id: number | string;
|
|
2221
2591
|
/** The type of entity referenced. */
|
|
@@ -2230,34 +2600,29 @@ export interface HistoryReferenceCommit {
|
|
|
2230
2600
|
url: string;
|
|
2231
2601
|
}
|
|
2232
2602
|
/** A reference to a CustomField value asserted on a Story. */
|
|
2233
|
-
|
|
2234
|
-
/** The type of entity referenced. */
|
|
2235
|
-
entity_type: string;
|
|
2236
|
-
/** The name as it is displayed to the user of the parent custom-field of this enum value. */
|
|
2237
|
-
field_name: string;
|
|
2238
|
-
/**
|
|
2239
|
-
* The custom-field enum value as a string.
|
|
2240
|
-
* @format int64
|
|
2241
|
-
*/
|
|
2242
|
-
integer_value?: number | null;
|
|
2243
|
-
/** Whether or not the custom-field is enabled. */
|
|
2244
|
-
field_enabled: boolean;
|
|
2603
|
+
interface HistoryReferenceCustomFieldEnumValue {
|
|
2245
2604
|
/** The ID of the entity referenced. */
|
|
2246
2605
|
id: number | string;
|
|
2247
|
-
/** The type
|
|
2248
|
-
|
|
2606
|
+
/** The type of entity referenced. */
|
|
2607
|
+
entity_type: string;
|
|
2608
|
+
/** The custom-field enum value as a string. */
|
|
2609
|
+
string_value?: string | null;
|
|
2610
|
+
/** Whether or not the custom-field enum value is enabled. */
|
|
2611
|
+
enum_value_enabled?: boolean | null;
|
|
2249
2612
|
/**
|
|
2250
2613
|
* The public-id of the parent custom-field of this enum value.
|
|
2251
2614
|
* @format uuid
|
|
2252
2615
|
*/
|
|
2253
2616
|
field_id: string;
|
|
2254
|
-
/** The custom-field enum value
|
|
2255
|
-
|
|
2256
|
-
/**
|
|
2257
|
-
|
|
2617
|
+
/** The type variety of the parent custom-field of this enum value. */
|
|
2618
|
+
field_type: string;
|
|
2619
|
+
/** The name as it is displayed to the user of the parent custom-field of this enum value. */
|
|
2620
|
+
field_name: string;
|
|
2621
|
+
/** Whether or not the custom-field is enabled. */
|
|
2622
|
+
field_enabled: boolean;
|
|
2258
2623
|
}
|
|
2259
2624
|
/** A reference to an Epic. */
|
|
2260
|
-
|
|
2625
|
+
interface HistoryReferenceEpic {
|
|
2261
2626
|
/** The ID of the entity referenced. */
|
|
2262
2627
|
id: number | string;
|
|
2263
2628
|
/** The type of entity referenced. */
|
|
@@ -2272,7 +2637,7 @@ export interface HistoryReferenceEpic {
|
|
|
2272
2637
|
name: string;
|
|
2273
2638
|
}
|
|
2274
2639
|
/** A default reference for entity types that don't have extra fields. */
|
|
2275
|
-
|
|
2640
|
+
interface HistoryReferenceGeneral {
|
|
2276
2641
|
/** The ID of the entity referenced. */
|
|
2277
2642
|
id: number | string;
|
|
2278
2643
|
/** The type of entity referenced. */
|
|
@@ -2281,7 +2646,7 @@ export interface HistoryReferenceGeneral {
|
|
|
2281
2646
|
name: string;
|
|
2282
2647
|
}
|
|
2283
2648
|
/** A reference to a Group. */
|
|
2284
|
-
|
|
2649
|
+
interface HistoryReferenceGroup {
|
|
2285
2650
|
/**
|
|
2286
2651
|
* The ID of the entity referenced.
|
|
2287
2652
|
* @format uuid
|
|
@@ -2293,7 +2658,7 @@ export interface HistoryReferenceGroup {
|
|
|
2293
2658
|
name: string;
|
|
2294
2659
|
}
|
|
2295
2660
|
/** A reference to an Iteration. */
|
|
2296
|
-
|
|
2661
|
+
interface HistoryReferenceIteration {
|
|
2297
2662
|
/** The ID of the entity referenced. */
|
|
2298
2663
|
id: number | string;
|
|
2299
2664
|
/** The type of entity referenced. */
|
|
@@ -2308,7 +2673,7 @@ export interface HistoryReferenceIteration {
|
|
|
2308
2673
|
name: string;
|
|
2309
2674
|
}
|
|
2310
2675
|
/** A reference to an Label. */
|
|
2311
|
-
|
|
2676
|
+
interface HistoryReferenceLabel {
|
|
2312
2677
|
/** The ID of the entity referenced. */
|
|
2313
2678
|
id: number | string;
|
|
2314
2679
|
/** The type of entity referenced. */
|
|
@@ -2323,7 +2688,7 @@ export interface HistoryReferenceLabel {
|
|
|
2323
2688
|
name: string;
|
|
2324
2689
|
}
|
|
2325
2690
|
/** A reference to an Project. */
|
|
2326
|
-
|
|
2691
|
+
interface HistoryReferenceProject {
|
|
2327
2692
|
/** The ID of the entity referenced. */
|
|
2328
2693
|
id: number | string;
|
|
2329
2694
|
/** The type of entity referenced. */
|
|
@@ -2338,7 +2703,7 @@ export interface HistoryReferenceProject {
|
|
|
2338
2703
|
name: string;
|
|
2339
2704
|
}
|
|
2340
2705
|
/** A reference to a Story. */
|
|
2341
|
-
|
|
2706
|
+
interface HistoryReferenceStory {
|
|
2342
2707
|
/** The ID of the entity referenced. */
|
|
2343
2708
|
id: number | string;
|
|
2344
2709
|
/** The type of entity referenced. */
|
|
@@ -2352,10 +2717,10 @@ export interface HistoryReferenceStory {
|
|
|
2352
2717
|
/** The name of the entity referenced. */
|
|
2353
2718
|
name: string;
|
|
2354
2719
|
/** If the referenced entity is a Story, either "bug", "chore", or "feature". */
|
|
2355
|
-
story_type:
|
|
2720
|
+
story_type: "feature" | "chore" | "bug";
|
|
2356
2721
|
}
|
|
2357
2722
|
/** A reference to a Story Task. */
|
|
2358
|
-
|
|
2723
|
+
interface HistoryReferenceStoryTask {
|
|
2359
2724
|
/** The ID of the entity referenced. */
|
|
2360
2725
|
id: number | string;
|
|
2361
2726
|
/** The type of entity referenced. */
|
|
@@ -2364,18 +2729,18 @@ export interface HistoryReferenceStoryTask {
|
|
|
2364
2729
|
description: string;
|
|
2365
2730
|
}
|
|
2366
2731
|
/** A references to a Story Workflow State. */
|
|
2367
|
-
|
|
2732
|
+
interface HistoryReferenceWorkflowState {
|
|
2368
2733
|
/** The ID of the entity referenced. */
|
|
2369
2734
|
id: number | string;
|
|
2370
2735
|
/** The type of entity referenced. */
|
|
2371
2736
|
entity_type: string;
|
|
2372
|
-
/** Either "unstarted", "started", or "done". */
|
|
2373
|
-
type:
|
|
2737
|
+
/** Either "backlog", "unstarted", "started", or "done". */
|
|
2738
|
+
type: "started" | "backlog" | "unstarted" | "done";
|
|
2374
2739
|
/** The name of the entity referenced. */
|
|
2375
2740
|
name: string;
|
|
2376
2741
|
}
|
|
2377
2742
|
/** Icons are used to attach images to Groups, Workspaces, Members, and Loading screens in the Shortcut web application. */
|
|
2378
|
-
|
|
2743
|
+
interface Icon {
|
|
2379
2744
|
/** A string description of this resource. */
|
|
2380
2745
|
entity_type: string;
|
|
2381
2746
|
/**
|
|
@@ -2397,16 +2762,16 @@ export interface Icon {
|
|
|
2397
2762
|
url: string;
|
|
2398
2763
|
}
|
|
2399
2764
|
/** The Identity of the VCS user that authored the Commit. */
|
|
2400
|
-
|
|
2765
|
+
interface Identity {
|
|
2401
2766
|
/** A string description of this resource. */
|
|
2402
2767
|
entity_type: string;
|
|
2403
2768
|
/** This is your login in VCS. */
|
|
2404
2769
|
name?: string | null;
|
|
2405
2770
|
/** The service this Identity is for. */
|
|
2406
|
-
type?:
|
|
2771
|
+
type?: "slack" | "github" | "gitlab" | "bitbucket" | null;
|
|
2407
2772
|
}
|
|
2408
2773
|
/** An Iteration is a defined, time-boxed period of development for a collection of Stories. See https://help.shortcut.com/hc/en-us/articles/360028953452-Iterations-Overview for more information. */
|
|
2409
|
-
|
|
2774
|
+
interface Iteration {
|
|
2410
2775
|
/** The Shortcut application url for the Iteration. */
|
|
2411
2776
|
app_url: string;
|
|
2412
2777
|
/** The description of the iteration. */
|
|
@@ -2415,7 +2780,7 @@ export interface Iteration {
|
|
|
2415
2780
|
entity_type: string;
|
|
2416
2781
|
/** An array of labels attached to the iteration. */
|
|
2417
2782
|
labels: Label[];
|
|
2418
|
-
/** Deprecated
|
|
2783
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
2419
2784
|
mention_ids: string[];
|
|
2420
2785
|
/** An array of Member IDs that have been mentioned in the Story description. */
|
|
2421
2786
|
member_mention_ids: string[];
|
|
@@ -2434,7 +2799,7 @@ export interface Iteration {
|
|
|
2434
2799
|
/** An array of Group IDs that have been mentioned in the Story description. */
|
|
2435
2800
|
group_mention_ids: string[];
|
|
2436
2801
|
/**
|
|
2437
|
-
* The date this iteration
|
|
2802
|
+
* The date this iteration ends.
|
|
2438
2803
|
* @format date-time
|
|
2439
2804
|
*/
|
|
2440
2805
|
end_date: string;
|
|
@@ -2462,7 +2827,7 @@ export interface Iteration {
|
|
|
2462
2827
|
*/
|
|
2463
2828
|
created_at: string;
|
|
2464
2829
|
}
|
|
2465
|
-
|
|
2830
|
+
interface IterationAssociatedGroup {
|
|
2466
2831
|
/**
|
|
2467
2832
|
* The Group ID of the associated group.
|
|
2468
2833
|
* @format uuid
|
|
@@ -2475,7 +2840,7 @@ export interface IterationAssociatedGroup {
|
|
|
2475
2840
|
associated_stories_count?: number;
|
|
2476
2841
|
}
|
|
2477
2842
|
/** The results of the Iteration search query. */
|
|
2478
|
-
|
|
2843
|
+
interface IterationSearchResults {
|
|
2479
2844
|
/**
|
|
2480
2845
|
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
2481
2846
|
* @format int64
|
|
@@ -2485,17 +2850,16 @@ export interface IterationSearchResults {
|
|
|
2485
2850
|
data: IterationSlim[];
|
|
2486
2851
|
/** The URL path and query string for the next page of search results. */
|
|
2487
2852
|
next?: string | null;
|
|
2488
|
-
cursors?: string[];
|
|
2489
2853
|
}
|
|
2490
2854
|
/** IterationSlim represents the same resource as an Iteration, but is more light-weight. Use the [Get Iteration](#Get-Iteration) endpoint to fetch the unabridged payload for an Iteration. */
|
|
2491
|
-
|
|
2855
|
+
interface IterationSlim {
|
|
2492
2856
|
/** The Shortcut application url for the Iteration. */
|
|
2493
2857
|
app_url: string;
|
|
2494
2858
|
/** A string description of this resource */
|
|
2495
2859
|
entity_type: string;
|
|
2496
2860
|
/** An array of labels attached to the iteration. */
|
|
2497
2861
|
labels: Label[];
|
|
2498
|
-
/** Deprecated
|
|
2862
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
2499
2863
|
mention_ids: string[];
|
|
2500
2864
|
/** An array of Member IDs that have been mentioned in the Story description. */
|
|
2501
2865
|
member_mention_ids: string[];
|
|
@@ -2514,7 +2878,7 @@ export interface IterationSlim {
|
|
|
2514
2878
|
/** An array of Group IDs that have been mentioned in the Story description. */
|
|
2515
2879
|
group_mention_ids: string[];
|
|
2516
2880
|
/**
|
|
2517
|
-
* The date this iteration
|
|
2881
|
+
* The date this iteration ends.
|
|
2518
2882
|
* @format date-time
|
|
2519
2883
|
*/
|
|
2520
2884
|
end_date: string;
|
|
@@ -2543,7 +2907,7 @@ export interface IterationSlim {
|
|
|
2543
2907
|
created_at: string;
|
|
2544
2908
|
}
|
|
2545
2909
|
/** A group of calculated values for this Iteration. */
|
|
2546
|
-
|
|
2910
|
+
interface IterationStats {
|
|
2547
2911
|
/**
|
|
2548
2912
|
* The total number of completed points in this Iteration.
|
|
2549
2913
|
* @format int64
|
|
@@ -2610,8 +2974,42 @@ export interface IterationStats {
|
|
|
2610
2974
|
*/
|
|
2611
2975
|
num_stories_done: number;
|
|
2612
2976
|
}
|
|
2977
|
+
interface KeyResult {
|
|
2978
|
+
/**
|
|
2979
|
+
* The ID of the Key Result.
|
|
2980
|
+
* @format uuid
|
|
2981
|
+
*/
|
|
2982
|
+
id: string;
|
|
2983
|
+
/** The name of the Key Result. */
|
|
2984
|
+
name: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* The Objective to which this Key Result belongs.
|
|
2987
|
+
* @format int64
|
|
2988
|
+
*/
|
|
2989
|
+
objective_id: number;
|
|
2990
|
+
/** The type of the Key Result (numeric, percent, or boolean). */
|
|
2991
|
+
type: "percent" | "boolean" | "numeric";
|
|
2992
|
+
/** The starting value of the Key Result. */
|
|
2993
|
+
initial_observed_value: KeyResultValue;
|
|
2994
|
+
/** The starting value of the Key Result. */
|
|
2995
|
+
current_observed_value: KeyResultValue;
|
|
2996
|
+
/** The starting value of the Key Result. */
|
|
2997
|
+
current_target_value: KeyResultValue;
|
|
2998
|
+
/**
|
|
2999
|
+
* The integer percentage of progress toward completion of the Key Result.
|
|
3000
|
+
* @format int64
|
|
3001
|
+
*/
|
|
3002
|
+
progress: number;
|
|
3003
|
+
}
|
|
3004
|
+
/** The starting value of the Key Result. */
|
|
3005
|
+
interface KeyResultValue {
|
|
3006
|
+
/** The numeric value, as a decimal string. No more than two decimal places are allowed. */
|
|
3007
|
+
numeric_value?: string;
|
|
3008
|
+
/** The boolean value. */
|
|
3009
|
+
boolean_value?: boolean;
|
|
3010
|
+
}
|
|
2613
3011
|
/** A Label can be used to associate and filter Stories and Epics, and also create new Workspaces. */
|
|
2614
|
-
|
|
3012
|
+
interface Label {
|
|
2615
3013
|
/** The Shortcut application url for the Label. */
|
|
2616
3014
|
app_url: string;
|
|
2617
3015
|
/** The description of the Label. */
|
|
@@ -2651,7 +3049,7 @@ export interface Label {
|
|
|
2651
3049
|
created_at?: string | null;
|
|
2652
3050
|
}
|
|
2653
3051
|
/** A Label can be used to associate and filter Stories and Epics, and also create new Workspaces. A slim Label does not include aggregate stats. Fetch the Label using the labels endpoint to retrieve them. */
|
|
2654
|
-
|
|
3052
|
+
interface LabelSlim {
|
|
2655
3053
|
/** The Shortcut application url for the Label. */
|
|
2656
3054
|
app_url: string;
|
|
2657
3055
|
/** The description of the Label. */
|
|
@@ -2689,7 +3087,7 @@ export interface LabelSlim {
|
|
|
2689
3087
|
created_at?: string | null;
|
|
2690
3088
|
}
|
|
2691
3089
|
/** A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint. */
|
|
2692
|
-
|
|
3090
|
+
interface LabelStats {
|
|
2693
3091
|
/**
|
|
2694
3092
|
* The total number of Documents associated this Label.
|
|
2695
3093
|
* @format int64
|
|
@@ -2776,15 +3174,22 @@ export interface LabelStats {
|
|
|
2776
3174
|
*/
|
|
2777
3175
|
num_epics_completed: number;
|
|
2778
3176
|
}
|
|
3177
|
+
interface LinkSubTaskParams {
|
|
3178
|
+
/**
|
|
3179
|
+
* The ID of the story to link as a sub-task of the parent story
|
|
3180
|
+
* @format int64
|
|
3181
|
+
*/
|
|
3182
|
+
story_id: number;
|
|
3183
|
+
}
|
|
2779
3184
|
/** Linked files are stored on a third-party website and linked to one or more Stories. Shortcut currently supports linking files from Google Drive, Dropbox, Box, and by URL. */
|
|
2780
|
-
|
|
3185
|
+
interface LinkedFile {
|
|
2781
3186
|
/** The description of the file. */
|
|
2782
3187
|
description?: string | null;
|
|
2783
3188
|
/** A string description of this resource. */
|
|
2784
3189
|
entity_type: string;
|
|
2785
3190
|
/** The IDs of the stories this file is attached to. */
|
|
2786
3191
|
story_ids: number[];
|
|
2787
|
-
/** Deprecated
|
|
3192
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
2788
3193
|
mention_ids: string[];
|
|
2789
3194
|
/** The members that are mentioned in the description of the file. */
|
|
2790
3195
|
member_mention_ids: string[];
|
|
@@ -2826,47 +3231,20 @@ export interface LinkedFile {
|
|
|
2826
3231
|
*/
|
|
2827
3232
|
created_at: string;
|
|
2828
3233
|
}
|
|
2829
|
-
export interface ListEpics {
|
|
2830
|
-
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
2831
|
-
includes_description?: boolean;
|
|
2832
|
-
}
|
|
2833
|
-
export interface ListGroupStories {
|
|
2834
|
-
/**
|
|
2835
|
-
* The maximum number of results to return. (Defaults to 1000, max 1000)
|
|
2836
|
-
* @format int64
|
|
2837
|
-
*/
|
|
2838
|
-
limit?: number;
|
|
2839
|
-
/**
|
|
2840
|
-
* The offset at which to begin returning results. (Defaults to 0)
|
|
2841
|
-
* @format int64
|
|
2842
|
-
*/
|
|
2843
|
-
offset?: number;
|
|
2844
|
-
}
|
|
2845
|
-
export interface ListLabels {
|
|
2846
|
-
/** A true/false boolean indicating if the slim versions of the Label should be returned. */
|
|
2847
|
-
slim?: boolean;
|
|
2848
|
-
}
|
|
2849
|
-
export interface ListMembers {
|
|
2850
|
-
/**
|
|
2851
|
-
* The unique ID of the Organization to limit the list to.
|
|
2852
|
-
* @format uuid
|
|
2853
|
-
*/
|
|
2854
|
-
'org-public-id'?: string;
|
|
2855
|
-
}
|
|
2856
3234
|
/** Error returned when total maximum supported results have been reached. */
|
|
2857
|
-
|
|
3235
|
+
interface MaxSearchResultsExceededError {
|
|
2858
3236
|
/** The name for this type of error, `maximum-results-exceeded` */
|
|
2859
|
-
error:
|
|
3237
|
+
error: "maximum-results-exceeded";
|
|
2860
3238
|
/** An explanatory message: "A maximum of 1000 search results are supported." */
|
|
2861
3239
|
message: string;
|
|
2862
3240
|
/**
|
|
2863
3241
|
* The maximum number of search results supported, `1000`
|
|
2864
3242
|
* @format int64
|
|
2865
3243
|
*/
|
|
2866
|
-
|
|
3244
|
+
"maximum-results": 1000;
|
|
2867
3245
|
}
|
|
2868
3246
|
/** Details about an individual user within the Workspace. */
|
|
2869
|
-
|
|
3247
|
+
interface Member {
|
|
2870
3248
|
/** The Member's role in the Workspace. */
|
|
2871
3249
|
role: string;
|
|
2872
3250
|
/** A string description of this resource. */
|
|
@@ -2875,7 +3253,7 @@ export interface Member {
|
|
|
2875
3253
|
disabled: boolean;
|
|
2876
3254
|
global_id: string;
|
|
2877
3255
|
/** The user state, one of partial, full, disabled, or imported. A partial user is disabled, has no means to log in, and is not an import user. A full user is enabled and has a means to log in. A disabled user is disabled and has a means to log in. An import user is disabled, has no means to log in, and is marked as an import user. */
|
|
2878
|
-
state:
|
|
3256
|
+
state: "partial" | "full" | "disabled" | "imported";
|
|
2879
3257
|
/**
|
|
2880
3258
|
* The time/date the Member was last updated.
|
|
2881
3259
|
* @format date-time
|
|
@@ -2903,15 +3281,17 @@ export interface Member {
|
|
|
2903
3281
|
*/
|
|
2904
3282
|
replaced_by?: string;
|
|
2905
3283
|
}
|
|
2906
|
-
|
|
3284
|
+
interface MemberInfo {
|
|
2907
3285
|
/** @format uuid */
|
|
2908
3286
|
id: string;
|
|
2909
|
-
|
|
3287
|
+
is_owner: boolean;
|
|
2910
3288
|
mention_name: string;
|
|
3289
|
+
name: string;
|
|
3290
|
+
role: string;
|
|
2911
3291
|
workspace2: BasicWorkspaceInfo;
|
|
2912
3292
|
}
|
|
2913
|
-
/** A Milestone is a collection of Epics that represent a release or some other large initiative that you are working on. */
|
|
2914
|
-
|
|
3293
|
+
/** (Deprecated) A Milestone is a collection of Epics that represent a release or some other large initiative that you are working on. Milestones have become Objectives, so you should use Objective-related API resources instead of Milestone ones. */
|
|
3294
|
+
interface Milestone {
|
|
2915
3295
|
/** The Shortcut application url for the Milestone. */
|
|
2916
3296
|
app_url: string;
|
|
2917
3297
|
/** The Milestone's description. */
|
|
@@ -2961,6 +3341,8 @@ export interface Milestone {
|
|
|
2961
3341
|
* @format int64
|
|
2962
3342
|
*/
|
|
2963
3343
|
id: number;
|
|
3344
|
+
/** The IDs of the Key Results associated with the Objective. */
|
|
3345
|
+
key_result_ids: string[];
|
|
2964
3346
|
/**
|
|
2965
3347
|
* A number representing the position of the Milestone in relation to every other Milestone within the Workspace.
|
|
2966
3348
|
* @format int64
|
|
@@ -2974,8 +3356,92 @@ export interface Milestone {
|
|
|
2974
3356
|
*/
|
|
2975
3357
|
created_at: string;
|
|
2976
3358
|
}
|
|
3359
|
+
/** A group of calculated values for this Milestone. */
|
|
3360
|
+
interface MilestoneStats {
|
|
3361
|
+
/**
|
|
3362
|
+
* The average cycle time (in seconds) of completed stories in this Milestone.
|
|
3363
|
+
* @format int64
|
|
3364
|
+
*/
|
|
3365
|
+
average_cycle_time?: number;
|
|
3366
|
+
/**
|
|
3367
|
+
* The average lead time (in seconds) of completed stories in this Milestone.
|
|
3368
|
+
* @format int64
|
|
3369
|
+
*/
|
|
3370
|
+
average_lead_time?: number;
|
|
3371
|
+
/**
|
|
3372
|
+
* The number of related documents to this Milestone.
|
|
3373
|
+
* @format int64
|
|
3374
|
+
*/
|
|
3375
|
+
num_related_documents: number;
|
|
3376
|
+
}
|
|
3377
|
+
/** An Objective is a collection of Epics that represent a release or some other large initiative that you are working on. */
|
|
3378
|
+
interface Objective {
|
|
3379
|
+
/** The Shortcut application url for the Objective. */
|
|
3380
|
+
app_url: string;
|
|
3381
|
+
/** The Objective's description. */
|
|
3382
|
+
description: string;
|
|
3383
|
+
/** A boolean indicating whether the Objective has been archived or not. */
|
|
3384
|
+
archived: boolean;
|
|
3385
|
+
/** A true/false boolean indicating if the Objective has been started. */
|
|
3386
|
+
started: boolean;
|
|
3387
|
+
/** A string description of this resource. */
|
|
3388
|
+
entity_type: string;
|
|
3389
|
+
/**
|
|
3390
|
+
* A manual override for the time/date the Objective was completed.
|
|
3391
|
+
* @format date-time
|
|
3392
|
+
*/
|
|
3393
|
+
completed_at_override?: string | null;
|
|
3394
|
+
/**
|
|
3395
|
+
* The time/date the Objective was started.
|
|
3396
|
+
* @format date-time
|
|
3397
|
+
*/
|
|
3398
|
+
started_at?: string | null;
|
|
3399
|
+
/**
|
|
3400
|
+
* The time/date the Objective was completed.
|
|
3401
|
+
* @format date-time
|
|
3402
|
+
*/
|
|
3403
|
+
completed_at?: string | null;
|
|
3404
|
+
/** The name of the Objective. */
|
|
3405
|
+
name: string;
|
|
3406
|
+
global_id: string;
|
|
3407
|
+
/** A true/false boolean indicating if the Objectivehas been completed. */
|
|
3408
|
+
completed: boolean;
|
|
3409
|
+
/** The workflow state that the Objective is in. */
|
|
3410
|
+
state: string;
|
|
3411
|
+
/**
|
|
3412
|
+
* A manual override for the time/date the Objective was started.
|
|
3413
|
+
* @format date-time
|
|
3414
|
+
*/
|
|
3415
|
+
started_at_override?: string | null;
|
|
3416
|
+
/**
|
|
3417
|
+
* The time/date the Objective was updated.
|
|
3418
|
+
* @format date-time
|
|
3419
|
+
*/
|
|
3420
|
+
updated_at: string;
|
|
3421
|
+
/** An array of Categories attached to the Objective. */
|
|
3422
|
+
categories: Category[];
|
|
3423
|
+
/**
|
|
3424
|
+
* The unique ID of the Objective.
|
|
3425
|
+
* @format int64
|
|
3426
|
+
*/
|
|
3427
|
+
id: number;
|
|
3428
|
+
/** The IDs of the Key Results associated with the Objective. */
|
|
3429
|
+
key_result_ids: string[];
|
|
3430
|
+
/**
|
|
3431
|
+
* A number representing the position of the Objective in relation to every other Objective within the Workspace.
|
|
3432
|
+
* @format int64
|
|
3433
|
+
*/
|
|
3434
|
+
position: number;
|
|
3435
|
+
/** A group of calculated values for this Objective. */
|
|
3436
|
+
stats: ObjectiveStats;
|
|
3437
|
+
/**
|
|
3438
|
+
* The time/date the Objective was created.
|
|
3439
|
+
* @format date-time
|
|
3440
|
+
*/
|
|
3441
|
+
created_at: string;
|
|
3442
|
+
}
|
|
2977
3443
|
/** A Milestone in search results. This is typed differently from Milestone because the details=slim search argument will omit some fields. */
|
|
2978
|
-
|
|
3444
|
+
interface ObjectiveSearchResult {
|
|
2979
3445
|
/** The Shortcut application url for the Milestone. */
|
|
2980
3446
|
app_url: string;
|
|
2981
3447
|
/** The Milestone's description. */
|
|
@@ -3025,6 +3491,8 @@ export interface MilestoneSearchResult {
|
|
|
3025
3491
|
* @format int64
|
|
3026
3492
|
*/
|
|
3027
3493
|
id: number;
|
|
3494
|
+
/** The IDs of the Key Results associated with the Objective. */
|
|
3495
|
+
key_result_ids: string[];
|
|
3028
3496
|
/**
|
|
3029
3497
|
* A number representing the position of the Milestone in relation to every other Milestone within the Workspace.
|
|
3030
3498
|
* @format int64
|
|
@@ -3038,39 +3506,38 @@ export interface MilestoneSearchResult {
|
|
|
3038
3506
|
*/
|
|
3039
3507
|
created_at: string;
|
|
3040
3508
|
}
|
|
3041
|
-
/** The results of the
|
|
3042
|
-
|
|
3509
|
+
/** The results of the Objective search query. */
|
|
3510
|
+
interface ObjectiveSearchResults {
|
|
3043
3511
|
/**
|
|
3044
3512
|
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
3045
3513
|
* @format int64
|
|
3046
3514
|
*/
|
|
3047
3515
|
total: number;
|
|
3048
3516
|
/** A list of search results. */
|
|
3049
|
-
data:
|
|
3517
|
+
data: ObjectiveSearchResult[];
|
|
3050
3518
|
/** The URL path and query string for the next page of search results. */
|
|
3051
3519
|
next?: string | null;
|
|
3052
|
-
cursors?: string[];
|
|
3053
3520
|
}
|
|
3054
|
-
/** A group of calculated values for this
|
|
3055
|
-
|
|
3521
|
+
/** A group of calculated values for this Objective. */
|
|
3522
|
+
interface ObjectiveStats {
|
|
3056
3523
|
/**
|
|
3057
|
-
* The average cycle time (in seconds) of completed stories in this
|
|
3524
|
+
* The average cycle time (in seconds) of completed stories in this Objective.
|
|
3058
3525
|
* @format int64
|
|
3059
3526
|
*/
|
|
3060
3527
|
average_cycle_time?: number;
|
|
3061
3528
|
/**
|
|
3062
|
-
* The average lead time (in seconds) of completed stories in this
|
|
3529
|
+
* The average lead time (in seconds) of completed stories in this Objective.
|
|
3063
3530
|
* @format int64
|
|
3064
3531
|
*/
|
|
3065
3532
|
average_lead_time?: number;
|
|
3066
3533
|
/**
|
|
3067
|
-
* The number of related documents
|
|
3534
|
+
* The number of related documents to this Objective.
|
|
3068
3535
|
* @format int64
|
|
3069
3536
|
*/
|
|
3070
3537
|
num_related_documents: number;
|
|
3071
3538
|
}
|
|
3072
3539
|
/** A group of Member profile details. */
|
|
3073
|
-
|
|
3540
|
+
interface Profile {
|
|
3074
3541
|
/** A string description of this resource. */
|
|
3075
3542
|
entity_type: string;
|
|
3076
3543
|
/** A true/false boolean indicating whether the Member has been deactivated within Shortcut. */
|
|
@@ -3081,6 +3548,8 @@ export interface Profile {
|
|
|
3081
3548
|
mention_name: string;
|
|
3082
3549
|
/** The Member's name within the Organization. */
|
|
3083
3550
|
name?: string | null;
|
|
3551
|
+
/** Whether this profile is an Agent/Bot user. */
|
|
3552
|
+
is_agent?: boolean;
|
|
3084
3553
|
/** This is the gravatar hash associated with email_address. */
|
|
3085
3554
|
gravatar_hash?: string | null;
|
|
3086
3555
|
/**
|
|
@@ -3096,7 +3565,7 @@ export interface Profile {
|
|
|
3096
3565
|
email_address?: string | null;
|
|
3097
3566
|
}
|
|
3098
3567
|
/** Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative. */
|
|
3099
|
-
|
|
3568
|
+
interface Project {
|
|
3100
3569
|
/** The Shortcut application url for the Project. */
|
|
3101
3570
|
app_url: string;
|
|
3102
3571
|
/** The description of the Project. */
|
|
@@ -3168,7 +3637,7 @@ export interface Project {
|
|
|
3168
3637
|
created_at?: string | null;
|
|
3169
3638
|
}
|
|
3170
3639
|
/** A group of calculated values for this Project. */
|
|
3171
|
-
|
|
3640
|
+
interface ProjectStats {
|
|
3172
3641
|
/**
|
|
3173
3642
|
* The total number of stories in this Project.
|
|
3174
3643
|
* @format int64
|
|
@@ -3186,7 +3655,7 @@ export interface ProjectStats {
|
|
|
3186
3655
|
num_related_documents: number;
|
|
3187
3656
|
}
|
|
3188
3657
|
/** Corresponds to a VCS Pull Request attached to a Shortcut story. */
|
|
3189
|
-
|
|
3658
|
+
interface PullRequest {
|
|
3190
3659
|
/** A string description of this resource. */
|
|
3191
3660
|
entity_type: string;
|
|
3192
3661
|
/** True/False boolean indicating whether the VCS pull request has been closed. */
|
|
@@ -3270,7 +3739,7 @@ export interface PullRequest {
|
|
|
3270
3739
|
created_at: string;
|
|
3271
3740
|
}
|
|
3272
3741
|
/** Corresponds to a VCS Label associated with a Pull Request. */
|
|
3273
|
-
|
|
3742
|
+
interface PullRequestLabel {
|
|
3274
3743
|
/** A string description of this resource. */
|
|
3275
3744
|
entity_type: string;
|
|
3276
3745
|
/**
|
|
@@ -3290,14 +3759,30 @@ export interface PullRequestLabel {
|
|
|
3290
3759
|
/** The name of the VCS label. */
|
|
3291
3760
|
name: string;
|
|
3292
3761
|
}
|
|
3762
|
+
interface RemoveCustomFieldParams {
|
|
3763
|
+
/**
|
|
3764
|
+
* The unique public ID for the CustomField.
|
|
3765
|
+
* @format uuid
|
|
3766
|
+
*/
|
|
3767
|
+
field_id: string;
|
|
3768
|
+
}
|
|
3769
|
+
/** Request parameters for removing a Label from a Shortcut Story. */
|
|
3770
|
+
interface RemoveLabelParams {
|
|
3771
|
+
/**
|
|
3772
|
+
* The name of the new Label to remove.
|
|
3773
|
+
* @minLength 1
|
|
3774
|
+
* @maxLength 128
|
|
3775
|
+
*/
|
|
3776
|
+
name: string;
|
|
3777
|
+
}
|
|
3293
3778
|
/** Repository refers to a VCS repository. */
|
|
3294
|
-
|
|
3779
|
+
interface Repository {
|
|
3295
3780
|
/** A string description of this resource. */
|
|
3296
3781
|
entity_type: string;
|
|
3297
3782
|
/** The shorthand name of the VCS repository. */
|
|
3298
3783
|
name?: string | null;
|
|
3299
3784
|
/** The VCS provider for the Repository. */
|
|
3300
|
-
type:
|
|
3785
|
+
type: "github" | "gitlab" | "bitbucket";
|
|
3301
3786
|
/**
|
|
3302
3787
|
* The time/date the Repository was updated.
|
|
3303
3788
|
* @format date-time
|
|
@@ -3320,44 +3805,18 @@ export interface Repository {
|
|
|
3320
3805
|
*/
|
|
3321
3806
|
created_at?: string | null;
|
|
3322
3807
|
}
|
|
3323
|
-
export interface Search {
|
|
3324
|
-
/**
|
|
3325
|
-
* See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
|
|
3326
|
-
* @minLength 1
|
|
3327
|
-
*/
|
|
3328
|
-
query: string;
|
|
3329
|
-
/**
|
|
3330
|
-
* The number of search results to include in a page. Minimum of 1 and maximum of 25.
|
|
3331
|
-
* @format int64
|
|
3332
|
-
*/
|
|
3333
|
-
page_size?: number;
|
|
3334
|
-
/**
|
|
3335
|
-
* The amount of detail included in each result item.
|
|
3336
|
-
* "full" will include all descriptions and comments and more fields on
|
|
3337
|
-
* related items such as pull requests, branches and tasks.
|
|
3338
|
-
* "slim" omits larger fulltext fields such as descriptions and comments
|
|
3339
|
-
* and only references related items by id.
|
|
3340
|
-
* The default is "full".
|
|
3341
|
-
*/
|
|
3342
|
-
detail?: 'full' | 'slim';
|
|
3343
|
-
/** The next page token. */
|
|
3344
|
-
next?: string;
|
|
3345
|
-
include?: 'cursors';
|
|
3346
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, milestone, story. */
|
|
3347
|
-
entity_types?: ('story' | 'milestone' | 'epic' | 'iteration')[];
|
|
3348
|
-
}
|
|
3349
3808
|
/** The results of the multi-entity search query. */
|
|
3350
|
-
|
|
3809
|
+
interface SearchResults {
|
|
3351
3810
|
/** The results of the Epic search query. */
|
|
3352
3811
|
epics?: EpicSearchResults;
|
|
3353
3812
|
/** The results of the Story search query. */
|
|
3354
3813
|
stories?: StorySearchResults;
|
|
3355
3814
|
/** The results of the Iteration search query. */
|
|
3356
3815
|
iterations?: IterationSearchResults;
|
|
3357
|
-
/** The results of the
|
|
3358
|
-
milestones?:
|
|
3816
|
+
/** The results of the Objective search query. */
|
|
3817
|
+
milestones?: ObjectiveSearchResults;
|
|
3359
3818
|
}
|
|
3360
|
-
|
|
3819
|
+
interface SearchStories {
|
|
3361
3820
|
/** A true/false boolean indicating whether the Story is in archived state. */
|
|
3362
3821
|
archived?: boolean;
|
|
3363
3822
|
/**
|
|
@@ -3366,7 +3825,7 @@ export interface SearchStories {
|
|
|
3366
3825
|
*/
|
|
3367
3826
|
owner_id?: string | null;
|
|
3368
3827
|
/** The type of Stories that you want returned. */
|
|
3369
|
-
story_type?:
|
|
3828
|
+
story_type?: "feature" | "chore" | "bug";
|
|
3370
3829
|
/**
|
|
3371
3830
|
* The Epic IDs that may be associated with the Stories.
|
|
3372
3831
|
* @uniqueItems true
|
|
@@ -3378,24 +3837,24 @@ export interface SearchStories {
|
|
|
3378
3837
|
*/
|
|
3379
3838
|
project_ids?: (number | null)[];
|
|
3380
3839
|
/**
|
|
3381
|
-
* Stories should have been updated before this date.
|
|
3840
|
+
* Stories should have been updated on or before this date.
|
|
3382
3841
|
* @format date-time
|
|
3383
3842
|
*/
|
|
3384
3843
|
updated_at_end?: string;
|
|
3385
3844
|
/**
|
|
3386
|
-
* Stories should have been completed before this date.
|
|
3845
|
+
* Stories should have been completed on or before this date.
|
|
3387
3846
|
* @format date-time
|
|
3388
3847
|
*/
|
|
3389
3848
|
completed_at_end?: string;
|
|
3390
3849
|
/** The type of Workflow State the Stories may be in. */
|
|
3391
|
-
workflow_state_types?: (
|
|
3850
|
+
workflow_state_types?: ("started" | "backlog" | "unstarted" | "done")[];
|
|
3392
3851
|
/**
|
|
3393
|
-
* Stories should have a deadline before this date.
|
|
3852
|
+
* Stories should have a deadline on or before this date.
|
|
3394
3853
|
* @format date-time
|
|
3395
3854
|
*/
|
|
3396
3855
|
deadline_end?: string;
|
|
3397
3856
|
/**
|
|
3398
|
-
* Stories should have been created after this date.
|
|
3857
|
+
* Stories should have been created on or after this date.
|
|
3399
3858
|
* @format date-time
|
|
3400
3859
|
*/
|
|
3401
3860
|
created_at_start?: string;
|
|
@@ -3440,12 +3899,12 @@ export interface SearchStories {
|
|
|
3440
3899
|
*/
|
|
3441
3900
|
iteration_ids?: number[];
|
|
3442
3901
|
/**
|
|
3443
|
-
* Stories should have been created before this date.
|
|
3902
|
+
* Stories should have been created on or before this date.
|
|
3444
3903
|
* @format date-time
|
|
3445
3904
|
*/
|
|
3446
3905
|
created_at_end?: string;
|
|
3447
3906
|
/**
|
|
3448
|
-
* Stories should have a deadline after this date.
|
|
3907
|
+
* Stories should have a deadline on or after this date.
|
|
3449
3908
|
* @format date-time
|
|
3450
3909
|
*/
|
|
3451
3910
|
deadline_start?: string;
|
|
@@ -3459,7 +3918,10 @@ export interface SearchStories {
|
|
|
3459
3918
|
* @uniqueItems true
|
|
3460
3919
|
*/
|
|
3461
3920
|
owner_ids?: string[];
|
|
3462
|
-
/**
|
|
3921
|
+
/**
|
|
3922
|
+
* An ID or URL that references an external resource. Useful during imports.
|
|
3923
|
+
* @maxLength 1024
|
|
3924
|
+
*/
|
|
3463
3925
|
external_id?: string;
|
|
3464
3926
|
/** Whether to include the story description in the response. */
|
|
3465
3927
|
includes_description?: boolean;
|
|
@@ -3474,18 +3936,18 @@ export interface SearchStories {
|
|
|
3474
3936
|
*/
|
|
3475
3937
|
project_id?: number | null;
|
|
3476
3938
|
/**
|
|
3477
|
-
* Stories should have been completed after this date.
|
|
3939
|
+
* Stories should have been completed on or after this date.
|
|
3478
3940
|
* @format date-time
|
|
3479
3941
|
*/
|
|
3480
3942
|
completed_at_start?: string;
|
|
3481
3943
|
/**
|
|
3482
|
-
* Stories should have been updated after this date.
|
|
3944
|
+
* Stories should have been updated on or after this date.
|
|
3483
3945
|
* @format date-time
|
|
3484
3946
|
*/
|
|
3485
3947
|
updated_at_start?: string;
|
|
3486
3948
|
}
|
|
3487
3949
|
/** Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores. */
|
|
3488
|
-
|
|
3950
|
+
interface Story {
|
|
3489
3951
|
/** The Shortcut application url for the Story. */
|
|
3490
3952
|
app_url: string;
|
|
3491
3953
|
/** The description of the story. */
|
|
@@ -3500,7 +3962,7 @@ export interface Story {
|
|
|
3500
3962
|
entity_type: string;
|
|
3501
3963
|
/** An array of labels attached to the story. */
|
|
3502
3964
|
labels: LabelSlim[];
|
|
3503
|
-
/** Deprecated
|
|
3965
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
3504
3966
|
mention_ids: string[];
|
|
3505
3967
|
/** The synced item for the story. */
|
|
3506
3968
|
synced_item?: SyncedItem;
|
|
@@ -3548,8 +4010,6 @@ export interface Story {
|
|
|
3548
4010
|
* @format int64
|
|
3549
4011
|
*/
|
|
3550
4012
|
epic_id?: number | null;
|
|
3551
|
-
/** The IDs of any unresolved blocker comments on the Story. */
|
|
3552
|
-
unresolved_blocker_comments?: number[];
|
|
3553
4013
|
/**
|
|
3554
4014
|
* The ID of the story template used to create this story, or null if not created using a template.
|
|
3555
4015
|
* @format uuid
|
|
@@ -3569,8 +4029,11 @@ export interface Story {
|
|
|
3569
4029
|
* @format int64
|
|
3570
4030
|
*/
|
|
3571
4031
|
iteration_id?: number | null;
|
|
4032
|
+
sub_task_story_ids?: number[];
|
|
3572
4033
|
/** An array of tasks connected to the story. */
|
|
3573
4034
|
tasks: Task[];
|
|
4035
|
+
/** The formatted branch name for this story. */
|
|
4036
|
+
formatted_vcs_branch_name?: string | null;
|
|
3574
4037
|
/** An array of label ids attached to the story. */
|
|
3575
4038
|
label_ids: number[];
|
|
3576
4039
|
/**
|
|
@@ -3613,6 +4076,8 @@ export interface Story {
|
|
|
3613
4076
|
* @format int64
|
|
3614
4077
|
*/
|
|
3615
4078
|
lead_time?: number;
|
|
4079
|
+
/** @format int64 */
|
|
4080
|
+
parent_story_id?: number | null;
|
|
3616
4081
|
/**
|
|
3617
4082
|
* The numeric point estimate of the story. Can also be null, which means unestimated.
|
|
3618
4083
|
* @format int64
|
|
@@ -3658,7 +4123,7 @@ export interface Story {
|
|
|
3658
4123
|
moved_at?: string | null;
|
|
3659
4124
|
}
|
|
3660
4125
|
/** A Comment is any note added within the Comment field of a Story. */
|
|
3661
|
-
|
|
4126
|
+
interface StoryComment {
|
|
3662
4127
|
/** The Shortcut application url for the Comment. */
|
|
3663
4128
|
app_url: string;
|
|
3664
4129
|
/** A string description of this resource. */
|
|
@@ -3670,7 +4135,7 @@ export interface StoryComment {
|
|
|
3670
4135
|
* @format int64
|
|
3671
4136
|
*/
|
|
3672
4137
|
story_id: number;
|
|
3673
|
-
/** Deprecated
|
|
4138
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
3674
4139
|
mention_ids: string[];
|
|
3675
4140
|
/**
|
|
3676
4141
|
* The unique ID of the Member who is the Comment's author.
|
|
@@ -3681,6 +4146,8 @@ export interface StoryComment {
|
|
|
3681
4146
|
member_mention_ids: string[];
|
|
3682
4147
|
/** Marks the comment as a blocker that can be surfaced to permissions or teams mentioned in the comment. Can only be used on a top-level comment. */
|
|
3683
4148
|
blocker?: boolean;
|
|
4149
|
+
/** Whether the Comment is currently the root of a thread that is linked to Slack. */
|
|
4150
|
+
linked_to_slack: boolean;
|
|
3684
4151
|
/**
|
|
3685
4152
|
* The time/date when the Comment was updated.
|
|
3686
4153
|
* @format date-time
|
|
@@ -3718,7 +4185,7 @@ export interface StoryComment {
|
|
|
3718
4185
|
text?: string | null;
|
|
3719
4186
|
}
|
|
3720
4187
|
/** A container entity for the attributes this template should populate. */
|
|
3721
|
-
|
|
4188
|
+
interface StoryContents {
|
|
3722
4189
|
/** The description of the story. */
|
|
3723
4190
|
description?: string;
|
|
3724
4191
|
/** A string description of this resource. */
|
|
@@ -3740,6 +4207,8 @@ export interface StoryContents {
|
|
|
3740
4207
|
epic_id?: number;
|
|
3741
4208
|
/** An array of external links connected to the story. */
|
|
3742
4209
|
external_links?: string[];
|
|
4210
|
+
/** An array of sub-tasks connected to the story */
|
|
4211
|
+
sub_tasks?: CreateSubTaskParams[];
|
|
3743
4212
|
/**
|
|
3744
4213
|
* The ID of the iteration the story belongs to.
|
|
3745
4214
|
* @format int64
|
|
@@ -3781,7 +4250,7 @@ export interface StoryContents {
|
|
|
3781
4250
|
*/
|
|
3782
4251
|
deadline?: string;
|
|
3783
4252
|
}
|
|
3784
|
-
|
|
4253
|
+
interface StoryContentsTask {
|
|
3785
4254
|
/** Full text of the Task. */
|
|
3786
4255
|
description: string;
|
|
3787
4256
|
/**
|
|
@@ -3796,7 +4265,7 @@ export interface StoryContentsTask {
|
|
|
3796
4265
|
/** This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. */
|
|
3797
4266
|
external_id?: string | null;
|
|
3798
4267
|
}
|
|
3799
|
-
|
|
4268
|
+
interface StoryCustomField {
|
|
3800
4269
|
/**
|
|
3801
4270
|
* The unique public ID for a CustomField.
|
|
3802
4271
|
* @format uuid
|
|
@@ -3811,28 +4280,28 @@ export interface StoryCustomField {
|
|
|
3811
4280
|
value: string;
|
|
3812
4281
|
}
|
|
3813
4282
|
/** Task IDs that have been added or removed from the Story. */
|
|
3814
|
-
|
|
4283
|
+
interface StoryHistoryChangeAddsRemovesInt {
|
|
3815
4284
|
/** The values that have been added. */
|
|
3816
4285
|
adds?: number[];
|
|
3817
4286
|
/** The values that have been removed */
|
|
3818
4287
|
removes?: number[];
|
|
3819
4288
|
}
|
|
3820
4289
|
/** Custom Field Enum Value IDs that have been added or removed from the Story. */
|
|
3821
|
-
|
|
4290
|
+
interface StoryHistoryChangeAddsRemovesUuid {
|
|
3822
4291
|
/** The values that have been added. */
|
|
3823
4292
|
adds?: string[];
|
|
3824
4293
|
/** The values that have been removed */
|
|
3825
4294
|
removes?: string[];
|
|
3826
4295
|
}
|
|
3827
4296
|
/** True if the Story has archived, otherwise false. */
|
|
3828
|
-
|
|
4297
|
+
interface StoryHistoryChangeOldNewBool {
|
|
3829
4298
|
/** The old value. */
|
|
3830
4299
|
old?: boolean;
|
|
3831
4300
|
/** The new value. */
|
|
3832
4301
|
new?: boolean;
|
|
3833
4302
|
}
|
|
3834
4303
|
/** The estimate value for the Story */
|
|
3835
|
-
|
|
4304
|
+
interface StoryHistoryChangeOldNewInt {
|
|
3836
4305
|
/**
|
|
3837
4306
|
* The old value.
|
|
3838
4307
|
* @format int64
|
|
@@ -3845,14 +4314,14 @@ export interface StoryHistoryChangeOldNewInt {
|
|
|
3845
4314
|
new?: number;
|
|
3846
4315
|
}
|
|
3847
4316
|
/** A timestamp that represents the Story's deadline. */
|
|
3848
|
-
|
|
4317
|
+
interface StoryHistoryChangeOldNewStr {
|
|
3849
4318
|
/** The old value. */
|
|
3850
4319
|
old?: string | null;
|
|
3851
4320
|
/** The new value. */
|
|
3852
4321
|
new?: string;
|
|
3853
4322
|
}
|
|
3854
4323
|
/** The Team ID for the Story. */
|
|
3855
|
-
|
|
4324
|
+
interface StoryHistoryChangeOldNewUuid {
|
|
3856
4325
|
/**
|
|
3857
4326
|
* The old value.
|
|
3858
4327
|
* @format uuid
|
|
@@ -3865,7 +4334,7 @@ export interface StoryHistoryChangeOldNewUuid {
|
|
|
3865
4334
|
new?: string;
|
|
3866
4335
|
}
|
|
3867
4336
|
/** Story links allow you create semantic relationships between two stories. Relationship types are relates to, blocks / blocked by, and duplicates / is duplicated by. The format is `subject -> link -> object`, or for example "story 5 blocks story 6". */
|
|
3868
|
-
|
|
4337
|
+
interface StoryLink {
|
|
3869
4338
|
/** A string description of this resource. */
|
|
3870
4339
|
entity_type: string;
|
|
3871
4340
|
/**
|
|
@@ -3902,14 +4371,14 @@ export interface StoryLink {
|
|
|
3902
4371
|
updated_at: string;
|
|
3903
4372
|
}
|
|
3904
4373
|
/** Emoji reaction on a comment. */
|
|
3905
|
-
|
|
4374
|
+
interface StoryReaction {
|
|
3906
4375
|
/** Emoji text of the reaction. */
|
|
3907
4376
|
emoji: string;
|
|
3908
4377
|
/** Permissions who have reacted with this. */
|
|
3909
4378
|
permission_ids: string[];
|
|
3910
4379
|
}
|
|
3911
4380
|
/** A Story in search results. This is typed differently from Story because the details=slim search argument will omit some fields. */
|
|
3912
|
-
|
|
4381
|
+
interface StorySearchResult {
|
|
3913
4382
|
/** The Shortcut application url for the Story. */
|
|
3914
4383
|
app_url: string;
|
|
3915
4384
|
/** The description of the story. */
|
|
@@ -3926,7 +4395,7 @@ export interface StorySearchResult {
|
|
|
3926
4395
|
labels: LabelSlim[];
|
|
3927
4396
|
/** An array of IDs of Tasks attached to the story. */
|
|
3928
4397
|
task_ids?: number[];
|
|
3929
|
-
/** Deprecated
|
|
4398
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
3930
4399
|
mention_ids: string[];
|
|
3931
4400
|
/** The synced item for the story. */
|
|
3932
4401
|
synced_item?: SyncedItem;
|
|
@@ -3981,8 +4450,6 @@ export interface StorySearchResult {
|
|
|
3981
4450
|
* @format int64
|
|
3982
4451
|
*/
|
|
3983
4452
|
epic_id?: number | null;
|
|
3984
|
-
/** The IDs of any unresolved blocker comments on the Story. */
|
|
3985
|
-
unresolved_blocker_comments?: number[];
|
|
3986
4453
|
/**
|
|
3987
4454
|
* The ID of the story template used to create this story, or null if not created using a template.
|
|
3988
4455
|
* @format uuid
|
|
@@ -4002,8 +4469,11 @@ export interface StorySearchResult {
|
|
|
4002
4469
|
* @format int64
|
|
4003
4470
|
*/
|
|
4004
4471
|
iteration_id?: number | null;
|
|
4472
|
+
sub_task_story_ids?: number[];
|
|
4005
4473
|
/** An array of tasks connected to the story. */
|
|
4006
4474
|
tasks?: Task[];
|
|
4475
|
+
/** The formatted branch name for this story. */
|
|
4476
|
+
formatted_vcs_branch_name?: string | null;
|
|
4007
4477
|
/** An array of label ids attached to the story. */
|
|
4008
4478
|
label_ids: number[];
|
|
4009
4479
|
/**
|
|
@@ -4046,6 +4516,8 @@ export interface StorySearchResult {
|
|
|
4046
4516
|
* @format int64
|
|
4047
4517
|
*/
|
|
4048
4518
|
lead_time?: number;
|
|
4519
|
+
/** @format int64 */
|
|
4520
|
+
parent_story_id?: number | null;
|
|
4049
4521
|
/**
|
|
4050
4522
|
* The numeric point estimate of the story. Can also be null, which means unestimated.
|
|
4051
4523
|
* @format int64
|
|
@@ -4095,7 +4567,7 @@ export interface StorySearchResult {
|
|
|
4095
4567
|
moved_at?: string | null;
|
|
4096
4568
|
}
|
|
4097
4569
|
/** The results of the Story search query. */
|
|
4098
|
-
|
|
4570
|
+
interface StorySearchResults {
|
|
4099
4571
|
/**
|
|
4100
4572
|
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
4101
4573
|
* @format int64
|
|
@@ -4105,10 +4577,9 @@ export interface StorySearchResults {
|
|
|
4105
4577
|
data: StorySearchResult[];
|
|
4106
4578
|
/** The URL path and query string for the next page of search results. */
|
|
4107
4579
|
next?: string | null;
|
|
4108
|
-
cursors?: string[];
|
|
4109
4580
|
}
|
|
4110
4581
|
/** StorySlim represents the same resource as a Story, but is more light-weight. For certain fields it provides ids rather than full resources (e.g., `comment_ids` and `file_ids`) and it also excludes certain aggregate values (e.g., `cycle_time`). The `description` field can be optionally included. Use the [Get Story](#Get-Story) endpoint to fetch the unabridged payload for a Story. */
|
|
4111
|
-
|
|
4582
|
+
interface StorySlim {
|
|
4112
4583
|
/** The Shortcut application url for the Story. */
|
|
4113
4584
|
app_url: string;
|
|
4114
4585
|
/** The description of the Story. */
|
|
@@ -4125,7 +4596,7 @@ export interface StorySlim {
|
|
|
4125
4596
|
labels: LabelSlim[];
|
|
4126
4597
|
/** An array of IDs of Tasks attached to the story. */
|
|
4127
4598
|
task_ids: number[];
|
|
4128
|
-
/** Deprecated
|
|
4599
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
4129
4600
|
mention_ids: string[];
|
|
4130
4601
|
/** The synced item for the story. */
|
|
4131
4602
|
synced_item?: SyncedItem;
|
|
@@ -4174,8 +4645,6 @@ export interface StorySlim {
|
|
|
4174
4645
|
* @format int64
|
|
4175
4646
|
*/
|
|
4176
4647
|
epic_id?: number | null;
|
|
4177
|
-
/** The IDs of any unresolved blocker comments on the Story. */
|
|
4178
|
-
unresolved_blocker_comments?: number[];
|
|
4179
4648
|
/**
|
|
4180
4649
|
* The ID of the story template used to create this story, or null if not created using a template.
|
|
4181
4650
|
* @format uuid
|
|
@@ -4195,6 +4664,9 @@ export interface StorySlim {
|
|
|
4195
4664
|
* @format int64
|
|
4196
4665
|
*/
|
|
4197
4666
|
iteration_id?: number | null;
|
|
4667
|
+
sub_task_story_ids?: number[];
|
|
4668
|
+
/** The formatted branch name for this story. */
|
|
4669
|
+
formatted_vcs_branch_name?: string | null;
|
|
4198
4670
|
/** An array of label ids attached to the story. */
|
|
4199
4671
|
label_ids: number[];
|
|
4200
4672
|
/**
|
|
@@ -4235,6 +4707,8 @@ export interface StorySlim {
|
|
|
4235
4707
|
* @format int64
|
|
4236
4708
|
*/
|
|
4237
4709
|
lead_time?: number;
|
|
4710
|
+
/** @format int64 */
|
|
4711
|
+
parent_story_id?: number | null;
|
|
4238
4712
|
/**
|
|
4239
4713
|
* The numeric point estimate of the story. Can also be null, which means unestimated.
|
|
4240
4714
|
* @format int64
|
|
@@ -4280,7 +4754,7 @@ export interface StorySlim {
|
|
|
4280
4754
|
moved_at?: string | null;
|
|
4281
4755
|
}
|
|
4282
4756
|
/** The stats object for Stories */
|
|
4283
|
-
|
|
4757
|
+
interface StoryStats {
|
|
4284
4758
|
/**
|
|
4285
4759
|
* The number of documents related to this Story.
|
|
4286
4760
|
* @format int64
|
|
@@ -4288,14 +4762,14 @@ export interface StoryStats {
|
|
|
4288
4762
|
num_related_documents: number;
|
|
4289
4763
|
}
|
|
4290
4764
|
/** The synced item for the story. */
|
|
4291
|
-
|
|
4765
|
+
interface SyncedItem {
|
|
4292
4766
|
/** The id used to reference an external entity. */
|
|
4293
4767
|
external_id: string;
|
|
4294
4768
|
/** The url to the external entity. */
|
|
4295
4769
|
url: string;
|
|
4296
4770
|
}
|
|
4297
4771
|
/** A Task on a Story. */
|
|
4298
|
-
|
|
4772
|
+
interface Task {
|
|
4299
4773
|
/** Full text of the Task. */
|
|
4300
4774
|
description: string;
|
|
4301
4775
|
/** A string description of this resource. */
|
|
@@ -4305,7 +4779,7 @@ export interface Task {
|
|
|
4305
4779
|
* @format int64
|
|
4306
4780
|
*/
|
|
4307
4781
|
story_id: number;
|
|
4308
|
-
/** Deprecated
|
|
4782
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
4309
4783
|
mention_ids: string[];
|
|
4310
4784
|
/** An array of UUIDs of Members mentioned in this Task. */
|
|
4311
4785
|
member_mention_ids: string[];
|
|
@@ -4314,6 +4788,7 @@ export interface Task {
|
|
|
4314
4788
|
* @format date-time
|
|
4315
4789
|
*/
|
|
4316
4790
|
completed_at?: string | null;
|
|
4791
|
+
global_id: string;
|
|
4317
4792
|
/**
|
|
4318
4793
|
* The time/date the Task was updated.
|
|
4319
4794
|
* @format date-time
|
|
@@ -4344,14 +4819,14 @@ export interface Task {
|
|
|
4344
4819
|
created_at: string;
|
|
4345
4820
|
}
|
|
4346
4821
|
/** Comments associated with Epic Discussions. */
|
|
4347
|
-
|
|
4822
|
+
interface ThreadedComment {
|
|
4348
4823
|
/** The Shortcut application url for the Comment. */
|
|
4349
4824
|
app_url: string;
|
|
4350
4825
|
/** A string description of this resource. */
|
|
4351
4826
|
entity_type: string;
|
|
4352
4827
|
/** True/false boolean indicating whether the Comment is deleted. */
|
|
4353
4828
|
deleted: boolean;
|
|
4354
|
-
/** Deprecated
|
|
4829
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
4355
4830
|
mention_ids: string[];
|
|
4356
4831
|
/**
|
|
4357
4832
|
* The unique ID of the Member that authored the Comment.
|
|
@@ -4385,7 +4860,7 @@ export interface ThreadedComment {
|
|
|
4385
4860
|
text: string;
|
|
4386
4861
|
}
|
|
4387
4862
|
/** The type of Story Link. The string can be subject or object. */
|
|
4388
|
-
|
|
4863
|
+
interface TypedStoryLink {
|
|
4389
4864
|
/** A string description of this resource. */
|
|
4390
4865
|
entity_type: string;
|
|
4391
4866
|
/**
|
|
@@ -4423,9 +4898,9 @@ export interface TypedStoryLink {
|
|
|
4423
4898
|
*/
|
|
4424
4899
|
created_at: string;
|
|
4425
4900
|
}
|
|
4426
|
-
|
|
4901
|
+
interface UnusableEntitlementError {
|
|
4427
4902
|
/** The tag for violating an entitlement action. */
|
|
4428
|
-
reason_tag:
|
|
4903
|
+
reason_tag: "entitlement-violation";
|
|
4429
4904
|
/**
|
|
4430
4905
|
* Short tag describing the unusable entitlement action taken by the user.
|
|
4431
4906
|
* @minLength 1
|
|
@@ -4439,7 +4914,7 @@ export interface UnusableEntitlementError {
|
|
|
4439
4914
|
*/
|
|
4440
4915
|
message: string;
|
|
4441
4916
|
}
|
|
4442
|
-
|
|
4917
|
+
interface UpdateCategory {
|
|
4443
4918
|
/**
|
|
4444
4919
|
* The new name of the Category.
|
|
4445
4920
|
* @minLength 1
|
|
@@ -4455,11 +4930,11 @@ export interface UpdateCategory {
|
|
|
4455
4930
|
/** A true/false boolean indicating if the Category has been archived. */
|
|
4456
4931
|
archived?: boolean;
|
|
4457
4932
|
}
|
|
4458
|
-
|
|
4933
|
+
interface UpdateComment {
|
|
4459
4934
|
/** The updated comment text. */
|
|
4460
4935
|
text: string;
|
|
4461
4936
|
}
|
|
4462
|
-
|
|
4937
|
+
interface UpdateCustomField {
|
|
4463
4938
|
/** Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories. */
|
|
4464
4939
|
enabled?: boolean;
|
|
4465
4940
|
/**
|
|
@@ -4489,7 +4964,7 @@ export interface UpdateCustomField {
|
|
|
4489
4964
|
*/
|
|
4490
4965
|
after_id?: string;
|
|
4491
4966
|
}
|
|
4492
|
-
|
|
4967
|
+
interface UpdateCustomFieldEnumValue {
|
|
4493
4968
|
/**
|
|
4494
4969
|
* The unique ID of an existing EnumValue within the CustomField's domain.
|
|
4495
4970
|
* @format uuid
|
|
@@ -4510,16 +4985,17 @@ export interface UpdateCustomFieldEnumValue {
|
|
|
4510
4985
|
* Request parameters for changing either a template's name or any of
|
|
4511
4986
|
* the attributes it is designed to pre-populate.
|
|
4512
4987
|
*/
|
|
4513
|
-
|
|
4988
|
+
interface UpdateEntityTemplate {
|
|
4514
4989
|
/**
|
|
4515
4990
|
* The updated template name.
|
|
4516
4991
|
* @minLength 1
|
|
4992
|
+
* @maxLength 128
|
|
4517
4993
|
*/
|
|
4518
4994
|
name?: string;
|
|
4519
4995
|
/** Updated attributes for the template to populate. */
|
|
4520
4996
|
story_contents?: UpdateStoryContents;
|
|
4521
4997
|
}
|
|
4522
|
-
|
|
4998
|
+
interface UpdateEpic {
|
|
4523
4999
|
/**
|
|
4524
5000
|
* The Epic's description.
|
|
4525
5001
|
* @maxLength 100000
|
|
@@ -4534,6 +5010,8 @@ export interface UpdateEpic {
|
|
|
4534
5010
|
* @format date-time
|
|
4535
5011
|
*/
|
|
4536
5012
|
completed_at_override?: string | null;
|
|
5013
|
+
/** An array of IDs for Objectives to which this Epic is related. */
|
|
5014
|
+
objective_ids?: number[];
|
|
4537
5015
|
/**
|
|
4538
5016
|
* The Epic's name.
|
|
4539
5017
|
* @minLength 1
|
|
@@ -4546,9 +5024,9 @@ export interface UpdateEpic {
|
|
|
4546
5024
|
*/
|
|
4547
5025
|
planned_start_date?: string | null;
|
|
4548
5026
|
/** `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. */
|
|
4549
|
-
state?:
|
|
5027
|
+
state?: "in progress" | "to do" | "done";
|
|
4550
5028
|
/**
|
|
4551
|
-
* The ID of the Milestone this Epic is related to.
|
|
5029
|
+
* `Deprecated` The ID of the Milestone this Epic is related to. Use `objective_ids`.
|
|
4552
5030
|
* @format int64
|
|
4553
5031
|
*/
|
|
4554
5032
|
milestone_id?: number | null;
|
|
@@ -4568,15 +5046,20 @@ export interface UpdateEpic {
|
|
|
4568
5046
|
*/
|
|
4569
5047
|
started_at_override?: string | null;
|
|
4570
5048
|
/**
|
|
4571
|
-
* The ID of the group to associate with the epic.
|
|
5049
|
+
* `Deprecated` The ID of the group to associate with the epic. Use `group_ids`.
|
|
4572
5050
|
* @format uuid
|
|
4573
5051
|
*/
|
|
4574
5052
|
group_id?: string | null;
|
|
4575
5053
|
/** An array of UUIDs for any Members you want to add as Followers on this Epic. */
|
|
4576
5054
|
follower_ids?: string[];
|
|
5055
|
+
/** An array of UUIDS for Groups to which this Epic is related. */
|
|
5056
|
+
group_ids?: string[];
|
|
4577
5057
|
/** An array of UUIDs for any members you want to add as Owners on this Epic. */
|
|
4578
5058
|
owner_ids?: string[];
|
|
4579
|
-
/**
|
|
5059
|
+
/**
|
|
5060
|
+
* This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
|
|
5061
|
+
* @maxLength 128
|
|
5062
|
+
*/
|
|
4580
5063
|
external_id?: string;
|
|
4581
5064
|
/**
|
|
4582
5065
|
* The ID of the Epic we want to move this Epic before.
|
|
@@ -4594,8 +5077,11 @@ export interface UpdateEpic {
|
|
|
4594
5077
|
*/
|
|
4595
5078
|
deadline?: string | null;
|
|
4596
5079
|
}
|
|
4597
|
-
|
|
4598
|
-
/**
|
|
5080
|
+
interface UpdateFile {
|
|
5081
|
+
/**
|
|
5082
|
+
* The description of the file.
|
|
5083
|
+
* @maxLength 4096
|
|
5084
|
+
*/
|
|
4599
5085
|
description?: string;
|
|
4600
5086
|
/**
|
|
4601
5087
|
* The time/date that the file was uploaded.
|
|
@@ -4618,11 +5104,17 @@ export interface UpdateFile {
|
|
|
4618
5104
|
* @format uuid
|
|
4619
5105
|
*/
|
|
4620
5106
|
uploader_id?: string;
|
|
4621
|
-
/**
|
|
5107
|
+
/**
|
|
5108
|
+
* An additional ID that you may wish to assign to the file.
|
|
5109
|
+
* @maxLength 128
|
|
5110
|
+
*/
|
|
4622
5111
|
external_id?: string;
|
|
4623
5112
|
}
|
|
4624
|
-
|
|
4625
|
-
/**
|
|
5113
|
+
interface UpdateGroup {
|
|
5114
|
+
/**
|
|
5115
|
+
* The description of this Group.
|
|
5116
|
+
* @maxLength 4096
|
|
5117
|
+
*/
|
|
4626
5118
|
description?: string;
|
|
4627
5119
|
/** Whether or not this Group is archived. */
|
|
4628
5120
|
archived?: boolean | null;
|
|
@@ -4651,7 +5143,12 @@ export interface UpdateGroup {
|
|
|
4651
5143
|
*/
|
|
4652
5144
|
name?: string;
|
|
4653
5145
|
/** The color key you wish to use for the Group in the system. */
|
|
4654
|
-
color_key?:
|
|
5146
|
+
color_key?: "blue" | "purple" | "midnight-blue" | "orange" | "yellow-green" | "brass" | "gray" | "fuchsia" | "yellow" | "pink" | "sky-blue" | "green" | "red" | "black" | "slate" | "turquoise";
|
|
5147
|
+
/**
|
|
5148
|
+
* The ID of the default workflow for stories created in this group.
|
|
5149
|
+
* @format int64
|
|
5150
|
+
*/
|
|
5151
|
+
default_workflow_id?: number | null;
|
|
4655
5152
|
/**
|
|
4656
5153
|
* The Member ids to add to this Group.
|
|
4657
5154
|
* @uniqueItems true
|
|
@@ -4660,7 +5157,13 @@ export interface UpdateGroup {
|
|
|
4660
5157
|
/** The Workflow ids to add to the Group. */
|
|
4661
5158
|
workflow_ids?: number[];
|
|
4662
5159
|
}
|
|
4663
|
-
|
|
5160
|
+
interface UpdateHealth {
|
|
5161
|
+
/** The health status of the Epic. */
|
|
5162
|
+
status?: "At Risk" | "On Track" | "Off Track" | "No Health";
|
|
5163
|
+
/** The description of the Health status. */
|
|
5164
|
+
text?: string;
|
|
5165
|
+
}
|
|
5166
|
+
interface UpdateIteration {
|
|
4664
5167
|
/** An array of UUIDs for any Members you want to add as Followers. */
|
|
4665
5168
|
follower_ids?: string[];
|
|
4666
5169
|
/** An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. */
|
|
@@ -4689,14 +5192,30 @@ export interface UpdateIteration {
|
|
|
4689
5192
|
*/
|
|
4690
5193
|
end_date?: string;
|
|
4691
5194
|
}
|
|
4692
|
-
|
|
5195
|
+
interface UpdateKeyResult {
|
|
5196
|
+
/**
|
|
5197
|
+
* The name of the Key Result.
|
|
5198
|
+
* @maxLength 1024
|
|
5199
|
+
*/
|
|
5200
|
+
name?: string;
|
|
5201
|
+
/** The starting value of the Key Result. */
|
|
5202
|
+
initial_observed_value?: KeyResultValue;
|
|
5203
|
+
/** The starting value of the Key Result. */
|
|
5204
|
+
observed_value?: KeyResultValue;
|
|
5205
|
+
/** The starting value of the Key Result. */
|
|
5206
|
+
target_value?: KeyResultValue;
|
|
5207
|
+
}
|
|
5208
|
+
interface UpdateLabel {
|
|
4693
5209
|
/**
|
|
4694
5210
|
* The new name of the label.
|
|
4695
5211
|
* @minLength 1
|
|
4696
5212
|
* @maxLength 128
|
|
4697
5213
|
*/
|
|
4698
5214
|
name?: string;
|
|
4699
|
-
/**
|
|
5215
|
+
/**
|
|
5216
|
+
* The new description of the label.
|
|
5217
|
+
* @maxLength 1024
|
|
5218
|
+
*/
|
|
4700
5219
|
description?: string;
|
|
4701
5220
|
/**
|
|
4702
5221
|
* The hex color to be displayed with the Label (for example, "#ff0000").
|
|
@@ -4708,8 +5227,11 @@ export interface UpdateLabel {
|
|
|
4708
5227
|
/** A true/false boolean indicating if the Label has been archived. */
|
|
4709
5228
|
archived?: boolean;
|
|
4710
5229
|
}
|
|
4711
|
-
|
|
4712
|
-
/**
|
|
5230
|
+
interface UpdateLinkedFile {
|
|
5231
|
+
/**
|
|
5232
|
+
* The description of the file.
|
|
5233
|
+
* @maxLength 512
|
|
5234
|
+
*/
|
|
4713
5235
|
description?: string;
|
|
4714
5236
|
/**
|
|
4715
5237
|
* The ID of the linked story.
|
|
@@ -4728,7 +5250,7 @@ export interface UpdateLinkedFile {
|
|
|
4728
5250
|
*/
|
|
4729
5251
|
thumbnail_url?: string;
|
|
4730
5252
|
/** The integration type of the file (e.g. google, dropbox, box). */
|
|
4731
|
-
type?:
|
|
5253
|
+
type?: "google" | "url" | "dropbox" | "box" | "onedrive";
|
|
4732
5254
|
/**
|
|
4733
5255
|
* The filesize, if the integration provided it.
|
|
4734
5256
|
* @format int64
|
|
@@ -4746,7 +5268,7 @@ export interface UpdateLinkedFile {
|
|
|
4746
5268
|
*/
|
|
4747
5269
|
url?: string;
|
|
4748
5270
|
}
|
|
4749
|
-
|
|
5271
|
+
interface UpdateMilestone {
|
|
4750
5272
|
/**
|
|
4751
5273
|
* The Milestone's description.
|
|
4752
5274
|
* @maxLength 100000
|
|
@@ -4766,7 +5288,7 @@ export interface UpdateMilestone {
|
|
|
4766
5288
|
*/
|
|
4767
5289
|
name?: string;
|
|
4768
5290
|
/** The workflow state that the Milestone is in. */
|
|
4769
|
-
state?:
|
|
5291
|
+
state?: "in progress" | "to do" | "done";
|
|
4770
5292
|
/**
|
|
4771
5293
|
* A manual override for the time/date the Milestone was started.
|
|
4772
5294
|
* @format date-time
|
|
@@ -4785,7 +5307,46 @@ export interface UpdateMilestone {
|
|
|
4785
5307
|
*/
|
|
4786
5308
|
after_id?: number;
|
|
4787
5309
|
}
|
|
4788
|
-
|
|
5310
|
+
interface UpdateObjective {
|
|
5311
|
+
/**
|
|
5312
|
+
* The Objective's description.
|
|
5313
|
+
* @maxLength 100000
|
|
5314
|
+
*/
|
|
5315
|
+
description?: string;
|
|
5316
|
+
/** A boolean indicating whether the Objective is archived or not */
|
|
5317
|
+
archived?: boolean;
|
|
5318
|
+
/**
|
|
5319
|
+
* A manual override for the time/date the Objective was completed.
|
|
5320
|
+
* @format date-time
|
|
5321
|
+
*/
|
|
5322
|
+
completed_at_override?: string | null;
|
|
5323
|
+
/**
|
|
5324
|
+
* The name of the Objective.
|
|
5325
|
+
* @minLength 1
|
|
5326
|
+
* @maxLength 256
|
|
5327
|
+
*/
|
|
5328
|
+
name?: string;
|
|
5329
|
+
/** The workflow state that the Objective is in. */
|
|
5330
|
+
state?: "in progress" | "to do" | "done";
|
|
5331
|
+
/**
|
|
5332
|
+
* A manual override for the time/date the Objective was started.
|
|
5333
|
+
* @format date-time
|
|
5334
|
+
*/
|
|
5335
|
+
started_at_override?: string | null;
|
|
5336
|
+
/** An array of IDs of Categories attached to the Objective. */
|
|
5337
|
+
categories?: CreateCategoryParams[];
|
|
5338
|
+
/**
|
|
5339
|
+
* The ID of the Objective we want to move this Objective before.
|
|
5340
|
+
* @format int64
|
|
5341
|
+
*/
|
|
5342
|
+
before_id?: number;
|
|
5343
|
+
/**
|
|
5344
|
+
* The ID of the Objective we want to move this Objective after.
|
|
5345
|
+
* @format int64
|
|
5346
|
+
*/
|
|
5347
|
+
after_id?: number;
|
|
5348
|
+
}
|
|
5349
|
+
interface UpdateProject {
|
|
4789
5350
|
/**
|
|
4790
5351
|
* The Project's description.
|
|
4791
5352
|
* @maxLength 100000
|
|
@@ -4823,7 +5384,7 @@ export interface UpdateProject {
|
|
|
4823
5384
|
/** The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. */
|
|
4824
5385
|
abbreviation?: string;
|
|
4825
5386
|
}
|
|
4826
|
-
|
|
5387
|
+
interface UpdateStories {
|
|
4827
5388
|
/** If the Stories should be archived or not. */
|
|
4828
5389
|
archived?: boolean;
|
|
4829
5390
|
/**
|
|
@@ -4832,9 +5393,9 @@ export interface UpdateStories {
|
|
|
4832
5393
|
*/
|
|
4833
5394
|
story_ids: number[];
|
|
4834
5395
|
/** The type of story (feature, bug, chore). */
|
|
4835
|
-
story_type?:
|
|
5396
|
+
story_type?: "feature" | "chore" | "bug";
|
|
4836
5397
|
/** One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. */
|
|
4837
|
-
move_to?:
|
|
5398
|
+
move_to?: "last" | "first";
|
|
4838
5399
|
/**
|
|
4839
5400
|
* The UUIDs of the new followers to be added.
|
|
4840
5401
|
* @uniqueItems true
|
|
@@ -4916,7 +5477,7 @@ export interface UpdateStories {
|
|
|
4916
5477
|
*/
|
|
4917
5478
|
owner_ids_add?: string[];
|
|
4918
5479
|
}
|
|
4919
|
-
|
|
5480
|
+
interface UpdateStory {
|
|
4920
5481
|
/**
|
|
4921
5482
|
* The description of the story.
|
|
4922
5483
|
* @maxLength 100000
|
|
@@ -4932,11 +5493,11 @@ export interface UpdateStory {
|
|
|
4932
5493
|
*/
|
|
4933
5494
|
pull_request_ids?: number[];
|
|
4934
5495
|
/** The type of story (feature, bug, chore). */
|
|
4935
|
-
story_type?:
|
|
5496
|
+
story_type?: "feature" | "chore" | "bug";
|
|
4936
5497
|
/** A map specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. */
|
|
4937
5498
|
custom_fields?: CustomFieldValueParams[];
|
|
4938
5499
|
/** One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. */
|
|
4939
|
-
move_to?:
|
|
5500
|
+
move_to?: "last" | "first";
|
|
4940
5501
|
/**
|
|
4941
5502
|
* An array of IDs of files attached to the story.
|
|
4942
5503
|
* @uniqueItems true
|
|
@@ -5005,6 +5566,11 @@ export interface UpdateStory {
|
|
|
5005
5566
|
* @uniqueItems true
|
|
5006
5567
|
*/
|
|
5007
5568
|
owner_ids?: string[];
|
|
5569
|
+
/**
|
|
5570
|
+
* The parent story id. If you want to unset this value set parent_story_id to null.
|
|
5571
|
+
* @format int64
|
|
5572
|
+
*/
|
|
5573
|
+
parent_story_id?: number | null;
|
|
5008
5574
|
/**
|
|
5009
5575
|
* The ID of the story we want to move this story before.
|
|
5010
5576
|
* @format int64
|
|
@@ -5036,7 +5602,7 @@ export interface UpdateStory {
|
|
|
5036
5602
|
*/
|
|
5037
5603
|
deadline?: string | null;
|
|
5038
5604
|
}
|
|
5039
|
-
|
|
5605
|
+
interface UpdateStoryComment {
|
|
5040
5606
|
/**
|
|
5041
5607
|
* The updated comment text.
|
|
5042
5608
|
* @maxLength 100000
|
|
@@ -5044,19 +5610,15 @@ export interface UpdateStoryComment {
|
|
|
5044
5610
|
text: string;
|
|
5045
5611
|
}
|
|
5046
5612
|
/** Updated attributes for the template to populate. */
|
|
5047
|
-
|
|
5613
|
+
interface UpdateStoryContents {
|
|
5048
5614
|
/** The description of the story. */
|
|
5049
5615
|
description?: string;
|
|
5050
|
-
/** A string description of this resource. */
|
|
5051
|
-
entity_type?: string;
|
|
5052
5616
|
/** An array of labels to be populated by the template. */
|
|
5053
5617
|
labels?: CreateLabelParams[];
|
|
5054
5618
|
/** The type of story (feature, bug, chore). */
|
|
5055
5619
|
story_type?: string;
|
|
5056
5620
|
/** An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField. */
|
|
5057
5621
|
custom_fields?: CustomFieldValueParams[];
|
|
5058
|
-
/** An array of linked files attached to the story. */
|
|
5059
|
-
linked_files?: LinkedFile[];
|
|
5060
5622
|
/**
|
|
5061
5623
|
* An array of the attached file IDs to be populated.
|
|
5062
5624
|
* @uniqueItems true
|
|
@@ -5071,25 +5633,25 @@ export interface UpdateStoryContents {
|
|
|
5071
5633
|
epic_id?: number | null;
|
|
5072
5634
|
/** An array of external links to be populated. */
|
|
5073
5635
|
external_links?: string[];
|
|
5636
|
+
/** An array of sub-tasks connected to the story */
|
|
5637
|
+
sub_tasks?: CreateSubTaskParams[];
|
|
5074
5638
|
/**
|
|
5075
5639
|
* The ID of the iteration the to be populated.
|
|
5076
5640
|
* @format int64
|
|
5077
5641
|
*/
|
|
5078
5642
|
iteration_id?: number | null;
|
|
5079
5643
|
/** An array of tasks to be populated by the template. */
|
|
5080
|
-
tasks?:
|
|
5081
|
-
/** An array of label ids attached to the story. */
|
|
5082
|
-
label_ids?: number[];
|
|
5644
|
+
tasks?: BaseTaskParams[];
|
|
5083
5645
|
/**
|
|
5084
5646
|
* The ID of the group to be populated.
|
|
5085
5647
|
* @format uuid
|
|
5086
5648
|
*/
|
|
5087
5649
|
group_id?: string | null;
|
|
5088
5650
|
/**
|
|
5089
|
-
* The ID of the workflow state
|
|
5651
|
+
* The ID of the workflow state to be populated.
|
|
5090
5652
|
* @format int64
|
|
5091
5653
|
*/
|
|
5092
|
-
workflow_state_id?: number;
|
|
5654
|
+
workflow_state_id?: number | null;
|
|
5093
5655
|
/** An array of UUIDs for any Members listed as Followers. */
|
|
5094
5656
|
follower_ids?: string[];
|
|
5095
5657
|
/** An array of UUIDs of the owners of this story. */
|
|
@@ -5099,8 +5661,6 @@ export interface UpdateStoryContents {
|
|
|
5099
5661
|
* @format int64
|
|
5100
5662
|
*/
|
|
5101
5663
|
estimate?: number | null;
|
|
5102
|
-
/** An array of files attached to the story. */
|
|
5103
|
-
files?: UploadedFile[];
|
|
5104
5664
|
/**
|
|
5105
5665
|
* The ID of the project the story belongs to.
|
|
5106
5666
|
* @format int64
|
|
@@ -5117,9 +5677,9 @@ export interface UpdateStoryContents {
|
|
|
5117
5677
|
*/
|
|
5118
5678
|
deadline?: string | null;
|
|
5119
5679
|
}
|
|
5120
|
-
|
|
5680
|
+
interface UpdateStoryLink {
|
|
5121
5681
|
/** The type of link. */
|
|
5122
|
-
verb?:
|
|
5682
|
+
verb?: "blocks" | "duplicates" | "relates to";
|
|
5123
5683
|
/**
|
|
5124
5684
|
* The ID of the subject Story.
|
|
5125
5685
|
* @format int64
|
|
@@ -5131,7 +5691,7 @@ export interface UpdateStoryLink {
|
|
|
5131
5691
|
*/
|
|
5132
5692
|
object_id?: number;
|
|
5133
5693
|
}
|
|
5134
|
-
|
|
5694
|
+
interface UpdateTask {
|
|
5135
5695
|
/**
|
|
5136
5696
|
* The Task's description.
|
|
5137
5697
|
* @minLength 1
|
|
@@ -5154,14 +5714,14 @@ export interface UpdateTask {
|
|
|
5154
5714
|
after_id?: number;
|
|
5155
5715
|
}
|
|
5156
5716
|
/** An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint. */
|
|
5157
|
-
|
|
5717
|
+
interface UploadedFile {
|
|
5158
5718
|
/** The description of the file. */
|
|
5159
5719
|
description?: string | null;
|
|
5160
5720
|
/** A string description of this resource. */
|
|
5161
5721
|
entity_type: string;
|
|
5162
5722
|
/** The unique IDs of the Stories associated with this file. */
|
|
5163
5723
|
story_ids: number[];
|
|
5164
|
-
/** Deprecated
|
|
5724
|
+
/** `Deprecated:` use `member_mention_ids`. */
|
|
5165
5725
|
mention_ids: string[];
|
|
5166
5726
|
/** The unique IDs of the Members who are mentioned in the file description. */
|
|
5167
5727
|
member_mention_ids: string[];
|
|
@@ -5206,7 +5766,7 @@ export interface UploadedFile {
|
|
|
5206
5766
|
created_at: string;
|
|
5207
5767
|
}
|
|
5208
5768
|
/** Workflow is the array of defined Workflow States. Workflow can be queried using the API but must be updated in the Shortcut UI. */
|
|
5209
|
-
|
|
5769
|
+
interface Workflow {
|
|
5210
5770
|
/** A description of the workflow. */
|
|
5211
5771
|
description: string;
|
|
5212
5772
|
/** A string description of this resource. */
|
|
@@ -5246,7 +5806,7 @@ export interface Workflow {
|
|
|
5246
5806
|
default_state_id: number;
|
|
5247
5807
|
}
|
|
5248
5808
|
/** Workflow State is any of the at least 3 columns. Workflow States correspond to one of 3 types: Unstarted, Started, or Done. */
|
|
5249
|
-
|
|
5809
|
+
interface WorkflowState {
|
|
5250
5810
|
/** The description of what sort of Stories belong in that Workflow state. */
|
|
5251
5811
|
description: string;
|
|
5252
5812
|
/** A string description of this resource. */
|
|
@@ -5296,3 +5856,5 @@ export interface WorkflowState {
|
|
|
5296
5856
|
*/
|
|
5297
5857
|
created_at: string;
|
|
5298
5858
|
}
|
|
5859
|
+
|
|
5860
|
+
export type { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState };
|