@useshortcut/client 1.1.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,1042 +1,1435 @@
1
- import { Category, CreateCategory, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, EntityTemplate, Epic, EpicSearchResults, EpicSlim, EpicWorkflow, GetEpicStories, GetExternalLinkStoriesParams, GetIterationStories, GetLabelStories, GetMember, GetProjectStories, Group, History, Iteration, IterationSearchResults, IterationSlim, Label, LinkedFile, ListEpics, ListGroupStories, ListLabels, ListMembers, Member, MemberInfo, Milestone, MilestoneSearchResults, Project, Repository, Search, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateIteration, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from './data-contracts';
2
- import { HttpClient, RequestParams } from './http-client';
1
+ import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
2
+ import { HttpClient, RequestParams } from "./http-client.js";
3
+ import * as axios0 from "axios";
4
+
5
+ //#region src/generated/Api.d.ts
6
+
3
7
  /**
4
8
  * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
5
9
  * @private
6
10
  */
7
- export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
8
- /**
9
- * @description List Categories returns a list of all Categories and their attributes.
10
- *
11
- * @name ListCategories
12
- * @summary List Categories
13
- * @request GET:/api/v3/categories
14
- * @secure
15
- */
16
- listCategories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Category[], any>>;
17
- /**
18
- * @description Create Category allows you to create a new Category in Shortcut.
19
- *
20
- * @name CreateCategory
21
- * @summary Create Category
22
- * @request POST:/api/v3/categories
23
- * @secure
24
- */
25
- createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
26
- /**
27
- * @description Get Category returns information about the selected Category.
28
- *
29
- * @name GetCategory
30
- * @summary Get Category
31
- * @request GET:/api/v3/categories/{category-public-id}
32
- * @secure
33
- */
34
- getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
35
- /**
36
- * @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.
37
- *
38
- * @name UpdateCategory
39
- * @summary Update Category
40
- * @request PUT:/api/v3/categories/{category-public-id}
41
- * @secure
42
- */
43
- updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
44
- /**
45
- * @description Delete Category can be used to delete any Category.
46
- *
47
- * @name DeleteCategory
48
- * @summary Delete Category
49
- * @request DELETE:/api/v3/categories/{category-public-id}
50
- * @secure
51
- */
52
- deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
53
- /**
54
- * @description List Category Milestones returns a list of all Milestones with the Category.
55
- *
56
- * @name ListCategoryMilestones
57
- * @summary List Category Milestones
58
- * @request GET:/api/v3/categories/{category-public-id}/milestones
59
- * @secure
60
- */
61
- listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
62
- /**
63
- * No description
64
- *
65
- * @name ListCustomFields
66
- * @summary List Custom Fields
67
- * @request GET:/api/v3/custom-fields
68
- * @secure
69
- */
70
- listCustomFields: (params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField[], any>>;
71
- /**
72
- * No description
73
- *
74
- * @name GetCustomField
75
- * @summary Get Custom Field
76
- * @request GET:/api/v3/custom-fields/{custom-field-public-id}
77
- * @secure
78
- */
79
- getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
80
- /**
81
- * @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'}).
82
- *
83
- * @name UpdateCustomField
84
- * @summary Update Custom Field
85
- * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
86
- * @secure
87
- */
88
- updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
89
- /**
90
- * No description
91
- *
92
- * @name DeleteCustomField
93
- * @summary Delete Custom Field
94
- * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
95
- * @secure
96
- */
97
- deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
98
- /**
99
- * @description List all the entity templates for the Workspace.
100
- *
101
- * @name ListEntityTemplates
102
- * @summary List Entity Templates
103
- * @request GET:/api/v3/entity-templates
104
- * @secure
105
- */
106
- listEntityTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate[], any>>;
107
- /**
108
- * @description Create a new entity template for the Workspace.
109
- *
110
- * @name CreateEntityTemplate
111
- * @summary Create Entity Template
112
- * @request POST:/api/v3/entity-templates
113
- * @secure
114
- */
115
- createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
116
- /**
117
- * @description Disables the Story Template feature for the Workspace.
118
- *
119
- * @name DisableStoryTemplates
120
- * @summary Disable Story Templates
121
- * @request PUT:/api/v3/entity-templates/disable
122
- * @secure
123
- */
124
- disableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
125
- /**
126
- * @description Enables the Story Template feature for the Workspace.
127
- *
128
- * @name EnableStoryTemplates
129
- * @summary Enable Story Templates
130
- * @request PUT:/api/v3/entity-templates/enable
131
- * @secure
132
- */
133
- enableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
134
- /**
135
- * @description Get Entity Template returns information about a given entity template.
136
- *
137
- * @name GetEntityTemplate
138
- * @summary Get Entity Template
139
- * @request GET:/api/v3/entity-templates/{entity-template-public-id}
140
- * @secure
141
- */
142
- getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
143
- /**
144
- * @description Update an entity template's name or its contents.
145
- *
146
- * @name UpdateEntityTemplate
147
- * @summary Update Entity Template
148
- * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
149
- * @secure
150
- */
151
- updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
152
- /**
153
- * No description
154
- *
155
- * @name DeleteEntityTemplate
156
- * @summary Delete Entity Template
157
- * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
158
- * @secure
159
- */
160
- deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
161
- /**
162
- * @description Returns the Epic Workflow for the Workspace.
163
- *
164
- * @name GetEpicWorkflow
165
- * @summary Get Epic Workflow
166
- * @request GET:/api/v3/epic-workflow
167
- * @secure
168
- */
169
- getEpicWorkflow: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicWorkflow, any>>;
170
- /**
171
- * @description List Epics returns a list of all Epics and their attributes.
172
- *
173
- * @name ListEpics
174
- * @summary List Epics
175
- * @request GET:/api/v3/epics
176
- * @secure
177
- */
178
- listEpics: (ListEpics: ListEpics, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
179
- /**
180
- * @description Create Epic allows you to create a new Epic in Shortcut.
181
- *
182
- * @name CreateEpic
183
- * @summary Create Epic
184
- * @request POST:/api/v3/epics
185
- * @secure
186
- */
187
- createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
188
- /**
189
- * @description Get Epic returns information about the selected Epic.
190
- *
191
- * @name GetEpic
192
- * @summary Get Epic
193
- * @request GET:/api/v3/epics/{epic-public-id}
194
- * @secure
195
- */
196
- getEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
197
- /**
198
- * @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.
199
- *
200
- * @name UpdateEpic
201
- * @summary Update Epic
202
- * @request PUT:/api/v3/epics/{epic-public-id}
203
- * @secure
204
- */
205
- updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
206
- /**
207
- * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
208
- *
209
- * @name DeleteEpic
210
- * @summary Delete Epic
211
- * @request DELETE:/api/v3/epics/{epic-public-id}
212
- * @secure
213
- */
214
- deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
215
- /**
216
- * @description Get a list of all Comments on an Epic.
217
- *
218
- * @name ListEpicComments
219
- * @summary List Epic Comments
220
- * @request GET:/api/v3/epics/{epic-public-id}/comments
221
- * @secure
222
- */
223
- listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment[], any>>;
224
- /**
225
- * @description This endpoint allows you to create a threaded Comment on an Epic.
226
- *
227
- * @name CreateEpicComment
228
- * @summary Create Epic Comment
229
- * @request POST:/api/v3/epics/{epic-public-id}/comments
230
- * @secure
231
- */
232
- createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
233
- /**
234
- * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
235
- *
236
- * @name CreateEpicCommentComment
237
- * @summary Create Epic Comment Comment
238
- * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
239
- * @secure
240
- */
241
- createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
242
- /**
243
- * @description This endpoint returns information about the selected Epic Comment.
244
- *
245
- * @name GetEpicComment
246
- * @summary Get Epic Comment
247
- * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
248
- * @secure
249
- */
250
- getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
251
- /**
252
- * @description This endpoint allows you to update a threaded Comment on an Epic.
253
- *
254
- * @name UpdateEpicComment
255
- * @summary Update Epic Comment
256
- * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
257
- * @secure
258
- */
259
- updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
260
- /**
261
- * @description This endpoint allows you to delete a Comment from an Epic.
262
- *
263
- * @name DeleteEpicComment
264
- * @summary Delete Epic Comment
265
- * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
266
- * @secure
267
- */
268
- deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
269
- /**
270
- * @description Get a list of all Stories in an Epic.
271
- *
272
- * @name ListEpicStories
273
- * @summary List Epic Stories
274
- * @request GET:/api/v3/epics/{epic-public-id}/stories
275
- * @secure
276
- */
277
- listEpicStories: (epicPublicId: number, GetEpicStories: GetEpicStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
278
- /**
279
- * @description This endpoint allows you to unlink a productboard epic.
280
- *
281
- * @name UnlinkProductboardFromEpic
282
- * @summary Unlink Productboard from Epic
283
- * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
284
- * @secure
285
- */
286
- unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
287
- /**
288
- * @description Get Stories which have a given External Link associated with them.
289
- *
290
- * @name GetExternalLinkStories
291
- * @summary Get External Link Stories
292
- * @request GET:/api/v3/external-link/stories
293
- * @secure
294
- */
295
- getExternalLinkStories: (GetExternalLinkStoriesParams: GetExternalLinkStoriesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
296
- /**
297
- * @description List Files returns a list of all UploadedFiles in the workspace.
298
- *
299
- * @name ListFiles
300
- * @summary List Files
301
- * @request GET:/api/v3/files
302
- * @secure
303
- */
304
- listFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
305
- /**
306
- * @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.
307
- *
308
- * @name UploadFiles
309
- * @summary Upload Files
310
- * @request POST:/api/v3/files
311
- * @secure
312
- */
313
- uploadFiles: (data: {
314
- /**
315
- * The story ID that these files will be associated with.
316
- * @format int64
317
- */
318
- story_id?: number;
319
- /**
320
- * A file upload. At least one is required.
321
- * @format binary
322
- */
323
- file0: File;
324
- /**
325
- * Optional additional files.
326
- * @format binary
327
- */
328
- file1?: File;
329
- /**
330
- * Optional additional files.
331
- * @format binary
332
- */
333
- file2?: File;
334
- /**
335
- * Optional additional files.
336
- * @format binary
337
- */
338
- file3?: File;
339
- }, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
340
- /**
341
- * @description Get File returns information about the selected UploadedFile.
342
- *
343
- * @name GetFile
344
- * @summary Get File
345
- * @request GET:/api/v3/files/{file-public-id}
346
- * @secure
347
- */
348
- getFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
349
- /**
350
- * @description Update File updates the properties of an UploadedFile (but not its content).
351
- *
352
- * @name UpdateFile
353
- * @summary Update File
354
- * @request PUT:/api/v3/files/{file-public-id}
355
- * @secure
356
- */
357
- updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
358
- /**
359
- * @description Delete File deletes a previously uploaded file.
360
- *
361
- * @name DeleteFile
362
- * @summary Delete File
363
- * @request DELETE:/api/v3/files/{file-public-id}
364
- * @secure
365
- */
366
- deleteFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
367
- /**
368
- * @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.
369
- *
370
- * @name ListGroups
371
- * @summary List Groups
372
- * @request GET:/api/v3/groups
373
- * @secure
374
- */
375
- listGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Group[], any>>;
376
- /**
377
- * No description
378
- *
379
- * @name CreateGroup
380
- * @summary Create Group
381
- * @request POST:/api/v3/groups
382
- * @secure
383
- */
384
- createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
385
- /**
386
- * @description Disables Groups for the current workspace2
387
- *
388
- * @name DisableGroups
389
- * @summary Disable Groups
390
- * @request PUT:/api/v3/groups/disable
391
- * @secure
392
- */
393
- disableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
394
- /**
395
- * @description Enables Groups for the current workspace2
396
- *
397
- * @name EnableGroups
398
- * @summary Enable Groups
399
- * @request PUT:/api/v3/groups/enable
400
- * @secure
401
- */
402
- enableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
403
- /**
404
- * No description
405
- *
406
- * @name GetGroup
407
- * @summary Get Group
408
- * @request GET:/api/v3/groups/{group-public-id}
409
- * @secure
410
- */
411
- getGroup: (groupPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
412
- /**
413
- * No description
414
- *
415
- * @name UpdateGroup
416
- * @summary Update Group
417
- * @request PUT:/api/v3/groups/{group-public-id}
418
- * @secure
419
- */
420
- updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
421
- /**
422
- * @description List the Stories assigned to the Group. (By default, limited to 1,000).
423
- *
424
- * @name ListGroupStories
425
- * @summary List Group Stories
426
- * @request GET:/api/v3/groups/{group-public-id}/stories
427
- * @secure
428
- */
429
- listGroupStories: (groupPublicId: string, ListGroupStories: ListGroupStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
430
- /**
431
- * No description
432
- *
433
- * @name ListIterations
434
- * @summary List Iterations
435
- * @request GET:/api/v3/iterations
436
- * @secure
437
- */
438
- listIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSlim[], any>>;
439
- /**
440
- * No description
441
- *
442
- * @name CreateIteration
443
- * @summary Create Iteration
444
- * @request POST:/api/v3/iterations
445
- * @secure
446
- */
447
- createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
448
- /**
449
- * @description Disables Iterations for the current workspace
450
- *
451
- * @name DisableIterations
452
- * @summary Disable Iterations
453
- * @request PUT:/api/v3/iterations/disable
454
- * @secure
455
- */
456
- disableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
457
- /**
458
- * @description Enables Iterations for the current workspace
459
- *
460
- * @name EnableIterations
461
- * @summary Enable Iterations
462
- * @request PUT:/api/v3/iterations/enable
463
- * @secure
464
- */
465
- enableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
466
- /**
467
- * No description
468
- *
469
- * @name GetIteration
470
- * @summary Get Iteration
471
- * @request GET:/api/v3/iterations/{iteration-public-id}
472
- * @secure
473
- */
474
- getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
475
- /**
476
- * No description
477
- *
478
- * @name UpdateIteration
479
- * @summary Update Iteration
480
- * @request PUT:/api/v3/iterations/{iteration-public-id}
481
- * @secure
482
- */
483
- updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
484
- /**
485
- * No description
486
- *
487
- * @name DeleteIteration
488
- * @summary Delete Iteration
489
- * @request DELETE:/api/v3/iterations/{iteration-public-id}
490
- * @secure
491
- */
492
- deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
493
- /**
494
- * @description Get a list of all Stories in an Iteration.
495
- *
496
- * @name ListIterationStories
497
- * @summary List Iteration Stories
498
- * @request GET:/api/v3/iterations/{iteration-public-id}/stories
499
- * @secure
500
- */
501
- listIterationStories: (iterationPublicId: number, GetIterationStories: GetIterationStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
502
- /**
503
- * @description List Labels returns a list of all Labels and their attributes.
504
- *
505
- * @name ListLabels
506
- * @summary List Labels
507
- * @request GET:/api/v3/labels
508
- * @secure
509
- */
510
- listLabels: (ListLabels: ListLabels, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label[], any>>;
511
- /**
512
- * @description Create Label allows you to create a new Label in Shortcut.
513
- *
514
- * @name CreateLabel
515
- * @summary Create Label
516
- * @request POST:/api/v3/labels
517
- * @secure
518
- */
519
- createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
520
- /**
521
- * @description Get Label returns information about the selected Label.
522
- *
523
- * @name GetLabel
524
- * @summary Get Label
525
- * @request GET:/api/v3/labels/{label-public-id}
526
- * @secure
527
- */
528
- getLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
529
- /**
530
- * @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.
531
- *
532
- * @name UpdateLabel
533
- * @summary Update Label
534
- * @request PUT:/api/v3/labels/{label-public-id}
535
- * @secure
536
- */
537
- updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
538
- /**
539
- * @description Delete Label can be used to delete any Label.
540
- *
541
- * @name DeleteLabel
542
- * @summary Delete Label
543
- * @request DELETE:/api/v3/labels/{label-public-id}
544
- * @secure
545
- */
546
- deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
547
- /**
548
- * @description List all of the Epics with the Label.
549
- *
550
- * @name ListLabelEpics
551
- * @summary List Label Epics
552
- * @request GET:/api/v3/labels/{label-public-id}/epics
553
- * @secure
554
- */
555
- listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
556
- /**
557
- * @description List all of the Stories with the Label.
558
- *
559
- * @name ListLabelStories
560
- * @summary List Label Stories
561
- * @request GET:/api/v3/labels/{label-public-id}/stories
562
- * @secure
563
- */
564
- listLabelStories: (labelPublicId: number, GetLabelStories: GetLabelStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
565
- /**
566
- * @description List Linked Files returns a list of all Linked-Files and their attributes.
567
- *
568
- * @name ListLinkedFiles
569
- * @summary List Linked Files
570
- * @request GET:/api/v3/linked-files
571
- * @secure
572
- */
573
- listLinkedFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile[], any>>;
574
- /**
575
- * @description Create Linked File allows you to create a new Linked File in Shortcut.
576
- *
577
- * @name CreateLinkedFile
578
- * @summary Create Linked File
579
- * @request POST:/api/v3/linked-files
580
- * @secure
581
- */
582
- createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
583
- /**
584
- * @description Get File returns information about the selected Linked File.
585
- *
586
- * @name GetLinkedFile
587
- * @summary Get Linked File
588
- * @request GET:/api/v3/linked-files/{linked-file-public-id}
589
- * @secure
590
- */
591
- getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
592
- /**
593
- * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
594
- *
595
- * @name UpdateLinkedFile
596
- * @summary Update Linked File
597
- * @request PUT:/api/v3/linked-files/{linked-file-public-id}
598
- * @secure
599
- */
600
- updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
601
- /**
602
- * @description Delete Linked File can be used to delete any previously attached Linked-File.
603
- *
604
- * @name DeleteLinkedFile
605
- * @summary Delete Linked File
606
- * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
607
- * @secure
608
- */
609
- deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
610
- /**
611
- * @description Returns information about the authenticated member.
612
- *
613
- * @name GetCurrentMemberInfo
614
- * @summary Get Current Member Info
615
- * @request GET:/api/v3/member
616
- * @secure
617
- */
618
- getCurrentMemberInfo: (params?: RequestParams) => Promise<import("axios").AxiosResponse<MemberInfo, any>>;
619
- /**
620
- * @description Returns information about members of the Workspace.
621
- *
622
- * @name ListMembers
623
- * @summary List Members
624
- * @request GET:/api/v3/members
625
- * @secure
626
- */
627
- listMembers: (ListMembers: ListMembers, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member[], any>>;
628
- /**
629
- * @description Returns information about a Member.
630
- *
631
- * @name GetMember
632
- * @summary Get Member
633
- * @request GET:/api/v3/members/{member-public-id}
634
- * @secure
635
- */
636
- getMember: (memberPublicId: string, GetMember: GetMember, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member, any>>;
637
- /**
638
- * @description List Milestones returns a list of all Milestones and their attributes.
639
- *
640
- * @name ListMilestones
641
- * @summary List Milestones
642
- * @request GET:/api/v3/milestones
643
- * @secure
644
- */
645
- listMilestones: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
646
- /**
647
- * @description Create Milestone allows you to create a new Milestone in Shortcut.
648
- *
649
- * @name CreateMilestone
650
- * @summary Create Milestone
651
- * @request POST:/api/v3/milestones
652
- * @secure
653
- */
654
- createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
655
- /**
656
- * @description Get Milestone returns information about a chosen Milestone.
657
- *
658
- * @name GetMilestone
659
- * @summary Get Milestone
660
- * @request GET:/api/v3/milestones/{milestone-public-id}
661
- * @secure
662
- */
663
- getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
664
- /**
665
- * @description Update Milestone can be used to update Milestone properties.
666
- *
667
- * @name UpdateMilestone
668
- * @summary Update Milestone
669
- * @request PUT:/api/v3/milestones/{milestone-public-id}
670
- * @secure
671
- */
672
- updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
673
- /**
674
- * @description Delete Milestone can be used to delete any Milestone.
675
- *
676
- * @name DeleteMilestone
677
- * @summary Delete Milestone
678
- * @request DELETE:/api/v3/milestones/{milestone-public-id}
679
- * @secure
680
- */
681
- deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
682
- /**
683
- * @description List all of the Epics within the Milestone.
684
- *
685
- * @name ListMilestoneEpics
686
- * @summary List Milestone Epics
687
- * @request GET:/api/v3/milestones/{milestone-public-id}/epics
688
- * @secure
689
- */
690
- listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
691
- /**
692
- * @description List Projects returns a list of all Projects and their attributes.
693
- *
694
- * @name ListProjects
695
- * @summary List Projects
696
- * @request GET:/api/v3/projects
697
- * @secure
698
- */
699
- listProjects: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Project[], any>>;
700
- /**
701
- * @description Create Project is used to create a new Shortcut Project.
702
- *
703
- * @name CreateProject
704
- * @summary Create Project
705
- * @request POST:/api/v3/projects
706
- * @secure
707
- */
708
- createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
709
- /**
710
- * @description Get Project returns information about the selected Project.
711
- *
712
- * @name GetProject
713
- * @summary Get Project
714
- * @request GET:/api/v3/projects/{project-public-id}
715
- * @secure
716
- */
717
- getProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
718
- /**
719
- * @description Update Project can be used to change properties of a Project.
720
- *
721
- * @name UpdateProject
722
- * @summary Update Project
723
- * @request PUT:/api/v3/projects/{project-public-id}
724
- * @secure
725
- */
726
- updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
727
- /**
728
- * @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.
729
- *
730
- * @name DeleteProject
731
- * @summary Delete Project
732
- * @request DELETE:/api/v3/projects/{project-public-id}
733
- * @secure
734
- */
735
- deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
736
- /**
737
- * @description List Stories returns a list of all Stories in a selected Project and their attributes.
738
- *
739
- * @name ListStories
740
- * @summary List Stories
741
- * @request GET:/api/v3/projects/{project-public-id}/stories
742
- * @secure
743
- */
744
- listStories: (projectPublicId: number, GetProjectStories: GetProjectStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
745
- /**
746
- * @description List Repositories returns a list of all Repositories and their attributes.
747
- *
748
- * @name ListRepositories
749
- * @summary List Repositories
750
- * @request GET:/api/v3/repositories
751
- * @secure
752
- */
753
- listRepositories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository[], any>>;
754
- /**
755
- * @description Get Repository returns information about the selected Repository.
756
- *
757
- * @name GetRepository
758
- * @summary Get Repository
759
- * @request GET:/api/v3/repositories/{repo-public-id}
760
- * @secure
761
- */
762
- getRepository: (repoPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository, any>>;
763
- /**
764
- * @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.
765
- *
766
- * @name Search
767
- * @summary Search
768
- * @request GET:/api/v3/search
769
- * @secure
770
- */
771
- search: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<SearchResults, any>>;
772
- /**
773
- * @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.
774
- *
775
- * @name SearchEpics
776
- * @summary Search Epics
777
- * @request GET:/api/v3/search/epics
778
- * @secure
779
- */
780
- searchEpics: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSearchResults, any>>;
781
- /**
782
- * @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.
783
- *
784
- * @name SearchIterations
785
- * @summary Search Iterations
786
- * @request GET:/api/v3/search/iterations
787
- * @secure
788
- */
789
- searchIterations: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSearchResults, any>>;
790
- /**
791
- * @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.
792
- *
793
- * @name SearchMilestones
794
- * @summary Search Milestones
795
- * @request GET:/api/v3/search/milestones
796
- * @secure
797
- */
798
- searchMilestones: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<MilestoneSearchResults, any>>;
799
- /**
800
- * @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.
801
- *
802
- * @name SearchStories
803
- * @summary Search Stories
804
- * @request GET:/api/v3/search/stories
805
- * @secure
806
- */
807
- searchStories: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySearchResults, any>>;
808
- /**
809
- * @description Create Story is used to add a new story to your Shortcut.
810
- *
811
- * @name CreateStory
812
- * @summary Create Story
813
- * @request POST:/api/v3/stories
814
- * @secure
815
- */
816
- createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
817
- /**
818
- * @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).
819
- *
820
- * @name CreateMultipleStories
821
- * @summary Create Multiple Stories
822
- * @request POST:/api/v3/stories/bulk
823
- * @secure
824
- */
825
- createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
826
- /**
827
- * @description Update Multiple Stories allows you to make changes to numerous stories at once.
828
- *
829
- * @name UpdateMultipleStories
830
- * @summary Update Multiple Stories
831
- * @request PUT:/api/v3/stories/bulk
832
- * @secure
833
- */
834
- updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
835
- /**
836
- * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
837
- *
838
- * @name DeleteMultipleStories
839
- * @summary Delete Multiple Stories
840
- * @request DELETE:/api/v3/stories/bulk
841
- * @secure
842
- */
843
- deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
844
- /**
845
- * @description Search Stories lets you search Stories based on desired parameters.
846
- *
847
- * @name SearchStoriesOld
848
- * @summary Search Stories (Old)
849
- * @request POST:/api/v3/stories/search
850
- * @secure
851
- */
852
- searchStoriesOld: (SearchStories: SearchStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
853
- /**
854
- * @description Get Story returns information about a chosen Story.
855
- *
856
- * @name GetStory
857
- * @summary Get Story
858
- * @request GET:/api/v3/stories/{story-public-id}
859
- * @secure
860
- */
861
- getStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
862
- /**
863
- * @description Update Story can be used to update Story properties.
864
- *
865
- * @name UpdateStory
866
- * @summary Update Story
867
- * @request PUT:/api/v3/stories/{story-public-id}
868
- * @secure
869
- */
870
- updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
871
- /**
872
- * @description Delete Story can be used to delete any Story.
873
- *
874
- * @name DeleteStory
875
- * @summary Delete Story
876
- * @request DELETE:/api/v3/stories/{story-public-id}
877
- * @secure
878
- */
879
- deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
880
- /**
881
- * @description Lists Comments associated with a Story
882
- *
883
- * @name ListStoryComment
884
- * @summary List Story Comment
885
- * @request GET:/api/v3/stories/{story-public-id}/comments
886
- * @secure
887
- */
888
- listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment[], any>>;
889
- /**
890
- * @description Create Comment allows you to create a Comment on any Story.
891
- *
892
- * @name CreateStoryComment
893
- * @summary Create Story Comment
894
- * @request POST:/api/v3/stories/{story-public-id}/comments
895
- * @secure
896
- */
897
- createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
898
- /**
899
- * @description Get Comment is used to get Comment information.
900
- *
901
- * @name GetStoryComment
902
- * @summary Get Story Comment
903
- * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
904
- * @secure
905
- */
906
- getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
907
- /**
908
- * @description Update Comment replaces the text of the existing Comment.
909
- *
910
- * @name UpdateStoryComment
911
- * @summary Update Story Comment
912
- * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
913
- * @secure
914
- */
915
- updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
916
- /**
917
- * @description Delete a Comment from any story.
918
- *
919
- * @name DeleteStoryComment
920
- * @summary Delete Story Comment
921
- * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
922
- * @secure
923
- */
924
- deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
925
- /**
926
- * @description Create a reaction to a story comment.
927
- *
928
- * @name CreateStoryReaction
929
- * @summary Create Story Reaction
930
- * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
931
- * @secure
932
- */
933
- createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryReaction[], any>>;
934
- /**
935
- * @description Delete a reaction from any story comment.
936
- *
937
- * @name DeleteStoryReaction
938
- * @summary Delete Story Reaction
939
- * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
940
- * @secure
941
- */
942
- deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
943
- /**
944
- * No description
945
- *
946
- * @name StoryHistory
947
- * @summary Story History
948
- * @request GET:/api/v3/stories/{story-public-id}/history
949
- * @secure
950
- */
951
- storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<History[], any>>;
952
- /**
953
- * @description Create Task is used to create a new task in a Story.
954
- *
955
- * @name CreateTask
956
- * @summary Create Task
957
- * @request POST:/api/v3/stories/{story-public-id}/tasks
958
- * @secure
959
- */
960
- createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
961
- /**
962
- * @description Returns information about a chosen Task.
963
- *
964
- * @name GetTask
965
- * @summary Get Task
966
- * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
967
- * @secure
968
- */
969
- getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
970
- /**
971
- * @description Update Task can be used to update Task properties.
972
- *
973
- * @name UpdateTask
974
- * @summary Update Task
975
- * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
976
- * @secure
977
- */
978
- updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
979
- /**
980
- * @description Delete Task can be used to delete any previously created Task on a Story.
981
- *
982
- * @name DeleteTask
983
- * @summary Delete Task
984
- * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
985
- * @secure
986
- */
987
- deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
988
- /**
989
- * @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”
990
- *
991
- * @name CreateStoryLink
992
- * @summary Create Story Link
993
- * @request POST:/api/v3/story-links
994
- * @secure
995
- */
996
- createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
997
- /**
998
- * @description Returns the stories and their relationship for the given Story Link.
999
- *
1000
- * @name GetStoryLink
1001
- * @summary Get Story Link
1002
- * @request GET:/api/v3/story-links/{story-link-public-id}
1003
- * @secure
1004
- */
1005
- getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
1006
- /**
1007
- * @description Updates the stories and/or the relationship for the given Story Link.
1008
- *
1009
- * @name UpdateStoryLink
1010
- * @summary Update Story Link
1011
- * @request PUT:/api/v3/story-links/{story-link-public-id}
1012
- * @secure
1013
- */
1014
- updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
1015
- /**
1016
- * @description Removes the relationship between the stories for the given Story Link.
1017
- *
1018
- * @name DeleteStoryLink
1019
- * @summary Delete Story Link
1020
- * @request DELETE:/api/v3/story-links/{story-link-public-id}
1021
- * @secure
1022
- */
1023
- deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
1024
- /**
1025
- * @description Returns a list of all Workflows in the Workspace.
1026
- *
1027
- * @name ListWorkflows
1028
- * @summary List Workflows
1029
- * @request GET:/api/v3/workflows
1030
- * @secure
1031
- */
1032
- listWorkflows: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow[], any>>;
1033
- /**
1034
- * @description Get Workflow returns information about a chosen Workflow.
1035
- *
1036
- * @name GetWorkflow
1037
- * @summary Get Workflow
1038
- * @request GET:/api/v3/workflows/{workflow-public-id}
1039
- * @secure
1040
- */
1041
- getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
11
+ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
12
+ /**
13
+ * @description List Categories returns a list of all Categories and their attributes.
14
+ *
15
+ * @name ListCategories
16
+ * @summary List Categories
17
+ * @request GET:/api/v3/categories
18
+ * @secure
19
+ */
20
+ listCategories: (params?: RequestParams) => Promise<axios0.AxiosResponse<Category[], any>>;
21
+ /**
22
+ * @description Create Category allows you to create a new Category in Shortcut.
23
+ *
24
+ * @name CreateCategory
25
+ * @summary Create Category
26
+ * @request POST:/api/v3/categories
27
+ * @secure
28
+ */
29
+ createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<axios0.AxiosResponse<Category, any>>;
30
+ /**
31
+ * @description Get Category returns information about the selected Category.
32
+ *
33
+ * @name GetCategory
34
+ * @summary Get Category
35
+ * @request GET:/api/v3/categories/{category-public-id}
36
+ * @secure
37
+ */
38
+ getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Category, any>>;
39
+ /**
40
+ * @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.
41
+ *
42
+ * @name UpdateCategory
43
+ * @summary Update Category
44
+ * @request PUT:/api/v3/categories/{category-public-id}
45
+ * @secure
46
+ */
47
+ updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<axios0.AxiosResponse<Category, any>>;
48
+ /**
49
+ * @description Delete Category can be used to delete any Category.
50
+ *
51
+ * @name DeleteCategory
52
+ * @summary Delete Category
53
+ * @request DELETE:/api/v3/categories/{category-public-id}
54
+ * @secure
55
+ */
56
+ deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
57
+ /**
58
+ * @description List Category Milestones returns a list of all Milestones with the Category.
59
+ *
60
+ * @name ListCategoryMilestones
61
+ * @summary List Category Milestones
62
+ * @request GET:/api/v3/categories/{category-public-id}/milestones
63
+ * @secure
64
+ */
65
+ listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone[], any>>;
66
+ /**
67
+ * @description Returns a list of all Objectives with the Category.
68
+ *
69
+ * @name ListCategoryObjectives
70
+ * @summary List Category Objectives
71
+ * @request GET:/api/v3/categories/{category-public-id}/objectives
72
+ * @secure
73
+ */
74
+ listCategoryObjectives: (categoryPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone[], any>>;
75
+ /**
76
+ * No description
77
+ *
78
+ * @name ListCustomFields
79
+ * @summary List Custom Fields
80
+ * @request GET:/api/v3/custom-fields
81
+ * @secure
82
+ */
83
+ listCustomFields: (params?: RequestParams) => Promise<axios0.AxiosResponse<CustomField[], any>>;
84
+ /**
85
+ * No description
86
+ *
87
+ * @name GetCustomField
88
+ * @summary Get Custom Field
89
+ * @request GET:/api/v3/custom-fields/{custom-field-public-id}
90
+ * @secure
91
+ */
92
+ getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<CustomField, any>>;
93
+ /**
94
+ * @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'}).
95
+ *
96
+ * @name UpdateCustomField
97
+ * @summary Update Custom Field
98
+ * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
99
+ * @secure
100
+ */
101
+ updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<axios0.AxiosResponse<CustomField, any>>;
102
+ /**
103
+ * No description
104
+ *
105
+ * @name DeleteCustomField
106
+ * @summary Delete Custom Field
107
+ * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
108
+ * @secure
109
+ */
110
+ deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
111
+ /**
112
+ * @description List Docs returns a list of Doc that the current user can read.
113
+ *
114
+ * @name ListDocs
115
+ * @summary List Docs
116
+ * @request GET:/api/v3/documents
117
+ * @secure
118
+ */
119
+ listDocs: (params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim[], any>>;
120
+ /**
121
+ * @description Creates a new Doc.
122
+ *
123
+ * @name CreateDoc
124
+ * @summary Create Doc
125
+ * @request POST:/api/v3/documents
126
+ * @secure
127
+ */
128
+ createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim, any>>;
129
+ /**
130
+ * @description List all the entity templates for the Workspace.
131
+ *
132
+ * @name ListEntityTemplates
133
+ * @summary List Entity Templates
134
+ * @request GET:/api/v3/entity-templates
135
+ * @secure
136
+ */
137
+ listEntityTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate[], any>>;
138
+ /**
139
+ * @description Create a new entity template for the Workspace.
140
+ *
141
+ * @name CreateEntityTemplate
142
+ * @summary Create Entity Template
143
+ * @request POST:/api/v3/entity-templates
144
+ * @secure
145
+ */
146
+ createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any>>;
147
+ /**
148
+ * @description Disables the Story Template feature for the Workspace.
149
+ *
150
+ * @name DisableStoryTemplates
151
+ * @summary Disable Story Templates
152
+ * @request PUT:/api/v3/entity-templates/disable
153
+ * @secure
154
+ */
155
+ disableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
156
+ /**
157
+ * @description Enables the Story Template feature for the Workspace.
158
+ *
159
+ * @name EnableStoryTemplates
160
+ * @summary Enable Story Templates
161
+ * @request PUT:/api/v3/entity-templates/enable
162
+ * @secure
163
+ */
164
+ enableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
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
+ getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any>>;
174
+ /**
175
+ * @description Update an entity template's name or its contents.
176
+ *
177
+ * @name UpdateEntityTemplate
178
+ * @summary Update Entity Template
179
+ * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
180
+ * @secure
181
+ */
182
+ updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any>>;
183
+ /**
184
+ * No description
185
+ *
186
+ * @name DeleteEntityTemplate
187
+ * @summary Delete Entity Template
188
+ * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
189
+ * @secure
190
+ */
191
+ deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
192
+ /**
193
+ * @description Returns the Epic Workflow for the Workspace.
194
+ *
195
+ * @name GetEpicWorkflow
196
+ * @summary Get Epic Workflow
197
+ * @request GET:/api/v3/epic-workflow
198
+ * @secure
199
+ */
200
+ getEpicWorkflow: (params?: RequestParams) => Promise<axios0.AxiosResponse<EpicWorkflow, any>>;
201
+ /**
202
+ * @description List Epics returns a list of all Epics and their attributes.
203
+ *
204
+ * @name ListEpics
205
+ * @summary List Epics
206
+ * @request GET:/api/v3/epics
207
+ * @secure
208
+ */
209
+ listEpics: (query?: {
210
+ /** A true/false boolean indicating whether to return Epics with their descriptions. */
211
+ includes_description?: boolean;
212
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any>>;
213
+ /**
214
+ * @description Create Epic allows you to create a new Epic in Shortcut.
215
+ *
216
+ * @name CreateEpic
217
+ * @summary Create Epic
218
+ * @request POST:/api/v3/epics
219
+ * @secure
220
+ */
221
+ createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any>>;
222
+ /**
223
+ * @description List Epics with pagination returns a paginated list of Epics and their attributes.
224
+ *
225
+ * @name ListEpicsPaginated
226
+ * @summary List Epics Paginated
227
+ * @request GET:/api/v3/epics/paginated
228
+ * @secure
229
+ */
230
+ listEpicsPaginated: (query?: {
231
+ /** A true/false boolean indicating whether to return Epics with their descriptions. */
232
+ includes_description?: boolean;
233
+ /**
234
+ * The page number to return, starting with 1. Defaults to 1.
235
+ * @format int64
236
+ */
237
+ page?: number;
238
+ /**
239
+ * The number of Epics to return per page. Minimum 1, maximum 250, default 10.
240
+ * @format int64
241
+ */
242
+ page_size?: number;
243
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicPaginatedResults, any>>;
244
+ /**
245
+ * @description Get Epic returns information about the selected Epic.
246
+ *
247
+ * @name GetEpic
248
+ * @summary Get Epic
249
+ * @request GET:/api/v3/epics/{epic-public-id}
250
+ * @secure
251
+ */
252
+ getEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any>>;
253
+ /**
254
+ * @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.
255
+ *
256
+ * @name UpdateEpic
257
+ * @summary Update Epic
258
+ * @request PUT:/api/v3/epics/{epic-public-id}
259
+ * @secure
260
+ */
261
+ updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any>>;
262
+ /**
263
+ * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
264
+ *
265
+ * @name DeleteEpic
266
+ * @summary Delete Epic
267
+ * @request DELETE:/api/v3/epics/{epic-public-id}
268
+ * @secure
269
+ */
270
+ deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
271
+ /**
272
+ * @description Get a list of all Comments on an Epic.
273
+ *
274
+ * @name ListEpicComments
275
+ * @summary List Epic Comments
276
+ * @request GET:/api/v3/epics/{epic-public-id}/comments
277
+ * @secure
278
+ */
279
+ listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment[], any>>;
280
+ /**
281
+ * @description This endpoint allows you to create a threaded Comment on an Epic.
282
+ *
283
+ * @name CreateEpicComment
284
+ * @summary Create Epic Comment
285
+ * @request POST:/api/v3/epics/{epic-public-id}/comments
286
+ * @secure
287
+ */
288
+ createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any>>;
289
+ /**
290
+ * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
291
+ *
292
+ * @name CreateEpicCommentComment
293
+ * @summary Create Epic Comment Comment
294
+ * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
295
+ * @secure
296
+ */
297
+ createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any>>;
298
+ /**
299
+ * @description This endpoint returns information about the selected Epic Comment.
300
+ *
301
+ * @name GetEpicComment
302
+ * @summary Get Epic Comment
303
+ * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
304
+ * @secure
305
+ */
306
+ getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any>>;
307
+ /**
308
+ * @description This endpoint allows you to update a threaded Comment on an Epic.
309
+ *
310
+ * @name UpdateEpicComment
311
+ * @summary Update Epic Comment
312
+ * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
313
+ * @secure
314
+ */
315
+ updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any>>;
316
+ /**
317
+ * @description This endpoint allows you to delete a Comment from an Epic.
318
+ *
319
+ * @name DeleteEpicComment
320
+ * @summary Delete Epic Comment
321
+ * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
322
+ * @secure
323
+ */
324
+ deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
325
+ /**
326
+ * @description Get the current health for the specified Epic.
327
+ *
328
+ * @name GetEpicHealth
329
+ * @summary Get Epic Health
330
+ * @request GET:/api/v3/epics/{epic-public-id}/health
331
+ * @secure
332
+ */
333
+ getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any>>;
334
+ /**
335
+ * @description Create a new health status for the specified Epic.
336
+ *
337
+ * @name CreateEpicHealth
338
+ * @summary Create Epic Health
339
+ * @request POST:/api/v3/epics/{epic-public-id}/health
340
+ * @secure
341
+ */
342
+ createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any>>;
343
+ /**
344
+ * @description List the history of health statuses for the specified Epic, most recent first.
345
+ *
346
+ * @name ListEpicHealths
347
+ * @summary List Epic Healths
348
+ * @request GET:/api/v3/epics/{epic-public-id}/health-history
349
+ * @secure
350
+ */
351
+ listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health[], any>>;
352
+ /**
353
+ * @description Get a list of all Stories in an Epic.
354
+ *
355
+ * @name ListEpicStories
356
+ * @summary List Epic Stories
357
+ * @request GET:/api/v3/epics/{epic-public-id}/stories
358
+ * @secure
359
+ */
360
+ listEpicStories: (epicPublicId: number, query?: {
361
+ /** A true/false boolean indicating whether to return Stories with their descriptions. */
362
+ includes_description?: boolean;
363
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
364
+ /**
365
+ * @description This endpoint allows you to unlink a productboard epic.
366
+ *
367
+ * @name UnlinkProductboardFromEpic
368
+ * @summary Unlink Productboard from Epic
369
+ * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
370
+ * @secure
371
+ */
372
+ unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
373
+ /**
374
+ * @description Get Stories which have a given External Link associated with them.
375
+ *
376
+ * @name GetExternalLinkStories
377
+ * @summary Get External Link Stories
378
+ * @request GET:/api/v3/external-link/stories
379
+ * @secure
380
+ */
381
+ getExternalLinkStories: (query: {
382
+ /**
383
+ * The external link associated with one or more stories.
384
+ * @maxLength 2048
385
+ * @pattern ^https?://.+$
386
+ */
387
+ external_link: string;
388
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
389
+ /**
390
+ * @description List Files returns a list of all UploadedFiles in the workspace.
391
+ *
392
+ * @name ListFiles
393
+ * @summary List Files
394
+ * @request GET:/api/v3/files
395
+ * @secure
396
+ */
397
+ listFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any>>;
398
+ /**
399
+ * @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.
400
+ *
401
+ * @name UploadFiles
402
+ * @summary Upload Files
403
+ * @request POST:/api/v3/files
404
+ * @secure
405
+ */
406
+ uploadFiles: (data: {
407
+ /**
408
+ * The story ID that these files will be associated with.
409
+ * @format int64
410
+ */
411
+ story_id?: number;
412
+ /**
413
+ * A file upload. At least one is required.
414
+ * @format binary
415
+ */
416
+ file0: File;
417
+ /**
418
+ * Optional additional files.
419
+ * @format binary
420
+ */
421
+ file1?: File;
422
+ /**
423
+ * Optional additional files.
424
+ * @format binary
425
+ */
426
+ file2?: File;
427
+ /**
428
+ * Optional additional files.
429
+ * @format binary
430
+ */
431
+ file3?: File;
432
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any>>;
433
+ /**
434
+ * @description Get File returns information about the selected UploadedFile.
435
+ *
436
+ * @name GetFile
437
+ * @summary Get File
438
+ * @request GET:/api/v3/files/{file-public-id}
439
+ * @secure
440
+ */
441
+ getFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any>>;
442
+ /**
443
+ * @description Update File updates the properties of an UploadedFile (but not its content).
444
+ *
445
+ * @name UpdateFile
446
+ * @summary Update File
447
+ * @request PUT:/api/v3/files/{file-public-id}
448
+ * @secure
449
+ */
450
+ updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any>>;
451
+ /**
452
+ * @description Delete File deletes a previously uploaded file.
453
+ *
454
+ * @name DeleteFile
455
+ * @summary Delete File
456
+ * @request DELETE:/api/v3/files/{file-public-id}
457
+ * @secure
458
+ */
459
+ deleteFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
460
+ /**
461
+ * @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.
462
+ *
463
+ * @name ListGroups
464
+ * @summary List Groups
465
+ * @request GET:/api/v3/groups
466
+ * @secure
467
+ */
468
+ listGroups: (params?: RequestParams) => Promise<axios0.AxiosResponse<Group[], any>>;
469
+ /**
470
+ * No description
471
+ *
472
+ * @name CreateGroup
473
+ * @summary Create Group
474
+ * @request POST:/api/v3/groups
475
+ * @secure
476
+ */
477
+ createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any>>;
478
+ /**
479
+ * No description
480
+ *
481
+ * @name GetGroup
482
+ * @summary Get Group
483
+ * @request GET:/api/v3/groups/{group-public-id}
484
+ * @secure
485
+ */
486
+ getGroup: (groupPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any>>;
487
+ /**
488
+ * No description
489
+ *
490
+ * @name UpdateGroup
491
+ * @summary Update Group
492
+ * @request PUT:/api/v3/groups/{group-public-id}
493
+ * @secure
494
+ */
495
+ updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any>>;
496
+ /**
497
+ * @description List the Stories assigned to the Group. (By default, limited to 1,000).
498
+ *
499
+ * @name ListGroupStories
500
+ * @summary List Group Stories
501
+ * @request GET:/api/v3/groups/{group-public-id}/stories
502
+ * @secure
503
+ */
504
+ listGroupStories: (groupPublicId: string, query?: {
505
+ /**
506
+ * The maximum number of results to return. (Defaults to 1000, max 1000)
507
+ * @format int64
508
+ */
509
+ limit?: number;
510
+ /**
511
+ * The offset at which to begin returning results. (Defaults to 0)
512
+ * @format int64
513
+ */
514
+ offset?: number;
515
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
516
+ /**
517
+ * @description Update an existing health status by its ID.
518
+ *
519
+ * @name UpdateHealth
520
+ * @summary Update Health
521
+ * @request PUT:/api/v3/health/{health-public-id}
522
+ * @secure
523
+ */
524
+ updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any>>;
525
+ /**
526
+ * No description
527
+ *
528
+ * @name CreateGenericIntegration
529
+ * @summary Create Generic Integration
530
+ * @request POST:/api/v3/integrations/webhook
531
+ * @secure
532
+ */
533
+ createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
534
+ /**
535
+ * No description
536
+ *
537
+ * @name GetGenericIntegration
538
+ * @summary Get Generic Integration
539
+ * @request GET:/api/v3/integrations/webhook/{integration-public-id}
540
+ * @secure
541
+ */
542
+ getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
543
+ /**
544
+ * No description
545
+ *
546
+ * @name DeleteGenericIntegration
547
+ * @summary Delete Generic Integration
548
+ * @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
549
+ * @secure
550
+ */
551
+ deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
552
+ /**
553
+ * No description
554
+ *
555
+ * @name ListIterations
556
+ * @summary List Iterations
557
+ * @request GET:/api/v3/iterations
558
+ * @secure
559
+ */
560
+ listIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSlim[], any>>;
561
+ /**
562
+ * No description
563
+ *
564
+ * @name CreateIteration
565
+ * @summary Create Iteration
566
+ * @request POST:/api/v3/iterations
567
+ * @secure
568
+ */
569
+ createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any>>;
570
+ /**
571
+ * @description Disables Iterations for the current workspace
572
+ *
573
+ * @name DisableIterations
574
+ * @summary Disable Iterations
575
+ * @request PUT:/api/v3/iterations/disable
576
+ * @secure
577
+ */
578
+ disableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
579
+ /**
580
+ * @description Enables Iterations for the current workspace
581
+ *
582
+ * @name EnableIterations
583
+ * @summary Enable Iterations
584
+ * @request PUT:/api/v3/iterations/enable
585
+ * @secure
586
+ */
587
+ enableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
588
+ /**
589
+ * No description
590
+ *
591
+ * @name GetIteration
592
+ * @summary Get Iteration
593
+ * @request GET:/api/v3/iterations/{iteration-public-id}
594
+ * @secure
595
+ */
596
+ getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any>>;
597
+ /**
598
+ * No description
599
+ *
600
+ * @name UpdateIteration
601
+ * @summary Update Iteration
602
+ * @request PUT:/api/v3/iterations/{iteration-public-id}
603
+ * @secure
604
+ */
605
+ updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any>>;
606
+ /**
607
+ * No description
608
+ *
609
+ * @name DeleteIteration
610
+ * @summary Delete Iteration
611
+ * @request DELETE:/api/v3/iterations/{iteration-public-id}
612
+ * @secure
613
+ */
614
+ deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
615
+ /**
616
+ * @description Get a list of all Stories in an Iteration.
617
+ *
618
+ * @name ListIterationStories
619
+ * @summary List Iteration Stories
620
+ * @request GET:/api/v3/iterations/{iteration-public-id}/stories
621
+ * @secure
622
+ */
623
+ listIterationStories: (iterationPublicId: number, query?: {
624
+ /** A true/false boolean indicating whether to return Stories with their descriptions. */
625
+ includes_description?: boolean;
626
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
627
+ /**
628
+ * @description Get Key Result returns information about a chosen Key Result.
629
+ *
630
+ * @name GetKeyResult
631
+ * @summary Get Key Result
632
+ * @request GET:/api/v3/key-results/{key-result-public-id}
633
+ * @secure
634
+ */
635
+ getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any>>;
636
+ /**
637
+ * @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
638
+ *
639
+ * @name UpdateKeyResult
640
+ * @summary Update Key Result
641
+ * @request PUT:/api/v3/key-results/{key-result-public-id}
642
+ * @secure
643
+ */
644
+ updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any>>;
645
+ /**
646
+ * @description List Labels returns a list of all Labels and their attributes.
647
+ *
648
+ * @name ListLabels
649
+ * @summary List Labels
650
+ * @request GET:/api/v3/labels
651
+ * @secure
652
+ */
653
+ listLabels: (query?: {
654
+ /** A true/false boolean indicating if the slim versions of the Label should be returned. */
655
+ slim?: boolean;
656
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<Label[], any>>;
657
+ /**
658
+ * @description Create Label allows you to create a new Label in Shortcut.
659
+ *
660
+ * @name CreateLabel
661
+ * @summary Create Label
662
+ * @request POST:/api/v3/labels
663
+ * @secure
664
+ */
665
+ createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any>>;
666
+ /**
667
+ * @description Get Label returns information about the selected Label.
668
+ *
669
+ * @name GetLabel
670
+ * @summary Get Label
671
+ * @request GET:/api/v3/labels/{label-public-id}
672
+ * @secure
673
+ */
674
+ getLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any>>;
675
+ /**
676
+ * @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.
677
+ *
678
+ * @name UpdateLabel
679
+ * @summary Update Label
680
+ * @request PUT:/api/v3/labels/{label-public-id}
681
+ * @secure
682
+ */
683
+ updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any>>;
684
+ /**
685
+ * @description Delete Label can be used to delete any Label.
686
+ *
687
+ * @name DeleteLabel
688
+ * @summary Delete Label
689
+ * @request DELETE:/api/v3/labels/{label-public-id}
690
+ * @secure
691
+ */
692
+ deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
693
+ /**
694
+ * @description List all of the Epics with the Label.
695
+ *
696
+ * @name ListLabelEpics
697
+ * @summary List Label Epics
698
+ * @request GET:/api/v3/labels/{label-public-id}/epics
699
+ * @secure
700
+ */
701
+ listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any>>;
702
+ /**
703
+ * @description List all of the Stories with the Label.
704
+ *
705
+ * @name ListLabelStories
706
+ * @summary List Label Stories
707
+ * @request GET:/api/v3/labels/{label-public-id}/stories
708
+ * @secure
709
+ */
710
+ listLabelStories: (labelPublicId: number, query?: {
711
+ /** A true/false boolean indicating whether to return Stories with their descriptions. */
712
+ includes_description?: boolean;
713
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
714
+ /**
715
+ * @description List Linked Files returns a list of all Linked-Files and their attributes.
716
+ *
717
+ * @name ListLinkedFiles
718
+ * @summary List Linked Files
719
+ * @request GET:/api/v3/linked-files
720
+ * @secure
721
+ */
722
+ listLinkedFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile[], any>>;
723
+ /**
724
+ * @description Create Linked File allows you to create a new Linked File in Shortcut.
725
+ *
726
+ * @name CreateLinkedFile
727
+ * @summary Create Linked File
728
+ * @request POST:/api/v3/linked-files
729
+ * @secure
730
+ */
731
+ createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any>>;
732
+ /**
733
+ * @description Get File returns information about the selected Linked File.
734
+ *
735
+ * @name GetLinkedFile
736
+ * @summary Get Linked File
737
+ * @request GET:/api/v3/linked-files/{linked-file-public-id}
738
+ * @secure
739
+ */
740
+ getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any>>;
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
+ updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any>>;
750
+ /**
751
+ * @description Delete Linked File can be used to delete any previously attached Linked-File.
752
+ *
753
+ * @name DeleteLinkedFile
754
+ * @summary Delete Linked File
755
+ * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
756
+ * @secure
757
+ */
758
+ deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
759
+ /**
760
+ * @description Returns information about the authenticated member.
761
+ *
762
+ * @name GetCurrentMemberInfo
763
+ * @summary Get Current Member Info
764
+ * @request GET:/api/v3/member
765
+ * @secure
766
+ */
767
+ getCurrentMemberInfo: (params?: RequestParams) => Promise<axios0.AxiosResponse<MemberInfo, any>>;
768
+ /**
769
+ * @description Returns information about members of the Workspace.
770
+ *
771
+ * @name ListMembers
772
+ * @summary List Members
773
+ * @request GET:/api/v3/members
774
+ * @secure
775
+ */
776
+ listMembers: (query?: {
777
+ /**
778
+ * The unique ID of the Organization to limit the list to.
779
+ * @format uuid
780
+ */
781
+ "org-public-id"?: string;
782
+ /** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
783
+ disabled?: boolean;
784
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<Member[], any>>;
785
+ /**
786
+ * @description Returns information about a Member.
787
+ *
788
+ * @name GetMember
789
+ * @summary Get Member
790
+ * @request GET:/api/v3/members/{member-public-id}
791
+ * @secure
792
+ */
793
+ getMember: (memberPublicId: string, query?: {
794
+ /**
795
+ * The unique ID of the Organization to limit the lookup to.
796
+ * @format uuid
797
+ */
798
+ "org-public-id"?: string;
799
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<Member, any>>;
800
+ /**
801
+ * @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
802
+ *
803
+ * @name ListMilestones
804
+ * @summary List Milestones
805
+ * @request GET:/api/v3/milestones
806
+ * @secure
807
+ */
808
+ listMilestones: (params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone[], any>>;
809
+ /**
810
+ * @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
811
+ *
812
+ * @name CreateMilestone
813
+ * @summary Create Milestone
814
+ * @request POST:/api/v3/milestones
815
+ * @secure
816
+ */
817
+ createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any>>;
818
+ /**
819
+ * @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
820
+ *
821
+ * @name GetMilestone
822
+ * @summary Get Milestone
823
+ * @request GET:/api/v3/milestones/{milestone-public-id}
824
+ * @secure
825
+ */
826
+ getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any>>;
827
+ /**
828
+ * @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
829
+ *
830
+ * @name UpdateMilestone
831
+ * @summary Update Milestone
832
+ * @request PUT:/api/v3/milestones/{milestone-public-id}
833
+ * @secure
834
+ */
835
+ updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any>>;
836
+ /**
837
+ * @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
838
+ *
839
+ * @name DeleteMilestone
840
+ * @summary Delete Milestone
841
+ * @request DELETE:/api/v3/milestones/{milestone-public-id}
842
+ * @secure
843
+ */
844
+ deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
845
+ /**
846
+ * @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
847
+ *
848
+ * @name ListMilestoneEpics
849
+ * @summary List Milestone Epics
850
+ * @request GET:/api/v3/milestones/{milestone-public-id}/epics
851
+ * @secure
852
+ */
853
+ listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any>>;
854
+ /**
855
+ * @description List Objectives returns a list of all Objectives and their attributes.
856
+ *
857
+ * @name ListObjectives
858
+ * @summary List Objectives
859
+ * @request GET:/api/v3/objectives
860
+ * @secure
861
+ */
862
+ listObjectives: (params?: RequestParams) => Promise<axios0.AxiosResponse<Objective[], any>>;
863
+ /**
864
+ * @description Create Objective allows you to create a new Objective in Shortcut.
865
+ *
866
+ * @name CreateObjective
867
+ * @summary Create Objective
868
+ * @request POST:/api/v3/objectives
869
+ * @secure
870
+ */
871
+ createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any>>;
872
+ /**
873
+ * @description Get Objective returns information about a chosen Objective.
874
+ *
875
+ * @name GetObjective
876
+ * @summary Get Objective
877
+ * @request GET:/api/v3/objectives/{objective-public-id}
878
+ * @secure
879
+ */
880
+ getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any>>;
881
+ /**
882
+ * @description Update Objective can be used to update Objective properties.
883
+ *
884
+ * @name UpdateObjective
885
+ * @summary Update Objective
886
+ * @request PUT:/api/v3/objectives/{objective-public-id}
887
+ * @secure
888
+ */
889
+ updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any>>;
890
+ /**
891
+ * @description Delete Objective can be used to delete any Objective.
892
+ *
893
+ * @name DeleteObjective
894
+ * @summary Delete Objective
895
+ * @request DELETE:/api/v3/objectives/{objective-public-id}
896
+ * @secure
897
+ */
898
+ deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
899
+ /**
900
+ * @description List all of the Epics within the Objective.
901
+ *
902
+ * @name ListObjectiveEpics
903
+ * @summary List Objective Epics
904
+ * @request GET:/api/v3/objectives/{objective-public-id}/epics
905
+ * @secure
906
+ */
907
+ listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any>>;
908
+ /**
909
+ * @description List Projects returns a list of all Projects and their attributes.
910
+ *
911
+ * @name ListProjects
912
+ * @summary List Projects
913
+ * @request GET:/api/v3/projects
914
+ * @secure
915
+ */
916
+ listProjects: (params?: RequestParams) => Promise<axios0.AxiosResponse<Project[], any>>;
917
+ /**
918
+ * @description Create Project is used to create a new Shortcut Project.
919
+ *
920
+ * @name CreateProject
921
+ * @summary Create Project
922
+ * @request POST:/api/v3/projects
923
+ * @secure
924
+ */
925
+ createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any>>;
926
+ /**
927
+ * @description Get Project returns information about the selected Project.
928
+ *
929
+ * @name GetProject
930
+ * @summary Get Project
931
+ * @request GET:/api/v3/projects/{project-public-id}
932
+ * @secure
933
+ */
934
+ getProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any>>;
935
+ /**
936
+ * @description Update Project can be used to change properties of a Project.
937
+ *
938
+ * @name UpdateProject
939
+ * @summary Update Project
940
+ * @request PUT:/api/v3/projects/{project-public-id}
941
+ * @secure
942
+ */
943
+ updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any>>;
944
+ /**
945
+ * @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.
946
+ *
947
+ * @name DeleteProject
948
+ * @summary Delete Project
949
+ * @request DELETE:/api/v3/projects/{project-public-id}
950
+ * @secure
951
+ */
952
+ deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
953
+ /**
954
+ * @description List Stories returns a list of all Stories in a selected Project and their attributes.
955
+ *
956
+ * @name ListStories
957
+ * @summary List Stories
958
+ * @request GET:/api/v3/projects/{project-public-id}/stories
959
+ * @secure
960
+ */
961
+ listStories: (projectPublicId: number, query?: {
962
+ /** A true/false boolean indicating whether to return Stories with their descriptions. */
963
+ includes_description?: boolean;
964
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
965
+ /**
966
+ * @description List Repositories returns a list of all Repositories and their attributes.
967
+ *
968
+ * @name ListRepositories
969
+ * @summary List Repositories
970
+ * @request GET:/api/v3/repositories
971
+ * @secure
972
+ */
973
+ listRepositories: (params?: RequestParams) => Promise<axios0.AxiosResponse<Repository[], any>>;
974
+ /**
975
+ * @description Get Repository returns information about the selected Repository.
976
+ *
977
+ * @name GetRepository
978
+ * @summary Get Repository
979
+ * @request GET:/api/v3/repositories/{repo-public-id}
980
+ * @secure
981
+ */
982
+ getRepository: (repoPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Repository, any>>;
983
+ /**
984
+ * @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.
985
+ *
986
+ * @name Search
987
+ * @summary Search
988
+ * @request GET:/api/v3/search
989
+ * @secure
990
+ */
991
+ search: (query: {
992
+ /**
993
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
994
+ * @minLength 1
995
+ */
996
+ query: string;
997
+ /**
998
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
999
+ * @format int64
1000
+ */
1001
+ page_size?: number;
1002
+ /**
1003
+ * The amount of detail included in each result item.
1004
+ * "full" will include all descriptions and comments and more fields on
1005
+ * related items such as pull requests, branches and tasks.
1006
+ * "slim" omits larger fulltext fields such as descriptions and comments
1007
+ * and only references related items by id.
1008
+ * The default is "full".
1009
+ */
1010
+ detail?: "full" | "slim";
1011
+ /** The next page token. */
1012
+ next?: string;
1013
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1014
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1015
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any>>;
1016
+ /**
1017
+ * @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.
1018
+ *
1019
+ * @name SearchEpics
1020
+ * @summary Search Epics
1021
+ * @request GET:/api/v3/search/epics
1022
+ * @secure
1023
+ */
1024
+ searchEpics: (query: {
1025
+ /**
1026
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
1027
+ * @minLength 1
1028
+ */
1029
+ query: string;
1030
+ /**
1031
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
1032
+ * @format int64
1033
+ */
1034
+ page_size?: number;
1035
+ /**
1036
+ * The amount of detail included in each result item.
1037
+ * "full" will include all descriptions and comments and more fields on
1038
+ * related items such as pull requests, branches and tasks.
1039
+ * "slim" omits larger fulltext fields such as descriptions and comments
1040
+ * and only references related items by id.
1041
+ * The default is "full".
1042
+ */
1043
+ detail?: "full" | "slim";
1044
+ /** The next page token. */
1045
+ next?: string;
1046
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1047
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1048
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSearchResults, any>>;
1049
+ /**
1050
+ * @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.
1051
+ *
1052
+ * @name SearchIterations
1053
+ * @summary Search Iterations
1054
+ * @request GET:/api/v3/search/iterations
1055
+ * @secure
1056
+ */
1057
+ searchIterations: (query: {
1058
+ /**
1059
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
1060
+ * @minLength 1
1061
+ */
1062
+ query: string;
1063
+ /**
1064
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
1065
+ * @format int64
1066
+ */
1067
+ page_size?: number;
1068
+ /**
1069
+ * The amount of detail included in each result item.
1070
+ * "full" will include all descriptions and comments and more fields on
1071
+ * related items such as pull requests, branches and tasks.
1072
+ * "slim" omits larger fulltext fields such as descriptions and comments
1073
+ * and only references related items by id.
1074
+ * The default is "full".
1075
+ */
1076
+ detail?: "full" | "slim";
1077
+ /** The next page token. */
1078
+ next?: string;
1079
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1080
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1081
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSearchResults, any>>;
1082
+ /**
1083
+ * @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.
1084
+ *
1085
+ * @name SearchMilestones
1086
+ * @summary Search Milestones
1087
+ * @request GET:/api/v3/search/milestones
1088
+ * @secure
1089
+ */
1090
+ searchMilestones: (query: {
1091
+ /**
1092
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
1093
+ * @minLength 1
1094
+ */
1095
+ query: string;
1096
+ /**
1097
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
1098
+ * @format int64
1099
+ */
1100
+ page_size?: number;
1101
+ /**
1102
+ * The amount of detail included in each result item.
1103
+ * "full" will include all descriptions and comments and more fields on
1104
+ * related items such as pull requests, branches and tasks.
1105
+ * "slim" omits larger fulltext fields such as descriptions and comments
1106
+ * and only references related items by id.
1107
+ * The default is "full".
1108
+ */
1109
+ detail?: "full" | "slim";
1110
+ /** The next page token. */
1111
+ next?: string;
1112
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1113
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1114
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any>>;
1115
+ /**
1116
+ * @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.
1117
+ *
1118
+ * @name SearchObjectives
1119
+ * @summary Search Objectives
1120
+ * @request GET:/api/v3/search/objectives
1121
+ * @secure
1122
+ */
1123
+ searchObjectives: (query: {
1124
+ /**
1125
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
1126
+ * @minLength 1
1127
+ */
1128
+ query: string;
1129
+ /**
1130
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
1131
+ * @format int64
1132
+ */
1133
+ page_size?: number;
1134
+ /**
1135
+ * The amount of detail included in each result item.
1136
+ * "full" will include all descriptions and comments and more fields on
1137
+ * related items such as pull requests, branches and tasks.
1138
+ * "slim" omits larger fulltext fields such as descriptions and comments
1139
+ * and only references related items by id.
1140
+ * The default is "full".
1141
+ */
1142
+ detail?: "full" | "slim";
1143
+ /** The next page token. */
1144
+ next?: string;
1145
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1146
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1147
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any>>;
1148
+ /**
1149
+ * @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.
1150
+ *
1151
+ * @name SearchStories
1152
+ * @summary Search Stories
1153
+ * @request GET:/api/v3/search/stories
1154
+ * @secure
1155
+ */
1156
+ searchStories: (query: {
1157
+ /**
1158
+ * See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators)
1159
+ * @minLength 1
1160
+ */
1161
+ query: string;
1162
+ /**
1163
+ * The number of search results to include in a page. Minimum of 1 and maximum of 250.
1164
+ * @format int64
1165
+ */
1166
+ page_size?: number;
1167
+ /**
1168
+ * The amount of detail included in each result item.
1169
+ * "full" will include all descriptions and comments and more fields on
1170
+ * related items such as pull requests, branches and tasks.
1171
+ * "slim" omits larger fulltext fields such as descriptions and comments
1172
+ * and only references related items by id.
1173
+ * The default is "full".
1174
+ */
1175
+ detail?: "full" | "slim";
1176
+ /** The next page token. */
1177
+ next?: string;
1178
+ /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
1179
+ entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
1180
+ }, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySearchResults, any>>;
1181
+ /**
1182
+ * @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.
1183
+ *
1184
+ * @name CreateStory
1185
+ * @summary Create Story
1186
+ * @request POST:/api/v3/stories
1187
+ * @secure
1188
+ */
1189
+ createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any>>;
1190
+ /**
1191
+ * @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).
1192
+ *
1193
+ * @name CreateMultipleStories
1194
+ * @summary Create Multiple Stories
1195
+ * @request POST:/api/v3/stories/bulk
1196
+ * @secure
1197
+ */
1198
+ createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
1199
+ /**
1200
+ * @description Update Multiple Stories allows you to make changes to numerous stories at once.
1201
+ *
1202
+ * @name UpdateMultipleStories
1203
+ * @summary Update Multiple Stories
1204
+ * @request PUT:/api/v3/stories/bulk
1205
+ * @secure
1206
+ */
1207
+ updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
1208
+ /**
1209
+ * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
1210
+ *
1211
+ * @name DeleteMultipleStories
1212
+ * @summary Delete Multiple Stories
1213
+ * @request DELETE:/api/v3/stories/bulk
1214
+ * @secure
1215
+ */
1216
+ deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1217
+ /**
1218
+ * @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
1219
+ *
1220
+ * @name CreateStoryFromTemplate
1221
+ * @summary Create Story From Template
1222
+ * @request POST:/api/v3/stories/from-template
1223
+ * @secure
1224
+ */
1225
+ createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any>>;
1226
+ /**
1227
+ * @description Search Stories lets you search Stories based on desired parameters.
1228
+ *
1229
+ * @name SearchStoriesOld
1230
+ * @summary Search Stories (Old)
1231
+ * @request POST:/api/v3/stories/search
1232
+ * @secure
1233
+ */
1234
+ searchStoriesOld: (SearchStories: SearchStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
1235
+ /**
1236
+ * @description Get Story returns information about a chosen Story.
1237
+ *
1238
+ * @name GetStory
1239
+ * @summary Get Story
1240
+ * @request GET:/api/v3/stories/{story-public-id}
1241
+ * @secure
1242
+ */
1243
+ getStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any>>;
1244
+ /**
1245
+ * @description Update Story can be used to update Story properties.
1246
+ *
1247
+ * @name UpdateStory
1248
+ * @summary Update Story
1249
+ * @request PUT:/api/v3/stories/{story-public-id}
1250
+ * @secure
1251
+ */
1252
+ updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any>>;
1253
+ /**
1254
+ * @description Delete Story can be used to delete any Story.
1255
+ *
1256
+ * @name DeleteStory
1257
+ * @summary Delete Story
1258
+ * @request DELETE:/api/v3/stories/{story-public-id}
1259
+ * @secure
1260
+ */
1261
+ deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1262
+ /**
1263
+ * @description Lists Comments associated with a Story
1264
+ *
1265
+ * @name ListStoryComment
1266
+ * @summary List Story Comment
1267
+ * @request GET:/api/v3/stories/{story-public-id}/comments
1268
+ * @secure
1269
+ */
1270
+ listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment[], any>>;
1271
+ /**
1272
+ * @description Create Comment allows you to create a Comment on any Story.
1273
+ *
1274
+ * @name CreateStoryComment
1275
+ * @summary Create Story Comment
1276
+ * @request POST:/api/v3/stories/{story-public-id}/comments
1277
+ * @secure
1278
+ */
1279
+ createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any>>;
1280
+ /**
1281
+ * @description Get Comment is used to get Comment information.
1282
+ *
1283
+ * @name GetStoryComment
1284
+ * @summary Get Story Comment
1285
+ * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1286
+ * @secure
1287
+ */
1288
+ getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any>>;
1289
+ /**
1290
+ * @description Update Comment replaces the text of the existing Comment.
1291
+ *
1292
+ * @name UpdateStoryComment
1293
+ * @summary Update Story Comment
1294
+ * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1295
+ * @secure
1296
+ */
1297
+ updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any>>;
1298
+ /**
1299
+ * @description Delete a Comment from any story.
1300
+ *
1301
+ * @name DeleteStoryComment
1302
+ * @summary Delete Story Comment
1303
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
1304
+ * @secure
1305
+ */
1306
+ deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1307
+ /**
1308
+ * @description Create a reaction to a story comment.
1309
+ *
1310
+ * @name CreateStoryReaction
1311
+ * @summary Create Story Reaction
1312
+ * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1313
+ * @secure
1314
+ */
1315
+ createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryReaction[], any>>;
1316
+ /**
1317
+ * @description Delete a reaction from any story comment.
1318
+ *
1319
+ * @name DeleteStoryReaction
1320
+ * @summary Delete Story Reaction
1321
+ * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
1322
+ * @secure
1323
+ */
1324
+ deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1325
+ /**
1326
+ * @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
1327
+ *
1328
+ * @name UnlinkCommentThreadFromSlack
1329
+ * @summary Unlink Comment thread from Slack
1330
+ * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
1331
+ * @secure
1332
+ */
1333
+ unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any>>;
1334
+ /**
1335
+ * No description
1336
+ *
1337
+ * @name StoryHistory
1338
+ * @summary Story History
1339
+ * @request GET:/api/v3/stories/{story-public-id}/history
1340
+ * @secure
1341
+ */
1342
+ storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<History[], any>>;
1343
+ /**
1344
+ * @description Create Task is used to create a new task in a Story.
1345
+ *
1346
+ * @name CreateTask
1347
+ * @summary Create Task
1348
+ * @request POST:/api/v3/stories/{story-public-id}/tasks
1349
+ * @secure
1350
+ */
1351
+ createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any>>;
1352
+ /**
1353
+ * @description Returns information about a chosen Task.
1354
+ *
1355
+ * @name GetTask
1356
+ * @summary Get Task
1357
+ * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1358
+ * @secure
1359
+ */
1360
+ getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any>>;
1361
+ /**
1362
+ * @description Update Task can be used to update Task properties.
1363
+ *
1364
+ * @name UpdateTask
1365
+ * @summary Update Task
1366
+ * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1367
+ * @secure
1368
+ */
1369
+ updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any>>;
1370
+ /**
1371
+ * @description Delete Task can be used to delete any previously created Task on a Story.
1372
+ *
1373
+ * @name DeleteTask
1374
+ * @summary Delete Task
1375
+ * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
1376
+ * @secure
1377
+ */
1378
+ deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1379
+ /**
1380
+ * @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”
1381
+ *
1382
+ * @name CreateStoryLink
1383
+ * @summary Create Story Link
1384
+ * @request POST:/api/v3/story-links
1385
+ * @secure
1386
+ */
1387
+ createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any>>;
1388
+ /**
1389
+ * @description Returns the stories and their relationship for the given Story Link.
1390
+ *
1391
+ * @name GetStoryLink
1392
+ * @summary Get Story Link
1393
+ * @request GET:/api/v3/story-links/{story-link-public-id}
1394
+ * @secure
1395
+ */
1396
+ getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any>>;
1397
+ /**
1398
+ * @description Updates the stories and/or the relationship for the given Story Link.
1399
+ *
1400
+ * @name UpdateStoryLink
1401
+ * @summary Update Story Link
1402
+ * @request PUT:/api/v3/story-links/{story-link-public-id}
1403
+ * @secure
1404
+ */
1405
+ updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any>>;
1406
+ /**
1407
+ * @description Removes the relationship between the stories for the given Story Link.
1408
+ *
1409
+ * @name DeleteStoryLink
1410
+ * @summary Delete Story Link
1411
+ * @request DELETE:/api/v3/story-links/{story-link-public-id}
1412
+ * @secure
1413
+ */
1414
+ deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any>>;
1415
+ /**
1416
+ * @description Returns a list of all Workflows in the Workspace.
1417
+ *
1418
+ * @name ListWorkflows
1419
+ * @summary List Workflows
1420
+ * @request GET:/api/v3/workflows
1421
+ * @secure
1422
+ */
1423
+ listWorkflows: (params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow[], any>>;
1424
+ /**
1425
+ * @description Get Workflow returns information about a chosen Workflow.
1426
+ *
1427
+ * @name GetWorkflow
1428
+ * @summary Get Workflow
1429
+ * @request GET:/api/v3/workflows/{workflow-public-id}
1430
+ * @secure
1431
+ */
1432
+ getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow, any>>;
1042
1433
  }
1434
+ //#endregion
1435
+ export { Api };