@useshortcut/client 2.2.0 → 2.3.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.
- package/lib/ShortcutClient.d.mts +13 -1
- package/lib/ShortcutClient.d.ts +13 -1
- package/lib/ShortcutClient.js +19 -0
- package/lib/ShortcutClient.mjs +19 -0
- package/lib/generated/Api.d.mts +135 -135
- package/lib/generated/Api.d.ts +135 -135
- package/lib/generated/Api.js +3 -3
- package/lib/generated/Api.mjs +3 -3
- package/lib/generated/data-contracts.d.mts +38 -0
- package/lib/generated/data-contracts.d.ts +38 -0
- package/package.json +2 -2
package/lib/generated/Api.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
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.mjs";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client.mjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as axios1 from "axios";
|
|
4
4
|
|
|
5
5
|
//#region src/generated/Api.d.ts
|
|
6
6
|
|
|
@@ -17,7 +17,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
17
17
|
* @request GET:/api/v3/categories
|
|
18
18
|
* @secure
|
|
19
19
|
*/
|
|
20
|
-
listCategories: (params?: RequestParams) => Promise<
|
|
20
|
+
listCategories: (params?: RequestParams) => Promise<axios1.AxiosResponse<Category[], any>>;
|
|
21
21
|
/**
|
|
22
22
|
* @description Create Category allows you to create a new Category in Shortcut.
|
|
23
23
|
*
|
|
@@ -26,7 +26,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
26
26
|
* @request POST:/api/v3/categories
|
|
27
27
|
* @secure
|
|
28
28
|
*/
|
|
29
|
-
createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<
|
|
29
|
+
createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<axios1.AxiosResponse<Category, any>>;
|
|
30
30
|
/**
|
|
31
31
|
* @description Get Category returns information about the selected Category.
|
|
32
32
|
*
|
|
@@ -35,7 +35,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
35
35
|
* @request GET:/api/v3/categories/{category-public-id}
|
|
36
36
|
* @secure
|
|
37
37
|
*/
|
|
38
|
-
getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
38
|
+
getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Category, any>>;
|
|
39
39
|
/**
|
|
40
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
41
|
*
|
|
@@ -44,7 +44,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
44
44
|
* @request PUT:/api/v3/categories/{category-public-id}
|
|
45
45
|
* @secure
|
|
46
46
|
*/
|
|
47
|
-
updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<
|
|
47
|
+
updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<axios1.AxiosResponse<Category, any>>;
|
|
48
48
|
/**
|
|
49
49
|
* @description Delete Category can be used to delete any Category.
|
|
50
50
|
*
|
|
@@ -53,7 +53,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
53
53
|
* @request DELETE:/api/v3/categories/{category-public-id}
|
|
54
54
|
* @secure
|
|
55
55
|
*/
|
|
56
|
-
deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
56
|
+
deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
57
57
|
/**
|
|
58
58
|
* @description List Category Milestones returns a list of all Milestones with the Category.
|
|
59
59
|
*
|
|
@@ -62,7 +62,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
62
62
|
* @request GET:/api/v3/categories/{category-public-id}/milestones
|
|
63
63
|
* @secure
|
|
64
64
|
*/
|
|
65
|
-
listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
65
|
+
listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone[], any>>;
|
|
66
66
|
/**
|
|
67
67
|
* @description Returns a list of all Objectives with the Category.
|
|
68
68
|
*
|
|
@@ -71,7 +71,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
71
71
|
* @request GET:/api/v3/categories/{category-public-id}/objectives
|
|
72
72
|
* @secure
|
|
73
73
|
*/
|
|
74
|
-
listCategoryObjectives: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
74
|
+
listCategoryObjectives: (categoryPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone[], any>>;
|
|
75
75
|
/**
|
|
76
76
|
* No description
|
|
77
77
|
*
|
|
@@ -80,7 +80,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
80
80
|
* @request GET:/api/v3/custom-fields
|
|
81
81
|
* @secure
|
|
82
82
|
*/
|
|
83
|
-
listCustomFields: (params?: RequestParams) => Promise<
|
|
83
|
+
listCustomFields: (params?: RequestParams) => Promise<axios1.AxiosResponse<CustomField[], any>>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -89,7 +89,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
89
89
|
* @request GET:/api/v3/custom-fields/{custom-field-public-id}
|
|
90
90
|
* @secure
|
|
91
91
|
*/
|
|
92
|
-
getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<
|
|
92
|
+
getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<CustomField, any>>;
|
|
93
93
|
/**
|
|
94
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
95
|
*
|
|
@@ -98,7 +98,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
98
98
|
* @request PUT:/api/v3/custom-fields/{custom-field-public-id}
|
|
99
99
|
* @secure
|
|
100
100
|
*/
|
|
101
|
-
updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<
|
|
101
|
+
updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<axios1.AxiosResponse<CustomField, any>>;
|
|
102
102
|
/**
|
|
103
103
|
* No description
|
|
104
104
|
*
|
|
@@ -107,7 +107,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
107
107
|
* @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
|
|
108
108
|
* @secure
|
|
109
109
|
*/
|
|
110
|
-
deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<
|
|
110
|
+
deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
111
111
|
/**
|
|
112
112
|
* @description List Docs returns a list of Doc that the current user can read.
|
|
113
113
|
*
|
|
@@ -116,7 +116,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
116
116
|
* @request GET:/api/v3/documents
|
|
117
117
|
* @secure
|
|
118
118
|
*/
|
|
119
|
-
listDocs: (params?: RequestParams) => Promise<
|
|
119
|
+
listDocs: (params?: RequestParams) => Promise<axios1.AxiosResponse<DocSlim[], any>>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Creates a new Doc.
|
|
122
122
|
*
|
|
@@ -125,7 +125,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
125
125
|
* @request POST:/api/v3/documents
|
|
126
126
|
* @secure
|
|
127
127
|
*/
|
|
128
|
-
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<
|
|
128
|
+
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios1.AxiosResponse<DocSlim, any>>;
|
|
129
129
|
/**
|
|
130
130
|
* @description List all the entity templates for the Workspace.
|
|
131
131
|
*
|
|
@@ -134,7 +134,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
134
134
|
* @request GET:/api/v3/entity-templates
|
|
135
135
|
* @secure
|
|
136
136
|
*/
|
|
137
|
-
listEntityTemplates: (params?: RequestParams) => Promise<
|
|
137
|
+
listEntityTemplates: (params?: RequestParams) => Promise<axios1.AxiosResponse<EntityTemplate[], any>>;
|
|
138
138
|
/**
|
|
139
139
|
* @description Create a new entity template for the Workspace.
|
|
140
140
|
*
|
|
@@ -143,7 +143,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
143
143
|
* @request POST:/api/v3/entity-templates
|
|
144
144
|
* @secure
|
|
145
145
|
*/
|
|
146
|
-
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<
|
|
146
|
+
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<axios1.AxiosResponse<EntityTemplate, any>>;
|
|
147
147
|
/**
|
|
148
148
|
* @description Disables the Story Template feature for the Workspace.
|
|
149
149
|
*
|
|
@@ -152,7 +152,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
152
152
|
* @request PUT:/api/v3/entity-templates/disable
|
|
153
153
|
* @secure
|
|
154
154
|
*/
|
|
155
|
-
disableStoryTemplates: (params?: RequestParams) => Promise<
|
|
155
|
+
disableStoryTemplates: (params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
156
156
|
/**
|
|
157
157
|
* @description Enables the Story Template feature for the Workspace.
|
|
158
158
|
*
|
|
@@ -161,7 +161,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
161
161
|
* @request PUT:/api/v3/entity-templates/enable
|
|
162
162
|
* @secure
|
|
163
163
|
*/
|
|
164
|
-
enableStoryTemplates: (params?: RequestParams) => Promise<
|
|
164
|
+
enableStoryTemplates: (params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
165
165
|
/**
|
|
166
166
|
* @description Get Entity Template returns information about a given entity template.
|
|
167
167
|
*
|
|
@@ -170,7 +170,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
170
170
|
* @request GET:/api/v3/entity-templates/{entity-template-public-id}
|
|
171
171
|
* @secure
|
|
172
172
|
*/
|
|
173
|
-
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
173
|
+
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<EntityTemplate, any>>;
|
|
174
174
|
/**
|
|
175
175
|
* @description Update an entity template's name or its contents.
|
|
176
176
|
*
|
|
@@ -179,7 +179,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
179
179
|
* @request PUT:/api/v3/entity-templates/{entity-template-public-id}
|
|
180
180
|
* @secure
|
|
181
181
|
*/
|
|
182
|
-
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<
|
|
182
|
+
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<axios1.AxiosResponse<EntityTemplate, any>>;
|
|
183
183
|
/**
|
|
184
184
|
* No description
|
|
185
185
|
*
|
|
@@ -188,7 +188,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
188
188
|
* @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
|
|
189
189
|
* @secure
|
|
190
190
|
*/
|
|
191
|
-
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
191
|
+
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
192
192
|
/**
|
|
193
193
|
* @description Returns the Epic Workflow for the Workspace.
|
|
194
194
|
*
|
|
@@ -197,7 +197,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
197
197
|
* @request GET:/api/v3/epic-workflow
|
|
198
198
|
* @secure
|
|
199
199
|
*/
|
|
200
|
-
getEpicWorkflow: (params?: RequestParams) => Promise<
|
|
200
|
+
getEpicWorkflow: (params?: RequestParams) => Promise<axios1.AxiosResponse<EpicWorkflow, any>>;
|
|
201
201
|
/**
|
|
202
202
|
* @description List Epics returns a list of all Epics and their attributes.
|
|
203
203
|
*
|
|
@@ -209,7 +209,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
209
209
|
listEpics: (query?: {
|
|
210
210
|
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
211
211
|
includes_description?: boolean;
|
|
212
|
-
}, params?: RequestParams) => Promise<
|
|
212
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicSlim[], any>>;
|
|
213
213
|
/**
|
|
214
214
|
* @description Create Epic allows you to create a new Epic in Shortcut.
|
|
215
215
|
*
|
|
@@ -218,7 +218,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
218
218
|
* @request POST:/api/v3/epics
|
|
219
219
|
* @secure
|
|
220
220
|
*/
|
|
221
|
-
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<
|
|
221
|
+
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<axios1.AxiosResponse<Epic, any>>;
|
|
222
222
|
/**
|
|
223
223
|
* @description List Epics with pagination returns a paginated list of Epics and their attributes.
|
|
224
224
|
*
|
|
@@ -240,7 +240,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
240
240
|
* @format int64
|
|
241
241
|
*/
|
|
242
242
|
page_size?: number;
|
|
243
|
-
}, params?: RequestParams) => Promise<
|
|
243
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicPaginatedResults, any>>;
|
|
244
244
|
/**
|
|
245
245
|
* @description Get Epic returns information about the selected Epic.
|
|
246
246
|
*
|
|
@@ -249,7 +249,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
249
249
|
* @request GET:/api/v3/epics/{epic-public-id}
|
|
250
250
|
* @secure
|
|
251
251
|
*/
|
|
252
|
-
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
252
|
+
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Epic, any>>;
|
|
253
253
|
/**
|
|
254
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
255
|
*
|
|
@@ -258,7 +258,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
258
258
|
* @request PUT:/api/v3/epics/{epic-public-id}
|
|
259
259
|
* @secure
|
|
260
260
|
*/
|
|
261
|
-
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<
|
|
261
|
+
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<axios1.AxiosResponse<Epic, any>>;
|
|
262
262
|
/**
|
|
263
263
|
* @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
|
|
264
264
|
*
|
|
@@ -267,7 +267,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
267
267
|
* @request DELETE:/api/v3/epics/{epic-public-id}
|
|
268
268
|
* @secure
|
|
269
269
|
*/
|
|
270
|
-
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
270
|
+
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
271
271
|
/**
|
|
272
272
|
* @description Get a list of all Comments on an Epic.
|
|
273
273
|
*
|
|
@@ -276,7 +276,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
276
276
|
* @request GET:/api/v3/epics/{epic-public-id}/comments
|
|
277
277
|
* @secure
|
|
278
278
|
*/
|
|
279
|
-
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
279
|
+
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<ThreadedComment[], any>>;
|
|
280
280
|
/**
|
|
281
281
|
* @description This endpoint allows you to create a threaded Comment on an Epic.
|
|
282
282
|
*
|
|
@@ -285,7 +285,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
285
285
|
* @request POST:/api/v3/epics/{epic-public-id}/comments
|
|
286
286
|
* @secure
|
|
287
287
|
*/
|
|
288
|
-
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<
|
|
288
|
+
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<axios1.AxiosResponse<ThreadedComment, any>>;
|
|
289
289
|
/**
|
|
290
290
|
* @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
|
|
291
291
|
*
|
|
@@ -294,7 +294,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
294
294
|
* @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
295
295
|
* @secure
|
|
296
296
|
*/
|
|
297
|
-
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<
|
|
297
|
+
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<axios1.AxiosResponse<ThreadedComment, any>>;
|
|
298
298
|
/**
|
|
299
299
|
* @description This endpoint returns information about the selected Epic Comment.
|
|
300
300
|
*
|
|
@@ -303,7 +303,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
303
303
|
* @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
304
304
|
* @secure
|
|
305
305
|
*/
|
|
306
|
-
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
306
|
+
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<ThreadedComment, any>>;
|
|
307
307
|
/**
|
|
308
308
|
* @description This endpoint allows you to update a threaded Comment on an Epic.
|
|
309
309
|
*
|
|
@@ -312,7 +312,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
312
312
|
* @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
313
313
|
* @secure
|
|
314
314
|
*/
|
|
315
|
-
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<
|
|
315
|
+
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<axios1.AxiosResponse<ThreadedComment, any>>;
|
|
316
316
|
/**
|
|
317
317
|
* @description This endpoint allows you to delete a Comment from an Epic.
|
|
318
318
|
*
|
|
@@ -321,7 +321,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
321
321
|
* @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
322
322
|
* @secure
|
|
323
323
|
*/
|
|
324
|
-
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
324
|
+
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
325
325
|
/**
|
|
326
326
|
* @description Get the current health for the specified Epic.
|
|
327
327
|
*
|
|
@@ -330,7 +330,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
330
330
|
* @request GET:/api/v3/epics/{epic-public-id}/health
|
|
331
331
|
* @secure
|
|
332
332
|
*/
|
|
333
|
-
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
333
|
+
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Health, any>>;
|
|
334
334
|
/**
|
|
335
335
|
* @description Create a new health status for the specified Epic.
|
|
336
336
|
*
|
|
@@ -339,7 +339,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
339
339
|
* @request POST:/api/v3/epics/{epic-public-id}/health
|
|
340
340
|
* @secure
|
|
341
341
|
*/
|
|
342
|
-
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<
|
|
342
|
+
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<axios1.AxiosResponse<Health, any>>;
|
|
343
343
|
/**
|
|
344
344
|
* @description List the history of health statuses for the specified Epic, most recent first.
|
|
345
345
|
*
|
|
@@ -348,7 +348,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
348
348
|
* @request GET:/api/v3/epics/{epic-public-id}/health-history
|
|
349
349
|
* @secure
|
|
350
350
|
*/
|
|
351
|
-
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
351
|
+
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Health[], any>>;
|
|
352
352
|
/**
|
|
353
353
|
* @description Get a list of all Stories in an Epic.
|
|
354
354
|
*
|
|
@@ -360,7 +360,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
360
360
|
listEpicStories: (epicPublicId: number, query?: {
|
|
361
361
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
362
362
|
includes_description?: boolean;
|
|
363
|
-
}, params?: RequestParams) => Promise<
|
|
363
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
364
364
|
/**
|
|
365
365
|
* @description This endpoint allows you to unlink a productboard epic.
|
|
366
366
|
*
|
|
@@ -369,7 +369,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
369
369
|
* @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
|
|
370
370
|
* @secure
|
|
371
371
|
*/
|
|
372
|
-
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
372
|
+
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
373
373
|
/**
|
|
374
374
|
* @description Get Stories which have a given External Link associated with them.
|
|
375
375
|
*
|
|
@@ -385,7 +385,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
385
385
|
* @pattern ^https?://.+$
|
|
386
386
|
*/
|
|
387
387
|
external_link: string;
|
|
388
|
-
}, params?: RequestParams) => Promise<
|
|
388
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
389
389
|
/**
|
|
390
390
|
* @description List Files returns a list of all UploadedFiles in the workspace.
|
|
391
391
|
*
|
|
@@ -394,7 +394,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
394
394
|
* @request GET:/api/v3/files
|
|
395
395
|
* @secure
|
|
396
396
|
*/
|
|
397
|
-
listFiles: (params?: RequestParams) => Promise<
|
|
397
|
+
listFiles: (params?: RequestParams) => Promise<axios1.AxiosResponse<UploadedFile[], any>>;
|
|
398
398
|
/**
|
|
399
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
400
|
*
|
|
@@ -429,7 +429,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
429
429
|
* @format binary
|
|
430
430
|
*/
|
|
431
431
|
file3?: File;
|
|
432
|
-
}, params?: RequestParams) => Promise<
|
|
432
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<UploadedFile[], any>>;
|
|
433
433
|
/**
|
|
434
434
|
* @description Get File returns information about the selected UploadedFile.
|
|
435
435
|
*
|
|
@@ -438,7 +438,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
438
438
|
* @request GET:/api/v3/files/{file-public-id}
|
|
439
439
|
* @secure
|
|
440
440
|
*/
|
|
441
|
-
getFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
441
|
+
getFile: (filePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<UploadedFile, any>>;
|
|
442
442
|
/**
|
|
443
443
|
* @description Update File updates the properties of an UploadedFile (but not its content).
|
|
444
444
|
*
|
|
@@ -447,7 +447,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
447
447
|
* @request PUT:/api/v3/files/{file-public-id}
|
|
448
448
|
* @secure
|
|
449
449
|
*/
|
|
450
|
-
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<
|
|
450
|
+
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<axios1.AxiosResponse<UploadedFile, any>>;
|
|
451
451
|
/**
|
|
452
452
|
* @description Delete File deletes a previously uploaded file.
|
|
453
453
|
*
|
|
@@ -456,7 +456,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
456
456
|
* @request DELETE:/api/v3/files/{file-public-id}
|
|
457
457
|
* @secure
|
|
458
458
|
*/
|
|
459
|
-
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
459
|
+
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
460
460
|
/**
|
|
461
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
462
|
*
|
|
@@ -465,7 +465,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
465
465
|
* @request GET:/api/v3/groups
|
|
466
466
|
* @secure
|
|
467
467
|
*/
|
|
468
|
-
listGroups: (params?: RequestParams) => Promise<
|
|
468
|
+
listGroups: (params?: RequestParams) => Promise<axios1.AxiosResponse<Group[], any>>;
|
|
469
469
|
/**
|
|
470
470
|
* No description
|
|
471
471
|
*
|
|
@@ -474,7 +474,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
474
474
|
* @request POST:/api/v3/groups
|
|
475
475
|
* @secure
|
|
476
476
|
*/
|
|
477
|
-
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<
|
|
477
|
+
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<axios1.AxiosResponse<Group, any>>;
|
|
478
478
|
/**
|
|
479
479
|
* No description
|
|
480
480
|
*
|
|
@@ -483,7 +483,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
483
483
|
* @request GET:/api/v3/groups/{group-public-id}
|
|
484
484
|
* @secure
|
|
485
485
|
*/
|
|
486
|
-
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<
|
|
486
|
+
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<Group, any>>;
|
|
487
487
|
/**
|
|
488
488
|
* No description
|
|
489
489
|
*
|
|
@@ -492,7 +492,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
492
492
|
* @request PUT:/api/v3/groups/{group-public-id}
|
|
493
493
|
* @secure
|
|
494
494
|
*/
|
|
495
|
-
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<
|
|
495
|
+
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<axios1.AxiosResponse<Group, any>>;
|
|
496
496
|
/**
|
|
497
497
|
* @description List the Stories assigned to the Group. (By default, limited to 1,000).
|
|
498
498
|
*
|
|
@@ -512,7 +512,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
512
512
|
* @format int64
|
|
513
513
|
*/
|
|
514
514
|
offset?: number;
|
|
515
|
-
}, params?: RequestParams) => Promise<
|
|
515
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
516
516
|
/**
|
|
517
517
|
* @description Update an existing health status by its ID.
|
|
518
518
|
*
|
|
@@ -521,7 +521,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
521
521
|
* @request PUT:/api/v3/health/{health-public-id}
|
|
522
522
|
* @secure
|
|
523
523
|
*/
|
|
524
|
-
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<
|
|
524
|
+
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<axios1.AxiosResponse<Health, any>>;
|
|
525
525
|
/**
|
|
526
526
|
* No description
|
|
527
527
|
*
|
|
@@ -530,7 +530,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
530
530
|
* @request POST:/api/v3/integrations/webhook
|
|
531
531
|
* @secure
|
|
532
532
|
*/
|
|
533
|
-
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<
|
|
533
|
+
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
534
534
|
/**
|
|
535
535
|
* No description
|
|
536
536
|
*
|
|
@@ -539,7 +539,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
539
539
|
* @request GET:/api/v3/integrations/webhook/{integration-public-id}
|
|
540
540
|
* @secure
|
|
541
541
|
*/
|
|
542
|
-
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
542
|
+
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
543
543
|
/**
|
|
544
544
|
* No description
|
|
545
545
|
*
|
|
@@ -548,7 +548,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
548
548
|
* @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
|
|
549
549
|
* @secure
|
|
550
550
|
*/
|
|
551
|
-
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
551
|
+
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
552
552
|
/**
|
|
553
553
|
* No description
|
|
554
554
|
*
|
|
@@ -557,7 +557,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
557
557
|
* @request GET:/api/v3/iterations
|
|
558
558
|
* @secure
|
|
559
559
|
*/
|
|
560
|
-
listIterations: (params?: RequestParams) => Promise<
|
|
560
|
+
listIterations: (params?: RequestParams) => Promise<axios1.AxiosResponse<IterationSlim[], any>>;
|
|
561
561
|
/**
|
|
562
562
|
* No description
|
|
563
563
|
*
|
|
@@ -566,7 +566,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
566
566
|
* @request POST:/api/v3/iterations
|
|
567
567
|
* @secure
|
|
568
568
|
*/
|
|
569
|
-
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<
|
|
569
|
+
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<axios1.AxiosResponse<Iteration, any>>;
|
|
570
570
|
/**
|
|
571
571
|
* @description Disables Iterations for the current workspace
|
|
572
572
|
*
|
|
@@ -575,7 +575,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
575
575
|
* @request PUT:/api/v3/iterations/disable
|
|
576
576
|
* @secure
|
|
577
577
|
*/
|
|
578
|
-
disableIterations: (params?: RequestParams) => Promise<
|
|
578
|
+
disableIterations: (params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
579
579
|
/**
|
|
580
580
|
* @description Enables Iterations for the current workspace
|
|
581
581
|
*
|
|
@@ -584,7 +584,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
584
584
|
* @request PUT:/api/v3/iterations/enable
|
|
585
585
|
* @secure
|
|
586
586
|
*/
|
|
587
|
-
enableIterations: (params?: RequestParams) => Promise<
|
|
587
|
+
enableIterations: (params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
588
588
|
/**
|
|
589
589
|
* No description
|
|
590
590
|
*
|
|
@@ -593,7 +593,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
593
593
|
* @request GET:/api/v3/iterations/{iteration-public-id}
|
|
594
594
|
* @secure
|
|
595
595
|
*/
|
|
596
|
-
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
596
|
+
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Iteration, any>>;
|
|
597
597
|
/**
|
|
598
598
|
* No description
|
|
599
599
|
*
|
|
@@ -602,7 +602,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
602
602
|
* @request PUT:/api/v3/iterations/{iteration-public-id}
|
|
603
603
|
* @secure
|
|
604
604
|
*/
|
|
605
|
-
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<
|
|
605
|
+
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<axios1.AxiosResponse<Iteration, any>>;
|
|
606
606
|
/**
|
|
607
607
|
* No description
|
|
608
608
|
*
|
|
@@ -611,7 +611,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
611
611
|
* @request DELETE:/api/v3/iterations/{iteration-public-id}
|
|
612
612
|
* @secure
|
|
613
613
|
*/
|
|
614
|
-
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
614
|
+
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
615
615
|
/**
|
|
616
616
|
* @description Get a list of all Stories in an Iteration.
|
|
617
617
|
*
|
|
@@ -623,7 +623,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
623
623
|
listIterationStories: (iterationPublicId: number, query?: {
|
|
624
624
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
625
625
|
includes_description?: boolean;
|
|
626
|
-
}, params?: RequestParams) => Promise<
|
|
626
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
627
627
|
/**
|
|
628
628
|
* @description Get Key Result returns information about a chosen Key Result.
|
|
629
629
|
*
|
|
@@ -632,7 +632,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
632
632
|
* @request GET:/api/v3/key-results/{key-result-public-id}
|
|
633
633
|
* @secure
|
|
634
634
|
*/
|
|
635
|
-
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<
|
|
635
|
+
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<axios1.AxiosResponse<KeyResult, any>>;
|
|
636
636
|
/**
|
|
637
637
|
* @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
|
|
638
638
|
*
|
|
@@ -641,7 +641,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
641
641
|
* @request PUT:/api/v3/key-results/{key-result-public-id}
|
|
642
642
|
* @secure
|
|
643
643
|
*/
|
|
644
|
-
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<
|
|
644
|
+
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<axios1.AxiosResponse<KeyResult, any>>;
|
|
645
645
|
/**
|
|
646
646
|
* @description List Labels returns a list of all Labels and their attributes.
|
|
647
647
|
*
|
|
@@ -653,7 +653,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
653
653
|
listLabels: (query?: {
|
|
654
654
|
/** A true/false boolean indicating if the slim versions of the Label should be returned. */
|
|
655
655
|
slim?: boolean;
|
|
656
|
-
}, params?: RequestParams) => Promise<
|
|
656
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<Label[], any>>;
|
|
657
657
|
/**
|
|
658
658
|
* @description Create Label allows you to create a new Label in Shortcut.
|
|
659
659
|
*
|
|
@@ -662,7 +662,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
662
662
|
* @request POST:/api/v3/labels
|
|
663
663
|
* @secure
|
|
664
664
|
*/
|
|
665
|
-
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<
|
|
665
|
+
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<axios1.AxiosResponse<Label, any>>;
|
|
666
666
|
/**
|
|
667
667
|
* @description Get Label returns information about the selected Label.
|
|
668
668
|
*
|
|
@@ -671,7 +671,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
671
671
|
* @request GET:/api/v3/labels/{label-public-id}
|
|
672
672
|
* @secure
|
|
673
673
|
*/
|
|
674
|
-
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
674
|
+
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Label, any>>;
|
|
675
675
|
/**
|
|
676
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
677
|
*
|
|
@@ -680,7 +680,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
680
680
|
* @request PUT:/api/v3/labels/{label-public-id}
|
|
681
681
|
* @secure
|
|
682
682
|
*/
|
|
683
|
-
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<
|
|
683
|
+
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<axios1.AxiosResponse<Label, any>>;
|
|
684
684
|
/**
|
|
685
685
|
* @description Delete Label can be used to delete any Label.
|
|
686
686
|
*
|
|
@@ -689,7 +689,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
689
689
|
* @request DELETE:/api/v3/labels/{label-public-id}
|
|
690
690
|
* @secure
|
|
691
691
|
*/
|
|
692
|
-
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
692
|
+
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
693
693
|
/**
|
|
694
694
|
* @description List all of the Epics with the Label.
|
|
695
695
|
*
|
|
@@ -698,7 +698,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
698
698
|
* @request GET:/api/v3/labels/{label-public-id}/epics
|
|
699
699
|
* @secure
|
|
700
700
|
*/
|
|
701
|
-
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
701
|
+
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicSlim[], any>>;
|
|
702
702
|
/**
|
|
703
703
|
* @description List all of the Stories with the Label.
|
|
704
704
|
*
|
|
@@ -710,7 +710,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
710
710
|
listLabelStories: (labelPublicId: number, query?: {
|
|
711
711
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
712
712
|
includes_description?: boolean;
|
|
713
|
-
}, params?: RequestParams) => Promise<
|
|
713
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
714
714
|
/**
|
|
715
715
|
* @description List Linked Files returns a list of all Linked-Files and their attributes.
|
|
716
716
|
*
|
|
@@ -719,7 +719,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
719
719
|
* @request GET:/api/v3/linked-files
|
|
720
720
|
* @secure
|
|
721
721
|
*/
|
|
722
|
-
listLinkedFiles: (params?: RequestParams) => Promise<
|
|
722
|
+
listLinkedFiles: (params?: RequestParams) => Promise<axios1.AxiosResponse<LinkedFile[], any>>;
|
|
723
723
|
/**
|
|
724
724
|
* @description Create Linked File allows you to create a new Linked File in Shortcut.
|
|
725
725
|
*
|
|
@@ -728,7 +728,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
728
728
|
* @request POST:/api/v3/linked-files
|
|
729
729
|
* @secure
|
|
730
730
|
*/
|
|
731
|
-
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<
|
|
731
|
+
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<axios1.AxiosResponse<LinkedFile, any>>;
|
|
732
732
|
/**
|
|
733
733
|
* @description Get File returns information about the selected Linked File.
|
|
734
734
|
*
|
|
@@ -737,7 +737,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
737
737
|
* @request GET:/api/v3/linked-files/{linked-file-public-id}
|
|
738
738
|
* @secure
|
|
739
739
|
*/
|
|
740
|
-
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
740
|
+
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<LinkedFile, any>>;
|
|
741
741
|
/**
|
|
742
742
|
* @description Updated Linked File allows you to update properties of a previously attached Linked-File.
|
|
743
743
|
*
|
|
@@ -746,7 +746,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
746
746
|
* @request PUT:/api/v3/linked-files/{linked-file-public-id}
|
|
747
747
|
* @secure
|
|
748
748
|
*/
|
|
749
|
-
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<
|
|
749
|
+
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<axios1.AxiosResponse<LinkedFile, any>>;
|
|
750
750
|
/**
|
|
751
751
|
* @description Delete Linked File can be used to delete any previously attached Linked-File.
|
|
752
752
|
*
|
|
@@ -755,7 +755,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
755
755
|
* @request DELETE:/api/v3/linked-files/{linked-file-public-id}
|
|
756
756
|
* @secure
|
|
757
757
|
*/
|
|
758
|
-
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
758
|
+
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
759
759
|
/**
|
|
760
760
|
* @description Returns information about the authenticated member.
|
|
761
761
|
*
|
|
@@ -764,7 +764,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
764
764
|
* @request GET:/api/v3/member
|
|
765
765
|
* @secure
|
|
766
766
|
*/
|
|
767
|
-
getCurrentMemberInfo: (params?: RequestParams) => Promise<
|
|
767
|
+
getCurrentMemberInfo: (params?: RequestParams) => Promise<axios1.AxiosResponse<MemberInfo, any>>;
|
|
768
768
|
/**
|
|
769
769
|
* @description Returns information about members of the Workspace.
|
|
770
770
|
*
|
|
@@ -781,7 +781,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
781
781
|
"org-public-id"?: string;
|
|
782
782
|
/** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
|
|
783
783
|
disabled?: boolean;
|
|
784
|
-
}, params?: RequestParams) => Promise<
|
|
784
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<Member[], any>>;
|
|
785
785
|
/**
|
|
786
786
|
* @description Returns information about a Member.
|
|
787
787
|
*
|
|
@@ -796,7 +796,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
796
796
|
* @format uuid
|
|
797
797
|
*/
|
|
798
798
|
"org-public-id"?: string;
|
|
799
|
-
}, params?: RequestParams) => Promise<
|
|
799
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<Member, any>>;
|
|
800
800
|
/**
|
|
801
801
|
* @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
|
|
802
802
|
*
|
|
@@ -805,7 +805,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
805
805
|
* @request GET:/api/v3/milestones
|
|
806
806
|
* @secure
|
|
807
807
|
*/
|
|
808
|
-
listMilestones: (params?: RequestParams) => Promise<
|
|
808
|
+
listMilestones: (params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone[], any>>;
|
|
809
809
|
/**
|
|
810
810
|
* @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
|
|
811
811
|
*
|
|
@@ -814,7 +814,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
814
814
|
* @request POST:/api/v3/milestones
|
|
815
815
|
* @secure
|
|
816
816
|
*/
|
|
817
|
-
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<
|
|
817
|
+
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone, any>>;
|
|
818
818
|
/**
|
|
819
819
|
* @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
|
|
820
820
|
*
|
|
@@ -823,7 +823,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
823
823
|
* @request GET:/api/v3/milestones/{milestone-public-id}
|
|
824
824
|
* @secure
|
|
825
825
|
*/
|
|
826
|
-
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
826
|
+
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone, any>>;
|
|
827
827
|
/**
|
|
828
828
|
* @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
|
|
829
829
|
*
|
|
@@ -832,7 +832,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
832
832
|
* @request PUT:/api/v3/milestones/{milestone-public-id}
|
|
833
833
|
* @secure
|
|
834
834
|
*/
|
|
835
|
-
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<
|
|
835
|
+
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<axios1.AxiosResponse<Milestone, any>>;
|
|
836
836
|
/**
|
|
837
837
|
* @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
|
|
838
838
|
*
|
|
@@ -841,7 +841,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
841
841
|
* @request DELETE:/api/v3/milestones/{milestone-public-id}
|
|
842
842
|
* @secure
|
|
843
843
|
*/
|
|
844
|
-
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
844
|
+
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
845
845
|
/**
|
|
846
846
|
* @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
|
|
847
847
|
*
|
|
@@ -850,7 +850,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
850
850
|
* @request GET:/api/v3/milestones/{milestone-public-id}/epics
|
|
851
851
|
* @secure
|
|
852
852
|
*/
|
|
853
|
-
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
853
|
+
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicSlim[], any>>;
|
|
854
854
|
/**
|
|
855
855
|
* @description List Objectives returns a list of all Objectives and their attributes.
|
|
856
856
|
*
|
|
@@ -859,7 +859,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
859
859
|
* @request GET:/api/v3/objectives
|
|
860
860
|
* @secure
|
|
861
861
|
*/
|
|
862
|
-
listObjectives: (params?: RequestParams) => Promise<
|
|
862
|
+
listObjectives: (params?: RequestParams) => Promise<axios1.AxiosResponse<Objective[], any>>;
|
|
863
863
|
/**
|
|
864
864
|
* @description Create Objective allows you to create a new Objective in Shortcut.
|
|
865
865
|
*
|
|
@@ -868,7 +868,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
868
868
|
* @request POST:/api/v3/objectives
|
|
869
869
|
* @secure
|
|
870
870
|
*/
|
|
871
|
-
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<
|
|
871
|
+
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<axios1.AxiosResponse<Objective, any>>;
|
|
872
872
|
/**
|
|
873
873
|
* @description Get Objective returns information about a chosen Objective.
|
|
874
874
|
*
|
|
@@ -877,7 +877,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
877
877
|
* @request GET:/api/v3/objectives/{objective-public-id}
|
|
878
878
|
* @secure
|
|
879
879
|
*/
|
|
880
|
-
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
880
|
+
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Objective, any>>;
|
|
881
881
|
/**
|
|
882
882
|
* @description Update Objective can be used to update Objective properties.
|
|
883
883
|
*
|
|
@@ -886,7 +886,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
886
886
|
* @request PUT:/api/v3/objectives/{objective-public-id}
|
|
887
887
|
* @secure
|
|
888
888
|
*/
|
|
889
|
-
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<
|
|
889
|
+
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<axios1.AxiosResponse<Objective, any>>;
|
|
890
890
|
/**
|
|
891
891
|
* @description Delete Objective can be used to delete any Objective.
|
|
892
892
|
*
|
|
@@ -895,7 +895,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
895
895
|
* @request DELETE:/api/v3/objectives/{objective-public-id}
|
|
896
896
|
* @secure
|
|
897
897
|
*/
|
|
898
|
-
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
898
|
+
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
899
899
|
/**
|
|
900
900
|
* @description List all of the Epics within the Objective.
|
|
901
901
|
*
|
|
@@ -904,7 +904,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
904
904
|
* @request GET:/api/v3/objectives/{objective-public-id}/epics
|
|
905
905
|
* @secure
|
|
906
906
|
*/
|
|
907
|
-
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
907
|
+
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicSlim[], any>>;
|
|
908
908
|
/**
|
|
909
909
|
* @description List Projects returns a list of all Projects and their attributes.
|
|
910
910
|
*
|
|
@@ -913,7 +913,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
913
913
|
* @request GET:/api/v3/projects
|
|
914
914
|
* @secure
|
|
915
915
|
*/
|
|
916
|
-
listProjects: (params?: RequestParams) => Promise<
|
|
916
|
+
listProjects: (params?: RequestParams) => Promise<axios1.AxiosResponse<Project[], any>>;
|
|
917
917
|
/**
|
|
918
918
|
* @description Create Project is used to create a new Shortcut Project.
|
|
919
919
|
*
|
|
@@ -922,7 +922,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
922
922
|
* @request POST:/api/v3/projects
|
|
923
923
|
* @secure
|
|
924
924
|
*/
|
|
925
|
-
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<
|
|
925
|
+
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<axios1.AxiosResponse<Project, any>>;
|
|
926
926
|
/**
|
|
927
927
|
* @description Get Project returns information about the selected Project.
|
|
928
928
|
*
|
|
@@ -931,7 +931,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
931
931
|
* @request GET:/api/v3/projects/{project-public-id}
|
|
932
932
|
* @secure
|
|
933
933
|
*/
|
|
934
|
-
getProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
934
|
+
getProject: (projectPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Project, any>>;
|
|
935
935
|
/**
|
|
936
936
|
* @description Update Project can be used to change properties of a Project.
|
|
937
937
|
*
|
|
@@ -940,7 +940,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
940
940
|
* @request PUT:/api/v3/projects/{project-public-id}
|
|
941
941
|
* @secure
|
|
942
942
|
*/
|
|
943
|
-
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<
|
|
943
|
+
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<axios1.AxiosResponse<Project, any>>;
|
|
944
944
|
/**
|
|
945
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
946
|
*
|
|
@@ -949,7 +949,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
949
949
|
* @request DELETE:/api/v3/projects/{project-public-id}
|
|
950
950
|
* @secure
|
|
951
951
|
*/
|
|
952
|
-
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
952
|
+
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
953
953
|
/**
|
|
954
954
|
* @description List Stories returns a list of all Stories in a selected Project and their attributes.
|
|
955
955
|
*
|
|
@@ -961,7 +961,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
961
961
|
listStories: (projectPublicId: number, query?: {
|
|
962
962
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
963
963
|
includes_description?: boolean;
|
|
964
|
-
}, params?: RequestParams) => Promise<
|
|
964
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
965
965
|
/**
|
|
966
966
|
* @description List Repositories returns a list of all Repositories and their attributes.
|
|
967
967
|
*
|
|
@@ -970,7 +970,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
970
970
|
* @request GET:/api/v3/repositories
|
|
971
971
|
* @secure
|
|
972
972
|
*/
|
|
973
|
-
listRepositories: (params?: RequestParams) => Promise<
|
|
973
|
+
listRepositories: (params?: RequestParams) => Promise<axios1.AxiosResponse<Repository[], any>>;
|
|
974
974
|
/**
|
|
975
975
|
* @description Get Repository returns information about the selected Repository.
|
|
976
976
|
*
|
|
@@ -979,7 +979,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
979
979
|
* @request GET:/api/v3/repositories/{repo-public-id}
|
|
980
980
|
* @secure
|
|
981
981
|
*/
|
|
982
|
-
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<
|
|
982
|
+
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Repository, any>>;
|
|
983
983
|
/**
|
|
984
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
985
|
*
|
|
@@ -1012,7 +1012,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1012
1012
|
next?: string;
|
|
1013
1013
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1014
1014
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1015
|
-
}, params?: RequestParams) => Promise<
|
|
1015
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<SearchResults, any>>;
|
|
1016
1016
|
/**
|
|
1017
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
1018
|
*
|
|
@@ -1045,7 +1045,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1045
1045
|
next?: string;
|
|
1046
1046
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1047
1047
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1048
|
-
}, params?: RequestParams) => Promise<
|
|
1048
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<EpicSearchResults, any>>;
|
|
1049
1049
|
/**
|
|
1050
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
1051
|
*
|
|
@@ -1078,7 +1078,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1078
1078
|
next?: string;
|
|
1079
1079
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1080
1080
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1081
|
-
}, params?: RequestParams) => Promise<
|
|
1081
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<IterationSearchResults, any>>;
|
|
1082
1082
|
/**
|
|
1083
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
1084
|
*
|
|
@@ -1111,7 +1111,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1111
1111
|
next?: string;
|
|
1112
1112
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1113
1113
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1114
|
-
}, params?: RequestParams) => Promise<
|
|
1114
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<ObjectiveSearchResults, any>>;
|
|
1115
1115
|
/**
|
|
1116
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
1117
|
*
|
|
@@ -1144,7 +1144,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1144
1144
|
next?: string;
|
|
1145
1145
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1146
1146
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1147
|
-
}, params?: RequestParams) => Promise<
|
|
1147
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<ObjectiveSearchResults, any>>;
|
|
1148
1148
|
/**
|
|
1149
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
1150
|
*
|
|
@@ -1177,7 +1177,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1177
1177
|
next?: string;
|
|
1178
1178
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1179
1179
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1180
|
-
}, params?: RequestParams) => Promise<
|
|
1180
|
+
}, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySearchResults, any>>;
|
|
1181
1181
|
/**
|
|
1182
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
1183
|
*
|
|
@@ -1186,7 +1186,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1186
1186
|
* @request POST:/api/v3/stories
|
|
1187
1187
|
* @secure
|
|
1188
1188
|
*/
|
|
1189
|
-
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<
|
|
1189
|
+
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<axios1.AxiosResponse<Story, any>>;
|
|
1190
1190
|
/**
|
|
1191
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
1192
|
*
|
|
@@ -1195,7 +1195,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1195
1195
|
* @request POST:/api/v3/stories/bulk
|
|
1196
1196
|
* @secure
|
|
1197
1197
|
*/
|
|
1198
|
-
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<
|
|
1198
|
+
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
1199
1199
|
/**
|
|
1200
1200
|
* @description Update Multiple Stories allows you to make changes to numerous stories at once.
|
|
1201
1201
|
*
|
|
@@ -1204,7 +1204,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1204
1204
|
* @request PUT:/api/v3/stories/bulk
|
|
1205
1205
|
* @secure
|
|
1206
1206
|
*/
|
|
1207
|
-
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<
|
|
1207
|
+
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
1208
1208
|
/**
|
|
1209
1209
|
* @description Delete Multiple Stories allows you to delete multiple archived stories at once.
|
|
1210
1210
|
*
|
|
@@ -1213,7 +1213,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1213
1213
|
* @request DELETE:/api/v3/stories/bulk
|
|
1214
1214
|
* @secure
|
|
1215
1215
|
*/
|
|
1216
|
-
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<
|
|
1216
|
+
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1217
1217
|
/**
|
|
1218
1218
|
* @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
|
|
1219
1219
|
*
|
|
@@ -1222,16 +1222,16 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1222
1222
|
* @request POST:/api/v3/stories/from-template
|
|
1223
1223
|
* @secure
|
|
1224
1224
|
*/
|
|
1225
|
-
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<
|
|
1225
|
+
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<axios1.AxiosResponse<Story, any>>;
|
|
1226
1226
|
/**
|
|
1227
1227
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1228
1228
|
*
|
|
1229
|
-
* @name
|
|
1230
|
-
* @summary
|
|
1229
|
+
* @name QueryStories
|
|
1230
|
+
* @summary Query Stories
|
|
1231
1231
|
* @request POST:/api/v3/stories/search
|
|
1232
1232
|
* @secure
|
|
1233
1233
|
*/
|
|
1234
|
-
|
|
1234
|
+
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<axios1.AxiosResponse<StorySlim[], any>>;
|
|
1235
1235
|
/**
|
|
1236
1236
|
* @description Get Story returns information about a chosen Story.
|
|
1237
1237
|
*
|
|
@@ -1240,7 +1240,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1240
1240
|
* @request GET:/api/v3/stories/{story-public-id}
|
|
1241
1241
|
* @secure
|
|
1242
1242
|
*/
|
|
1243
|
-
getStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1243
|
+
getStory: (storyPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Story, any>>;
|
|
1244
1244
|
/**
|
|
1245
1245
|
* @description Update Story can be used to update Story properties.
|
|
1246
1246
|
*
|
|
@@ -1249,7 +1249,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1249
1249
|
* @request PUT:/api/v3/stories/{story-public-id}
|
|
1250
1250
|
* @secure
|
|
1251
1251
|
*/
|
|
1252
|
-
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<
|
|
1252
|
+
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<axios1.AxiosResponse<Story, any>>;
|
|
1253
1253
|
/**
|
|
1254
1254
|
* @description Delete Story can be used to delete any Story.
|
|
1255
1255
|
*
|
|
@@ -1258,7 +1258,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1258
1258
|
* @request DELETE:/api/v3/stories/{story-public-id}
|
|
1259
1259
|
* @secure
|
|
1260
1260
|
*/
|
|
1261
|
-
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1261
|
+
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1262
1262
|
/**
|
|
1263
1263
|
* @description Lists Comments associated with a Story
|
|
1264
1264
|
*
|
|
@@ -1267,7 +1267,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1267
1267
|
* @request GET:/api/v3/stories/{story-public-id}/comments
|
|
1268
1268
|
* @secure
|
|
1269
1269
|
*/
|
|
1270
|
-
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1270
|
+
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryComment[], any>>;
|
|
1271
1271
|
/**
|
|
1272
1272
|
* @description Create Comment allows you to create a Comment on any Story.
|
|
1273
1273
|
*
|
|
@@ -1276,7 +1276,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1276
1276
|
* @request POST:/api/v3/stories/{story-public-id}/comments
|
|
1277
1277
|
* @secure
|
|
1278
1278
|
*/
|
|
1279
|
-
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<
|
|
1279
|
+
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryComment, any>>;
|
|
1280
1280
|
/**
|
|
1281
1281
|
* @description Get Comment is used to get Comment information.
|
|
1282
1282
|
*
|
|
@@ -1285,7 +1285,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1285
1285
|
* @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1286
1286
|
* @secure
|
|
1287
1287
|
*/
|
|
1288
|
-
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1288
|
+
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryComment, any>>;
|
|
1289
1289
|
/**
|
|
1290
1290
|
* @description Update Comment replaces the text of the existing Comment.
|
|
1291
1291
|
*
|
|
@@ -1294,7 +1294,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1294
1294
|
* @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1295
1295
|
* @secure
|
|
1296
1296
|
*/
|
|
1297
|
-
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<
|
|
1297
|
+
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryComment, any>>;
|
|
1298
1298
|
/**
|
|
1299
1299
|
* @description Delete a Comment from any story.
|
|
1300
1300
|
*
|
|
@@ -1303,7 +1303,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1303
1303
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1304
1304
|
* @secure
|
|
1305
1305
|
*/
|
|
1306
|
-
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1306
|
+
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1307
1307
|
/**
|
|
1308
1308
|
* @description Create a reaction to a story comment.
|
|
1309
1309
|
*
|
|
@@ -1312,7 +1312,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1312
1312
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1313
1313
|
* @secure
|
|
1314
1314
|
*/
|
|
1315
|
-
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1315
|
+
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryReaction[], any>>;
|
|
1316
1316
|
/**
|
|
1317
1317
|
* @description Delete a reaction from any story comment.
|
|
1318
1318
|
*
|
|
@@ -1321,7 +1321,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1321
1321
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1322
1322
|
* @secure
|
|
1323
1323
|
*/
|
|
1324
|
-
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1324
|
+
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
|
|
1327
1327
|
*
|
|
@@ -1330,7 +1330,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1330
1330
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
|
|
1331
1331
|
* @secure
|
|
1332
1332
|
*/
|
|
1333
|
-
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1333
|
+
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryComment, any>>;
|
|
1334
1334
|
/**
|
|
1335
1335
|
* No description
|
|
1336
1336
|
*
|
|
@@ -1339,7 +1339,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1339
1339
|
* @request GET:/api/v3/stories/{story-public-id}/history
|
|
1340
1340
|
* @secure
|
|
1341
1341
|
*/
|
|
1342
|
-
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1342
|
+
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<History[], any>>;
|
|
1343
1343
|
/**
|
|
1344
1344
|
* @description Create Task is used to create a new task in a Story.
|
|
1345
1345
|
*
|
|
@@ -1348,7 +1348,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1348
1348
|
* @request POST:/api/v3/stories/{story-public-id}/tasks
|
|
1349
1349
|
* @secure
|
|
1350
1350
|
*/
|
|
1351
|
-
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<
|
|
1351
|
+
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<axios1.AxiosResponse<Task, any>>;
|
|
1352
1352
|
/**
|
|
1353
1353
|
* @description Returns information about a chosen Task.
|
|
1354
1354
|
*
|
|
@@ -1357,7 +1357,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1357
1357
|
* @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1358
1358
|
* @secure
|
|
1359
1359
|
*/
|
|
1360
|
-
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1360
|
+
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Task, any>>;
|
|
1361
1361
|
/**
|
|
1362
1362
|
* @description Update Task can be used to update Task properties.
|
|
1363
1363
|
*
|
|
@@ -1366,7 +1366,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1366
1366
|
* @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1367
1367
|
* @secure
|
|
1368
1368
|
*/
|
|
1369
|
-
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<
|
|
1369
|
+
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<axios1.AxiosResponse<Task, any>>;
|
|
1370
1370
|
/**
|
|
1371
1371
|
* @description Delete Task can be used to delete any previously created Task on a Story.
|
|
1372
1372
|
*
|
|
@@ -1375,7 +1375,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1375
1375
|
* @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1376
1376
|
* @secure
|
|
1377
1377
|
*/
|
|
1378
|
-
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1378
|
+
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1379
1379
|
/**
|
|
1380
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
1381
|
*
|
|
@@ -1384,7 +1384,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1384
1384
|
* @request POST:/api/v3/story-links
|
|
1385
1385
|
* @secure
|
|
1386
1386
|
*/
|
|
1387
|
-
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<
|
|
1387
|
+
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryLink, any>>;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* @description Returns the stories and their relationship for the given Story Link.
|
|
1390
1390
|
*
|
|
@@ -1393,7 +1393,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1393
1393
|
* @request GET:/api/v3/story-links/{story-link-public-id}
|
|
1394
1394
|
* @secure
|
|
1395
1395
|
*/
|
|
1396
|
-
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1396
|
+
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryLink, any>>;
|
|
1397
1397
|
/**
|
|
1398
1398
|
* @description Updates the stories and/or the relationship for the given Story Link.
|
|
1399
1399
|
*
|
|
@@ -1402,7 +1402,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1402
1402
|
* @request PUT:/api/v3/story-links/{story-link-public-id}
|
|
1403
1403
|
* @secure
|
|
1404
1404
|
*/
|
|
1405
|
-
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<
|
|
1405
|
+
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<axios1.AxiosResponse<StoryLink, any>>;
|
|
1406
1406
|
/**
|
|
1407
1407
|
* @description Removes the relationship between the stories for the given Story Link.
|
|
1408
1408
|
*
|
|
@@ -1411,7 +1411,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1411
1411
|
* @request DELETE:/api/v3/story-links/{story-link-public-id}
|
|
1412
1412
|
* @secure
|
|
1413
1413
|
*/
|
|
1414
|
-
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1414
|
+
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<void, any>>;
|
|
1415
1415
|
/**
|
|
1416
1416
|
* @description Returns a list of all Workflows in the Workspace.
|
|
1417
1417
|
*
|
|
@@ -1420,7 +1420,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1420
1420
|
* @request GET:/api/v3/workflows
|
|
1421
1421
|
* @secure
|
|
1422
1422
|
*/
|
|
1423
|
-
listWorkflows: (params?: RequestParams) => Promise<
|
|
1423
|
+
listWorkflows: (params?: RequestParams) => Promise<axios1.AxiosResponse<Workflow[], any>>;
|
|
1424
1424
|
/**
|
|
1425
1425
|
* @description Get Workflow returns information about a chosen Workflow.
|
|
1426
1426
|
*
|
|
@@ -1429,7 +1429,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1429
1429
|
* @request GET:/api/v3/workflows/{workflow-public-id}
|
|
1430
1430
|
* @secure
|
|
1431
1431
|
*/
|
|
1432
|
-
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<
|
|
1432
|
+
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<axios1.AxiosResponse<Workflow, any>>;
|
|
1433
1433
|
}
|
|
1434
1434
|
//#endregion
|
|
1435
1435
|
export { Api };
|