@shortcut/client 2.0.0 → 2.1.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.
@@ -1,2128 +1,2075 @@
1
- // src/generated/http-client.ts
2
- import axios from "axios";
3
- var HttpClient = class {
4
- instance;
5
- securityData = null;
6
- securityWorker;
7
- secure;
8
- format;
9
- constructor({
10
- securityWorker,
11
- secure,
12
- format,
13
- ...axiosConfig
14
- } = {}) {
15
- this.instance = axios.create({
16
- ...axiosConfig,
17
- baseURL: axiosConfig.baseURL || "https://api.app.shortcut.com"
18
- });
19
- this.secure = secure;
20
- this.format = format;
21
- this.securityWorker = securityWorker;
22
- }
23
- setSecurityData = (data) => {
24
- this.securityData = data;
25
- };
26
- mergeRequestParams(params1, params2) {
27
- const method = params1.method || params2 && params2.method;
28
- return {
29
- ...this.instance.defaults,
30
- ...params1,
31
- ...params2 || {},
32
- headers: {
33
- ...method && this.instance.defaults.headers[method.toLowerCase()] || {},
34
- ...params1.headers || {},
35
- ...params2 && params2.headers || {}
36
- }
37
- };
38
- }
39
- stringifyFormItem(formItem) {
40
- if (typeof formItem === "object" && formItem !== null) {
41
- return JSON.stringify(formItem);
42
- } else {
43
- return `${formItem}`;
44
- }
45
- }
46
- createFormData(input) {
47
- return Object.keys(input || {}).reduce((formData, key) => {
48
- const property = input[key];
49
- const propertyContent = property instanceof Array ? property : [property];
50
- for (const formItem of propertyContent) {
51
- const isFileType = formItem instanceof Blob;
52
- formData.append(
53
- key,
54
- isFileType ? formItem : this.stringifyFormItem(formItem)
55
- );
56
- }
57
- return formData;
58
- }, new FormData());
59
- }
60
- request = async ({
61
- secure,
62
- path,
63
- type,
64
- query,
65
- format,
66
- body,
67
- ...params
68
- }) => {
69
- const secureParams = (typeof secure === "boolean" ? secure : this.secure) && this.securityWorker && await this.securityWorker(this.securityData) || {};
70
- const requestParams = this.mergeRequestParams(params, secureParams);
71
- const responseFormat = format || this.format || void 0;
72
- if (type === "multipart/form-data" /* FormData */ && body && body !== null && typeof body === "object") {
73
- body = this.createFormData(body);
74
- }
75
- if (type === "text/plain" /* Text */ && body && body !== null && typeof body !== "string") {
76
- body = JSON.stringify(body);
77
- }
78
- return this.instance.request({
79
- ...requestParams,
80
- headers: {
81
- ...requestParams.headers || {},
82
- ...type && type !== "multipart/form-data" /* FormData */ ? { "Content-Type": type } : {}
83
- },
84
- params: query,
85
- responseType: responseFormat,
86
- data: body,
87
- url: path
88
- });
89
- };
90
- };
1
+ import { ContentType, HttpClient } from "./http-client.mjs";
91
2
 
