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