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