92
- // src/generated/Api.ts
3
+ //#region src/generated/Api.ts
4
+ /**
5
+ * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
6
+ * @private
7
+ */
93
8
  var Api = class extends HttpClient {
94
- /**
95
- * @description List Categories returns a list of all Categories and their attributes.
96
- *
97
- * @name ListCategories
98
- * @summary List Categories
99
- * @request GET:/api/v3/categories
100
- * @secure
101
- */
102
- listCategories = (params = {}) => this.request({
103
- path: `/api/v3/categories`,
104
- method: "GET",
105
- secure: true,
106
- format: "json",
107
- ...params
108
- });
109
- /**
110
- * @description Create Category allows you to create a new Category in Shortcut.
111
- *
112
- * @name CreateCategory
113
- * @summary Create Category
114
- * @request POST:/api/v3/categories
115
- * @secure
116
- */
117
- createCategory = (CreateCategory, params = {}) => this.request({
118
- path: `/api/v3/categories`,
119
- method: "POST",
120
- body: CreateCategory,
121
- secure: true,
122
- type: "application/json" /* Json */,
123
- format: "json",
124
- ...params
125
- });
126
- /**
127
- * @description Get Category returns information about the selected Category.
128
- *
129
- * @name GetCategory
130
- * @summary Get Category
131
- * @request GET:/api/v3/categories/{category-public-id}
132
- * @secure
133
- */
134
- getCategory = (categoryPublicId, params = {}) => this.request({
135
- path: `/api/v3/categories/${categoryPublicId}`,
136
- method: "GET",
137
- secure: true,
138
- format: "json",
139
- ...params
140
- });
141
- /**
142
- * @description Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.
143
- *
144
- * @name UpdateCategory
145
- * @summary Update Category
146
- * @request PUT:/api/v3/categories/{category-public-id}
147
- * @secure
148
- */
149
- updateCategory = (categoryPublicId, UpdateCategory, params = {}) => this.request({
150
- path: `/api/v3/categories/${categoryPublicId}`,
151
- method: "PUT",
152
- body: UpdateCategory,
153
- secure: true,
154
- type: "application/json" /* Json */,
155
- format: "json",
156
- ...params
157
- });
158
- /**
159
- * @description Delete Category can be used to delete any Category.
160
- *
161
- * @name DeleteCategory
162
- * @summary Delete Category
163
- * @request DELETE:/api/v3/categories/{category-public-id}
164
- * @secure
165
- */
166
- deleteCategory = (categoryPublicId, params = {}) => this.request({
167
- path: `/api/v3/categories/${categoryPublicId}`,
168
- method: "DELETE",
169
- secure: true,
170
- ...params
171
- });
172
- /**
173
- * @description List Category Milestones returns a list of all Milestones with the Category.
174
- *
175
- * @name ListCategoryMilestones
176
- * @summary List Category Milestones
177
- * @request GET:/api/v3/categories/{category-public-id}/milestones
178
- * @secure
179
- */
180
- listCategoryMilestones = (categoryPublicId, params = {}) => this.request({
181
- path: `/api/v3/categories/${categoryPublicId}/milestones`,
182
- method: "GET",
183
- secure: true,
184
- format: "json",
185
- ...params
186
- });
187
- /**
188
- * @description Returns a list of all Objectives with the Category.
189
- *
190
- * @name ListCategoryObjectives
191
- * @summary List Category Objectives
192
- * @request GET:/api/v3/categories/{category-public-id}/objectives
193
- * @secure
194
- */
195
- listCategoryObjectives = (categoryPublicId, params = {}) => this.request({
196
- path: `/api/v3/categories/${categoryPublicId}/objectives`,
197
- method: "GET",
198
- secure: true,
199
- format: "json",
200
- ...params
201
- });
202
- /**
203
- * No description
204
- *
205
- * @name ListCustomFields
206
- * @summary List Custom Fields
207
- * @request GET:/api/v3/custom-fields
208
- * @secure
209
- */
210
- listCustomFields = (params = {}) => this.request({
211
- path: `/api/v3/custom-fields`,
212
- method: "GET",
213
- secure: true,
214
- format: "json",
215
- ...params
216
- });
217
- /**
218
- * No description
219
- *
220
- * @name GetCustomField
221
- * @summary Get Custom Field
222
- * @request GET:/api/v3/custom-fields/{custom-field-public-id}
223
- * @secure
224
- */
225
- getCustomField = (customFieldPublicId, params = {}) => this.request({
226
- path: `/api/v3/custom-fields/${customFieldPublicId}`,
227
- method: "GET",
228
- secure: true,
229
- format: "json",
230
- ...params
231
- });
232
- /**
233
- * @description Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).
234
- *
235
- * @name UpdateCustomField
236
- * @summary Update Custom Field
237
- * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
238
- * @secure
239
- */
240
- updateCustomField = (customFieldPublicId, UpdateCustomField, params = {}) => this.request({
241
- path: `/api/v3/custom-fields/${customFieldPublicId}`,
242
- method: "PUT",
243
- body: UpdateCustomField,
244
- secure: true,
245
- type: "application/json" /* Json */,
246
- format: "json",
247
- ...params
248
- });
249
- /**
250
- * No description
251
- *
252
- * @name DeleteCustomField
253
- * @summary Delete Custom Field
254
- * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
255
- * @secure
256
- */
257
- deleteCustomField = (customFieldPublicId, params = {}) => this.request({
258
- path: `/api/v3/custom-fields/${customFieldPublicId}`,
259
- method: "DELETE",
260
- secure: true,
261
- ...params
262
- });
263
- /**
264
- * @description List all the entity templates for the Workspace.
265
- *
266
- * @name ListEntityTemplates
267
- * @summary List Entity Templates
268
- * @request GET:/api/v3/entity-templates
269
- * @secure
270
- */
271
- listEntityTemplates = (params = {}) => this.request({
272
- path: `/api/v3/entity-templates`,
273
- method: "GET",
274
- secure: true,
275
- format: "json",
276
- ...params
277
- });
278
- /**
279
- * @description Create a new entity template for the Workspace.
280
- *
281
- * @name CreateEntityTemplate
282
- * @summary Create Entity Template
283
- * @request POST:/api/v3/entity-templates
284
- * @secure
285
- */
286
- createEntityTemplate = (CreateEntityTemplate, params = {}) => this.request({
287
- path: `/api/v3/entity-templates`,
288
- method: "POST",
289
- body: CreateEntityTemplate,
290
- secure: true,
291
- type: "application/json" /* Json */,
292
- format: "json",
293
- ...params
294
- });
295
- /**
296
- * @description Disables the Story Template feature for the Workspace.
297
- *
298
- * @name DisableStoryTemplates
299
- * @summary Disable Story Templates
300
- * @request PUT:/api/v3/entity-templates/disable
301
- * @secure
302
- */
303
- disableStoryTemplates = (params = {}) => this.request({
304
- path: `/api/v3/entity-templates/disable`,
305
- method: "PUT",
306
- secure: true,
307
- ...params
308
- });
309
- /**
310
- * @description Enables the Story Template feature for the Workspace.
311
- *
312
- * @name EnableStoryTemplates
313
- * @summary Enable Story Templates
314
- * @request PUT:/api/v3/entity-templates/enable
315
- * @secure
316
- */
317
- enableStoryTemplates = (params = {}) => this.request({
318
- path: `/api/v3/entity-templates/enable`,
319
- method: "PUT",
320
- secure: true,
321
- ...params
322
- });
323
- /**
324
- * @description Get Entity Template returns information about a given entity template.
325
- *
326
- * @name GetEntityTemplate
327
- * @summary Get Entity Template
328
- * @request GET:/api/v3/entity-templates/{entity-template-public-id}
329
- * @secure
330
- */
331
- getEntityTemplate = (entityTemplatePublicId, params = {}) => this.request({
332
- path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
333
- method: "GET",
334
- secure: true,
335
- format: "json",
336
- ...params
337
- });
338
- /**
339
- * @description Update an entity template's name or its contents.
340
- *
341
- * @name UpdateEntityTemplate
342
- * @summary Update Entity Template
343
- * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
344
- * @secure
345
- */
346
- updateEntityTemplate = (entityTemplatePublicId, UpdateEntityTemplate, params = {}) => this.request({
347
- path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
348
- method: "PUT",
349
- body: UpdateEntityTemplate,
350
- secure: true,
351
- type: "application/json" /* Json */,
352
- format: "json",
353
- ...params
354
- });
355
- /**
356
- * No description
357
- *
358
- * @name DeleteEntityTemplate
359
- * @summary Delete Entity Template
360
- * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
361
- * @secure
362
- */
363
- deleteEntityTemplate = (entityTemplatePublicId, params = {}) => this.request({
364
- path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
365
- method: "DELETE",
366
- secure: true,
367
- ...params
368
- });
369
- /**
370
- * @description Returns the Epic Workflow for the Workspace.
371
- *
372
- * @name GetEpicWorkflow
373
- * @summary Get Epic Workflow
374
- * @request GET:/api/v3/epic-workflow
375
- * @secure
376
- */
377
- getEpicWorkflow = (params = {}) => this.request({
378
- path: `/api/v3/epic-workflow`,
379
- method: "GET",
380
- secure: true,
381
- format: "json",
382
- ...params
383
- });
384
- /**
385
- * @description List Epics returns a list of all Epics and their attributes.
386
- *
387
- * @name ListEpics
388
- * @summary List Epics
389
- * @request GET:/api/v3/epics
390
- * @secure
391
- */
392
- listEpics = (query, params = {}) => this.request({
393
- path: `/api/v3/epics`,
394
- method: "GET",
395
- query,
396
- secure: true,
397
- format: "json",
398
- ...params
399
- });
400
- /**
401
- * @description Create Epic allows you to create a new Epic in Shortcut.
402
- *
403
- * @name CreateEpic
404
- * @summary Create Epic
405
- * @request POST:/api/v3/epics
406
- * @secure
407
- */
408
- createEpic = (CreateEpic, params = {}) => this.request({
409
- path: `/api/v3/epics`,
410
- method: "POST",
411
- body: CreateEpic,
412
- secure: true,
413
- type: "application/json" /* Json */,
414
- format: "json",
415
- ...params
416
- });
417
- /**
418
- * @description List Epics with pagination returns a paginated list of Epics and their attributes.
419
- *
420
- * @name ListEpicsPaginated
421
- * @summary List Epics Paginated
422
- * @request GET:/api/v3/epics/paginated
423
- * @secure
424
- */
425
- listEpicsPaginated = (query, params = {}) => this.request({
426
- path: `/api/v3/epics/paginated`,
427
- method: "GET",
428
- query,
429
- secure: true,
430
- format: "json",
431
- ...params
432
- });
433
- /**
434
- * @description Get Epic returns information about the selected Epic.
435
- *
436
- * @name GetEpic
437
- * @summary Get Epic
438
- * @request GET:/api/v3/epics/{epic-public-id}
439
- * @secure
440
- */
441
- getEpic = (epicPublicId, params = {}) => this.request({
442
- path: `/api/v3/epics/${epicPublicId}`,
443
- method: "GET",
444
- secure: true,
445
- format: "json",
446
- ...params
447
- });
448
- /**
449
- * @description Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
450
- *
451
- * @name UpdateEpic
452
- * @summary Update Epic
453
- * @request PUT:/api/v3/epics/{epic-public-id}
454
- * @secure
455
- */
456
- updateEpic = (epicPublicId, UpdateEpic, params = {}) => this.request({
457
- path: `/api/v3/epics/${epicPublicId}`,
458
- method: "PUT",
459
- body: UpdateEpic,
460
- secure: true,
461
- type: "application/json" /* Json */,
462
- format: "json",
463
- ...params
464
- });
465
- /**
466
- * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
467
- *
468
- * @name DeleteEpic
469
- * @summary Delete Epic
470
- * @request DELETE:/api/v3/epics/{epic-public-id}
471
- * @secure
472
- */
473
- deleteEpic = (epicPublicId, params = {}) => this.request({
474
- path: `/api/v3/epics/${epicPublicId}`,
475
- method: "DELETE",
476
- secure: true,
477
- ...params
478
- });
479
- /**
480
- * @description Get a list of all Comments on an Epic.
481
- *
482
- * @name ListEpicComments
483
- * @summary List Epic Comments
484
- * @request GET:/api/v3/epics/{epic-public-id}/comments
485
- * @secure
486
- */
487
- listEpicComments = (epicPublicId, params = {}) => this.request({
488
- path: `/api/v3/epics/${epicPublicId}/comments`,
489
- method: "GET",
490
- secure: true,
491
- format: "json",
492
- ...params
493
- });
494
- /**
495
- * @description This endpoint allows you to create a threaded Comment on an Epic.
496
- *
497
- * @name CreateEpicComment
498
- * @summary Create Epic Comment
499
- * @request POST:/api/v3/epics/{epic-public-id}/comments
500
- * @secure
501
- */
502
- createEpicComment = (epicPublicId, CreateEpicComment, params = {}) => this.request({
503
- path: `/api/v3/epics/${epicPublicId}/comments`,
504
- method: "POST",
505
- body: CreateEpicComment,
506
- secure: true,
507
- type: "application/json" /* Json */,
508
- format: "json",
509
- ...params
510
- });
511
- /**
512
- * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
513
- *
514
- * @name CreateEpicCommentComment
515
- * @summary Create Epic Comment Comment
516
- * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
517
- * @secure
518
- */
519
- createEpicCommentComment = (epicPublicId, commentPublicId, CreateCommentComment, params = {}) => this.request({
520
- path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
521
- method: "POST",
522
- body: CreateCommentComment,
523
- secure: true,
524
- type: "application/json" /* Json */,
525
- format: "json",
526
- ...params
527
- });
528
- /**
529
- * @description This endpoint returns information about the selected Epic Comment.
530
- *
531
- * @name GetEpicComment
532
- * @summary Get Epic Comment
533
- * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
534
- * @secure
535
- */
536
- getEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request({
537
- path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
538
- method: "GET",
539
- secure: true,
540
- format: "json",
541
- ...params
542
- });
543
- /**
544
- * @description This endpoint allows you to update a threaded Comment on an Epic.
545
- *
546
- * @name UpdateEpicComment
547
- * @summary Update Epic Comment
548
- * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
549
- * @secure
550
- */
551
- updateEpicComment = (epicPublicId, commentPublicId, UpdateComment, params = {}) => this.request({
552
- path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
553
- method: "PUT",
554
- body: UpdateComment,
555
- secure: true,
556
- type: "application/json" /* Json */,
557
- format: "json",
558
- ...params
559
- });
560
- /**
561
- * @description This endpoint allows you to delete a Comment from an Epic.
562
- *
563
- * @name DeleteEpicComment
564
- * @summary Delete Epic Comment
565
- * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
566
- * @secure
567
- */
568
- deleteEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request({
569
- path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
570
- method: "DELETE",
571
- secure: true,
572
- ...params
573
- });
574
- /**
575
- * @description Get the current health for the specified Epic.
576
- *
577
- * @name GetEpicHealth
578
- * @summary Get Epic Health
579
- * @request GET:/api/v3/epics/{epic-public-id}/health
580
- * @secure
581
- */
582
- getEpicHealth = (epicPublicId, params = {}) => this.request({
583
- path: `/api/v3/epics/${epicPublicId}/health`,
584
- method: "GET",
585
- secure: true,
586
- format: "json",
587
- ...params
588
- });
589
- /**
590
- * @description Create a new health status for the specified Epic.
591
- *
592
- * @name CreateEpicHealth
593
- * @summary Create Epic Health
594
- * @request POST:/api/v3/epics/{epic-public-id}/health
595
- * @secure
596
- */
597
- createEpicHealth = (epicPublicId, CreateEpicHealth, params = {}) => this.request({
598
- path: `/api/v3/epics/${epicPublicId}/health`,
599
- method: "POST",
600
- body: CreateEpicHealth,
601
- secure: true,
602
- type: "application/json" /* Json */,
603
- format: "json",
604
- ...params
605
- });
606
- /**
607
- * @description List the history of health statuses for the specified Epic, most recent first.
608
- *
609
- * @name ListEpicHealths
610
- * @summary List Epic Healths
611
- * @request GET:/api/v3/epics/{epic-public-id}/health-history
612
- * @secure
613
- */
614
- listEpicHealths = (epicPublicId, params = {}) => this.request({
615
- path: `/api/v3/epics/${epicPublicId}/health-history`,
616
- method: "GET",
617
- secure: true,
618
- format: "json",
619
- ...params
620
- });
621
- /**
622
- * @description Get a list of all Stories in an Epic.
623
- *
624
- * @name ListEpicStories
625
- * @summary List Epic Stories
626
- * @request GET:/api/v3/epics/{epic-public-id}/stories
627
- * @secure
628
- */
629
- listEpicStories = (epicPublicId, query, params = {}) => this.request({
630
- path: `/api/v3/epics/${epicPublicId}/stories`,
631
- method: "GET",
632
- query,
633
- secure: true,
634
- format: "json",
635
- ...params
636
- });
637
- /**
638
- * @description This endpoint allows you to unlink a productboard epic.
639
- *
640
- * @name UnlinkProductboardFromEpic
641
- * @summary Unlink Productboard from Epic
642
- * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
643
- * @secure
644
- */
645
- unlinkProductboardFromEpic = (epicPublicId, params = {}) => this.request({
646
- path: `/api/v3/epics/${epicPublicId}/unlink-productboard`,
647
- method: "POST",
648
- secure: true,
649
- ...params
650
- });
651
- /**
652
- * @description Get Stories which have a given External Link associated with them.
653
- *
654
- * @name GetExternalLinkStories
655
- * @summary Get External Link Stories
656
- * @request GET:/api/v3/external-link/stories
657
- * @secure
658
- */
659
- getExternalLinkStories = (query, params = {}) => this.request({
660
- path: `/api/v3/external-link/stories`,
661
- method: "GET",
662
- query,
663
- secure: true,
664
- format: "json",
665
- ...params
666
- });
667
- /**
668
- * @description List Files returns a list of all UploadedFiles in the workspace.
669
- *
670
- * @name ListFiles
671
- * @summary List Files
672
- * @request GET:/api/v3/files
673
- * @secure
674
- */
675
- listFiles = (params = {}) => this.request({
676
- path: `/api/v3/files`,
677
- method: "GET",
678
- secure: true,
679
- format: "json",
680
- ...params
681
- });
682
- /**
683
- * @description Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.
684
- *
685
- * @name UploadFiles
686
- * @summary Upload Files
687
- * @request POST:/api/v3/files
688
- * @secure
689
- */
690
- uploadFiles = (data, params = {}) => this.request({
691
- path: `/api/v3/files`,
692
- method: "POST",
693
- body: data,
694
- secure: true,
695
- type: "multipart/form-data" /* FormData */,
696
- format: "json",
697
- ...params
698
- });
699
- /**
700
- * @description Get File returns information about the selected UploadedFile.
701
- *
702
- * @name GetFile
703
- * @summary Get File
704
- * @request GET:/api/v3/files/{file-public-id}
705
- * @secure
706
- */
707
- getFile = (filePublicId, params = {}) => this.request({
708
- path: `/api/v3/files/${filePublicId}`,
709
- method: "GET",
710
- secure: true,
711
- format: "json",
712
- ...params
713
- });
714
- /**
715
- * @description Update File updates the properties of an UploadedFile (but not its content).
716
- *
717
- * @name UpdateFile
718
- * @summary Update File
719
- * @request PUT:/api/v3/files/{file-public-id}
720
- * @secure
721
- */
722
- updateFile = (filePublicId, UpdateFile, params = {}) => this.request({
723
- path: `/api/v3/files/${filePublicId}`,
724
- method: "PUT",
725
- body: UpdateFile,
726
- secure: true,
727
- type: "application/json" /* Json */,
728
- format: "json",
729
- ...params
730
- });
731
- /**
732
- * @description Delete File deletes a previously uploaded file.
733
- *
734
- * @name DeleteFile
735
- * @summary Delete File
736
- * @request DELETE:/api/v3/files/{file-public-id}
737
- * @secure
738
- */
739
- deleteFile = (filePublicId, params = {}) => this.request({
740
- path: `/api/v3/files/${filePublicId}`,
741
- method: "DELETE",
742
- secure: true,
743
- ...params
744
- });
745
- /**
746
- * @description A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
747
- *
748
- * @name ListGroups
749
- * @summary List Groups
750
- * @request GET:/api/v3/groups
751
- * @secure
752
- */
753
- listGroups = (params = {}) => this.request({
754
- path: `/api/v3/groups`,
755
- method: "GET",
756
- secure: true,
757
- format: "json",
758
- ...params
759
- });
760
- /**
761
- * No description
762
- *
763
- * @name CreateGroup
764
- * @summary Create Group
765
- * @request POST:/api/v3/groups
766
- * @secure
767
- */
768
- createGroup = (CreateGroup, params = {}) => this.request({
769
- path: `/api/v3/groups`,
770
- method: "POST",
771
- body: CreateGroup,
772
- secure: true,
773
- type: "application/json" /* Json */,
774
- format: "json",
775
- ...params
776
- });
777
- /**
778
- * No description
779
- *
780
- * @name GetGroup
781
- * @summary Get Group
782
- * @request GET:/api/v3/groups/{group-public-id}
783
- * @secure
784
- */
785
- getGroup = (groupPublicId, params = {}) => this.request({
786
- path: `/api/v3/groups/${groupPublicId}`,
787
- method: "GET",
788
- secure: true,
789
- format: "json",
790
- ...params
791
- });
792
- /**
793
- * No description
794
- *
795
- * @name UpdateGroup
796
- * @summary Update Group
797
- * @request PUT:/api/v3/groups/{group-public-id}
798
- * @secure
799
- */
800
- updateGroup = (groupPublicId, UpdateGroup, params = {}) => this.request({
801
- path: `/api/v3/groups/${groupPublicId}`,
802
- method: "PUT",
803
- body: UpdateGroup,
804
- secure: true,
805
- type: "application/json" /* Json */,
806
- format: "json",
807
- ...params
808
- });
809
- /**
810
- * @description List the Stories assigned to the Group. (By default, limited to 1,000).
811
- *
812
- * @name ListGroupStories
813
- * @summary List Group Stories
814
- * @request GET:/api/v3/groups/{group-public-id}/stories
815
- * @secure
816
- */
817
- listGroupStories = (groupPublicId, query, params = {}) => this.request({
818
- path: `/api/v3/groups/${groupPublicId}/stories`,
819
- method: "GET",
820
- query,
821
- secure: true,
822
- format: "json",
823
- ...params
824
- });
825
- /**
826
- * @description Update an existing health status by its ID.
827
- *
828
- * @name UpdateHealth
829
- * @summary Update Health
830
- * @request PUT:/api/v3/health/{health-public-id}
831
- * @secure
832
- */
833
- updateHealth = (healthPublicId, UpdateHealth, params = {}) => this.request({
834
- path: `/api/v3/health/${healthPublicId}`,
835
- method: "PUT",
836
- body: UpdateHealth,
837
- secure: true,
838
- type: "application/json" /* Json */,
839
- format: "json",
840
- ...params
841
- });
842
- /**
843
- * No description
844
- *
845
- * @name CreateGenericIntegration
846
- * @summary Create Generic Integration
847
- * @request POST:/api/v3/integrations/webhook
848
- * @secure
849
- */
850
- createGenericIntegration = (CreateGenericIntegration, params = {}) => this.request({
851
- path: `/api/v3/integrations/webhook`,
852
- method: "POST",
853
- body: CreateGenericIntegration,
854
- secure: true,
855
- type: "application/json" /* Json */,
856
- ...params
857
- });
858
- /**
859
- * No description
860
- *
861
- * @name GetGenericIntegration
862
- * @summary Get Generic Integration
863
- * @request GET:/api/v3/integrations/webhook/{integration-public-id}
864
- * @secure
865
- */
866
- getGenericIntegration = (integrationPublicId, params = {}) => this.request({
867
- path: `/api/v3/integrations/webhook/${integrationPublicId}`,
868
- method: "GET",
869
- secure: true,
870
- ...params
871
- });
872
- /**
873
- * No description
874
- *
875
- * @name DeleteGenericIntegration
876
- * @summary Delete Generic Integration
877
- * @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
878
- * @secure
879
- */
880
- deleteGenericIntegration = (integrationPublicId, params = {}) => this.request({
881
- path: `/api/v3/integrations/webhook/${integrationPublicId}`,
882
- method: "DELETE",
883
- secure: true,
884
- ...params
885
- });
886
- /**
887
- * No description
888
- *
889
- * @name ListIterations
890
- * @summary List Iterations
891
- * @request GET:/api/v3/iterations
892
- * @secure
893
- */
894
- listIterations = (params = {}) => this.request({
895
- path: `/api/v3/iterations`,
896
- method: "GET",
897
- secure: true,
898
- format: "json",
899
- ...params
900
- });
901
- /**
902
- * No description
903
- *
904
- * @name CreateIteration
905
- * @summary Create Iteration
906
- * @request POST:/api/v3/iterations
907
- * @secure
908
- */
909
- createIteration = (CreateIteration, params = {}) => this.request({
910
- path: `/api/v3/iterations`,
911
- method: "POST",
912
- body: CreateIteration,
913
- secure: true,
914
- type: "application/json" /* Json */,
915
- format: "json",
916
- ...params
917
- });
918
- /**
919
- * @description Disables Iterations for the current workspace
920
- *
921
- * @name DisableIterations
922
- * @summary Disable Iterations
923
- * @request PUT:/api/v3/iterations/disable
924
- * @secure
925
- */
926
- disableIterations = (params = {}) => this.request({
927
- path: `/api/v3/iterations/disable`,
928
- method: "PUT",
929
- secure: true,
930
- ...params
931
- });
932
- /**
933
- * @description Enables Iterations for the current workspace
934
- *
935
- * @name EnableIterations
936
- * @summary Enable Iterations
937
- * @request PUT:/api/v3/iterations/enable
938
- * @secure
939
- */
940
- enableIterations = (params = {}) => this.request({
941
- path: `/api/v3/iterations/enable`,
942
- method: "PUT",
943
- secure: true,
944
- ...params
945
- });
946
- /**
947
- * No description
948
- *
949
- * @name GetIteration
950
- * @summary Get Iteration
951
- * @request GET:/api/v3/iterations/{iteration-public-id}
952
- * @secure
953
- */
954
- getIteration = (iterationPublicId, params = {}) => this.request({
955
- path: `/api/v3/iterations/${iterationPublicId}`,
956
- method: "GET",
957
- secure: true,
958
- format: "json",
959
- ...params
960
- });
961
- /**
962
- * No description
963
- *
964
- * @name UpdateIteration
965
- * @summary Update Iteration
966
- * @request PUT:/api/v3/iterations/{iteration-public-id}
967
- * @secure
968
- */
969
- updateIteration = (iterationPublicId, UpdateIteration, params = {}) => this.request({
970
- path: `/api/v3/iterations/${iterationPublicId}`,
971
- method: "PUT",
972
- body: UpdateIteration,
973
- secure: true,
974
- type: "application/json" /* Json */,
975
- format: "json",
976
- ...params
977
- });
978
- /**
979
- * No description
980
- *
981
- * @name DeleteIteration
982
- * @summary Delete Iteration
983
- * @request DELETE:/api/v3/iterations/{iteration-public-id}
984
- * @secure
985
- */
986
- deleteIteration = (iterationPublicId, params = {}) => this.request({
987
- path: `/api/v3/iterations/${iterationPublicId}`,
988
- method: "DELETE",
989
- secure: true,
990
- ...params
991
- });
992
- /**
993
- * @description Get a list of all Stories in an Iteration.
994
- *
995
- * @name ListIterationStories
996
- * @summary List Iteration Stories
997
- * @request GET:/api/v3/iterations/{iteration-public-id}/stories
998
- * @secure
999
- */
1000
- listIterationStories = (iterationPublicId, query, params = {}) => this.request({
1001
- path: `/api/v3/iterations/${iterationPublicId}/stories`,
1002
- method: "GET",
1003
- query,
1004
- secure: true,
1005
- format: "json",
1006
- ...params
1007
- });
1008
- /**
1009
- * @description Get Key Result returns information about a chosen Key Result.
1010
- *
1011
- * @name GetKeyResult
1012
- * @summary Get Key Result
1013
- * @request GET:/api/v3/key-results/{key-result-public-id}
1014
- * @secure
1015
- */
1016
- getKeyResult = (keyResultPublicId, params = {}) => this.request({
1017
- path: `/api/v3/key-results/${keyResultPublicId}`,
1018
- method: "GET",
1019
- secure: true,
1020
- format: "json",
1021
- ...params
1022
- });
1023
- /**
1024
- * @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
1025
- *
1026
- * @name UpdateKeyResult
1027
- * @summary Update Key Result
1028
- * @request PUT:/api/v3/key-results/{key-result-public-id}
1029
- * @secure
1030
- */
1031
- updateKeyResult = (keyResultPublicId, UpdateKeyResult, params = {}) => this.request({
1032
- path: `/api/v3/key-results/${keyResultPublicId}`,
1033
- method: "PUT",
1034
- body: UpdateKeyResult,
1035
- secure: true,
1036
- type: "application/json" /* Json */,
1037
- format: "json",
1038
- ...params
1039
- });
1040
- /**
1041
- * @description List Labels returns a list of all Labels and their attributes.
1042
- *
1043
- * @name ListLabels
1044
- * @summary List Labels
1045
- * @request GET:/api/v3/labels
1046
- * @secure
1047
- */
1048
- listLabels = (query, params = {}) => this.request({
1049
- path: `/api/v3/labels`,
1050
- method: "GET",
1051
- query,
1052
- secure: true,
1053
- format: "json",
1054
- ...params
1055
- });
1056
- /**
1057
- * @description Create Label allows you to create a new Label in Shortcut.
1058
- *
1059
- * @name CreateLabel
1060
- * @summary Create Label
1061
- * @request POST:/api/v3/labels
1062
- * @secure
1063
- */
1064
- createLabel = (CreateLabelParams, params = {}) => this.request({
1065
- path: `/api/v3/labels`,
1066
- method: "POST",
1067
- body: CreateLabelParams,
1068
- secure: true,
1069
- type: "application/json" /* Json */,
1070
- format: "json",
1071
- ...params
1072
- });
1073
- /**
1074
- * @description Get Label returns information about the selected Label.
1075
- *
1076
- * @name GetLabel
1077
- * @summary Get Label
1078
- * @request GET:/api/v3/labels/{label-public-id}
1079
- * @secure
1080
- */
1081
- getLabel = (labelPublicId, params = {}) => this.request({
1082
- path: `/api/v3/labels/${labelPublicId}`,
1083
- method: "GET",
1084
- secure: true,
1085
- format: "json",
1086
- ...params
1087
- });
1088
- /**
1089
- * @description Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
1090
- *
1091
- * @name UpdateLabel
1092
- * @summary Update Label
1093
- * @request PUT:/api/v3/labels/{label-public-id}
1094
- * @secure
1095
- */
1096
- updateLabel = (labelPublicId, UpdateLabel, params = {}) => this.request({
1097
- path: `/api/v3/labels/${labelPublicId}`,
1098
- method: "PUT",
1099
- body: UpdateLabel,
1100
- secure: true,
1101
- type: "application/json" /* Json */,
1102
- format: "json",
1103
- ...params
1104
- });
1105
- /**
1106
- * @description Delete Label can be used to delete any Label.
1107
- *
1108
- * @name DeleteLabel
1109
- * @summary Delete Label
1110
- * @request DELETE:/api/v3/labels/{label-public-id}
1111
- * @secure
1112
- */
1113
- deleteLabel = (labelPublicId, params = {}) => this.request({
1114
- path: `/api/v3/labels/${labelPublicId}`,
1115
- method: "DELETE",
1116
- secure: true,
1117
- ...params
1118
- });
1119
- /**
1120
- * @description List all of the Epics with the Label.
1121
- *
1122
- * @name ListLabelEpics
1123
- * @summary List Label Epics
1124
- * @request GET:/api/v3/labels/{label-public-id}/epics
1125
- * @secure
1126
- */
1127
- listLabelEpics = (labelPublicId, params = {}) => this.request({
1128
- path: `/api/v3/labels/${labelPublicId}/epics`,
1129
- method: "GET",
1130
- secure: true,
1131
- format: "json",
1132
- ...params
1133
- });
1134
- /**
1135
- * @description List all of the Stories with the Label.
1136
- *
1137
- * @name ListLabelStories
1138
- * @summary List Label Stories
1139
- * @request GET:/api/v3/labels/{label-public-id}/stories
1140
- * @secure
1141
- */
1142
- listLabelStories = (labelPublicId, query, params = {}) => this.request({
1143
- path: `/api/v3/labels/${labelPublicId}/stories`,
1144
- method: "GET",
1145
- query,
1146
- secure: true,
1147
- format: "json",
1148
- ...params
1149
- });
1150
- /**
1151
- * @description List Linked Files returns a list of all Linked-Files and their attributes.
1152
- *
1153
- * @name ListLinkedFiles
1154
- * @summary List Linked Files
1155
- * @request GET:/api/v3/linked-files
1156
- * @secure
1157
- */
1158
- listLinkedFiles = (params = {}) => this.request({
1159
- path: `/api/v3/linked-files`,
1160
- method: "GET",
1161
- secure: true,
1162
- format: "json",
1163
- ...params
1164
- });
1165
- /**
1166
- * @description Create Linked File allows you to create a new Linked File in Shortcut.
1167
- *
1168
- * @name CreateLinkedFile
1169
- * @summary Create Linked File
1170
- * @request POST:/api/v3/linked-files
1171
- * @secure
1172
- */
1173
- createLinkedFile = (CreateLinkedFile, params = {}) => this.request({
1174
- path: `/api/v3/linked-files`,
1175
- method: "POST",
1176
- body: CreateLinkedFile,
1177
- secure: true,
1178
- type: "application/json" /* Json */,
1179
- format: "json",
1180
- ...params
1181
- });
1182
- /**
1183
- * @description Get File returns information about the selected Linked File.
1184
- *
1185
- * @name GetLinkedFile
1186
- * @summary Get Linked File
1187
- * @request GET:/api/v3/linked-files/{linked-file-public-id}
1188
- * @secure
1189
- */
1190
- getLinkedFile = (linkedFilePublicId, params = {}) => this.request({
1191
- path: `/api/v3/linked-files/${linkedFilePublicId}`,
1192
- method: "GET",
1193
- secure: true,
1194
- format: "json",
1195
- ...params
1196
- });
1197
- /**
1198
- * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
1199
- *
1200
- * @name UpdateLinkedFile
1201
- * @summary Update Linked File
1202
- * @request PUT:/api/v3/linked-files/{linked-file-public-id}
1203
- * @secure
1204
- */
1205
- updateLinkedFile = (linkedFilePublicId, UpdateLinkedFile, params = {}) => this.request({
1206
- path: `/api/v3/linked-files/${linkedFilePublicId}`,
1207
- method: "PUT",
1208
- body: UpdateLinkedFile,
1209
- secure: true,
1210
- type: "application/json" /* Json */,
1211
- format: "json",
1212
- ...params
1213
- });
1214
- /**
1215
- * @description Delete Linked File can be used to delete any previously attached Linked-File.
1216
- *
1217
- * @name DeleteLinkedFile
1218
- * @summary Delete Linked File
1219
- * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
1220
- * @secure
1221
- */
1222
- deleteLinkedFile = (linkedFilePublicId, params = {}) => this.request({
1223
- path: `/api/v3/linked-files/${linkedFilePublicId}`,
1224
- method: "DELETE",
1225
- secure: true,
1226
- ...params
1227
- });
1228
- /**
1229
- * @description Returns information about the authenticated member.
1230
- *
1231
- * @name GetCurrentMemberInfo
1232
- * @summary Get Current Member Info
1233
- * @request GET:/api/v3/member
1234
- * @secure
1235
- */
1236
- getCurrentMemberInfo = (params = {}) => this.request({
1237
- path: `/api/v3/member`,
1238
- method: "GET",
1239
- secure: true,
1240
- format: "json",
1241
- ...params
1242
- });
1243
- /**
1244
- * @description Returns information about members of the Workspace.
1245
- *
1246
- * @name ListMembers
1247
- * @summary List Members
1248
- * @request GET:/api/v3/members
1249
- * @secure
1250
- */
1251
- listMembers = (query, params = {}) => this.request({
1252
- path: `/api/v3/members`,
1253
- method: "GET",
1254
- query,
1255
- secure: true,
1256
- format: "json",
1257
- ...params
1258
- });
1259
- /**
1260
- * @description Returns information about a Member.
1261
- *
1262
- * @name GetMember
1263
- * @summary Get Member
1264
- * @request GET:/api/v3/members/{member-public-id}
1265
- * @secure
1266
- */
1267
- getMember = (memberPublicId, query, params = {}) => this.request({
1268
- path: `/api/v3/members/${memberPublicId}`,
1269
- method: "GET",
1270
- query,
1271
- secure: true,
1272
- format: "json",
1273
- ...params
1274
- });
1275
- /**
1276
- * @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
1277
- *
1278
- * @name ListMilestones
1279
- * @summary List Milestones
1280
- * @request GET:/api/v3/milestones
1281
- * @secure
1282
- */
1283
- listMilestones = (params = {}) => this.request({
1284
- path: `/api/v3/milestones`,
1285
- method: "GET",
1286
- secure: true,
1287
- format: "json",
1288
- ...params
1289
- });
1290
- /**
1291
- * @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
1292
- *
1293
- * @name CreateMilestone
1294
- * @summary Create Milestone
1295
- * @request POST:/api/v3/milestones
1296
- * @secure
1297
- */
1298
- createMilestone = (CreateMilestone, params = {}) => this.request({
1299
- path: `/api/v3/milestones`,
1300
- method: "POST",
1301
- body: CreateMilestone,
1302
- secure: true,
1303
- type: "application/json" /* Json */,
1304
- format: "json",
1305
- ...params
1306
- });
1307
- /**
1308
- * @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
1309
- *
1310
- * @name GetMilestone
1311
- * @summary Get Milestone
1312
- * @request GET:/api/v3/milestones/{milestone-public-id}
1313
- * @secure
1314
- */
1315
- getMilestone = (milestonePublicId, params = {}) => this.request({
1316
- path: `/api/v3/milestones/${milestonePublicId}`,
1317
- method: "GET",
1318
- secure: true,
1319
- format: "json",
1320
- ...params
1321
- });
1322
- /**
1323
- * @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
1324
- *
1325
- * @name UpdateMilestone
1326
- * @summary Update Milestone
1327
- * @request PUT:/api/v3/milestones/{milestone-public-id}
1328
- * @secure
1329
- */
1330
- updateMilestone = (milestonePublicId, UpdateMilestone, params = {}) => this.request({
1331
- path: `/api/v3/milestones/${milestonePublicId}`,
1332
- method: "PUT",
1333
- body: UpdateMilestone,
1334
- secure: true,
1335
- type: "application/json" /* Json */,
1336
- format: "json",
1337
- ...params
1338
- });
1339
- /**
1340
- * @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
1341
- *
1342
- * @name DeleteMilestone
1343
- * @summary Delete Milestone
1344
- * @request DELETE:/api/v3/milestones/{milestone-public-id}
1345
- * @secure
1346
- */
1347
- deleteMilestone = (milestonePublicId, params = {}) => this.request({
1348
- path: `/api/v3/milestones/${milestonePublicId}`,
1349
- method: "DELETE",
1350
- secure: true,
1351
- ...params
1352
- });
1353
- /**
1354
- * @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
1355
- *
1356
- * @name ListMilestoneEpics
1357
- * @summary List Milestone Epics
1358
- * @request GET:/api/v3/milestones/{milestone-public-id}/epics
1359
- * @secure
1360
- */
1361
- listMilestoneEpics = (milestonePublicId, params = {}) => this.request({
1362
- path: `/api/v3/milestones/${milestonePublicId}/epics`,
1363
- method: "GET",
1364
- secure: true,
1365
- format: "json",
1366
- ...params
1367
- });
1368
- /**
1369
- * @description List Objectives returns a list of all Objectives and their attributes.
1370
- *
1371
- * @name ListObjectives
1372
- * @summary List Objectives
1373
- * @request GET:/api/v3/objectives
1374
- * @secure
1375
- */
1376
- listObjectives = (params = {}) => this.request({
1377
- path: `/api/v3/objectives`,
1378
- method: "GET",
1379
- secure: true,
1380
- format: "json",
1381
- ...params
1382
- });
1383
- /**
1384
- * @description Create Objective allows you to create a new Objective in Shortcut.
1385
- *
1386
- * @name CreateObjective
1387
- * @summary Create Objective
1388
- * @request POST:/api/v3/objectives
1389
- * @secure
1390
- */
1391
- createObjective = (CreateObjective, params = {}) => this.request({
1392
- path: `/api/v3/objectives`,
1393
- method: "POST",
1394
- body: CreateObjective,
1395
- secure: true,
1396
- type: "application/json" /* Json */,
1397
- format: "json",
1398
- ...params
1399
- });
1400
- /**
1401
- * @description Get Objective returns information about a chosen Objective.
1402
- *
1403
- * @name GetObjective
1404
- * @summary Get Objective
1405
- * @request GET:/api/v3/objectives/{objective-public-id}
1406
- * @secure
1407
- */
1408
- getObjective = (objectivePublicId, params = {}) => this.request({
1409
- path: `/api/v3/objectives/${objectivePublicId}`,
1410
- method: "GET",
1411
- secure: true,
1412
- format: "json",
1413
- ...params
1414
- });
1415
- /**
1416
- * @description Update Objective can be used to update Objective properties.
1417
- *
1418
- * @name UpdateObjective
1419
- * @summary Update Objective
1420
- * @request PUT:/api/v3/objectives/{objective-public-id}
1421
- * @secure
1422
- */
1423
- updateObjective = (objectivePublicId, UpdateObjective, params = {}) => this.request({
1424
- path: `/api/v3/objectives/${objectivePublicId}`,
1425
- method: "PUT",
1426
- body: UpdateObjective,
1427
- secure: true,
1428
- type: "application/json" /* Json */,
1429
- format: "json",
1430
- ...params
1431
- });
1432
- /**
1433
- * @description Delete Objective can be used to delete any Objective.
1434
- *
1435
- * @name DeleteObjective
1436
- * @summary Delete Objective
1437
- * @request DELETE:/api/v3/objectives/{objective-public-id}
1438
- * @secure
1439
- */
1440
- deleteObjective = (objectivePublicId, params = {}) => this.request({
1441
- path: `/api/v3/objectives/${objectivePublicId}`,
1442
- method: "DELETE",
1443
- secure: true,
1444
- ...params
1445
- });
1446
- /**
1447
- * @description List all of the Epics within the Objective.
1448
- *
1449
- * @name ListObjectiveEpics
1450
- * @summary List Objective Epics
1451
- * @request GET:/api/v3/objectives/{objective-public-id}/epics
1452
- * @secure
1453
- */
1454
- listObjectiveEpics = (objectivePublicId, params = {}) => this.request({
1455
- path: `/api/v3/objectives/${objectivePublicId}/epics`,
1456
- method: "GET",
1457
- secure: true,
1458
- format: "json",
1459
- ...params
1460
- });
1461
- /**
1462
- * @description List Projects returns a list of all Projects and their attributes.
1463
- *
1464
- * @name ListProjects
1465
- * @summary List Projects
1466
- * @request GET:/api/v3/projects
1467
- * @secure
1468
- */
1469
- listProjects = (params = {}) => this.request({
1470
- path: `/api/v3/projects`,
1471
- method: "GET",
1472
- secure: true,
1473
- format: "json",
1474
- ...params
1475
- });
1476
- /**
1477
- * @description Create Project is used to create a new Shortcut Project.
1478
- *
1479
- * @name CreateProject
1480
- * @summary Create Project
1481
- * @request POST:/api/v3/projects
1482
- * @secure
1483
- */
1484
- createProject = (CreateProject, params = {}) => this.request({
1485
- path: `/api/v3/projects`,
1486
- method: "POST",
1487
- body: CreateProject,
1488
- secure: true,
1489
- type: "application/json" /* Json */,
1490
- format: "json",
1491
- ...params
1492
- });
1493
- /**
1494
- * @description Get Project returns information about the selected Project.
1495
- *
1496
- * @name GetProject
1497
- * @summary Get Project
1498
- * @request GET:/api/v3/projects/{project-public-id}
1499
- * @secure
1500
- */
1501
- getProject = (projectPublicId, params = {}) => this.request({
1502
- path: `/api/v3/projects/${projectPublicId}`,
1503
- method: "GET",
1504
- secure: true,
1505
- format: "json",
1506
- ...params
1507
- });
1508
- /**
1509
- * @description Update Project can be used to change properties of a Project.
1510
- *
1511
- * @name UpdateProject
1512
- * @summary Update Project
1513
- * @request PUT:/api/v3/projects/{project-public-id}
1514
- * @secure
1515
- */
1516
- updateProject = (projectPublicId, UpdateProject, params = {}) => this.request({
1517
- path: `/api/v3/projects/${projectPublicId}`,
1518
- method: "PUT",
1519
- body: UpdateProject,
1520
- secure: true,
1521
- type: "application/json" /* Json */,
1522
- format: "json",
1523
- ...params
1524
- });
1525
- /**
1526
- * @description Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.
1527
- *
1528
- * @name DeleteProject
1529
- * @summary Delete Project
1530
- * @request DELETE:/api/v3/projects/{project-public-id}
1531
- * @secure
1532
- */
1533
- deleteProject = (projectPublicId, params = {}) => this.request({
1534
- path: `/api/v3/projects/${projectPublicId}`,
1535
- method: "DELETE",
1536
- secure: true,
1537
- ...params
1538
- });
1539
- /**
1540
- * @description List Stories returns a list of all Stories in a selected Project and their attributes.
1541
- *
1542
- * @name ListStories
1543
- * @summary List Stories
1544
- * @request GET:/api/v3/projects/{project-public-id}/stories
1545
- * @secure
1546
- */
1547
- listStories = (projectPublicId, query, params = {}) => this.request({
1548
- path: `/api/v3/projects/${projectPublicId}/stories`,
1549
- method: "GET",
1550
- query,
1551
- secure: true,
1552
- format: "json",
1553
- ...params
1554
- });
1555
- /**
1556
- * @description List Repositories returns a list of all Repositories and their attributes.
1557
- *
1558
- * @name ListRepositories
1559
- * @summary List Repositories
1560
- * @request GET:/api/v3/repositories
1561
- * @secure
1562
- */
1563
- listRepositories = (params = {}) => this.request({
1564
- path: `/api/v3/repositories`,
1565
- method: "GET",
1566
- secure: true,
1567
- format: "json",
1568
- ...params
1569
- });
1570
- /**
1571
- * @description Get Repository returns information about the selected Repository.
1572
- *
1573
- * @name GetRepository
1574
- * @summary Get Repository
1575
- * @request GET:/api/v3/repositories/{repo-public-id}
1576
- * @secure
1577
- */
1578
- getRepository = (repoPublicId, params = {}) => this.request({
1579
- path: `/api/v3/repositories/${repoPublicId}`,
1580
- method: "GET",
1581
- secure: true,
1582
- format: "json",
1583
- ...params
1584
- });
1585
- /**
1586
- * @description Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1587
- *
1588
- * @name Search
1589
- * @summary Search
1590
- * @request GET:/api/v3/search
1591
- * @secure
1592
- */
1593
- search = (query, params = {}) => this.request({
1594
- path: `/api/v3/search`,
1595
- method: "GET",
1596
- query,
1597
- secure: true,
1598
- format: "json",
1599
- ...params
1600
- });
1601
- /**
1602
- * @description Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1603
- *
1604
- * @name SearchEpics
1605
- * @summary Search Epics
1606
- * @request GET:/api/v3/search/epics
1607
- * @secure
1608
- */
1609
- searchEpics = (query, params = {}) => this.request({
1610
- path: `/api/v3/search/epics`,
1611
- method: "GET",
1612
- query,
1613
- secure: true,
1614
- format: "json",
1615
- ...params
1616
- });
1617
- /**
1618
- * @description Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1619
- *
1620
- * @name SearchIterations
1621
- * @summary Search Iterations
1622
- * @request GET:/api/v3/search/iterations
1623
- * @secure
1624
- */
1625
- searchIterations = (query, params = {}) => this.request({
1626
- path: `/api/v3/search/iterations`,
1627
- method: "GET",
1628
- query,
1629
- secure: true,
1630
- format: "json",
1631
- ...params
1632
- });
1633
- /**
1634
- * @description Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1635
- *
1636
- * @name SearchMilestones
1637
- * @summary Search Milestones
1638
- * @request GET:/api/v3/search/milestones
1639
- * @secure
1640
- */
1641
- searchMilestones = (query, params = {}) => this.request({
1642
- path: `/api/v3/search/milestones`,
1643
- method: "GET",
1644
- query,
1645
- secure: true,
1646
- format: "json",
1647
- ...params
1648
- });
1649
- /**
1650
- * @description Search Objectives lets you search Objectives based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1651
- *
1652
- * @name SearchObjectives
1653
- * @summary Search Objectives
1654
- * @request GET:/api/v3/search/objectives
1655
- * @secure
1656
- */
1657
- searchObjectives = (query, params = {}) => this.request({
1658
- path: `/api/v3/search/objectives`,
1659
- method: "GET",
1660
- query,
1661
- secure: true,
1662
- format: "json",
1663
- ...params
1664
- });
1665
- /**
1666
- * @description Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1667
- *
1668
- * @name SearchStories
1669
- * @summary Search Stories
1670
- * @request GET:/api/v3/search/stories
1671
- * @secure
1672
- */
1673
- searchStories = (query, params = {}) => this.request({
1674
- path: `/api/v3/search/stories`,
1675
- method: "GET",
1676
- query,
1677
- secure: true,
1678
- format: "json",
1679
- ...params
1680
- });
1681
- /**
1682
- * @description Create Story is used to add a new story to your Shortcut Workspace. This endpoint requires that either **workflow_state_id** or **project_id** be provided, but will reject the request if both or neither are specified. The workflow_state_id has been marked as required and is the recommended field to specify because we are in the process of sunsetting Projects in Shortcut.
1683
- *
1684
- * @name CreateStory
1685
- * @summary Create Story
1686
- * @request POST:/api/v3/stories
1687
- * @secure
1688
- */
1689
- createStory = (CreateStoryParams, params = {}) => this.request({
1690
- path: `/api/v3/stories`,
1691
- method: "POST",
1692
- body: CreateStoryParams,
1693
- secure: true,
1694
- type: "application/json" /* Json */,
1695
- format: "json",
1696
- ...params
1697
- });
1698
- /**
1699
- * @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).
1700
- *
1701
- * @name CreateMultipleStories
1702
- * @summary Create Multiple Stories
1703
- * @request POST:/api/v3/stories/bulk
1704
- * @secure
1705
- */
1706
- createMultipleStories = (CreateStories, params = {}) => this.request({
1707
- path: `/api/v3/stories/bulk`,
1708
- method: "POST",
1709
- body: CreateStories,
1710
- secure: true,
1711
- type: "application/json" /* Json */,
1712
- format: "json",
1713
- ...params
1714
- });
1715
- /**
1716
- * @description Update Multiple Stories allows you to make changes to numerous stories at once.
1717
- *
1718
- * @name UpdateMultipleStories
1719
- * @summary Update Multiple Stories
1720
- * @request PUT:/api/v3/stories/bulk
1721
- * @secure
1722
- */
1723
- updateMultipleStories = (UpdateStories, params = {}) => this.request({
1724
- path: `/api/v3/stories/bulk`,
1725
- method: "PUT",
1726
- body: UpdateStories,
1727
- secure: true,
1728
- type: "application/json" /* Json */,
1729
- format: "json",
1730
- ...params
1731
- });
1732
- /**
1733
- * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
1734
- *
1735
- * @name DeleteMultipleStories
1736
- * @summary Delete Multiple Stories
1737
- * @request DELETE:/api/v3/stories/bulk
1738
- * @secure
1739
- */
1740
- deleteMultipleStories = (DeleteStories, params = {}) => this.request({
1741
- path: `/api/v3/stories/bulk`,
1742
- method: "DELETE",
1743
- body: DeleteStories,
1744
- secure: true,
1745
- type: "application/json" /* Json */,
1746
- ...params
1747
- });
1748
- /**
1749
- * @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
1750
- *
1751
- * @name CreateStoryFromTemplate
1752
- * @summary Create Story From Template
1753
- * @request POST:/api/v3/stories/from-template
1754
- * @secure
1755
- */
1756
- createStoryFromTemplate = (CreateStoryFromTemplateParams, params = {}) => this.request({
1757
- path: `/api/v3/stories/from-template`,
1758
- method: "POST",
1759
- body: CreateStoryFromTemplateParams,
1760
- secure: true,
1761
- type: "application/json" /* Json */,
1762
- format: "json",
1763
- ...params
1764
- });
1765
- /**
1766
- * @description Search Stories lets you search Stories based on desired parameters.
1767
- *
1768
- * @name SearchStoriesOld
1769
- * @summary Search Stories (Old)
1770
- * @request POST:/api/v3/stories/search
1771
- * @secure
1772
- */
1773
- searchStoriesOld = (SearchStories, params = {}) => this.request({
1774
- path: `/api/v3/stories/search`,
1775
- method: "POST",
1776
- body: SearchStories,
1777
- secure: true,
1778
- type: "application/json" /* Json */,
1779
- format: "json",
1780
- ...params
1781
- });
1782
- /**
1783
- * @description Get Story returns information about a chosen Story.
1784
- *
1785
- * @name GetStory
1786
- * @summary Get Story
1787
- * @request GET:/api/v3/stories/{story-public-id}
1788
- * @secure
1789
- */
1790
- getStory = (storyPublicId, params = {}) => this.request({
1791
- path: `/api/v3/stories/${storyPublicId}`,
1792
- method: "GET",
1793
- secure: true,
1794
- format: "json",
1795
- ...params
1796
- });
1797
- /**
1798
- * @description Update Story can be used to update Story properties.
1799
- *
1800
- * @name UpdateStory
1801
- * @summary Update Story
1802
- * @request PUT:/api/v3/stories/{story-public-id}
1803
- * @secure
1804
- */
1805
- updateStory = (storyPublicId, UpdateStory, params = {}) => this.request({
1806
- path: `/api/v3/stories/${storyPublicId}`,
1807
- method: "PUT",
1808
- body: UpdateStory,
1809
- secure: true,
1810
- type: "application/json" /* Json */,
1811
- format: "json",
1812
- ...params
1813
- });
1814
- /**
1815
- * @description Delete Story can be used to delete any Story.
1816
- *
1817
- * @name DeleteStory
1818
- * @summary Delete Story
1819
- * @request DELETE:/api/v3/stories/{story-public-id}
1820
- * @secure
1821
- */
1822
- deleteStory = (storyPublicId, params = {}) => this.request({
1823
- path: `/api/v3/stories/${storyPublicId}`,
1824
- method: "DELETE",
1825
- secure: true,
1826
- ...params
1827
- });
1828
- /**
1829
- * @description Lists Comments associated with a Story
1830
- *
1831
- * @name ListStoryComment
1832
- * @summary List Story Comment
1833
- * @request GET:/api/v3/stories/{story-public-id}/comments
1834
- * @secure
1835
- */
1836
- listStoryComment = (storyPublicId, params = {}) => this.request({
1837
- path: `/api/v3/stories/${storyPublicId}/comments`,
1838
- method: "GET",
1839
- secure: true,
1840
- format: "json",
1841
- ...params
1842
- });
1843
- /**
1844
- * @description Create Comment allows you to create a Comment on any Story.
1845
- *
1846
- * @name CreateStoryComment
1847
- * @summary Create Story Comment
1848
- * @request POST:/api/v3/stories/{story-public-id}/comments
1849
- * @secure
1850
- */
1851
- createStoryComment = (storyPublicId, CreateStoryComment, params = {}) => this.request({
1852
- path: `/api/v3/stories/${storyPublicId}/comments`,
1853
- method: "POST",
1854
- body: CreateStoryComment,
1855
- secure: true,
1856
- type: "application/json" /* Json */,
1857
- format: "json",
1858
- ...params
1859
- });
1860
- /**
1861
- * @description Get Comment is used to get Comment information.
1862
- *
1863
- * @name GetStoryComment
1864
- * @summary Get Story Comment
1865
- * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1866
- * @secure
1867
- */
1868
- getStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request({
1869
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1870
- method: "GET",
1871
- secure: true,
1872
- format: "json",
1873
- ...params
1874
- });
1875
- /**
1876
- * @description Update Comment replaces the text of the existing Comment.
1877
- *
1878
- * @name UpdateStoryComment
1879
- * @summary Update Story Comment
1880
- * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1881
- * @secure
1882
- */
1883
- updateStoryComment = (storyPublicId, commentPublicId, UpdateStoryComment, params = {}) => this.request({
1884
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1885
- method: "PUT",
1886
- body: UpdateStoryComment,
1887
- secure: true,
1888
- type: "application/json" /* Json */,
1889
- format: "json",
1890
- ...params
1891
- });
1892
- /**
1893
- * @description Delete a Comment from any story.
1894
- *
1895
- * @name DeleteStoryComment
1896
- * @summary Delete Story Comment
1897
- * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1898
- * @secure
1899
- */
1900
- deleteStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request({
1901
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1902
- method: "DELETE",
1903
- secure: true,
1904
- ...params
1905
- });
1906
- /**
1907
- * @description Create a reaction to a story comment.
1908
- *
1909
- * @name CreateStoryReaction
1910
- * @summary Create Story Reaction
1911
- * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1912
- * @secure
1913
- */
1914
- createStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request({
1915
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`,
1916
- method: "POST",
1917
- body: CreateOrDeleteStoryReaction,
1918
- secure: true,
1919
- type: "application/json" /* Json */,
1920
- format: "json",
1921
- ...params
1922
- });
1923
- /**
1924
- * @description Delete a reaction from any story comment.
1925
- *
1926
- * @name DeleteStoryReaction
1927
- * @summary Delete Story Reaction
1928
- * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1929
- * @secure
1930
- */
1931
- deleteStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request({
1932
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`,
1933
- method: "DELETE",
1934
- body: CreateOrDeleteStoryReaction,
1935
- secure: true,
1936
- type: "application/json" /* Json */,
1937
- ...params
1938
- });
1939
- /**
1940
- * @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
1941
- *
1942
- * @name UnlinkCommentThreadFromSlack
1943
- * @summary Unlink Comment thread from Slack
1944
- * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
1945
- * @secure
1946
- */
1947
- unlinkCommentThreadFromSlack = (storyPublicId, commentPublicId, params = {}) => this.request({
1948
- path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/unlink-from-slack`,
1949
- method: "POST",
1950
- secure: true,
1951
- format: "json",
1952
- ...params
1953
- });
1954
- /**
1955
- * No description
1956
- *
1957
- * @name StoryHistory
1958
- * @summary Story History
1959
- * @request GET:/api/v3/stories/{story-public-id}/history
1960
- * @secure
1961
- */
1962
- storyHistory = (storyPublicId, params = {}) => this.request({
1963
- path: `/api/v3/stories/${storyPublicId}/history`,
1964
- method: "GET",
1965
- secure: true,
1966
- format: "json",
1967
- ...params
1968
- });
1969
- /**
1970
- * @description Create Task is used to create a new task in a Story.
1971
- *
1972
- * @name CreateTask
1973
- * @summary Create Task
1974
- * @request POST:/api/v3/stories/{story-public-id}/tasks
1975
- * @secure
1976
- */
1977
- createTask = (storyPublicId, CreateTask, params = {}) => this.request({
1978
- path: `/api/v3/stories/${storyPublicId}/tasks`,
1979
- method: "POST",
1980
- body: CreateTask,
1981
- secure: true,
1982
- type: "application/json" /* Json */,
1983
- format: "json",
1984
- ...params
1985
- });
1986
- /**
1987
- * @description Returns information about a chosen Task.
1988
- *
1989
- * @name GetTask
1990
- * @summary Get Task
1991
- * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1992
- * @secure
1993
- */
1994
- getTask = (storyPublicId, taskPublicId, params = {}) => this.request({
1995
- path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
1996
- method: "GET",
1997
- secure: true,
1998
- format: "json",
1999
- ...params
2000
- });
2001
- /**
2002
- * @description Update Task can be used to update Task properties.
2003
- *
2004
- * @name UpdateTask
2005
- * @summary Update Task
2006
- * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
2007
- * @secure
2008
- */
2009
- updateTask = (storyPublicId, taskPublicId, UpdateTask, params = {}) => this.request({
2010
- path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
2011
- method: "PUT",
2012
- body: UpdateTask,
2013
- secure: true,
2014
- type: "application/json" /* Json */,
2015
- format: "json",
2016
- ...params
2017
- });
2018
- /**
2019
- * @description Delete Task can be used to delete any previously created Task on a Story.
2020
- *
2021
- * @name DeleteTask
2022
- * @summary Delete Task
2023
- * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
2024
- * @secure
2025
- */
2026
- deleteTask = (storyPublicId, taskPublicId, params = {}) => this.request({
2027
- path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
2028
- method: "DELETE",
2029
- secure: true,
2030
- ...params
2031
- });
2032
- /**
2033
- * @description Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”
2034
- *
2035
- * @name CreateStoryLink
2036
- * @summary Create Story Link
2037
- * @request POST:/api/v3/story-links
2038
- * @secure
2039
- */
2040
- createStoryLink = (CreateStoryLink, params = {}) => this.request({
2041
- path: `/api/v3/story-links`,
2042
- method: "POST",
2043
- body: CreateStoryLink,
2044
- secure: true,
2045
- type: "application/json" /* Json */,
2046
- format: "json",
2047
- ...params
2048
- });
2049
- /**
2050
- * @description Returns the stories and their relationship for the given Story Link.
2051
- *
2052
- * @name GetStoryLink
2053
- * @summary Get Story Link
2054
- * @request GET:/api/v3/story-links/{story-link-public-id}
2055
- * @secure
2056
- */
2057
- getStoryLink = (storyLinkPublicId, params = {}) => this.request({
2058
- path: `/api/v3/story-links/${storyLinkPublicId}`,
2059
- method: "GET",
2060
- secure: true,
2061
- format: "json",
2062
- ...params
2063
- });
2064
- /**
2065
- * @description Updates the stories and/or the relationship for the given Story Link.
2066
- *
2067
- * @name UpdateStoryLink
2068
- * @summary Update Story Link
2069
- * @request PUT:/api/v3/story-links/{story-link-public-id}
2070
- * @secure
2071
- */
2072
- updateStoryLink = (storyLinkPublicId, UpdateStoryLink, params = {}) => this.request({
2073
- path: `/api/v3/story-links/${storyLinkPublicId}`,
2074
- method: "PUT",
2075
- body: UpdateStoryLink,
2076
- secure: true,
2077
- type: "application/json" /* Json */,
2078
- format: "json",
2079
- ...params
2080
- });
2081
- /**
2082
- * @description Removes the relationship between the stories for the given Story Link.
2083
- *
2084
- * @name DeleteStoryLink
2085
- * @summary Delete Story Link
2086
- * @request DELETE:/api/v3/story-links/{story-link-public-id}
2087
- * @secure
2088
- */
2089
- deleteStoryLink = (storyLinkPublicId, params = {}) => this.request({
2090
- path: `/api/v3/story-links/${storyLinkPublicId}`,
2091
- method: "DELETE",
2092
- secure: true,
2093
- ...params
2094
- });
2095
- /**
2096
- * @description Returns a list of all Workflows in the Workspace.
2097
- *
2098
- * @name ListWorkflows
2099
- * @summary List Workflows
2100
- * @request GET:/api/v3/workflows
2101
- * @secure
2102
- */
2103
- listWorkflows = (params = {}) => this.request({
2104
- path: `/api/v3/workflows`,
2105
- method: "GET",
2106
- secure: true,
2107
- format: "json",
2108
- ...params
2109
- });
2110
- /**
2111
- * @description Get Workflow returns information about a chosen Workflow.
2112
- *
2113
- * @name GetWorkflow
2114
- * @summary Get Workflow
2115
- * @request GET:/api/v3/workflows/{workflow-public-id}
2116
- * @secure
2117
- */
2118
- getWorkflow = (workflowPublicId, params = {}) => this.request({
2119
- path: `/api/v3/workflows/${workflowPublicId}`,
2120
- method: "GET",
2121
- secure: true,
2122
- format: "json",
2123
- ...params
2124
- });
2125
- };
2126
- export {
2127
- Api
9
+ /**
10
+ * @description List Categories returns a list of all Categories and their attributes.
11
+ *
12
+ * @name ListCategories
13
+ * @summary List Categories
14
+ * @request GET:/api/v3/categories
15
+ * @secure
16
+ */
17
+ listCategories = (params = {}) => this.request({
18
+ path: `/api/v3/categories`,
19
+ method: "GET",
20
+ secure: true,
21
+ format: "json",
22
+ ...params
23
+ });
24
+ /**
25
+ * @description Create Category allows you to create a new Category in Shortcut.
26
+ *
27
+ * @name CreateCategory
28
+ * @summary Create Category
29
+ * @request POST:/api/v3/categories
30
+ * @secure
31
+ */
32
+ createCategory = (CreateCategory, params = {}) => this.request({
33
+ path: `/api/v3/categories`,
34
+ method: "POST",
35
+ body: CreateCategory,
36
+ secure: true,
37
+ type: ContentType.Json,
38
+ format: "json",
39
+ ...params
40
+ });
41
+ /**
42
+ * @description Get Category returns information about the selected Category.
43
+ *
44
+ * @name GetCategory
45
+ * @summary Get Category
46
+ * @request GET:/api/v3/categories/{category-public-id}
47
+ * @secure
48
+ */
49
+ getCategory = (categoryPublicId, params = {}) => this.request({
50
+ path: `/api/v3/categories/${categoryPublicId}`,
51
+ method: "GET",
52
+ secure: true,
53
+ format: "json",
54
+ ...params
55
+ });
56
+ /**
57
+ * @description Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.
58
+ *
59
+ * @name UpdateCategory
60
+ * @summary Update Category
61
+ * @request PUT:/api/v3/categories/{category-public-id}
62
+ * @secure
63
+ */
64
+ updateCategory = (categoryPublicId, UpdateCategory, params = {}) => this.request({
65
+ path: `/api/v3/categories/${categoryPublicId}`,
66
+ method: "PUT",
67
+ body: UpdateCategory,
68
+ secure: true,
69
+ type: ContentType.Json,
70
+ format: "json",
71
+ ...params
72
+ });
73
+ /**
74
+ * @description Delete Category can be used to delete any Category.
75
+ *
76
+ * @name DeleteCategory
77
+ * @summary Delete Category
78
+ * @request DELETE:/api/v3/categories/{category-public-id}
79
+ * @secure
80
+ */
81
+ deleteCategory = (categoryPublicId, params = {}) => this.request({
82
+ path: `/api/v3/categories/${categoryPublicId}`,
83
+ method: "DELETE",
84
+ secure: true,
85
+ ...params
86
+ });
87
+ /**
88
+ * @description List Category Milestones returns a list of all Milestones with the Category.
89
+ *
90
+ * @name ListCategoryMilestones
91
+ * @summary List Category Milestones
92
+ * @request GET:/api/v3/categories/{category-public-id}/milestones
93
+ * @secure
94
+ */
95
+ listCategoryMilestones = (categoryPublicId, params = {}) => this.request({
96
+ path: `/api/v3/categories/${categoryPublicId}/milestones`,
97
+ method: "GET",
98
+ secure: true,
99
+ format: "json",
100
+ ...params
101
+ });
102
+ /**
103
+ * @description Returns a list of all Objectives with the Category.
104
+ *
105
+ * @name ListCategoryObjectives
106
+ * @summary List Category Objectives
107
+ * @request GET:/api/v3/categories/{category-public-id}/objectives
108
+ * @secure
109
+ */
110
+ listCategoryObjectives = (categoryPublicId, params = {}) => this.request({
111
+ path: `/api/v3/categories/${categoryPublicId}/objectives`,
112
+ method: "GET",
113
+ secure: true,
114
+ format: "json",
115
+ ...params
116
+ });
117
+ /**
118
+ * No description
119
+ *
120
+ * @name ListCustomFields
121
+ * @summary List Custom Fields
122
+ * @request GET:/api/v3/custom-fields
123
+ * @secure
124
+ */
125
+ listCustomFields = (params = {}) => this.request({
126
+ path: `/api/v3/custom-fields`,
127
+ method: "GET",
128
+ secure: true,
129
+ format: "json",
130
+ ...params
131
+ });
132
+ /**
133
+ * No description
134
+ *
135
+ * @name GetCustomField
136
+ * @summary Get Custom Field
137
+ * @request GET:/api/v3/custom-fields/{custom-field-public-id}
138
+ * @secure
139
+ */
140
+ getCustomField = (customFieldPublicId, params = {}) => this.request({
141
+ path: `/api/v3/custom-fields/${customFieldPublicId}`,
142
+ method: "GET",
143
+ secure: true,
144
+ format: "json",
145
+ ...params
146
+ });
147
+ /**
148
+ * @description Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).
149
+ *
150
+ * @name UpdateCustomField
151
+ * @summary Update Custom Field
152
+ * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
153
+ * @secure
154
+ */
155
+ updateCustomField = (customFieldPublicId, UpdateCustomField, params = {}) => this.request({
156
+ path: `/api/v3/custom-fields/${customFieldPublicId}`,
157
+ method: "PUT",
158
+ body: UpdateCustomField,
159
+ secure: true,
160
+ type: ContentType.Json,
161
+ format: "json",
162
+ ...params
163
+ });
164
+ /**
165
+ * No description
166
+ *
167
+ * @name DeleteCustomField
168
+ * @summary Delete Custom Field
169
+ * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
170
+ * @secure
171
+ */
172
+ deleteCustomField = (customFieldPublicId, params = {}) => this.request({
173
+ path: `/api/v3/custom-fields/${customFieldPublicId}`,
174
+ method: "DELETE",
175
+ secure: true,
176
+ ...params
177
+ });
178
+ /**
179
+ * @description List Docs returns a list of Doc that the current user can read.
180
+ *
181
+ * @name ListDocs
182
+ * @summary List Docs
183
+ * @request GET:/api/v3/documents
184
+ * @secure
185
+ */
186
+ listDocs = (params = {}) => this.request({
187
+ path: `/api/v3/documents`,
188
+ method: "GET",
189
+ secure: true,
190
+ format: "json",
191
+ ...params
192
+ });
193
+ /**
194
+ * @description Creates a new Doc.
195
+ *
196
+ * @name CreateDoc
197
+ * @summary Create Doc
198
+ * @request POST:/api/v3/documents
199
+ * @secure
200
+ */
201
+ createDoc = (CreateDoc, params = {}) => this.request({
202
+ path: `/api/v3/documents`,
203
+ method: "POST",
204
+ body: CreateDoc,
205
+ secure: true,
206
+ type: ContentType.Json,
207
+ format: "json",
208
+ ...params
209
+ });
210
+ /**
211
+ * @description List all the entity templates for the Workspace.
212
+ *
213
+ * @name ListEntityTemplates
214
+ * @summary List Entity Templates
215
+ * @request GET:/api/v3/entity-templates
216
+ * @secure
217
+ */
218
+ listEntityTemplates = (params = {}) => this.request({
219
+ path: `/api/v3/entity-templates`,
220
+ method: "GET",
221
+ secure: true,
222
+ format: "json",
223
+ ...params
224
+ });
225
+ /**
226
+ * @description Create a new entity template for the Workspace.
227
+ *
228
+ * @name CreateEntityTemplate
229
+ * @summary Create Entity Template
230
+ * @request POST:/api/v3/entity-templates
231
+ * @secure
232
+ */
233
+ createEntityTemplate = (CreateEntityTemplate, params = {}) => this.request({
234
+ path: `/api/v3/entity-templates`,
235
+ method: "POST",
236
+ body: CreateEntityTemplate,
237
+ secure: true,
238
+ type: ContentType.Json,
239
+ format: "json",
240
+ ...params
241
+ });
242
+ /**
243
+ * @description Disables the Story Template feature for the Workspace.
244
+ *
245
+ * @name DisableStoryTemplates
246
+ * @summary Disable Story Templates
247
+ * @request PUT:/api/v3/entity-templates/disable
248
+ * @secure
249
+ */
250
+ disableStoryTemplates = (params = {}) => this.request({
251
+ path: `/api/v3/entity-templates/disable`,
252
+ method: "PUT",
253
+ secure: true,
254
+ ...params
255
+ });
256
+ /**
257
+ * @description Enables the Story Template feature for the Workspace.
258
+ *
259
+ * @name EnableStoryTemplates
260
+ * @summary Enable Story Templates
261
+ * @request PUT:/api/v3/entity-templates/enable
262
+ * @secure
263
+ */
264
+ enableStoryTemplates = (params = {}) => this.request({
265
+ path: `/api/v3/entity-templates/enable`,
266
+ method: "PUT",
267
+ secure: true,
268
+ ...params
269
+ });
270
+ /**
271
+ * @description Get Entity Template returns information about a given entity template.
272
+ *
273
+ * @name GetEntityTemplate
274
+ * @summary Get Entity Template
275
+ * @request GET:/api/v3/entity-templates/{entity-template-public-id}
276
+ * @secure
277
+ */
278
+ getEntityTemplate = (entityTemplatePublicId, params = {}) => this.request({
279
+ path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
280
+ method: "GET",
281
+ secure: true,
282
+ format: "json",
283
+ ...params
284
+ });
285
+ /**
286
+ * @description Update an entity template's name or its contents.
287
+ *
288
+ * @name UpdateEntityTemplate
289
+ * @summary Update Entity Template
290
+ * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
291
+ * @secure
292
+ */
293
+ updateEntityTemplate = (entityTemplatePublicId, UpdateEntityTemplate, params = {}) => this.request({
294
+ path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
295
+ method: "PUT",
296
+ body: UpdateEntityTemplate,
297
+ secure: true,
298
+ type: ContentType.Json,
299
+ format: "json",
300
+ ...params
301
+ });
302
+ /**
303
+ * No description
304
+ *
305
+ * @name DeleteEntityTemplate
306
+ * @summary Delete Entity Template
307
+ * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
308
+ * @secure
309
+ */
310
+ deleteEntityTemplate = (entityTemplatePublicId, params = {}) => this.request({
311
+ path: `/api/v3/entity-templates/${entityTemplatePublicId}`,
312
+ method: "DELETE",
313
+ secure: true,
314
+ ...params
315
+ });
316
+ /**
317
+ * @description Returns the Epic Workflow for the Workspace.
318
+ *
319
+ * @name GetEpicWorkflow
320
+ * @summary Get Epic Workflow
321
+ * @request GET:/api/v3/epic-workflow
322
+ * @secure
323
+ */
324
+ getEpicWorkflow = (params = {}) => this.request({
325
+ path: `/api/v3/epic-workflow`,
326
+ method: "GET",
327
+ secure: true,
328
+ format: "json",
329
+ ...params
330
+ });
331
+ /**
332
+ * @description List Epics returns a list of all Epics and their attributes.
333
+ *
334
+ * @name ListEpics
335
+ * @summary List Epics
336
+ * @request GET:/api/v3/epics
337
+ * @secure
338
+ */
339
+ listEpics = (query, params = {}) => this.request({
340
+ path: `/api/v3/epics`,
341
+ method: "GET",
342
+ query,
343
+ secure: true,
344
+ format: "json",
345
+ ...params
346
+ });
347
+ /**
348
+ * @description Create Epic allows you to create a new Epic in Shortcut.
349
+ *
350
+ * @name CreateEpic
351
+ * @summary Create Epic
352
+ * @request POST:/api/v3/epics
353
+ * @secure
354
+ */
355
+ createEpic = (CreateEpic, params = {}) => this.request({
356
+ path: `/api/v3/epics`,
357
+ method: "POST",
358
+ body: CreateEpic,
359
+ secure: true,
360
+ type: ContentType.Json,
361
+ format: "json",
362
+ ...params
363
+ });
364
+ /**
365
+ * @description List Epics with pagination returns a paginated list of Epics and their attributes.
366
+ *
367
+ * @name ListEpicsPaginated
368
+ * @summary List Epics Paginated
369
+ * @request GET:/api/v3/epics/paginated
370
+ * @secure
371
+ */
372
+ listEpicsPaginated = (query, params = {}) => this.request({
373
+ path: `/api/v3/epics/paginated`,
374
+ method: "GET",
375
+ query,
376
+ secure: true,
377
+ format: "json",
378
+ ...params
379
+ });
380
+ /**
381
+ * @description Get Epic returns information about the selected Epic.
382
+ *
383
+ * @name GetEpic
384
+ * @summary Get Epic
385
+ * @request GET:/api/v3/epics/{epic-public-id}
386
+ * @secure
387
+ */
388
+ getEpic = (epicPublicId, params = {}) => this.request({
389
+ path: `/api/v3/epics/${epicPublicId}`,
390
+ method: "GET",
391
+ secure: true,
392
+ format: "json",
393
+ ...params
394
+ });
395
+ /**
396
+ * @description Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
397
+ *
398
+ * @name UpdateEpic
399
+ * @summary Update Epic
400
+ * @request PUT:/api/v3/epics/{epic-public-id}
401
+ * @secure
402
+ */
403
+ updateEpic = (epicPublicId, UpdateEpic, params = {}) => this.request({
404
+ path: `/api/v3/epics/${epicPublicId}`,
405
+ method: "PUT",
406
+ body: UpdateEpic,
407
+ secure: true,
408
+ type: ContentType.Json,
409
+ format: "json",
410
+ ...params
411
+ });
412
+ /**
413
+ * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
414
+ *
415
+ * @name DeleteEpic
416
+ * @summary Delete Epic
417
+ * @request DELETE:/api/v3/epics/{epic-public-id}
418
+ * @secure
419
+ */
420
+ deleteEpic = (epicPublicId, params = {}) => this.request({
421
+ path: `/api/v3/epics/${epicPublicId}`,
422
+ method: "DELETE",
423
+ secure: true,
424
+ ...params
425
+ });
426
+ /**
427
+ * @description Get a list of all Comments on an Epic.
428
+ *
429
+ * @name ListEpicComments
430
+ * @summary List Epic Comments
431
+ * @request GET:/api/v3/epics/{epic-public-id}/comments
432
+ * @secure
433
+ */
434
+ listEpicComments = (epicPublicId, params = {}) => this.request({
435
+ path: `/api/v3/epics/${epicPublicId}/comments`,
436
+ method: "GET",
437
+ secure: true,
438
+ format: "json",
439
+ ...params
440
+ });
441
+ /**
442
+ * @description This endpoint allows you to create a threaded Comment on an Epic.
443
+ *
444
+ * @name CreateEpicComment
445
+ * @summary Create Epic Comment
446
+ * @request POST:/api/v3/epics/{epic-public-id}/comments
447
+ * @secure
448
+ */
449
+ createEpicComment = (epicPublicId, CreateEpicComment, params = {}) => this.request({
450
+ path: `/api/v3/epics/${epicPublicId}/comments`,
451
+ method: "POST",
452
+ body: CreateEpicComment,
453
+ secure: true,
454
+ type: ContentType.Json,
455
+ format: "json",
456
+ ...params
457
+ });
458
+ /**
459
+ * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
460
+ *
461
+ * @name CreateEpicCommentComment
462
+ * @summary Create Epic Comment Comment
463
+ * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
464
+ * @secure
465
+ */
466
+ createEpicCommentComment = (epicPublicId, commentPublicId, CreateCommentComment, params = {}) => this.request({
467
+ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
468
+ method: "POST",
469
+ body: CreateCommentComment,
470
+ secure: true,
471
+ type: ContentType.Json,
472
+ format: "json",
473
+ ...params
474
+ });
475
+ /**
476
+ * @description This endpoint returns information about the selected Epic Comment.
477
+ *
478
+ * @name GetEpicComment
479
+ * @summary Get Epic Comment
480
+ * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
481
+ * @secure
482
+ */
483
+ getEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request({
484
+ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
485
+ method: "GET",
486
+ secure: true,
487
+ format: "json",
488
+ ...params
489
+ });
490
+ /**
491
+ * @description This endpoint allows you to update a threaded Comment on an Epic.
492
+ *
493
+ * @name UpdateEpicComment
494
+ * @summary Update Epic Comment
495
+ * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
496
+ * @secure
497
+ */
498
+ updateEpicComment = (epicPublicId, commentPublicId, UpdateComment, params = {}) => this.request({
499
+ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
500
+ method: "PUT",
501
+ body: UpdateComment,
502
+ secure: true,
503
+ type: ContentType.Json,
504
+ format: "json",
505
+ ...params
506
+ });
507
+ /**
508
+ * @description This endpoint allows you to delete a Comment from an Epic.
509
+ *
510
+ * @name DeleteEpicComment
511
+ * @summary Delete Epic Comment
512
+ * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
513
+ * @secure
514
+ */
515
+ deleteEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request({
516
+ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`,
517
+ method: "DELETE",
518
+ secure: true,
519
+ ...params
520
+ });
521
+ /**
522
+ * @description Get the current health for the specified Epic.
523
+ *
524
+ * @name GetEpicHealth
525
+ * @summary Get Epic Health
526
+ * @request GET:/api/v3/epics/{epic-public-id}/health
527
+ * @secure
528
+ */
529
+ getEpicHealth = (epicPublicId, params = {}) => this.request({
530
+ path: `/api/v3/epics/${epicPublicId}/health`,
531
+ method: "GET",
532
+ secure: true,
533
+ format: "json",
534
+ ...params
535
+ });
536
+ /**
537
+ * @description Create a new health status for the specified Epic.
538
+ *
539
+ * @name CreateEpicHealth
540
+ * @summary Create Epic Health
541
+ * @request POST:/api/v3/epics/{epic-public-id}/health
542
+ * @secure
543
+ */
544
+ createEpicHealth = (epicPublicId, CreateEpicHealth, params = {}) => this.request({
545
+ path: `/api/v3/epics/${epicPublicId}/health`,
546
+ method: "POST",
547
+ body: CreateEpicHealth,
548
+ secure: true,
549
+ type: ContentType.Json,
550
+ format: "json",
551
+ ...params
552
+ });
553
+ /**
554
+ * @description List the history of health statuses for the specified Epic, most recent first.
555
+ *
556
+ * @name ListEpicHealths
557
+ * @summary List Epic Healths
558
+ * @request GET:/api/v3/epics/{epic-public-id}/health-history
559
+ * @secure
560
+ */
561
+ listEpicHealths = (epicPublicId, params = {}) => this.request({
562
+ path: `/api/v3/epics/${epicPublicId}/health-history`,
563
+ method: "GET",
564
+ secure: true,
565
+ format: "json",
566
+ ...params
567
+ });
568
+ /**
569
+ * @description Get a list of all Stories in an Epic.
570
+ *
571
+ * @name ListEpicStories
572
+ * @summary List Epic Stories
573
+ * @request GET:/api/v3/epics/{epic-public-id}/stories
574
+ * @secure
575
+ */
576
+ listEpicStories = (epicPublicId, query, params = {}) => this.request({
577
+ path: `/api/v3/epics/${epicPublicId}/stories`,
578
+ method: "GET",
579
+ query,
580
+ secure: true,
581
+ format: "json",
582
+ ...params
583
+ });
584
+ /**
585
+ * @description This endpoint allows you to unlink a productboard epic.
586
+ *
587
+ * @name UnlinkProductboardFromEpic
588
+ * @summary Unlink Productboard from Epic
589
+ * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
590
+ * @secure
591
+ */
592
+ unlinkProductboardFromEpic = (epicPublicId, params = {}) => this.request({
593
+ path: `/api/v3/epics/${epicPublicId}/unlink-productboard`,
594
+ method: "POST",
595
+ secure: true,
596
+ ...params
597
+ });
598
+ /**
599
+ * @description Get Stories which have a given External Link associated with them.
600
+ *
601
+ * @name GetExternalLinkStories
602
+ * @summary Get External Link Stories
603
+ * @request GET:/api/v3/external-link/stories
604
+ * @secure
605
+ */
606
+ getExternalLinkStories = (query, params = {}) => this.request({
607
+ path: `/api/v3/external-link/stories`,
608
+ method: "GET",
609
+ query,
610
+ secure: true,
611
+ format: "json",
612
+ ...params
613
+ });
614
+ /**
615
+ * @description List Files returns a list of all UploadedFiles in the workspace.
616
+ *
617
+ * @name ListFiles
618
+ * @summary List Files
619
+ * @request GET:/api/v3/files
620
+ * @secure
621
+ */
622
+ listFiles = (params = {}) => this.request({
623
+ path: `/api/v3/files`,
624
+ method: "GET",
625
+ secure: true,
626
+ format: "json",
627
+ ...params
628
+ });
629
+ /**
630
+ * @description Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.
631
+ *
632
+ * @name UploadFiles
633
+ * @summary Upload Files
634
+ * @request POST:/api/v3/files
635
+ * @secure
636
+ */
637
+ uploadFiles = (data, params = {}) => this.request({
638
+ path: `/api/v3/files`,
639
+ method: "POST",
640
+ body: data,
641
+ secure: true,
642
+ type: ContentType.FormData,
643
+ format: "json",
644
+ ...params
645
+ });
646
+ /**
647
+ * @description Get File returns information about the selected UploadedFile.
648
+ *
649
+ * @name GetFile
650
+ * @summary Get File
651
+ * @request GET:/api/v3/files/{file-public-id}
652
+ * @secure
653
+ */
654
+ getFile = (filePublicId, params = {}) => this.request({
655
+ path: `/api/v3/files/${filePublicId}`,
656
+ method: "GET",
657
+ secure: true,
658
+ format: "json",
659
+ ...params
660
+ });
661
+ /**
662
+ * @description Update File updates the properties of an UploadedFile (but not its content).
663
+ *
664
+ * @name UpdateFile
665
+ * @summary Update File
666
+ * @request PUT:/api/v3/files/{file-public-id}
667
+ * @secure
668
+ */
669
+ updateFile = (filePublicId, UpdateFile, params = {}) => this.request({
670
+ path: `/api/v3/files/${filePublicId}`,
671
+ method: "PUT",
672
+ body: UpdateFile,
673
+ secure: true,
674
+ type: ContentType.Json,
675
+ format: "json",
676
+ ...params
677
+ });
678
+ /**
679
+ * @description Delete File deletes a previously uploaded file.
680
+ *
681
+ * @name DeleteFile
682
+ * @summary Delete File
683
+ * @request DELETE:/api/v3/files/{file-public-id}
684
+ * @secure
685
+ */
686
+ deleteFile = (filePublicId, params = {}) => this.request({
687
+ path: `/api/v3/files/${filePublicId}`,
688
+ method: "DELETE",
689
+ secure: true,
690
+ ...params
691
+ });
692
+ /**
693
+ * @description A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
694
+ *
695
+ * @name ListGroups
696
+ * @summary List Groups
697
+ * @request GET:/api/v3/groups
698
+ * @secure
699
+ */
700
+ listGroups = (params = {}) => this.request({
701
+ path: `/api/v3/groups`,
702
+ method: "GET",
703
+ secure: true,
704
+ format: "json",
705
+ ...params
706
+ });
707
+ /**
708
+ * No description
709
+ *
710
+ * @name CreateGroup
711
+ * @summary Create Group
712
+ * @request POST:/api/v3/groups
713
+ * @secure
714
+ */
715
+ createGroup = (CreateGroup, params = {}) => this.request({
716
+ path: `/api/v3/groups`,
717
+ method: "POST",
718
+ body: CreateGroup,
719
+ secure: true,
720
+ type: ContentType.Json,
721
+ format: "json",
722
+ ...params
723
+ });
724
+ /**
725
+ * No description
726
+ *
727
+ * @name GetGroup
728
+ * @summary Get Group
729
+ * @request GET:/api/v3/groups/{group-public-id}
730
+ * @secure
731
+ */
732
+ getGroup = (groupPublicId, params = {}) => this.request({
733
+ path: `/api/v3/groups/${groupPublicId}`,
734
+ method: "GET",
735
+ secure: true,
736
+ format: "json",
737
+ ...params
738
+ });
739
+ /**
740
+ * No description
741
+ *
742
+ * @name UpdateGroup
743
+ * @summary Update Group
744
+ * @request PUT:/api/v3/groups/{group-public-id}
745
+ * @secure
746
+ */
747
+ updateGroup = (groupPublicId, UpdateGroup, params = {}) => this.request({
748
+ path: `/api/v3/groups/${groupPublicId}`,
749
+ method: "PUT",
750
+ body: UpdateGroup,
751
+ secure: true,
752
+ type: ContentType.Json,
753
+ format: "json",
754
+ ...params
755
+ });
756
+ /**
757
+ * @description List the Stories assigned to the Group. (By default, limited to 1,000).
758
+ *
759
+ * @name ListGroupStories
760
+ * @summary List Group Stories
761
+ * @request GET:/api/v3/groups/{group-public-id}/stories
762
+ * @secure
763
+ */
764
+ listGroupStories = (groupPublicId, query, params = {}) => this.request({
765
+ path: `/api/v3/groups/${groupPublicId}/stories`,
766
+ method: "GET",
767
+ query,
768
+ secure: true,
769
+ format: "json",
770
+ ...params
771
+ });
772
+ /**
773
+ * @description Update an existing health status by its ID.
774
+ *
775
+ * @name UpdateHealth
776
+ * @summary Update Health
777
+ * @request PUT:/api/v3/health/{health-public-id}
778
+ * @secure
779
+ */
780
+ updateHealth = (healthPublicId, UpdateHealth, params = {}) => this.request({
781
+ path: `/api/v3/health/${healthPublicId}`,
782
+ method: "PUT",
783
+ body: UpdateHealth,
784
+ secure: true,
785
+ type: ContentType.Json,
786
+ format: "json",
787
+ ...params
788
+ });
789
+ /**
790
+ * No description
791
+ *
792
+ * @name CreateGenericIntegration
793
+ * @summary Create Generic Integration
794
+ * @request POST:/api/v3/integrations/webhook
795
+ * @secure
796
+ */
797
+ createGenericIntegration = (CreateGenericIntegration, params = {}) => this.request({
798
+ path: `/api/v3/integrations/webhook`,
799
+ method: "POST",
800
+ body: CreateGenericIntegration,
801
+ secure: true,
802
+ type: ContentType.Json,
803
+ ...params
804
+ });
805
+ /**
806
+ * No description
807
+ *
808
+ * @name GetGenericIntegration
809
+ * @summary Get Generic Integration
810
+ * @request GET:/api/v3/integrations/webhook/{integration-public-id}
811
+ * @secure
812
+ */
813
+ getGenericIntegration = (integrationPublicId, params = {}) => this.request({
814
+ path: `/api/v3/integrations/webhook/${integrationPublicId}`,
815
+ method: "GET",
816
+ secure: true,
817
+ ...params
818
+ });
819
+ /**
820
+ * No description
821
+ *
822
+ * @name DeleteGenericIntegration
823
+ * @summary Delete Generic Integration
824
+ * @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
825
+ * @secure
826
+ */
827
+ deleteGenericIntegration = (integrationPublicId, params = {}) => this.request({
828
+ path: `/api/v3/integrations/webhook/${integrationPublicId}`,
829
+ method: "DELETE",
830
+ secure: true,
831
+ ...params
832
+ });
833
+ /**
834
+ * No description
835
+ *
836
+ * @name ListIterations
837
+ * @summary List Iterations
838
+ * @request GET:/api/v3/iterations
839
+ * @secure
840
+ */
841
+ listIterations = (params = {}) => this.request({
842
+ path: `/api/v3/iterations`,
843
+ method: "GET",
844
+ secure: true,
845
+ format: "json",
846
+ ...params
847
+ });
848
+ /**
849
+ * No description
850
+ *
851
+ * @name CreateIteration
852
+ * @summary Create Iteration
853
+ * @request POST:/api/v3/iterations
854
+ * @secure
855
+ */
856
+ createIteration = (CreateIteration, params = {}) => this.request({
857
+ path: `/api/v3/iterations`,
858
+ method: "POST",
859
+ body: CreateIteration,
860
+ secure: true,
861
+ type: ContentType.Json,
862
+ format: "json",
863
+ ...params
864
+ });
865
+ /**
866
+ * @description Disables Iterations for the current workspace
867
+ *
868
+ * @name DisableIterations
869
+ * @summary Disable Iterations
870
+ * @request PUT:/api/v3/iterations/disable
871
+ * @secure
872
+ */
873
+ disableIterations = (params = {}) => this.request({
874
+ path: `/api/v3/iterations/disable`,
875
+ method: "PUT",
876
+ secure: true,
877
+ ...params
878
+ });
879
+ /**
880
+ * @description Enables Iterations for the current workspace
881
+ *
882
+ * @name EnableIterations
883
+ * @summary Enable Iterations
884
+ * @request PUT:/api/v3/iterations/enable
885
+ * @secure
886
+ */
887
+ enableIterations = (params = {}) => this.request({
888
+ path: `/api/v3/iterations/enable`,
889
+ method: "PUT",
890
+ secure: true,
891
+ ...params
892
+ });
893
+ /**
894
+ * No description
895
+ *
896
+ * @name GetIteration
897
+ * @summary Get Iteration
898
+ * @request GET:/api/v3/iterations/{iteration-public-id}
899
+ * @secure
900
+ */
901
+ getIteration = (iterationPublicId, params = {}) => this.request({
902
+ path: `/api/v3/iterations/${iterationPublicId}`,
903
+ method: "GET",
904
+ secure: true,
905
+ format: "json",
906
+ ...params
907
+ });
908
+ /**
909
+ * No description
910
+ *
911
+ * @name UpdateIteration
912
+ * @summary Update Iteration
913
+ * @request PUT:/api/v3/iterations/{iteration-public-id}
914
+ * @secure
915
+ */
916
+ updateIteration = (iterationPublicId, UpdateIteration, params = {}) => this.request({
917
+ path: `/api/v3/iterations/${iterationPublicId}`,
918
+ method: "PUT",
919
+ body: UpdateIteration,
920
+ secure: true,
921
+ type: ContentType.Json,
922
+ format: "json",
923
+ ...params
924
+ });
925
+ /**
926
+ * No description
927
+ *
928
+ * @name DeleteIteration
929
+ * @summary Delete Iteration
930
+ * @request DELETE:/api/v3/iterations/{iteration-public-id}
931
+ * @secure
932
+ */
933
+ deleteIteration = (iterationPublicId, params = {}) => this.request({
934
+ path: `/api/v3/iterations/${iterationPublicId}`,
935
+ method: "DELETE",
936
+ secure: true,
937
+ ...params
938
+ });
939
+ /**
940
+ * @description Get a list of all Stories in an Iteration.
941
+ *
942
+ * @name ListIterationStories
943
+ * @summary List Iteration Stories
944
+ * @request GET:/api/v3/iterations/{iteration-public-id}/stories
945
+ * @secure
946
+ */
947
+ listIterationStories = (iterationPublicId, query, params = {}) => this.request({
948
+ path: `/api/v3/iterations/${iterationPublicId}/stories`,
949
+ method: "GET",
950
+ query,
951
+ secure: true,
952
+ format: "json",
953
+ ...params
954
+ });
955
+ /**
956
+ * @description Get Key Result returns information about a chosen Key Result.
957
+ *
958
+ * @name GetKeyResult
959
+ * @summary Get Key Result
960
+ * @request GET:/api/v3/key-results/{key-result-public-id}
961
+ * @secure
962
+ */
963
+ getKeyResult = (keyResultPublicId, params = {}) => this.request({
964
+ path: `/api/v3/key-results/${keyResultPublicId}`,
965
+ method: "GET",
966
+ secure: true,
967
+ format: "json",
968
+ ...params
969
+ });
970
+ /**
971
+ * @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
972
+ *
973
+ * @name UpdateKeyResult
974
+ * @summary Update Key Result
975
+ * @request PUT:/api/v3/key-results/{key-result-public-id}
976
+ * @secure
977
+ */
978
+ updateKeyResult = (keyResultPublicId, UpdateKeyResult, params = {}) => this.request({
979
+ path: `/api/v3/key-results/${keyResultPublicId}`,
980
+ method: "PUT",
981
+ body: UpdateKeyResult,
982
+ secure: true,
983
+ type: ContentType.Json,
984
+ format: "json",
985
+ ...params
986
+ });
987
+ /**
988
+ * @description List Labels returns a list of all Labels and their attributes.
989
+ *
990
+ * @name ListLabels
991
+ * @summary List Labels
992
+ * @request GET:/api/v3/labels
993
+ * @secure
994
+ */
995
+ listLabels = (query, params = {}) => this.request({
996
+ path: `/api/v3/labels`,
997
+ method: "GET",
998
+ query,
999
+ secure: true,
1000
+ format: "json",
1001
+ ...params
1002
+ });
1003
+ /**
1004
+ * @description Create Label allows you to create a new Label in Shortcut.
1005
+ *
1006
+ * @name CreateLabel
1007
+ * @summary Create Label
1008
+ * @request POST:/api/v3/labels
1009
+ * @secure
1010
+ */
1011
+ createLabel = (CreateLabelParams, params = {}) => this.request({
1012
+ path: `/api/v3/labels`,
1013
+ method: "POST",
1014
+ body: CreateLabelParams,
1015
+ secure: true,
1016
+ type: ContentType.Json,
1017
+ format: "json",
1018
+ ...params
1019
+ });
1020
+ /**
1021
+ * @description Get Label returns information about the selected Label.
1022
+ *
1023
+ * @name GetLabel
1024
+ * @summary Get Label
1025
+ * @request GET:/api/v3/labels/{label-public-id}
1026
+ * @secure
1027
+ */
1028
+ getLabel = (labelPublicId, params = {}) => this.request({
1029
+ path: `/api/v3/labels/${labelPublicId}`,
1030
+ method: "GET",
1031
+ secure: true,
1032
+ format: "json",
1033
+ ...params
1034
+ });
1035
+ /**
1036
+ * @description Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
1037
+ *
1038
+ * @name UpdateLabel
1039
+ * @summary Update Label
1040
+ * @request PUT:/api/v3/labels/{label-public-id}
1041
+ * @secure
1042
+ */
1043
+ updateLabel = (labelPublicId, UpdateLabel, params = {}) => this.request({
1044
+ path: `/api/v3/labels/${labelPublicId}`,
1045
+ method: "PUT",
1046
+ body: UpdateLabel,
1047
+ secure: true,
1048
+ type: ContentType.Json,
1049
+ format: "json",
1050
+ ...params
1051
+ });
1052
+ /**
1053
+ * @description Delete Label can be used to delete any Label.
1054
+ *
1055
+ * @name DeleteLabel
1056
+ * @summary Delete Label
1057
+ * @request DELETE:/api/v3/labels/{label-public-id}
1058
+ * @secure
1059
+ */
1060
+ deleteLabel = (labelPublicId, params = {}) => this.request({
1061
+ path: `/api/v3/labels/${labelPublicId}`,
1062
+ method: "DELETE",
1063
+ secure: true,
1064
+ ...params
1065
+ });
1066
+ /**
1067
+ * @description List all of the Epics with the Label.
1068
+ *
1069
+ * @name ListLabelEpics
1070
+ * @summary List Label Epics
1071
+ * @request GET:/api/v3/labels/{label-public-id}/epics
1072
+ * @secure
1073
+ */
1074
+ listLabelEpics = (labelPublicId, params = {}) => this.request({
1075
+ path: `/api/v3/labels/${labelPublicId}/epics`,
1076
+ method: "GET",
1077
+ secure: true,
1078
+ format: "json",
1079
+ ...params
1080
+ });
1081
+ /**
1082
+ * @description List all of the Stories with the Label.
1083
+ *
1084
+ * @name ListLabelStories
1085
+ * @summary List Label Stories
1086
+ * @request GET:/api/v3/labels/{label-public-id}/stories
1087
+ * @secure
1088
+ */
1089
+ listLabelStories = (labelPublicId, query, params = {}) => this.request({
1090
+ path: `/api/v3/labels/${labelPublicId}/stories`,
1091
+ method: "GET",
1092
+ query,
1093
+ secure: true,
1094
+ format: "json",
1095
+ ...params
1096
+ });
1097
+ /**
1098
+ * @description List Linked Files returns a list of all Linked-Files and their attributes.
1099
+ *
1100
+ * @name ListLinkedFiles
1101
+ * @summary List Linked Files
1102
+ * @request GET:/api/v3/linked-files
1103
+ * @secure
1104
+ */
1105
+ listLinkedFiles = (params = {}) => this.request({
1106
+ path: `/api/v3/linked-files`,
1107
+ method: "GET",
1108
+ secure: true,
1109
+ format: "json",
1110
+ ...params
1111
+ });
1112
+ /**
1113
+ * @description Create Linked File allows you to create a new Linked File in Shortcut.
1114
+ *
1115
+ * @name CreateLinkedFile
1116
+ * @summary Create Linked File
1117
+ * @request POST:/api/v3/linked-files
1118
+ * @secure
1119
+ */
1120
+ createLinkedFile = (CreateLinkedFile, params = {}) => this.request({
1121
+ path: `/api/v3/linked-files`,
1122
+ method: "POST",
1123
+ body: CreateLinkedFile,
1124
+ secure: true,
1125
+ type: ContentType.Json,
1126
+ format: "json",
1127
+ ...params
1128
+ });
1129
+ /**
1130
+ * @description Get File returns information about the selected Linked File.
1131
+ *
1132
+ * @name GetLinkedFile
1133
+ * @summary Get Linked File
1134
+ * @request GET:/api/v3/linked-files/{linked-file-public-id}
1135
+ * @secure
1136
+ */
1137
+ getLinkedFile = (linkedFilePublicId, params = {}) => this.request({
1138
+ path: `/api/v3/linked-files/${linkedFilePublicId}`,
1139
+ method: "GET",
1140
+ secure: true,
1141
+ format: "json",
1142
+ ...params
1143
+ });
1144
+ /**
1145
+ * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
1146
+ *
1147
+ * @name UpdateLinkedFile
1148
+ * @summary Update Linked File
1149
+ * @request PUT:/api/v3/linked-files/{linked-file-public-id}
1150
+ * @secure
1151
+ */
1152
+ updateLinkedFile = (linkedFilePublicId, UpdateLinkedFile, params = {}) => this.request({
1153
+ path: `/api/v3/linked-files/${linkedFilePublicId}`,
1154
+ method: "PUT",
1155
+ body: UpdateLinkedFile,
1156
+ secure: true,
1157
+ type: ContentType.Json,
1158
+ format: "json",
1159
+ ...params
1160
+ });
1161
+ /**
1162
+ * @description Delete Linked File can be used to delete any previously attached Linked-File.
1163
+ *
1164
+ * @name DeleteLinkedFile
1165
+ * @summary Delete Linked File
1166
+ * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
1167
+ * @secure
1168
+ */
1169
+ deleteLinkedFile = (linkedFilePublicId, params = {}) => this.request({
1170
+ path: `/api/v3/linked-files/${linkedFilePublicId}`,
1171
+ method: "DELETE",
1172
+ secure: true,
1173
+ ...params
1174
+ });
1175
+ /**
1176
+ * @description Returns information about the authenticated member.
1177
+ *
1178
+ * @name GetCurrentMemberInfo
1179
+ * @summary Get Current Member Info
1180
+ * @request GET:/api/v3/member
1181
+ * @secure
1182
+ */
1183
+ getCurrentMemberInfo = (params = {}) => this.request({
1184
+ path: `/api/v3/member`,
1185
+ method: "GET",
1186
+ secure: true,
1187
+ format: "json",
1188
+ ...params
1189
+ });
1190
+ /**
1191
+ * @description Returns information about members of the Workspace.
1192
+ *
1193
+ * @name ListMembers
1194
+ * @summary List Members
1195
+ * @request GET:/api/v3/members
1196
+ * @secure
1197
+ */
1198
+ listMembers = (query, params = {}) => this.request({
1199
+ path: `/api/v3/members`,
1200
+ method: "GET",
1201
+ query,
1202
+ secure: true,
1203
+ format: "json",
1204
+ ...params
1205
+ });
1206
+ /**
1207
+ * @description Returns information about a Member.
1208
+ *
1209
+ * @name GetMember
1210
+ * @summary Get Member
1211
+ * @request GET:/api/v3/members/{member-public-id}
1212
+ * @secure
1213
+ */
1214
+ getMember = (memberPublicId, query, params = {}) => this.request({
1215
+ path: `/api/v3/members/${memberPublicId}`,
1216
+ method: "GET",
1217
+ query,
1218
+ secure: true,
1219
+ format: "json",
1220
+ ...params
1221
+ });
1222
+ /**
1223
+ * @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
1224
+ *
1225
+ * @name ListMilestones
1226
+ * @summary List Milestones
1227
+ * @request GET:/api/v3/milestones
1228
+ * @secure
1229
+ */
1230
+ listMilestones = (params = {}) => this.request({
1231
+ path: `/api/v3/milestones`,
1232
+ method: "GET",
1233
+ secure: true,
1234
+ format: "json",
1235
+ ...params
1236
+ });
1237
+ /**
1238
+ * @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
1239
+ *
1240
+ * @name CreateMilestone
1241
+ * @summary Create Milestone
1242
+ * @request POST:/api/v3/milestones
1243
+ * @secure
1244
+ */
1245
+ createMilestone = (CreateMilestone, params = {}) => this.request({
1246
+ path: `/api/v3/milestones`,
1247
+ method: "POST",
1248
+ body: CreateMilestone,
1249
+ secure: true,
1250
+ type: ContentType.Json,
1251
+ format: "json",
1252
+ ...params
1253
+ });
1254
+ /**
1255
+ * @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
1256
+ *
1257
+ * @name GetMilestone
1258
+ * @summary Get Milestone
1259
+ * @request GET:/api/v3/milestones/{milestone-public-id}
1260
+ * @secure
1261
+ */
1262
+ getMilestone = (milestonePublicId, params = {}) => this.request({
1263
+ path: `/api/v3/milestones/${milestonePublicId}`,
1264
+ method: "GET",
1265
+ secure: true,
1266
+ format: "json",
1267
+ ...params
1268
+ });
1269
+ /**
1270
+ * @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
1271
+ *
1272
+ * @name UpdateMilestone
1273
+ * @summary Update Milestone
1274
+ * @request PUT:/api/v3/milestones/{milestone-public-id}
1275
+ * @secure
1276
+ */
1277
+ updateMilestone = (milestonePublicId, UpdateMilestone, params = {}) => this.request({
1278
+ path: `/api/v3/milestones/${milestonePublicId}`,
1279
+ method: "PUT",
1280
+ body: UpdateMilestone,
1281
+ secure: true,
1282
+ type: ContentType.Json,
1283
+ format: "json",
1284
+ ...params
1285
+ });
1286
+ /**
1287
+ * @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
1288
+ *
1289
+ * @name DeleteMilestone
1290
+ * @summary Delete Milestone
1291
+ * @request DELETE:/api/v3/milestones/{milestone-public-id}
1292
+ * @secure
1293
+ */
1294
+ deleteMilestone = (milestonePublicId, params = {}) => this.request({
1295
+ path: `/api/v3/milestones/${milestonePublicId}`,
1296
+ method: "DELETE",
1297
+ secure: true,
1298
+ ...params
1299
+ });
1300
+ /**
1301
+ * @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
1302
+ *
1303
+ * @name ListMilestoneEpics
1304
+ * @summary List Milestone Epics
1305
+ * @request GET:/api/v3/milestones/{milestone-public-id}/epics
1306
+ * @secure
1307
+ */
1308
+ listMilestoneEpics = (milestonePublicId, params = {}) => this.request({
1309
+ path: `/api/v3/milestones/${milestonePublicId}/epics`,
1310
+ method: "GET",
1311
+ secure: true,
1312
+ format: "json",
1313
+ ...params
1314
+ });
1315
+ /**
1316
+ * @description List Objectives returns a list of all Objectives and their attributes.
1317
+ *
1318
+ * @name ListObjectives
1319
+ * @summary List Objectives
1320
+ * @request GET:/api/v3/objectives
1321
+ * @secure
1322
+ */
1323
+ listObjectives = (params = {}) => this.request({
1324
+ path: `/api/v3/objectives`,
1325
+ method: "GET",
1326
+ secure: true,
1327
+ format: "json",
1328
+ ...params
1329
+ });
1330
+ /**
1331
+ * @description Create Objective allows you to create a new Objective in Shortcut.
1332
+ *
1333
+ * @name CreateObjective
1334
+ * @summary Create Objective
1335
+ * @request POST:/api/v3/objectives
1336
+ * @secure
1337
+ */
1338
+ createObjective = (CreateObjective, params = {}) => this.request({
1339
+ path: `/api/v3/objectives`,
1340
+ method: "POST",
1341
+ body: CreateObjective,
1342
+ secure: true,
1343
+ type: ContentType.Json,
1344
+ format: "json",
1345
+ ...params
1346
+ });
1347
+ /**
1348
+ * @description Get Objective returns information about a chosen Objective.
1349
+ *
1350
+ * @name GetObjective
1351
+ * @summary Get Objective
1352
+ * @request GET:/api/v3/objectives/{objective-public-id}
1353
+ * @secure
1354
+ */
1355
+ getObjective = (objectivePublicId, params = {}) => this.request({
1356
+ path: `/api/v3/objectives/${objectivePublicId}`,
1357
+ method: "GET",
1358
+ secure: true,
1359
+ format: "json",
1360
+ ...params
1361
+ });
1362
+ /**
1363
+ * @description Update Objective can be used to update Objective properties.
1364
+ *
1365
+ * @name UpdateObjective
1366
+ * @summary Update Objective
1367
+ * @request PUT:/api/v3/objectives/{objective-public-id}
1368
+ * @secure
1369
+ */
1370
+ updateObjective = (objectivePublicId, UpdateObjective, params = {}) => this.request({
1371
+ path: `/api/v3/objectives/${objectivePublicId}`,
1372
+ method: "PUT",
1373
+ body: UpdateObjective,
1374
+ secure: true,
1375
+ type: ContentType.Json,
1376
+ format: "json",
1377
+ ...params
1378
+ });
1379
+ /**
1380
+ * @description Delete Objective can be used to delete any Objective.
1381
+ *
1382
+ * @name DeleteObjective
1383
+ * @summary Delete Objective
1384
+ * @request DELETE:/api/v3/objectives/{objective-public-id}
1385
+ * @secure
1386
+ */
1387
+ deleteObjective = (objectivePublicId, params = {}) => this.request({
1388
+ path: `/api/v3/objectives/${objectivePublicId}`,
1389
+ method: "DELETE",
1390
+ secure: true,
1391
+ ...params
1392
+ });
1393
+ /**
1394
+ * @description List all of the Epics within the Objective.
1395
+ *
1396
+ * @name ListObjectiveEpics
1397
+ * @summary List Objective Epics
1398
+ * @request GET:/api/v3/objectives/{objective-public-id}/epics
1399
+ * @secure
1400
+ */
1401
+ listObjectiveEpics = (objectivePublicId, params = {}) => this.request({
1402
+ path: `/api/v3/objectives/${objectivePublicId}/epics`,
1403
+ method: "GET",
1404
+ secure: true,
1405
+ format: "json",
1406
+ ...params
1407
+ });
1408
+ /**
1409
+ * @description List Projects returns a list of all Projects and their attributes.
1410
+ *
1411
+ * @name ListProjects
1412
+ * @summary List Projects
1413
+ * @request GET:/api/v3/projects
1414
+ * @secure
1415
+ */
1416
+ listProjects = (params = {}) => this.request({
1417
+ path: `/api/v3/projects`,
1418
+ method: "GET",
1419
+ secure: true,
1420
+ format: "json",
1421
+ ...params
1422
+ });
1423
+ /**
1424
+ * @description Create Project is used to create a new Shortcut Project.
1425
+ *
1426
+ * @name CreateProject
1427
+ * @summary Create Project
1428
+ * @request POST:/api/v3/projects
1429
+ * @secure
1430
+ */
1431
+ createProject = (CreateProject, params = {}) => this.request({
1432
+ path: `/api/v3/projects`,
1433
+ method: "POST",
1434
+ body: CreateProject,
1435
+ secure: true,
1436
+ type: ContentType.Json,
1437
+ format: "json",
1438
+ ...params
1439
+ });
1440
+ /**
1441
+ * @description Get Project returns information about the selected Project.
1442
+ *
1443
+ * @name GetProject
1444
+ * @summary Get Project
1445
+ * @request GET:/api/v3/projects/{project-public-id}
1446
+ * @secure
1447
+ */
1448
+ getProject = (projectPublicId, params = {}) => this.request({
1449
+ path: `/api/v3/projects/${projectPublicId}`,
1450
+ method: "GET",
1451
+ secure: true,
1452
+ format: "json",
1453
+ ...params
1454
+ });
1455
+ /**
1456
+ * @description Update Project can be used to change properties of a Project.
1457
+ *
1458
+ * @name UpdateProject
1459
+ * @summary Update Project
1460
+ * @request PUT:/api/v3/projects/{project-public-id}
1461
+ * @secure
1462
+ */
1463
+ updateProject = (projectPublicId, UpdateProject, params = {}) => this.request({
1464
+ path: `/api/v3/projects/${projectPublicId}`,
1465
+ method: "PUT",
1466
+ body: UpdateProject,
1467
+ secure: true,
1468
+ type: ContentType.Json,
1469
+ format: "json",
1470
+ ...params
1471
+ });
1472
+ /**
1473
+ * @description Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.
1474
+ *
1475
+ * @name DeleteProject
1476
+ * @summary Delete Project
1477
+ * @request DELETE:/api/v3/projects/{project-public-id}
1478
+ * @secure
1479
+ */
1480
+ deleteProject = (projectPublicId, params = {}) => this.request({
1481
+ path: `/api/v3/projects/${projectPublicId}`,
1482
+ method: "DELETE",
1483
+ secure: true,
1484
+ ...params
1485
+ });
1486
+ /**
1487
+ * @description List Stories returns a list of all Stories in a selected Project and their attributes.
1488
+ *
1489
+ * @name ListStories
1490
+ * @summary List Stories
1491
+ * @request GET:/api/v3/projects/{project-public-id}/stories
1492
+ * @secure
1493
+ */
1494
+ listStories = (projectPublicId, query, params = {}) => this.request({
1495
+ path: `/api/v3/projects/${projectPublicId}/stories`,
1496
+ method: "GET",
1497
+ query,
1498
+ secure: true,
1499
+ format: "json",
1500
+ ...params
1501
+ });
1502
+ /**
1503
+ * @description List Repositories returns a list of all Repositories and their attributes.
1504
+ *
1505
+ * @name ListRepositories
1506
+ * @summary List Repositories
1507
+ * @request GET:/api/v3/repositories
1508
+ * @secure
1509
+ */
1510
+ listRepositories = (params = {}) => this.request({
1511
+ path: `/api/v3/repositories`,
1512
+ method: "GET",
1513
+ secure: true,
1514
+ format: "json",
1515
+ ...params
1516
+ });
1517
+ /**
1518
+ * @description Get Repository returns information about the selected Repository.
1519
+ *
1520
+ * @name GetRepository
1521
+ * @summary Get Repository
1522
+ * @request GET:/api/v3/repositories/{repo-public-id}
1523
+ * @secure
1524
+ */
1525
+ getRepository = (repoPublicId, params = {}) => this.request({
1526
+ path: `/api/v3/repositories/${repoPublicId}`,
1527
+ method: "GET",
1528
+ secure: true,
1529
+ format: "json",
1530
+ ...params
1531
+ });
1532
+ /**
1533
+ * @description Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1534
+ *
1535
+ * @name Search
1536
+ * @summary Search
1537
+ * @request GET:/api/v3/search
1538
+ * @secure
1539
+ */
1540
+ search = (query, params = {}) => this.request({
1541
+ path: `/api/v3/search`,
1542
+ method: "GET",
1543
+ query,
1544
+ secure: true,
1545
+ format: "json",
1546
+ ...params
1547
+ });
1548
+ /**
1549
+ * @description Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1550
+ *
1551
+ * @name SearchEpics
1552
+ * @summary Search Epics
1553
+ * @request GET:/api/v3/search/epics
1554
+ * @secure
1555
+ */
1556
+ searchEpics = (query, params = {}) => this.request({
1557
+ path: `/api/v3/search/epics`,
1558
+ method: "GET",
1559
+ query,
1560
+ secure: true,
1561
+ format: "json",
1562
+ ...params
1563
+ });
1564
+ /**
1565
+ * @description Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1566
+ *
1567
+ * @name SearchIterations
1568
+ * @summary Search Iterations
1569
+ * @request GET:/api/v3/search/iterations
1570
+ * @secure
1571
+ */
1572
+ searchIterations = (query, params = {}) => this.request({
1573
+ path: `/api/v3/search/iterations`,
1574
+ method: "GET",
1575
+ query,
1576
+ secure: true,
1577
+ format: "json",
1578
+ ...params
1579
+ });
1580
+ /**
1581
+ * @description Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1582
+ *
1583
+ * @name SearchMilestones
1584
+ * @summary Search Milestones
1585
+ * @request GET:/api/v3/search/milestones
1586
+ * @secure
1587
+ */
1588
+ searchMilestones = (query, params = {}) => this.request({
1589
+ path: `/api/v3/search/milestones`,
1590
+ method: "GET",
1591
+ query,
1592
+ secure: true,
1593
+ format: "json",
1594
+ ...params
1595
+ });
1596
+ /**
1597
+ * @description Search Objectives lets you search Objectives based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1598
+ *
1599
+ * @name SearchObjectives
1600
+ * @summary Search Objectives
1601
+ * @request GET:/api/v3/search/objectives
1602
+ * @secure
1603
+ */
1604
+ searchObjectives = (query, params = {}) => this.request({
1605
+ path: `/api/v3/search/objectives`,
1606
+ method: "GET",
1607
+ query,
1608
+ secure: true,
1609
+ format: "json",
1610
+ ...params
1611
+ });
1612
+ /**
1613
+ * @description Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
1614
+ *
1615
+ * @name SearchStories
1616
+ * @summary Search Stories
1617
+ * @request GET:/api/v3/search/stories
1618
+ * @secure
1619
+ */
1620
+ searchStories = (query, params = {}) => this.request({
1621
+ path: `/api/v3/search/stories`,
1622
+ method: "GET",
1623
+ query,
1624
+ secure: true,
1625
+ format: "json",
1626
+ ...params
1627
+ });
1628
+ /**
1629
+ * @description Create Story is used to add a new story to your Shortcut Workspace. This endpoint requires that either **workflow_state_id** or **project_id** be provided, but will reject the request if both or neither are specified. The workflow_state_id has been marked as required and is the recommended field to specify because we are in the process of sunsetting Projects in Shortcut.
1630
+ *
1631
+ * @name CreateStory
1632
+ * @summary Create Story
1633
+ * @request POST:/api/v3/stories
1634
+ * @secure
1635
+ */
1636
+ createStory = (CreateStoryParams, params = {}) => this.request({
1637
+ path: `/api/v3/stories`,
1638
+ method: "POST",
1639
+ body: CreateStoryParams,
1640
+ secure: true,
1641
+ type: ContentType.Json,
1642
+ format: "json",
1643
+ ...params
1644
+ });
1645
+ /**
1646
+ * @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).
1647
+ *
1648
+ * @name CreateMultipleStories
1649
+ * @summary Create Multiple Stories
1650
+ * @request POST:/api/v3/stories/bulk
1651
+ * @secure
1652
+ */
1653
+ createMultipleStories = (CreateStories, params = {}) => this.request({
1654
+ path: `/api/v3/stories/bulk`,
1655
+ method: "POST",
1656
+ body: CreateStories,
1657
+ secure: true,
1658
+ type: ContentType.Json,
1659
+ format: "json",
1660
+ ...params
1661
+ });
1662
+ /**
1663
+ * @description Update Multiple Stories allows you to make changes to numerous stories at once.
1664
+ *
1665
+ * @name UpdateMultipleStories
1666
+ * @summary Update Multiple Stories
1667
+ * @request PUT:/api/v3/stories/bulk
1668
+ * @secure
1669
+ */
1670
+ updateMultipleStories = (UpdateStories, params = {}) => this.request({
1671
+ path: `/api/v3/stories/bulk`,
1672
+ method: "PUT",
1673
+ body: UpdateStories,
1674
+ secure: true,
1675
+ type: ContentType.Json,
1676
+ format: "json",
1677
+ ...params
1678
+ });
1679
+ /**
1680
+ * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
1681
+ *
1682
+ * @name DeleteMultipleStories
1683
+ * @summary Delete Multiple Stories
1684
+ * @request DELETE:/api/v3/stories/bulk
1685
+ * @secure
1686
+ */
1687
+ deleteMultipleStories = (DeleteStories, params = {}) => this.request({
1688
+ path: `/api/v3/stories/bulk`,
1689
+ method: "DELETE",
1690
+ body: DeleteStories,
1691
+ secure: true,
1692
+ type: ContentType.Json,
1693
+ ...params
1694
+ });
1695
+ /**
1696
+ * @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
1697
+ *
1698
+ * @name CreateStoryFromTemplate
1699
+ * @summary Create Story From Template
1700
+ * @request POST:/api/v3/stories/from-template
1701
+ * @secure
1702
+ */
1703
+ createStoryFromTemplate = (CreateStoryFromTemplateParams, params = {}) => this.request({
1704
+ path: `/api/v3/stories/from-template`,
1705
+ method: "POST",
1706
+ body: CreateStoryFromTemplateParams,
1707
+ secure: true,
1708
+ type: ContentType.Json,
1709
+ format: "json",
1710
+ ...params
1711
+ });
1712
+ /**
1713
+ * @description Search Stories lets you search Stories based on desired parameters.
1714
+ *
1715
+ * @name SearchStoriesOld
1716
+ * @summary Search Stories (Old)
1717
+ * @request POST:/api/v3/stories/search
1718
+ * @secure
1719
+ */
1720
+ searchStoriesOld = (SearchStories, params = {}) => this.request({
1721
+ path: `/api/v3/stories/search`,
1722
+ method: "POST",
1723
+ body: SearchStories,
1724
+ secure: true,
1725
+ type: ContentType.Json,
1726
+ format: "json",
1727
+ ...params
1728
+ });
1729
+ /**
1730
+ * @description Get Story returns information about a chosen Story.
1731
+ *
1732
+ * @name GetStory
1733
+ * @summary Get Story
1734
+ * @request GET:/api/v3/stories/{story-public-id}
1735
+ * @secure
1736
+ */
1737
+ getStory = (storyPublicId, params = {}) => this.request({
1738
+ path: `/api/v3/stories/${storyPublicId}`,
1739
+ method: "GET",
1740
+ secure: true,
1741
+ format: "json",
1742
+ ...params
1743
+ });
1744
+ /**
1745
+ * @description Update Story can be used to update Story properties.
1746
+ *
1747
+ * @name UpdateStory
1748
+ * @summary Update Story
1749
+ * @request PUT:/api/v3/stories/{story-public-id}
1750
+ * @secure
1751
+ */
1752
+ updateStory = (storyPublicId, UpdateStory, params = {}) => this.request({
1753
+ path: `/api/v3/stories/${storyPublicId}`,
1754
+ method: "PUT",
1755
+ body: UpdateStory,
1756
+ secure: true,
1757
+ type: ContentType.Json,
1758
+ format: "json",
1759
+ ...params
1760
+ });
1761
+ /**
1762
+ * @description Delete Story can be used to delete any Story.
1763
+ *
1764
+ * @name DeleteStory
1765
+ * @summary Delete Story
1766
+ * @request DELETE:/api/v3/stories/{story-public-id}
1767
+ * @secure
1768
+ */
1769
+ deleteStory = (storyPublicId, params = {}) => this.request({
1770
+ path: `/api/v3/stories/${storyPublicId}`,
1771
+ method: "DELETE",
1772
+ secure: true,
1773
+ ...params
1774
+ });
1775
+ /**
1776
+ * @description Lists Comments associated with a Story
1777
+ *
1778
+ * @name ListStoryComment
1779
+ * @summary List Story Comment
1780
+ * @request GET:/api/v3/stories/{story-public-id}/comments
1781
+ * @secure
1782
+ */
1783
+ listStoryComment = (storyPublicId, params = {}) => this.request({
1784
+ path: `/api/v3/stories/${storyPublicId}/comments`,
1785
+ method: "GET",
1786
+ secure: true,
1787
+ format: "json",
1788
+ ...params
1789
+ });
1790
+ /**
1791
+ * @description Create Comment allows you to create a Comment on any Story.
1792
+ *
1793
+ * @name CreateStoryComment
1794
+ * @summary Create Story Comment
1795
+ * @request POST:/api/v3/stories/{story-public-id}/comments
1796
+ * @secure
1797
+ */
1798
+ createStoryComment = (storyPublicId, CreateStoryComment, params = {}) => this.request({
1799
+ path: `/api/v3/stories/${storyPublicId}/comments`,
1800
+ method: "POST",
1801
+ body: CreateStoryComment,
1802
+ secure: true,
1803
+ type: ContentType.Json,
1804
+ format: "json",
1805
+ ...params
1806
+ });
1807
+ /**
1808
+ * @description Get Comment is used to get Comment information.
1809
+ *
1810
+ * @name GetStoryComment
1811
+ * @summary Get Story Comment
1812
+ * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1813
+ * @secure
1814
+ */
1815
+ getStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request({
1816
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1817
+ method: "GET",
1818
+ secure: true,
1819
+ format: "json",
1820
+ ...params
1821
+ });
1822
+ /**
1823
+ * @description Update Comment replaces the text of the existing Comment.
1824
+ *
1825
+ * @name UpdateStoryComment
1826
+ * @summary Update Story Comment
1827
+ * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1828
+ * @secure
1829
+ */
1830
+ updateStoryComment = (storyPublicId, commentPublicId, UpdateStoryComment, params = {}) => this.request({
1831
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1832
+ method: "PUT",
1833
+ body: UpdateStoryComment,
1834
+ secure: true,
1835
+ type: ContentType.Json,
1836
+ format: "json",
1837
+ ...params
1838
+ });
1839
+ /**
1840
+ * @description Delete a Comment from any story.
1841
+ *
1842
+ * @name DeleteStoryComment
1843
+ * @summary Delete Story Comment
1844
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1845
+ * @secure
1846
+ */
1847
+ deleteStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request({
1848
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`,
1849
+ method: "DELETE",
1850
+ secure: true,
1851
+ ...params
1852
+ });
1853
+ /**
1854
+ * @description Create a reaction to a story comment.
1855
+ *
1856
+ * @name CreateStoryReaction
1857
+ * @summary Create Story Reaction
1858
+ * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1859
+ * @secure
1860
+ */
1861
+ createStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request({
1862
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`,
1863
+ method: "POST",
1864
+ body: CreateOrDeleteStoryReaction,
1865
+ secure: true,
1866
+ type: ContentType.Json,
1867
+ format: "json",
1868
+ ...params
1869
+ });
1870
+ /**
1871
+ * @description Delete a reaction from any story comment.
1872
+ *
1873
+ * @name DeleteStoryReaction
1874
+ * @summary Delete Story Reaction
1875
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1876
+ * @secure
1877
+ */
1878
+ deleteStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request({
1879
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`,
1880
+ method: "DELETE",
1881
+ body: CreateOrDeleteStoryReaction,
1882
+ secure: true,
1883
+ type: ContentType.Json,
1884
+ ...params
1885
+ });
1886
+ /**
1887
+ * @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
1888
+ *
1889
+ * @name UnlinkCommentThreadFromSlack
1890
+ * @summary Unlink Comment thread from Slack
1891
+ * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
1892
+ * @secure
1893
+ */
1894
+ unlinkCommentThreadFromSlack = (storyPublicId, commentPublicId, params = {}) => this.request({
1895
+ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/unlink-from-slack`,
1896
+ method: "POST",
1897
+ secure: true,
1898
+ format: "json",
1899
+ ...params
1900
+ });
1901
+ /**
1902
+ * No description
1903
+ *
1904
+ * @name StoryHistory
1905
+ * @summary Story History
1906
+ * @request GET:/api/v3/stories/{story-public-id}/history
1907
+ * @secure
1908
+ */
1909
+ storyHistory = (storyPublicId, params = {}) => this.request({
1910
+ path: `/api/v3/stories/${storyPublicId}/history`,
1911
+ method: "GET",
1912
+ secure: true,
1913
+ format: "json",
1914
+ ...params
1915
+ });
1916
+ /**
1917
+ * @description Create Task is used to create a new task in a Story.
1918
+ *
1919
+ * @name CreateTask
1920
+ * @summary Create Task
1921
+ * @request POST:/api/v3/stories/{story-public-id}/tasks
1922
+ * @secure
1923
+ */
1924
+ createTask = (storyPublicId, CreateTask, params = {}) => this.request({
1925
+ path: `/api/v3/stories/${storyPublicId}/tasks`,
1926
+ method: "POST",
1927
+ body: CreateTask,
1928
+ secure: true,
1929
+ type: ContentType.Json,
1930
+ format: "json",
1931
+ ...params
1932
+ });
1933
+ /**
1934
+ * @description Returns information about a chosen Task.
1935
+ *
1936
+ * @name GetTask
1937
+ * @summary Get Task
1938
+ * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1939
+ * @secure
1940
+ */
1941
+ getTask = (storyPublicId, taskPublicId, params = {}) => this.request({
1942
+ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
1943
+ method: "GET",
1944
+ secure: true,
1945
+ format: "json",
1946
+ ...params
1947
+ });
1948
+ /**
1949
+ * @description Update Task can be used to update Task properties.
1950
+ *
1951
+ * @name UpdateTask
1952
+ * @summary Update Task
1953
+ * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1954
+ * @secure
1955
+ */
1956
+ updateTask = (storyPublicId, taskPublicId, UpdateTask, params = {}) => this.request({
1957
+ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
1958
+ method: "PUT",
1959
+ body: UpdateTask,
1960
+ secure: true,
1961
+ type: ContentType.Json,
1962
+ format: "json",
1963
+ ...params
1964
+ });
1965
+ /**
1966
+ * @description Delete Task can be used to delete any previously created Task on a Story.
1967
+ *
1968
+ * @name DeleteTask
1969
+ * @summary Delete Task
1970
+ * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1971
+ * @secure
1972
+ */
1973
+ deleteTask = (storyPublicId, taskPublicId, params = {}) => this.request({
1974
+ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`,
1975
+ method: "DELETE",
1976
+ secure: true,
1977
+ ...params
1978
+ });
1979
+ /**
1980
+ * @description Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”
1981
+ *
1982
+ * @name CreateStoryLink
1983
+ * @summary Create Story Link
1984
+ * @request POST:/api/v3/story-links
1985
+ * @secure
1986
+ */
1987
+ createStoryLink = (CreateStoryLink, params = {}) => this.request({
1988
+ path: `/api/v3/story-links`,
1989
+ method: "POST",
1990
+ body: CreateStoryLink,
1991
+ secure: true,
1992
+ type: ContentType.Json,
1993
+ format: "json",
1994
+ ...params
1995
+ });
1996
+ /**
1997
+ * @description Returns the stories and their relationship for the given Story Link.
1998
+ *
1999
+ * @name GetStoryLink
2000
+ * @summary Get Story Link
2001
+ * @request GET:/api/v3/story-links/{story-link-public-id}
2002
+ * @secure
2003
+ */
2004
+ getStoryLink = (storyLinkPublicId, params = {}) => this.request({
2005
+ path: `/api/v3/story-links/${storyLinkPublicId}`,
2006
+ method: "GET",
2007
+ secure: true,
2008
+ format: "json",
2009
+ ...params
2010
+ });
2011
+ /**
2012
+ * @description Updates the stories and/or the relationship for the given Story Link.
2013
+ *
2014
+ * @name UpdateStoryLink
2015
+ * @summary Update Story Link
2016
+ * @request PUT:/api/v3/story-links/{story-link-public-id}
2017
+ * @secure
2018
+ */
2019
+ updateStoryLink = (storyLinkPublicId, UpdateStoryLink, params = {}) => this.request({
2020
+ path: `/api/v3/story-links/${storyLinkPublicId}`,
2021
+ method: "PUT",
2022
+ body: UpdateStoryLink,
2023
+ secure: true,
2024
+ type: ContentType.Json,
2025
+ format: "json",
2026
+ ...params
2027
+ });
2028
+ /**
2029
+ * @description Removes the relationship between the stories for the given Story Link.
2030
+ *
2031
+ * @name DeleteStoryLink
2032
+ * @summary Delete Story Link
2033
+ * @request DELETE:/api/v3/story-links/{story-link-public-id}
2034
+ * @secure
2035
+ */
2036
+ deleteStoryLink = (storyLinkPublicId, params = {}) => this.request({
2037
+ path: `/api/v3/story-links/${storyLinkPublicId}`,
2038
+ method: "DELETE",
2039
+ secure: true,
2040
+ ...params
2041
+ });
2042
+ /**
2043
+ * @description Returns a list of all Workflows in the Workspace.
2044
+ *
2045
+ * @name ListWorkflows
2046
+ * @summary List Workflows
2047
+ * @request GET:/api/v3/workflows
2048
+ * @secure
2049
+ */
2050
+ listWorkflows = (params = {}) => this.request({
2051
+ path: `/api/v3/workflows`,
2052
+ method: "GET",
2053
+ secure: true,
2054
+ format: "json",
2055
+ ...params
2056
+ });
2057
+ /**
2058
+ * @description Get Workflow returns information about a chosen Workflow.
2059
+ *
2060
+ * @name GetWorkflow
2061
+ * @summary Get Workflow
2062
+ * @request GET:/api/v3/workflows/{workflow-public-id}
2063
+ * @secure
2064
+ */
2065
+ getWorkflow = (workflowPublicId, params = {}) => this.request({
2066
+ path: `/api/v3/workflows/${workflowPublicId}`,
2067
+ method: "GET",
2068
+ secure: true,
2069
+ format: "json",
2070
+ ...params
2071
+ });
2128
2072
  };
2073
+
2074
+ //#endregion
2075
+ export { Api };