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