@useshortcut/client 1.0.0-beta.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.
@@ -0,0 +1,1309 @@
1
+ "use strict";
2
+ /* eslint-disable */
3
+ /* tslint:disable */
4
+ /*
5
+ * ---------------------------------------------------------------
6
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
7
+ * ## ##
8
+ * ## AUTHOR: acacode ##
9
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
10
+ * ---------------------------------------------------------------
11
+ */
12
+ var __extends = (this && this.__extends) || (function () {
13
+ var extendStatics = function (d, b) {
14
+ extendStatics = Object.setPrototypeOf ||
15
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
16
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
17
+ return extendStatics(d, b);
18
+ };
19
+ return function (d, b) {
20
+ if (typeof b !== "function" && b !== null)
21
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
22
+ extendStatics(d, b);
23
+ function __() { this.constructor = d; }
24
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
25
+ };
26
+ })();
27
+ var __assign = (this && this.__assign) || function () {
28
+ __assign = Object.assign || function(t) {
29
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
30
+ s = arguments[i];
31
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
32
+ t[p] = s[p];
33
+ }
34
+ return t;
35
+ };
36
+ return __assign.apply(this, arguments);
37
+ };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.Api = void 0;
40
+ var http_client_1 = require("./http-client");
41
+ var Api = /** @class */ (function (_super) {
42
+ __extends(Api, _super);
43
+ function Api() {
44
+ var _this = _super !== null && _super.apply(this, arguments) || this;
45
+ /**
46
+ * @description List Categories returns a list of all Categories and their attributes.
47
+ *
48
+ * @name ListCategories
49
+ * @summary List Categories
50
+ * @request GET:/api/v3/categories
51
+ * @secure
52
+ */
53
+ _this.listCategories = function (params) {
54
+ if (params === void 0) { params = {}; }
55
+ return _this.request(__assign({ path: "/api/v3/categories", method: "GET", secure: true, format: "json" }, params));
56
+ };
57
+ /**
58
+ * @description Create Category allows you to create a new Category in Shortcut.
59
+ *
60
+ * @name CreateCategory
61
+ * @summary Create Category
62
+ * @request POST:/api/v3/categories
63
+ * @secure
64
+ */
65
+ _this.createCategory = function (CreateCategory, params) {
66
+ if (params === void 0) { params = {}; }
67
+ return _this.request(__assign({ path: "/api/v3/categories", method: "POST", body: CreateCategory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
68
+ };
69
+ /**
70
+ * @description Get Category returns information about the selected Category.
71
+ *
72
+ * @name GetCategory
73
+ * @summary Get Category
74
+ * @request GET:/api/v3/categories/{category-public-id}
75
+ * @secure
76
+ */
77
+ _this.getCategory = function (categoryPublicId, params) {
78
+ if (params === void 0) { params = {}; }
79
+ return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "GET", secure: true, format: "json" }, params));
80
+ };
81
+ /**
82
+ * @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.
83
+ *
84
+ * @name UpdateCategory
85
+ * @summary Update Category
86
+ * @request PUT:/api/v3/categories/{category-public-id}
87
+ * @secure
88
+ */
89
+ _this.updateCategory = function (categoryPublicId, UpdateCategory, params) {
90
+ if (params === void 0) { params = {}; }
91
+ return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "PUT", body: UpdateCategory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
92
+ };
93
+ /**
94
+ * @description Delete Category can be used to delete any Category.
95
+ *
96
+ * @name DeleteCategory
97
+ * @summary Delete Category
98
+ * @request DELETE:/api/v3/categories/{category-public-id}
99
+ * @secure
100
+ */
101
+ _this.deleteCategory = function (categoryPublicId, params) {
102
+ if (params === void 0) { params = {}; }
103
+ return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "DELETE", secure: true }, params));
104
+ };
105
+ /**
106
+ * @description List Category Milestones returns a list of all Milestones with the Category.
107
+ *
108
+ * @name ListCategoryMilestones
109
+ * @summary List Category Milestones
110
+ * @request GET:/api/v3/categories/{category-public-id}/milestones
111
+ * @secure
112
+ */
113
+ _this.listCategoryMilestones = function (categoryPublicId, params) {
114
+ if (params === void 0) { params = {}; }
115
+ return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId + "/milestones", method: "GET", secure: true, format: "json" }, params));
116
+ };
117
+ /**
118
+ * @description List all the entity templates for an organization.
119
+ *
120
+ * @name ListEntityTemplates
121
+ * @summary List Entity Templates
122
+ * @request GET:/api/v3/entity-templates
123
+ * @secure
124
+ */
125
+ _this.listEntityTemplates = function (params) {
126
+ if (params === void 0) { params = {}; }
127
+ return _this.request(__assign({ path: "/api/v3/entity-templates", method: "GET", secure: true, format: "json" }, params));
128
+ };
129
+ /**
130
+ * @description Create a new entity template for your organization.
131
+ *
132
+ * @name CreateEntityTemplate
133
+ * @summary Create Entity Template
134
+ * @request POST:/api/v3/entity-templates
135
+ * @secure
136
+ */
137
+ _this.createEntityTemplate = function (CreateEntityTemplate, params) {
138
+ if (params === void 0) { params = {}; }
139
+ return _this.request(__assign({ path: "/api/v3/entity-templates", method: "POST", body: CreateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
140
+ };
141
+ /**
142
+ * @description Disables the Story Template feature for the given Organization.
143
+ *
144
+ * @name DisableStoryTemplates
145
+ * @summary Disable Story Templates
146
+ * @request PUT:/api/v3/entity-templates/disable
147
+ * @secure
148
+ */
149
+ _this.disableStoryTemplates = function (params) {
150
+ if (params === void 0) { params = {}; }
151
+ return _this.request(__assign({ path: "/api/v3/entity-templates/disable", method: "PUT", secure: true }, params));
152
+ };
153
+ /**
154
+ * @description Enables the Story Template feature for the given Organization.
155
+ *
156
+ * @name EnableStoryTemplates
157
+ * @summary Enable Story Templates
158
+ * @request PUT:/api/v3/entity-templates/enable
159
+ * @secure
160
+ */
161
+ _this.enableStoryTemplates = function (params) {
162
+ if (params === void 0) { params = {}; }
163
+ return _this.request(__assign({ path: "/api/v3/entity-templates/enable", method: "PUT", secure: true }, params));
164
+ };
165
+ /**
166
+ * @description Get Entity Template returns information about a given entity template.
167
+ *
168
+ * @name GetEntityTemplate
169
+ * @summary Get Entity Template
170
+ * @request GET:/api/v3/entity-templates/{entity-template-public-id}
171
+ * @secure
172
+ */
173
+ _this.getEntityTemplate = function (entityTemplatePublicId, params) {
174
+ if (params === void 0) { params = {}; }
175
+ return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "GET", secure: true, format: "json" }, params));
176
+ };
177
+ /**
178
+ * @description Update an entity template's name or its contents.
179
+ *
180
+ * @name UpdateEntityTemplate
181
+ * @summary Update Entity Template
182
+ * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
183
+ * @secure
184
+ */
185
+ _this.updateEntityTemplate = function (entityTemplatePublicId, UpdateEntityTemplate, params) {
186
+ if (params === void 0) { params = {}; }
187
+ return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "PUT", body: UpdateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
188
+ };
189
+ /**
190
+ * No description
191
+ *
192
+ * @name DeleteEntityTemplate
193
+ * @summary Delete Entity Template
194
+ * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
195
+ * @secure
196
+ */
197
+ _this.deleteEntityTemplate = function (entityTemplatePublicId, params) {
198
+ if (params === void 0) { params = {}; }
199
+ return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "DELETE", secure: true }, params));
200
+ };
201
+ /**
202
+ * @description Get Epic Workflow returns the Epic Workflow for the organization.
203
+ *
204
+ * @name GetEpicWorkflow
205
+ * @summary Get Epic Workflow
206
+ * @request GET:/api/v3/epic-workflow
207
+ * @secure
208
+ */
209
+ _this.getEpicWorkflow = function (params) {
210
+ if (params === void 0) { params = {}; }
211
+ return _this.request(__assign({ path: "/api/v3/epic-workflow", method: "GET", secure: true, format: "json" }, params));
212
+ };
213
+ /**
214
+ * @description List Epics returns a list of all Epics and their attributes.
215
+ *
216
+ * @name ListEpics
217
+ * @summary List Epics
218
+ * @request GET:/api/v3/epics
219
+ * @secure
220
+ */
221
+ _this.listEpics = function (ListEpics, params) {
222
+ if (params === void 0) { params = {}; }
223
+ return _this.request(__assign({ path: "/api/v3/epics", method: "GET", body: ListEpics, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
224
+ };
225
+ /**
226
+ * @description Create Epic allows you to create a new Epic in Shortcut.
227
+ *
228
+ * @name CreateEpic
229
+ * @summary Create Epic
230
+ * @request POST:/api/v3/epics
231
+ * @secure
232
+ */
233
+ _this.createEpic = function (CreateEpic, params) {
234
+ if (params === void 0) { params = {}; }
235
+ return _this.request(__assign({ path: "/api/v3/epics", method: "POST", body: CreateEpic, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
236
+ };
237
+ /**
238
+ * @description Get Epic returns information about the selected Epic.
239
+ *
240
+ * @name GetEpic
241
+ * @summary Get Epic
242
+ * @request GET:/api/v3/epics/{epic-public-id}
243
+ * @secure
244
+ */
245
+ _this.getEpic = function (epicPublicId, params) {
246
+ if (params === void 0) { params = {}; }
247
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "GET", secure: true, format: "json" }, params));
248
+ };
249
+ /**
250
+ * @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.
251
+ *
252
+ * @name UpdateEpic
253
+ * @summary Update Epic
254
+ * @request PUT:/api/v3/epics/{epic-public-id}
255
+ * @secure
256
+ */
257
+ _this.updateEpic = function (epicPublicId, UpdateEpic, params) {
258
+ if (params === void 0) { params = {}; }
259
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "PUT", body: UpdateEpic, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
260
+ };
261
+ /**
262
+ * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
263
+ *
264
+ * @name DeleteEpic
265
+ * @summary Delete Epic
266
+ * @request DELETE:/api/v3/epics/{epic-public-id}
267
+ * @secure
268
+ */
269
+ _this.deleteEpic = function (epicPublicId, params) {
270
+ if (params === void 0) { params = {}; }
271
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "DELETE", secure: true }, params));
272
+ };
273
+ /**
274
+ * @description Get a list of all Comments on an Epic.
275
+ *
276
+ * @name ListEpicComments
277
+ * @summary List Epic Comments
278
+ * @request GET:/api/v3/epics/{epic-public-id}/comments
279
+ * @secure
280
+ */
281
+ _this.listEpicComments = function (epicPublicId, params) {
282
+ if (params === void 0) { params = {}; }
283
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments", method: "GET", secure: true, format: "json" }, params));
284
+ };
285
+ /**
286
+ * @description This endpoint allows you to create a threaded Comment on an Epic.
287
+ *
288
+ * @name CreateEpicComment
289
+ * @summary Create Epic Comment
290
+ * @request POST:/api/v3/epics/{epic-public-id}/comments
291
+ * @secure
292
+ */
293
+ _this.createEpicComment = function (epicPublicId, CreateEpicComment, params) {
294
+ if (params === void 0) { params = {}; }
295
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments", method: "POST", body: CreateEpicComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
296
+ };
297
+ /**
298
+ * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
299
+ *
300
+ * @name CreateEpicCommentComment
301
+ * @summary Create Epic Comment Comment
302
+ * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
303
+ * @secure
304
+ */
305
+ _this.createEpicCommentComment = function (epicPublicId, commentPublicId, CreateCommentComment, params) {
306
+ if (params === void 0) { params = {}; }
307
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "POST", body: CreateCommentComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
308
+ };
309
+ /**
310
+ * @description This endpoint returns information about the selected Epic Comment.
311
+ *
312
+ * @name GetEpicComment
313
+ * @summary Get Epic Comment
314
+ * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
315
+ * @secure
316
+ */
317
+ _this.getEpicComment = function (epicPublicId, commentPublicId, params) {
318
+ if (params === void 0) { params = {}; }
319
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "GET", secure: true, format: "json" }, params));
320
+ };
321
+ /**
322
+ * @description This endpoint allows you to update a threaded Comment on an Epic.
323
+ *
324
+ * @name UpdateEpicComment
325
+ * @summary Update Epic Comment
326
+ * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
327
+ * @secure
328
+ */
329
+ _this.updateEpicComment = function (epicPublicId, commentPublicId, UpdateComment, params) {
330
+ if (params === void 0) { params = {}; }
331
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "PUT", body: UpdateComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
332
+ };
333
+ /**
334
+ * @description This endpoint allows you to delete a Comment from an Epic.
335
+ *
336
+ * @name DeleteEpicComment
337
+ * @summary Delete Epic Comment
338
+ * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
339
+ * @secure
340
+ */
341
+ _this.deleteEpicComment = function (epicPublicId, commentPublicId, params) {
342
+ if (params === void 0) { params = {}; }
343
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "DELETE", secure: true }, params));
344
+ };
345
+ /**
346
+ * @description Get a list of all Stories in an Epic.
347
+ *
348
+ * @name ListEpicStories
349
+ * @summary List Epic Stories
350
+ * @request GET:/api/v3/epics/{epic-public-id}/stories
351
+ * @secure
352
+ */
353
+ _this.listEpicStories = function (epicPublicId, GetEpicStories, params) {
354
+ if (params === void 0) { params = {}; }
355
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/stories", method: "GET", body: GetEpicStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
356
+ };
357
+ /**
358
+ * @description This endpoint allows you to unlink a productboard epic.
359
+ *
360
+ * @name UnlinkProductboardFromEpic
361
+ * @summary Unlink Productboard from Epic
362
+ * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
363
+ * @secure
364
+ */
365
+ _this.unlinkProductboardFromEpic = function (epicPublicId, params) {
366
+ if (params === void 0) { params = {}; }
367
+ return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/unlink-productboard", method: "POST", secure: true }, params));
368
+ };
369
+ /**
370
+ * @description Get Stories which have a given External Link associated with them.
371
+ *
372
+ * @name GetExternalLinkStories
373
+ * @summary Get External Link Stories
374
+ * @request GET:/api/v3/external-link/stories
375
+ * @secure
376
+ */
377
+ _this.getExternalLinkStories = function (GetExternalLinkStoriesParams, params) {
378
+ if (params === void 0) { params = {}; }
379
+ return _this.request(__assign({ path: "/api/v3/external-link/stories", method: "GET", body: GetExternalLinkStoriesParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
380
+ };
381
+ /**
382
+ * @description List Files returns a list of all UploadedFiles in the workspace.
383
+ *
384
+ * @name ListFiles
385
+ * @summary List Files
386
+ * @request GET:/api/v3/files
387
+ * @secure
388
+ */
389
+ _this.listFiles = function (params) {
390
+ if (params === void 0) { params = {}; }
391
+ return _this.request(__assign({ path: "/api/v3/files", method: "GET", secure: true, format: "json" }, params));
392
+ };
393
+ /**
394
+ * @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.
395
+ *
396
+ * @name UploadFiles
397
+ * @summary Upload Files
398
+ * @request POST:/api/v3/files
399
+ * @secure
400
+ */
401
+ _this.uploadFiles = function (data, params) {
402
+ if (params === void 0) { params = {}; }
403
+ return _this.request(__assign({ path: "/api/v3/files", method: "POST", body: data, secure: true, type: http_client_1.ContentType.FormData, format: "json" }, params));
404
+ };
405
+ /**
406
+ * @description Get File returns information about the selected UploadedFile.
407
+ *
408
+ * @name GetFile
409
+ * @summary Get File
410
+ * @request GET:/api/v3/files/{file-public-id}
411
+ * @secure
412
+ */
413
+ _this.getFile = function (filePublicId, params) {
414
+ if (params === void 0) { params = {}; }
415
+ return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "GET", secure: true, format: "json" }, params));
416
+ };
417
+ /**
418
+ * @description Update File updates the properties of an UploadedFile (but not its content).
419
+ *
420
+ * @name UpdateFile
421
+ * @summary Update File
422
+ * @request PUT:/api/v3/files/{file-public-id}
423
+ * @secure
424
+ */
425
+ _this.updateFile = function (filePublicId, UpdateFile, params) {
426
+ if (params === void 0) { params = {}; }
427
+ return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "PUT", body: UpdateFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
428
+ };
429
+ /**
430
+ * @description Delete File deletes a previously uploaded file.
431
+ *
432
+ * @name DeleteFile
433
+ * @summary Delete File
434
+ * @request DELETE:/api/v3/files/{file-public-id}
435
+ * @secure
436
+ */
437
+ _this.deleteFile = function (filePublicId, params) {
438
+ if (params === void 0) { params = {}; }
439
+ return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "DELETE", secure: true }, params));
440
+ };
441
+ /**
442
+ * @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.
443
+ *
444
+ * @name ListGroups
445
+ * @summary List Groups
446
+ * @request GET:/api/v3/groups
447
+ * @secure
448
+ */
449
+ _this.listGroups = function (params) {
450
+ if (params === void 0) { params = {}; }
451
+ return _this.request(__assign({ path: "/api/v3/groups", method: "GET", secure: true, format: "json" }, params));
452
+ };
453
+ /**
454
+ * No description
455
+ *
456
+ * @name CreateGroup
457
+ * @summary Create Group
458
+ * @request POST:/api/v3/groups
459
+ * @secure
460
+ */
461
+ _this.createGroup = function (CreateGroup, params) {
462
+ if (params === void 0) { params = {}; }
463
+ return _this.request(__assign({ path: "/api/v3/groups", method: "POST", body: CreateGroup, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
464
+ };
465
+ /**
466
+ * @description Disables Groups for the current workspace2
467
+ *
468
+ * @name DisableGroups
469
+ * @summary Disable Groups
470
+ * @request PUT:/api/v3/groups/disable
471
+ * @secure
472
+ */
473
+ _this.disableGroups = function (params) {
474
+ if (params === void 0) { params = {}; }
475
+ return _this.request(__assign({ path: "/api/v3/groups/disable", method: "PUT", secure: true }, params));
476
+ };
477
+ /**
478
+ * @description Enables Groups for the current workspace2
479
+ *
480
+ * @name EnableGroups
481
+ * @summary Enable Groups
482
+ * @request PUT:/api/v3/groups/enable
483
+ * @secure
484
+ */
485
+ _this.enableGroups = function (params) {
486
+ if (params === void 0) { params = {}; }
487
+ return _this.request(__assign({ path: "/api/v3/groups/enable", method: "PUT", secure: true }, params));
488
+ };
489
+ /**
490
+ * No description
491
+ *
492
+ * @name GetGroup
493
+ * @summary Get Group
494
+ * @request GET:/api/v3/groups/{group-public-id}
495
+ * @secure
496
+ */
497
+ _this.getGroup = function (groupPublicId, params) {
498
+ if (params === void 0) { params = {}; }
499
+ return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId, method: "GET", secure: true, format: "json" }, params));
500
+ };
501
+ /**
502
+ * No description
503
+ *
504
+ * @name UpdateGroup
505
+ * @summary Update Group
506
+ * @request PUT:/api/v3/groups/{group-public-id}
507
+ * @secure
508
+ */
509
+ _this.updateGroup = function (groupPublicId, UpdateGroup, params) {
510
+ if (params === void 0) { params = {}; }
511
+ return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId, method: "PUT", body: UpdateGroup, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
512
+ };
513
+ /**
514
+ * @description List the Stories assigned to the Group. (By default, limited to 1,000).
515
+ *
516
+ * @name ListGroupStories
517
+ * @summary List Group Stories
518
+ * @request GET:/api/v3/groups/{group-public-id}/stories
519
+ * @secure
520
+ */
521
+ _this.listGroupStories = function (groupPublicId, ListGroupStories, params) {
522
+ if (params === void 0) { params = {}; }
523
+ return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId + "/stories", method: "GET", body: ListGroupStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
524
+ };
525
+ /**
526
+ * No description
527
+ *
528
+ * @name ListIterations
529
+ * @summary List Iterations
530
+ * @request GET:/api/v3/iterations
531
+ * @secure
532
+ */
533
+ _this.listIterations = function (params) {
534
+ if (params === void 0) { params = {}; }
535
+ return _this.request(__assign({ path: "/api/v3/iterations", method: "GET", secure: true, format: "json" }, params));
536
+ };
537
+ /**
538
+ * No description
539
+ *
540
+ * @name CreateIteration
541
+ * @summary Create Iteration
542
+ * @request POST:/api/v3/iterations
543
+ * @secure
544
+ */
545
+ _this.createIteration = function (CreateIteration, params) {
546
+ if (params === void 0) { params = {}; }
547
+ return _this.request(__assign({ path: "/api/v3/iterations", method: "POST", body: CreateIteration, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
548
+ };
549
+ /**
550
+ * @description Disables Iterations for the current workspace
551
+ *
552
+ * @name DisableIterations
553
+ * @summary Disable Iterations
554
+ * @request PUT:/api/v3/iterations/disable
555
+ * @secure
556
+ */
557
+ _this.disableIterations = function (params) {
558
+ if (params === void 0) { params = {}; }
559
+ return _this.request(__assign({ path: "/api/v3/iterations/disable", method: "PUT", secure: true }, params));
560
+ };
561
+ /**
562
+ * @description Enables Iterations for the current workspace
563
+ *
564
+ * @name EnableIterations
565
+ * @summary Enable Iterations
566
+ * @request PUT:/api/v3/iterations/enable
567
+ * @secure
568
+ */
569
+ _this.enableIterations = function (params) {
570
+ if (params === void 0) { params = {}; }
571
+ return _this.request(__assign({ path: "/api/v3/iterations/enable", method: "PUT", secure: true }, params));
572
+ };
573
+ /**
574
+ * No description
575
+ *
576
+ * @name GetIteration
577
+ * @summary Get Iteration
578
+ * @request GET:/api/v3/iterations/{iteration-public-id}
579
+ * @secure
580
+ */
581
+ _this.getIteration = function (iterationPublicId, params) {
582
+ if (params === void 0) { params = {}; }
583
+ return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "GET", secure: true, format: "json" }, params));
584
+ };
585
+ /**
586
+ * No description
587
+ *
588
+ * @name UpdateIteration
589
+ * @summary Update Iteration
590
+ * @request PUT:/api/v3/iterations/{iteration-public-id}
591
+ * @secure
592
+ */
593
+ _this.updateIteration = function (iterationPublicId, UpdateIteration, params) {
594
+ if (params === void 0) { params = {}; }
595
+ return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "PUT", body: UpdateIteration, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
596
+ };
597
+ /**
598
+ * No description
599
+ *
600
+ * @name DeleteIteration
601
+ * @summary Delete Iteration
602
+ * @request DELETE:/api/v3/iterations/{iteration-public-id}
603
+ * @secure
604
+ */
605
+ _this.deleteIteration = function (iterationPublicId, params) {
606
+ if (params === void 0) { params = {}; }
607
+ return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "DELETE", secure: true }, params));
608
+ };
609
+ /**
610
+ * @description Get a list of all Stories in an Iteration.
611
+ *
612
+ * @name ListIterationStories
613
+ * @summary List Iteration Stories
614
+ * @request GET:/api/v3/iterations/{iteration-public-id}/stories
615
+ * @secure
616
+ */
617
+ _this.listIterationStories = function (iterationPublicId, GetIterationStories, params) {
618
+ if (params === void 0) { params = {}; }
619
+ return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId + "/stories", method: "GET", body: GetIterationStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
620
+ };
621
+ /**
622
+ * @description List Labels returns a list of all Labels and their attributes.
623
+ *
624
+ * @name ListLabels
625
+ * @summary List Labels
626
+ * @request GET:/api/v3/labels
627
+ * @secure
628
+ */
629
+ _this.listLabels = function (ListLabels, params) {
630
+ if (params === void 0) { params = {}; }
631
+ return _this.request(__assign({ path: "/api/v3/labels", method: "GET", body: ListLabels, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
632
+ };
633
+ /**
634
+ * @description Create Label allows you to create a new Label in Shortcut.
635
+ *
636
+ * @name CreateLabel
637
+ * @summary Create Label
638
+ * @request POST:/api/v3/labels
639
+ * @secure
640
+ */
641
+ _this.createLabel = function (CreateLabelParams, params) {
642
+ if (params === void 0) { params = {}; }
643
+ return _this.request(__assign({ path: "/api/v3/labels", method: "POST", body: CreateLabelParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
644
+ };
645
+ /**
646
+ * @description Get Label returns information about the selected Label.
647
+ *
648
+ * @name GetLabel
649
+ * @summary Get Label
650
+ * @request GET:/api/v3/labels/{label-public-id}
651
+ * @secure
652
+ */
653
+ _this.getLabel = function (labelPublicId, params) {
654
+ if (params === void 0) { params = {}; }
655
+ return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "GET", secure: true, format: "json" }, params));
656
+ };
657
+ /**
658
+ * @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.
659
+ *
660
+ * @name UpdateLabel
661
+ * @summary Update Label
662
+ * @request PUT:/api/v3/labels/{label-public-id}
663
+ * @secure
664
+ */
665
+ _this.updateLabel = function (labelPublicId, UpdateLabel, params) {
666
+ if (params === void 0) { params = {}; }
667
+ return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "PUT", body: UpdateLabel, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
668
+ };
669
+ /**
670
+ * @description Delete Label can be used to delete any Label.
671
+ *
672
+ * @name DeleteLabel
673
+ * @summary Delete Label
674
+ * @request DELETE:/api/v3/labels/{label-public-id}
675
+ * @secure
676
+ */
677
+ _this.deleteLabel = function (labelPublicId, params) {
678
+ if (params === void 0) { params = {}; }
679
+ return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "DELETE", secure: true }, params));
680
+ };
681
+ /**
682
+ * @description List all of the Epics with the Label.
683
+ *
684
+ * @name ListLabelEpics
685
+ * @summary List Label Epics
686
+ * @request GET:/api/v3/labels/{label-public-id}/epics
687
+ * @secure
688
+ */
689
+ _this.listLabelEpics = function (labelPublicId, params) {
690
+ if (params === void 0) { params = {}; }
691
+ return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId + "/epics", method: "GET", secure: true, format: "json" }, params));
692
+ };
693
+ /**
694
+ * @description List all of the Stories with the Label.
695
+ *
696
+ * @name ListLabelStories
697
+ * @summary List Label Stories
698
+ * @request GET:/api/v3/labels/{label-public-id}/stories
699
+ * @secure
700
+ */
701
+ _this.listLabelStories = function (labelPublicId, GetLabelStories, params) {
702
+ if (params === void 0) { params = {}; }
703
+ return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId + "/stories", method: "GET", body: GetLabelStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
704
+ };
705
+ /**
706
+ * @description List Linked Files returns a list of all Linked-Files and their attributes.
707
+ *
708
+ * @name ListLinkedFiles
709
+ * @summary List Linked Files
710
+ * @request GET:/api/v3/linked-files
711
+ * @secure
712
+ */
713
+ _this.listLinkedFiles = function (params) {
714
+ if (params === void 0) { params = {}; }
715
+ return _this.request(__assign({ path: "/api/v3/linked-files", method: "GET", secure: true, format: "json" }, params));
716
+ };
717
+ /**
718
+ * @description Create Linked File allows you to create a new Linked File in Shortcut.
719
+ *
720
+ * @name CreateLinkedFile
721
+ * @summary Create Linked File
722
+ * @request POST:/api/v3/linked-files
723
+ * @secure
724
+ */
725
+ _this.createLinkedFile = function (CreateLinkedFile, params) {
726
+ if (params === void 0) { params = {}; }
727
+ return _this.request(__assign({ path: "/api/v3/linked-files", method: "POST", body: CreateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
728
+ };
729
+ /**
730
+ * @description Get File returns information about the selected Linked File.
731
+ *
732
+ * @name GetLinkedFile
733
+ * @summary Get Linked File
734
+ * @request GET:/api/v3/linked-files/{linked-file-public-id}
735
+ * @secure
736
+ */
737
+ _this.getLinkedFile = function (linkedFilePublicId, params) {
738
+ if (params === void 0) { params = {}; }
739
+ return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "GET", secure: true, format: "json" }, params));
740
+ };
741
+ /**
742
+ * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
743
+ *
744
+ * @name UpdateLinkedFile
745
+ * @summary Update Linked File
746
+ * @request PUT:/api/v3/linked-files/{linked-file-public-id}
747
+ * @secure
748
+ */
749
+ _this.updateLinkedFile = function (linkedFilePublicId, UpdateLinkedFile, params) {
750
+ if (params === void 0) { params = {}; }
751
+ return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "PUT", body: UpdateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
752
+ };
753
+ /**
754
+ * @description Delete Linked File can be used to delete any previously attached Linked-File.
755
+ *
756
+ * @name DeleteLinkedFile
757
+ * @summary Delete Linked File
758
+ * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
759
+ * @secure
760
+ */
761
+ _this.deleteLinkedFile = function (linkedFilePublicId, params) {
762
+ if (params === void 0) { params = {}; }
763
+ return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "DELETE", secure: true }, params));
764
+ };
765
+ /**
766
+ * @description Returns information about the authenticated member.
767
+ *
768
+ * @name GetCurrentMemberInfo
769
+ * @summary Get Current Member Info
770
+ * @request GET:/api/v3/member
771
+ * @secure
772
+ */
773
+ _this.getCurrentMemberInfo = function (params) {
774
+ if (params === void 0) { params = {}; }
775
+ return _this.request(__assign({ path: "/api/v3/member", method: "GET", secure: true, format: "json" }, params));
776
+ };
777
+ /**
778
+ * @description List Members returns information about members of the organization.
779
+ *
780
+ * @name ListMembers
781
+ * @summary List Members
782
+ * @request GET:/api/v3/members
783
+ * @secure
784
+ */
785
+ _this.listMembers = function (ListMembers, params) {
786
+ if (params === void 0) { params = {}; }
787
+ return _this.request(__assign({ path: "/api/v3/members", method: "GET", body: ListMembers, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
788
+ };
789
+ /**
790
+ * @description Returns information about a Member.
791
+ *
792
+ * @name GetMember
793
+ * @summary Get Member
794
+ * @request GET:/api/v3/members/{member-public-id}
795
+ * @secure
796
+ */
797
+ _this.getMember = function (memberPublicId, GetMember, params) {
798
+ if (params === void 0) { params = {}; }
799
+ return _this.request(__assign({ path: "/api/v3/members/" + memberPublicId, method: "GET", body: GetMember, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
800
+ };
801
+ /**
802
+ * @description List Milestones returns a list of all Milestones and their attributes.
803
+ *
804
+ * @name ListMilestones
805
+ * @summary List Milestones
806
+ * @request GET:/api/v3/milestones
807
+ * @secure
808
+ */
809
+ _this.listMilestones = function (params) {
810
+ if (params === void 0) { params = {}; }
811
+ return _this.request(__assign({ path: "/api/v3/milestones", method: "GET", secure: true, format: "json" }, params));
812
+ };
813
+ /**
814
+ * @description Create Milestone allows you to create a new Milestone in Shortcut.
815
+ *
816
+ * @name CreateMilestone
817
+ * @summary Create Milestone
818
+ * @request POST:/api/v3/milestones
819
+ * @secure
820
+ */
821
+ _this.createMilestone = function (CreateMilestone, params) {
822
+ if (params === void 0) { params = {}; }
823
+ return _this.request(__assign({ path: "/api/v3/milestones", method: "POST", body: CreateMilestone, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
824
+ };
825
+ /**
826
+ * @description Get Milestone returns information about a chosen Milestone.
827
+ *
828
+ * @name GetMilestone
829
+ * @summary Get Milestone
830
+ * @request GET:/api/v3/milestones/{milestone-public-id}
831
+ * @secure
832
+ */
833
+ _this.getMilestone = function (milestonePublicId, params) {
834
+ if (params === void 0) { params = {}; }
835
+ return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "GET", secure: true, format: "json" }, params));
836
+ };
837
+ /**
838
+ * @description Update Milestone can be used to update Milestone properties.
839
+ *
840
+ * @name UpdateMilestone
841
+ * @summary Update Milestone
842
+ * @request PUT:/api/v3/milestones/{milestone-public-id}
843
+ * @secure
844
+ */
845
+ _this.updateMilestone = function (milestonePublicId, UpdateMilestone, params) {
846
+ if (params === void 0) { params = {}; }
847
+ return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "PUT", body: UpdateMilestone, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
848
+ };
849
+ /**
850
+ * @description Delete Milestone can be used to delete any Milestone.
851
+ *
852
+ * @name DeleteMilestone
853
+ * @summary Delete Milestone
854
+ * @request DELETE:/api/v3/milestones/{milestone-public-id}
855
+ * @secure
856
+ */
857
+ _this.deleteMilestone = function (milestonePublicId, params) {
858
+ if (params === void 0) { params = {}; }
859
+ return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "DELETE", secure: true }, params));
860
+ };
861
+ /**
862
+ * @description List all of the Epics within the Milestone.
863
+ *
864
+ * @name ListMilestoneEpics
865
+ * @summary List Milestone Epics
866
+ * @request GET:/api/v3/milestones/{milestone-public-id}/epics
867
+ * @secure
868
+ */
869
+ _this.listMilestoneEpics = function (milestonePublicId, params) {
870
+ if (params === void 0) { params = {}; }
871
+ return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId + "/epics", method: "GET", secure: true, format: "json" }, params));
872
+ };
873
+ /**
874
+ * @description List Projects returns a list of all Projects and their attributes.
875
+ *
876
+ * @name ListProjects
877
+ * @summary List Projects
878
+ * @request GET:/api/v3/projects
879
+ * @secure
880
+ */
881
+ _this.listProjects = function (params) {
882
+ if (params === void 0) { params = {}; }
883
+ return _this.request(__assign({ path: "/api/v3/projects", method: "GET", secure: true, format: "json" }, params));
884
+ };
885
+ /**
886
+ * @description Create Project is used to create a new Shortcut Project.
887
+ *
888
+ * @name CreateProject
889
+ * @summary Create Project
890
+ * @request POST:/api/v3/projects
891
+ * @secure
892
+ */
893
+ _this.createProject = function (CreateProject, params) {
894
+ if (params === void 0) { params = {}; }
895
+ return _this.request(__assign({ path: "/api/v3/projects", method: "POST", body: CreateProject, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
896
+ };
897
+ /**
898
+ * @description Get Project returns information about the selected Project.
899
+ *
900
+ * @name GetProject
901
+ * @summary Get Project
902
+ * @request GET:/api/v3/projects/{project-public-id}
903
+ * @secure
904
+ */
905
+ _this.getProject = function (projectPublicId, params) {
906
+ if (params === void 0) { params = {}; }
907
+ return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "GET", secure: true, format: "json" }, params));
908
+ };
909
+ /**
910
+ * @description Update Project can be used to change properties of a Project.
911
+ *
912
+ * @name UpdateProject
913
+ * @summary Update Project
914
+ * @request PUT:/api/v3/projects/{project-public-id}
915
+ * @secure
916
+ */
917
+ _this.updateProject = function (projectPublicId, UpdateProject, params) {
918
+ if (params === void 0) { params = {}; }
919
+ return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "PUT", body: UpdateProject, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
920
+ };
921
+ /**
922
+ * @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.
923
+ *
924
+ * @name DeleteProject
925
+ * @summary Delete Project
926
+ * @request DELETE:/api/v3/projects/{project-public-id}
927
+ * @secure
928
+ */
929
+ _this.deleteProject = function (projectPublicId, params) {
930
+ if (params === void 0) { params = {}; }
931
+ return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "DELETE", secure: true }, params));
932
+ };
933
+ /**
934
+ * @description List Stories returns a list of all Stories in a selected Project and their attributes.
935
+ *
936
+ * @name ListStories
937
+ * @summary List Stories
938
+ * @request GET:/api/v3/projects/{project-public-id}/stories
939
+ * @secure
940
+ */
941
+ _this.listStories = function (projectPublicId, GetProjectStories, params) {
942
+ if (params === void 0) { params = {}; }
943
+ return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId + "/stories", method: "GET", body: GetProjectStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
944
+ };
945
+ /**
946
+ * @description List Repositories returns a list of all Repositories and their attributes.
947
+ *
948
+ * @name ListRepositories
949
+ * @summary List Repositories
950
+ * @request GET:/api/v3/repositories
951
+ * @secure
952
+ */
953
+ _this.listRepositories = function (params) {
954
+ if (params === void 0) { params = {}; }
955
+ return _this.request(__assign({ path: "/api/v3/repositories", method: "GET", secure: true, format: "json" }, params));
956
+ };
957
+ /**
958
+ * @description Get Repository returns information about the selected Repository.
959
+ *
960
+ * @name GetRepository
961
+ * @summary Get Repository
962
+ * @request GET:/api/v3/repositories/{repo-public-id}
963
+ * @secure
964
+ */
965
+ _this.getRepository = function (repoPublicId, params) {
966
+ if (params === void 0) { params = {}; }
967
+ return _this.request(__assign({ path: "/api/v3/repositories/" + repoPublicId, method: "GET", secure: true, format: "json" }, params));
968
+ };
969
+ /**
970
+ * @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.
971
+ *
972
+ * @name Search
973
+ * @summary Search
974
+ * @request GET:/api/v3/search
975
+ * @secure
976
+ */
977
+ _this.search = function (Search, params) {
978
+ if (params === void 0) { params = {}; }
979
+ return _this.request(__assign({ path: "/api/v3/search", method: "GET", body: Search, secure: true, format: "json" }, params));
980
+ };
981
+ /**
982
+ * @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.
983
+ *
984
+ * @name SearchEpics
985
+ * @summary Search Epics
986
+ * @request GET:/api/v3/search/epics
987
+ * @secure
988
+ */
989
+ _this.searchEpics = function (Search, params) {
990
+ if (params === void 0) { params = {}; }
991
+ return _this.request(__assign({ path: "/api/v3/search/epics", method: "GET", body: Search, secure: true, format: "json" }, params));
992
+ };
993
+ /**
994
+ * @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.
995
+ *
996
+ * @name SearchStories
997
+ * @summary Search Stories
998
+ * @request GET:/api/v3/search/stories
999
+ * @secure
1000
+ */
1001
+ _this.searchStories = function (Search, params) {
1002
+ if (params === void 0) { params = {}; }
1003
+ return _this.request(__assign({ path: "/api/v3/search/stories", method: "GET", body: Search, secure: true, format: "json" }, params));
1004
+ };
1005
+ /**
1006
+ * @description Create Story is used to add a new story to your Shortcut.
1007
+ *
1008
+ * @name CreateStory
1009
+ * @summary Create Story
1010
+ * @request POST:/api/v3/stories
1011
+ * @secure
1012
+ */
1013
+ _this.createStory = function (CreateStoryParams, params) {
1014
+ if (params === void 0) { params = {}; }
1015
+ return _this.request(__assign({ path: "/api/v3/stories", method: "POST", body: CreateStoryParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1016
+ };
1017
+ /**
1018
+ * @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://shortcut.com/api/#create-story).
1019
+ *
1020
+ * @name CreateMultipleStories
1021
+ * @summary Create Multiple Stories
1022
+ * @request POST:/api/v3/stories/bulk
1023
+ * @secure
1024
+ */
1025
+ _this.createMultipleStories = function (CreateStories, params) {
1026
+ if (params === void 0) { params = {}; }
1027
+ return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "POST", body: CreateStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1028
+ };
1029
+ /**
1030
+ * @description Update Multiple Stories allows you to make changes to numerous stories at once.
1031
+ *
1032
+ * @name UpdateMultipleStories
1033
+ * @summary Update Multiple Stories
1034
+ * @request PUT:/api/v3/stories/bulk
1035
+ * @secure
1036
+ */
1037
+ _this.updateMultipleStories = function (UpdateStories, params) {
1038
+ if (params === void 0) { params = {}; }
1039
+ return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "PUT", body: UpdateStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1040
+ };
1041
+ /**
1042
+ * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
1043
+ *
1044
+ * @name DeleteMultipleStories
1045
+ * @summary Delete Multiple Stories
1046
+ * @request DELETE:/api/v3/stories/bulk
1047
+ * @secure
1048
+ */
1049
+ _this.deleteMultipleStories = function (DeleteStories, params) {
1050
+ if (params === void 0) { params = {}; }
1051
+ return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "DELETE", body: DeleteStories, secure: true, type: http_client_1.ContentType.Json }, params));
1052
+ };
1053
+ /**
1054
+ * @description Search Stories lets you search Stories based on desired parameters.
1055
+ *
1056
+ * @name SearchStoriesOld
1057
+ * @summary Search Stories (Old)
1058
+ * @request POST:/api/v3/stories/search
1059
+ * @secure
1060
+ */
1061
+ _this.searchStoriesOld = function (SearchStories, params) {
1062
+ if (params === void 0) { params = {}; }
1063
+ return _this.request(__assign({ path: "/api/v3/stories/search", method: "POST", body: SearchStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1064
+ };
1065
+ /**
1066
+ * @description Get Story returns information about a chosen Story.
1067
+ *
1068
+ * @name GetStory
1069
+ * @summary Get Story
1070
+ * @request GET:/api/v3/stories/{story-public-id}
1071
+ * @secure
1072
+ */
1073
+ _this.getStory = function (storyPublicId, params) {
1074
+ if (params === void 0) { params = {}; }
1075
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId, method: "GET", secure: true, format: "json" }, params));
1076
+ };
1077
+ /**
1078
+ * @description Update Story can be used to update Story properties.
1079
+ *
1080
+ * @name UpdateStory
1081
+ * @summary Update Story
1082
+ * @request PUT:/api/v3/stories/{story-public-id}
1083
+ * @secure
1084
+ */
1085
+ _this.updateStory = function (storyPublicId, UpdateStory, params) {
1086
+ if (params === void 0) { params = {}; }
1087
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId, method: "PUT", body: UpdateStory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1088
+ };
1089
+ /**
1090
+ * @description Delete Story can be used to delete any Story.
1091
+ *
1092
+ * @name DeleteStory
1093
+ * @summary Delete Story
1094
+ * @request DELETE:/api/v3/stories/{story-public-id}
1095
+ * @secure
1096
+ */
1097
+ _this.deleteStory = function (storyPublicId, params) {
1098
+ if (params === void 0) { params = {}; }
1099
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId, method: "DELETE", secure: true }, params));
1100
+ };
1101
+ /**
1102
+ * @description Create Comment allows you to create a Comment on any Story.
1103
+ *
1104
+ * @name CreateStoryComment
1105
+ * @summary Create Story Comment
1106
+ * @request POST:/api/v3/stories/{story-public-id}/comments
1107
+ * @secure
1108
+ */
1109
+ _this.createStoryComment = function (storyPublicId, CreateStoryComment, params) {
1110
+ if (params === void 0) { params = {}; }
1111
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments", method: "POST", body: CreateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1112
+ };
1113
+ /**
1114
+ * @description Get Comment is used to get Comment information.
1115
+ *
1116
+ * @name GetStoryComment
1117
+ * @summary Get Story Comment
1118
+ * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1119
+ * @secure
1120
+ */
1121
+ _this.getStoryComment = function (storyPublicId, commentPublicId, params) {
1122
+ if (params === void 0) { params = {}; }
1123
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "GET", secure: true, format: "json" }, params));
1124
+ };
1125
+ /**
1126
+ * @description Update Comment replaces the text of the existing Comment.
1127
+ *
1128
+ * @name UpdateStoryComment
1129
+ * @summary Update Story Comment
1130
+ * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1131
+ * @secure
1132
+ */
1133
+ _this.updateStoryComment = function (storyPublicId, commentPublicId, UpdateStoryComment, params) {
1134
+ if (params === void 0) { params = {}; }
1135
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "PUT", body: UpdateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1136
+ };
1137
+ /**
1138
+ * @description Delete a Comment from any story.
1139
+ *
1140
+ * @name DeleteStoryComment
1141
+ * @summary Delete Story Comment
1142
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1143
+ * @secure
1144
+ */
1145
+ _this.deleteStoryComment = function (storyPublicId, commentPublicId, params) {
1146
+ if (params === void 0) { params = {}; }
1147
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "DELETE", secure: true }, params));
1148
+ };
1149
+ /**
1150
+ * @description Create a reaction to a story comment.
1151
+ *
1152
+ * @name CreateStoryReaction
1153
+ * @summary Create Story Reaction
1154
+ * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1155
+ * @secure
1156
+ */
1157
+ _this.createStoryReaction = function (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params) {
1158
+ if (params === void 0) { params = {}; }
1159
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId + "/reactions", method: "POST", body: CreateOrDeleteStoryReaction, secure: true, format: "json" }, params));
1160
+ };
1161
+ /**
1162
+ * @description Delete a reaction from any story comment.
1163
+ *
1164
+ * @name DeleteStoryReaction
1165
+ * @summary Delete Story Reaction
1166
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1167
+ * @secure
1168
+ */
1169
+ _this.deleteStoryReaction = function (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params) {
1170
+ if (params === void 0) { params = {}; }
1171
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId + "/reactions", method: "DELETE", body: CreateOrDeleteStoryReaction, secure: true }, params));
1172
+ };
1173
+ /**
1174
+ * No description
1175
+ *
1176
+ * @name StoryHistory
1177
+ * @summary Story History
1178
+ * @request GET:/api/v3/stories/{story-public-id}/history
1179
+ * @secure
1180
+ */
1181
+ _this.storyHistory = function (storyPublicId, params) {
1182
+ if (params === void 0) { params = {}; }
1183
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/history", method: "GET", secure: true, format: "json" }, params));
1184
+ };
1185
+ /**
1186
+ * @description Create Task is used to create a new task in a Story.
1187
+ *
1188
+ * @name CreateTask
1189
+ * @summary Create Task
1190
+ * @request POST:/api/v3/stories/{story-public-id}/tasks
1191
+ * @secure
1192
+ */
1193
+ _this.createTask = function (storyPublicId, CreateTask, params) {
1194
+ if (params === void 0) { params = {}; }
1195
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks", method: "POST", body: CreateTask, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1196
+ };
1197
+ /**
1198
+ * @description Returns information about a chosen Task.
1199
+ *
1200
+ * @name GetTask
1201
+ * @summary Get Task
1202
+ * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1203
+ * @secure
1204
+ */
1205
+ _this.getTask = function (storyPublicId, taskPublicId, params) {
1206
+ if (params === void 0) { params = {}; }
1207
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "GET", secure: true, format: "json" }, params));
1208
+ };
1209
+ /**
1210
+ * @description Update Task can be used to update Task properties.
1211
+ *
1212
+ * @name UpdateTask
1213
+ * @summary Update Task
1214
+ * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1215
+ * @secure
1216
+ */
1217
+ _this.updateTask = function (storyPublicId, taskPublicId, UpdateTask, params) {
1218
+ if (params === void 0) { params = {}; }
1219
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "PUT", body: UpdateTask, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1220
+ };
1221
+ /**
1222
+ * @description Delete Task can be used to delete any previously created Task on a Story.
1223
+ *
1224
+ * @name DeleteTask
1225
+ * @summary Delete Task
1226
+ * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1227
+ * @secure
1228
+ */
1229
+ _this.deleteTask = function (storyPublicId, taskPublicId, params) {
1230
+ if (params === void 0) { params = {}; }
1231
+ return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "DELETE", secure: true }, params));
1232
+ };
1233
+ /**
1234
+ * @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”
1235
+ *
1236
+ * @name CreateStoryLink
1237
+ * @summary Create Story Link
1238
+ * @request POST:/api/v3/story-links
1239
+ * @secure
1240
+ */
1241
+ _this.createStoryLink = function (CreateStoryLink, params) {
1242
+ if (params === void 0) { params = {}; }
1243
+ return _this.request(__assign({ path: "/api/v3/story-links", method: "POST", body: CreateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1244
+ };
1245
+ /**
1246
+ * @description Returns the stories and their relationship for the given Story Link.
1247
+ *
1248
+ * @name GetStoryLink
1249
+ * @summary Get Story Link
1250
+ * @request GET:/api/v3/story-links/{story-link-public-id}
1251
+ * @secure
1252
+ */
1253
+ _this.getStoryLink = function (storyLinkPublicId, params) {
1254
+ if (params === void 0) { params = {}; }
1255
+ return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "GET", secure: true, format: "json" }, params));
1256
+ };
1257
+ /**
1258
+ * @description Updates the stories and/or the relationship for the given Story Link.
1259
+ *
1260
+ * @name UpdateStoryLink
1261
+ * @summary Update Story Link
1262
+ * @request PUT:/api/v3/story-links/{story-link-public-id}
1263
+ * @secure
1264
+ */
1265
+ _this.updateStoryLink = function (storyLinkPublicId, UpdateStoryLink, params) {
1266
+ if (params === void 0) { params = {}; }
1267
+ return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "PUT", body: UpdateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
1268
+ };
1269
+ /**
1270
+ * @description Removes the relationship between the stories for the given Story Link.
1271
+ *
1272
+ * @name DeleteStoryLink
1273
+ * @summary Delete Story Link
1274
+ * @request DELETE:/api/v3/story-links/{story-link-public-id}
1275
+ * @secure
1276
+ */
1277
+ _this.deleteStoryLink = function (storyLinkPublicId, params) {
1278
+ if (params === void 0) { params = {}; }
1279
+ return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "DELETE", secure: true }, params));
1280
+ };
1281
+ /**
1282
+ * @description List Workflows returns a list of all Workflows in the organization.
1283
+ *
1284
+ * @name ListWorkflows
1285
+ * @summary List Workflows
1286
+ * @request GET:/api/v3/workflows
1287
+ * @secure
1288
+ */
1289
+ _this.listWorkflows = function (params) {
1290
+ if (params === void 0) { params = {}; }
1291
+ return _this.request(__assign({ path: "/api/v3/workflows", method: "GET", secure: true, format: "json" }, params));
1292
+ };
1293
+ /**
1294
+ * @description Get Workflow returns information about a chosen Workflow.
1295
+ *
1296
+ * @name GetWorkflow
1297
+ * @summary Get Workflow
1298
+ * @request GET:/api/v3/workflows/{workflow-public-id}
1299
+ * @secure
1300
+ */
1301
+ _this.getWorkflow = function (workflowPublicId, params) {
1302
+ if (params === void 0) { params = {}; }
1303
+ return _this.request(__assign({ path: "/api/v3/workflows/" + workflowPublicId, method: "GET", secure: true, format: "json" }, params));
1304
+ };
1305
+ return _this;
1306
+ }
1307
+ return Api;
1308
+ }(http_client_1.HttpClient));
1309
+ exports.Api = Api;