@shortcut/client 2.3.1 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/lib/ShortcutClient.d.mts +1 -13
- package/lib/ShortcutClient.d.ts +1 -13
- package/lib/ShortcutClient.js +0 -19
- package/lib/ShortcutClient.mjs +0 -19
- package/lib/generated/Api.d.mts +205 -135
- package/lib/generated/Api.d.ts +205 -135
- package/lib/generated/Api.js +83 -2
- package/lib/generated/Api.mjs +83 -2
- package/lib/generated/data-contracts.d.mts +113 -13
- package/lib/generated/data-contracts.d.ts +113 -13
- package/lib/index.d.mts +2 -2
- package/lib/index.d.ts +2 -2
- package/package.json +1 -1
package/lib/generated/Api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
|
|
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, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, GetDoc, 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, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client.js";
|
|
3
|
-
import * as
|
|
3
|
+
import * as axios0 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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.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<axios0.AxiosResponse<void, any, {}>>;
|
|
111
111
|
/**
|
|
112
112
|
* @description List Docs returns a list of Doc that the current user can read.
|
|
113
113
|
*
|
|
@@ -116,16 +116,46 @@ 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<axios0.AxiosResponse<DocSlim[], any, {}>>;
|
|
120
120
|
/**
|
|
121
|
-
* @description Creates a new Doc.
|
|
121
|
+
* @description Creates a new Doc. Supports markdown or HTML input via content_format parameter.
|
|
122
122
|
*
|
|
123
123
|
* @name CreateDoc
|
|
124
124
|
* @summary Create Doc
|
|
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<axios0.AxiosResponse<DocSlim, any, {}>>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
131
|
+
*
|
|
132
|
+
* @name GetDoc
|
|
133
|
+
* @summary Get Doc
|
|
134
|
+
* @request GET:/api/v3/documents/{doc-public-id}
|
|
135
|
+
* @secure
|
|
136
|
+
*/
|
|
137
|
+
getDoc: (docPublicId: string, query?: {
|
|
138
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
139
|
+
content_format?: "markdown" | "html";
|
|
140
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
141
|
+
/**
|
|
142
|
+
* @description Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. When a document is updated: (1) If users are connected, SSE events notify them to refresh their view. (2) If no users are connected, CKEditor cache is flushed to ensure fresh content.
|
|
143
|
+
*
|
|
144
|
+
* @name UpdateDoc
|
|
145
|
+
* @summary Update Doc
|
|
146
|
+
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
147
|
+
* @secure
|
|
148
|
+
*/
|
|
149
|
+
updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
150
|
+
/**
|
|
151
|
+
* @description Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
|
|
152
|
+
*
|
|
153
|
+
* @name DeleteDoc
|
|
154
|
+
* @summary Delete Doc
|
|
155
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
156
|
+
* @secure
|
|
157
|
+
*/
|
|
158
|
+
deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
129
159
|
/**
|
|
130
160
|
* @description List all the entity templates for the Workspace.
|
|
131
161
|
*
|
|
@@ -134,7 +164,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
134
164
|
* @request GET:/api/v3/entity-templates
|
|
135
165
|
* @secure
|
|
136
166
|
*/
|
|
137
|
-
listEntityTemplates: (params?: RequestParams) => Promise<
|
|
167
|
+
listEntityTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate[], any, {}>>;
|
|
138
168
|
/**
|
|
139
169
|
* @description Create a new entity template for the Workspace.
|
|
140
170
|
*
|
|
@@ -143,7 +173,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
143
173
|
* @request POST:/api/v3/entity-templates
|
|
144
174
|
* @secure
|
|
145
175
|
*/
|
|
146
|
-
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<
|
|
176
|
+
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
147
177
|
/**
|
|
148
178
|
* @description Disables the Story Template feature for the Workspace.
|
|
149
179
|
*
|
|
@@ -152,7 +182,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
152
182
|
* @request PUT:/api/v3/entity-templates/disable
|
|
153
183
|
* @secure
|
|
154
184
|
*/
|
|
155
|
-
disableStoryTemplates: (params?: RequestParams) => Promise<
|
|
185
|
+
disableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
156
186
|
/**
|
|
157
187
|
* @description Enables the Story Template feature for the Workspace.
|
|
158
188
|
*
|
|
@@ -161,7 +191,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
161
191
|
* @request PUT:/api/v3/entity-templates/enable
|
|
162
192
|
* @secure
|
|
163
193
|
*/
|
|
164
|
-
enableStoryTemplates: (params?: RequestParams) => Promise<
|
|
194
|
+
enableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
165
195
|
/**
|
|
166
196
|
* @description Get Entity Template returns information about a given entity template.
|
|
167
197
|
*
|
|
@@ -170,7 +200,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
170
200
|
* @request GET:/api/v3/entity-templates/{entity-template-public-id}
|
|
171
201
|
* @secure
|
|
172
202
|
*/
|
|
173
|
-
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
203
|
+
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
174
204
|
/**
|
|
175
205
|
* @description Update an entity template's name or its contents.
|
|
176
206
|
*
|
|
@@ -179,7 +209,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
179
209
|
* @request PUT:/api/v3/entity-templates/{entity-template-public-id}
|
|
180
210
|
* @secure
|
|
181
211
|
*/
|
|
182
|
-
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<
|
|
212
|
+
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
183
213
|
/**
|
|
184
214
|
* No description
|
|
185
215
|
*
|
|
@@ -188,7 +218,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
188
218
|
* @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
|
|
189
219
|
* @secure
|
|
190
220
|
*/
|
|
191
|
-
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
221
|
+
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
192
222
|
/**
|
|
193
223
|
* @description Returns the Epic Workflow for the Workspace.
|
|
194
224
|
*
|
|
@@ -197,7 +227,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
197
227
|
* @request GET:/api/v3/epic-workflow
|
|
198
228
|
* @secure
|
|
199
229
|
*/
|
|
200
|
-
getEpicWorkflow: (params?: RequestParams) => Promise<
|
|
230
|
+
getEpicWorkflow: (params?: RequestParams) => Promise<axios0.AxiosResponse<EpicWorkflow, any, {}>>;
|
|
201
231
|
/**
|
|
202
232
|
* @description List Epics returns a list of all Epics and their attributes.
|
|
203
233
|
*
|
|
@@ -209,7 +239,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
209
239
|
listEpics: (query?: {
|
|
210
240
|
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
211
241
|
includes_description?: boolean;
|
|
212
|
-
}, params?: RequestParams) => Promise<
|
|
242
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
213
243
|
/**
|
|
214
244
|
* @description Create Epic allows you to create a new Epic in Shortcut.
|
|
215
245
|
*
|
|
@@ -218,7 +248,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
218
248
|
* @request POST:/api/v3/epics
|
|
219
249
|
* @secure
|
|
220
250
|
*/
|
|
221
|
-
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<
|
|
251
|
+
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
222
252
|
/**
|
|
223
253
|
* @description List Epics with pagination returns a paginated list of Epics and their attributes.
|
|
224
254
|
*
|
|
@@ -240,7 +270,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
240
270
|
* @format int64
|
|
241
271
|
*/
|
|
242
272
|
page_size?: number;
|
|
243
|
-
}, params?: RequestParams) => Promise<
|
|
273
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicPaginatedResults, any, {}>>;
|
|
244
274
|
/**
|
|
245
275
|
* @description Get Epic returns information about the selected Epic.
|
|
246
276
|
*
|
|
@@ -249,7 +279,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
249
279
|
* @request GET:/api/v3/epics/{epic-public-id}
|
|
250
280
|
* @secure
|
|
251
281
|
*/
|
|
252
|
-
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
282
|
+
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
253
283
|
/**
|
|
254
284
|
* @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
285
|
*
|
|
@@ -258,7 +288,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
258
288
|
* @request PUT:/api/v3/epics/{epic-public-id}
|
|
259
289
|
* @secure
|
|
260
290
|
*/
|
|
261
|
-
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<
|
|
291
|
+
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
262
292
|
/**
|
|
263
293
|
* @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
|
|
264
294
|
*
|
|
@@ -267,7 +297,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
267
297
|
* @request DELETE:/api/v3/epics/{epic-public-id}
|
|
268
298
|
* @secure
|
|
269
299
|
*/
|
|
270
|
-
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
300
|
+
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
271
301
|
/**
|
|
272
302
|
* @description Get a list of all Comments on an Epic.
|
|
273
303
|
*
|
|
@@ -276,7 +306,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
276
306
|
* @request GET:/api/v3/epics/{epic-public-id}/comments
|
|
277
307
|
* @secure
|
|
278
308
|
*/
|
|
279
|
-
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
309
|
+
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment[], any, {}>>;
|
|
280
310
|
/**
|
|
281
311
|
* @description This endpoint allows you to create a threaded Comment on an Epic.
|
|
282
312
|
*
|
|
@@ -285,7 +315,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
285
315
|
* @request POST:/api/v3/epics/{epic-public-id}/comments
|
|
286
316
|
* @secure
|
|
287
317
|
*/
|
|
288
|
-
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<
|
|
318
|
+
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
289
319
|
/**
|
|
290
320
|
* @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
|
|
291
321
|
*
|
|
@@ -294,7 +324,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
294
324
|
* @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
295
325
|
* @secure
|
|
296
326
|
*/
|
|
297
|
-
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<
|
|
327
|
+
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
298
328
|
/**
|
|
299
329
|
* @description This endpoint returns information about the selected Epic Comment.
|
|
300
330
|
*
|
|
@@ -303,7 +333,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
303
333
|
* @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
304
334
|
* @secure
|
|
305
335
|
*/
|
|
306
|
-
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
336
|
+
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
307
337
|
/**
|
|
308
338
|
* @description This endpoint allows you to update a threaded Comment on an Epic.
|
|
309
339
|
*
|
|
@@ -312,7 +342,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
312
342
|
* @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
313
343
|
* @secure
|
|
314
344
|
*/
|
|
315
|
-
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<
|
|
345
|
+
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
316
346
|
/**
|
|
317
347
|
* @description This endpoint allows you to delete a Comment from an Epic.
|
|
318
348
|
*
|
|
@@ -321,7 +351,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
321
351
|
* @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
322
352
|
* @secure
|
|
323
353
|
*/
|
|
324
|
-
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
354
|
+
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
325
355
|
/**
|
|
326
356
|
* @description Get the current health for the specified Epic.
|
|
327
357
|
*
|
|
@@ -330,7 +360,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
330
360
|
* @request GET:/api/v3/epics/{epic-public-id}/health
|
|
331
361
|
* @secure
|
|
332
362
|
*/
|
|
333
|
-
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
363
|
+
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
334
364
|
/**
|
|
335
365
|
* @description Create a new health status for the specified Epic.
|
|
336
366
|
*
|
|
@@ -339,7 +369,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
339
369
|
* @request POST:/api/v3/epics/{epic-public-id}/health
|
|
340
370
|
* @secure
|
|
341
371
|
*/
|
|
342
|
-
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<
|
|
372
|
+
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
343
373
|
/**
|
|
344
374
|
* @description List the history of health statuses for the specified Epic, most recent first.
|
|
345
375
|
*
|
|
@@ -348,7 +378,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
348
378
|
* @request GET:/api/v3/epics/{epic-public-id}/health-history
|
|
349
379
|
* @secure
|
|
350
380
|
*/
|
|
351
|
-
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
381
|
+
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health[], any, {}>>;
|
|
352
382
|
/**
|
|
353
383
|
* @description Get a list of all Stories in an Epic.
|
|
354
384
|
*
|
|
@@ -360,7 +390,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
360
390
|
listEpicStories: (epicPublicId: number, query?: {
|
|
361
391
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
362
392
|
includes_description?: boolean;
|
|
363
|
-
}, params?: RequestParams) => Promise<
|
|
393
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
364
394
|
/**
|
|
365
395
|
* @description This endpoint allows you to unlink a productboard epic.
|
|
366
396
|
*
|
|
@@ -369,7 +399,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
369
399
|
* @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
|
|
370
400
|
* @secure
|
|
371
401
|
*/
|
|
372
|
-
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
402
|
+
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
373
403
|
/**
|
|
374
404
|
* @description Get Stories which have a given External Link associated with them.
|
|
375
405
|
*
|
|
@@ -385,7 +415,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
385
415
|
* @pattern ^https?://.+$
|
|
386
416
|
*/
|
|
387
417
|
external_link: string;
|
|
388
|
-
}, params?: RequestParams) => Promise<
|
|
418
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
389
419
|
/**
|
|
390
420
|
* @description List Files returns a list of all UploadedFiles in the workspace.
|
|
391
421
|
*
|
|
@@ -394,7 +424,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
394
424
|
* @request GET:/api/v3/files
|
|
395
425
|
* @secure
|
|
396
426
|
*/
|
|
397
|
-
listFiles: (params?: RequestParams) => Promise<
|
|
427
|
+
listFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any, {}>>;
|
|
398
428
|
/**
|
|
399
429
|
* @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
430
|
*
|
|
@@ -429,7 +459,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
429
459
|
* @format binary
|
|
430
460
|
*/
|
|
431
461
|
file3?: File;
|
|
432
|
-
}, params?: RequestParams) => Promise<
|
|
462
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any, {}>>;
|
|
433
463
|
/**
|
|
434
464
|
* @description Get File returns information about the selected UploadedFile.
|
|
435
465
|
*
|
|
@@ -438,7 +468,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
438
468
|
* @request GET:/api/v3/files/{file-public-id}
|
|
439
469
|
* @secure
|
|
440
470
|
*/
|
|
441
|
-
getFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
471
|
+
getFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any, {}>>;
|
|
442
472
|
/**
|
|
443
473
|
* @description Update File updates the properties of an UploadedFile (but not its content).
|
|
444
474
|
*
|
|
@@ -447,7 +477,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
447
477
|
* @request PUT:/api/v3/files/{file-public-id}
|
|
448
478
|
* @secure
|
|
449
479
|
*/
|
|
450
|
-
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<
|
|
480
|
+
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any, {}>>;
|
|
451
481
|
/**
|
|
452
482
|
* @description Delete File deletes a previously uploaded file.
|
|
453
483
|
*
|
|
@@ -456,7 +486,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
456
486
|
* @request DELETE:/api/v3/files/{file-public-id}
|
|
457
487
|
* @secure
|
|
458
488
|
*/
|
|
459
|
-
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
489
|
+
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
460
490
|
/**
|
|
461
491
|
* @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
492
|
*
|
|
@@ -465,7 +495,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
465
495
|
* @request GET:/api/v3/groups
|
|
466
496
|
* @secure
|
|
467
497
|
*/
|
|
468
|
-
listGroups: (
|
|
498
|
+
listGroups: (query?: {
|
|
499
|
+
/** Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups */
|
|
500
|
+
archived?: boolean;
|
|
501
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Group[], any, {}>>;
|
|
469
502
|
/**
|
|
470
503
|
* No description
|
|
471
504
|
*
|
|
@@ -474,7 +507,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
474
507
|
* @request POST:/api/v3/groups
|
|
475
508
|
* @secure
|
|
476
509
|
*/
|
|
477
|
-
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<
|
|
510
|
+
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
478
511
|
/**
|
|
479
512
|
* No description
|
|
480
513
|
*
|
|
@@ -483,7 +516,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
483
516
|
* @request GET:/api/v3/groups/{group-public-id}
|
|
484
517
|
* @secure
|
|
485
518
|
*/
|
|
486
|
-
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<
|
|
519
|
+
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
487
520
|
/**
|
|
488
521
|
* No description
|
|
489
522
|
*
|
|
@@ -492,7 +525,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
492
525
|
* @request PUT:/api/v3/groups/{group-public-id}
|
|
493
526
|
* @secure
|
|
494
527
|
*/
|
|
495
|
-
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<
|
|
528
|
+
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
496
529
|
/**
|
|
497
530
|
* @description List the Stories assigned to the Group. (By default, limited to 1,000).
|
|
498
531
|
*
|
|
@@ -512,7 +545,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
512
545
|
* @format int64
|
|
513
546
|
*/
|
|
514
547
|
offset?: number;
|
|
515
|
-
}, params?: RequestParams) => Promise<
|
|
548
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
516
549
|
/**
|
|
517
550
|
* @description Update an existing health status by its ID.
|
|
518
551
|
*
|
|
@@ -521,7 +554,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
521
554
|
* @request PUT:/api/v3/health/{health-public-id}
|
|
522
555
|
* @secure
|
|
523
556
|
*/
|
|
524
|
-
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<
|
|
557
|
+
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
525
558
|
/**
|
|
526
559
|
* No description
|
|
527
560
|
*
|
|
@@ -530,7 +563,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
530
563
|
* @request POST:/api/v3/integrations/webhook
|
|
531
564
|
* @secure
|
|
532
565
|
*/
|
|
533
|
-
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<
|
|
566
|
+
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
534
567
|
/**
|
|
535
568
|
* No description
|
|
536
569
|
*
|
|
@@ -539,7 +572,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
539
572
|
* @request GET:/api/v3/integrations/webhook/{integration-public-id}
|
|
540
573
|
* @secure
|
|
541
574
|
*/
|
|
542
|
-
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
575
|
+
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
543
576
|
/**
|
|
544
577
|
* No description
|
|
545
578
|
*
|
|
@@ -548,7 +581,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
548
581
|
* @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
|
|
549
582
|
* @secure
|
|
550
583
|
*/
|
|
551
|
-
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
584
|
+
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
552
585
|
/**
|
|
553
586
|
* No description
|
|
554
587
|
*
|
|
@@ -557,7 +590,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
557
590
|
* @request GET:/api/v3/iterations
|
|
558
591
|
* @secure
|
|
559
592
|
*/
|
|
560
|
-
listIterations: (params?: RequestParams) => Promise<
|
|
593
|
+
listIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSlim[], any, {}>>;
|
|
561
594
|
/**
|
|
562
595
|
* No description
|
|
563
596
|
*
|
|
@@ -566,7 +599,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
566
599
|
* @request POST:/api/v3/iterations
|
|
567
600
|
* @secure
|
|
568
601
|
*/
|
|
569
|
-
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<
|
|
602
|
+
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
570
603
|
/**
|
|
571
604
|
* @description Disables Iterations for the current workspace
|
|
572
605
|
*
|
|
@@ -575,7 +608,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
575
608
|
* @request PUT:/api/v3/iterations/disable
|
|
576
609
|
* @secure
|
|
577
610
|
*/
|
|
578
|
-
disableIterations: (params?: RequestParams) => Promise<
|
|
611
|
+
disableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
579
612
|
/**
|
|
580
613
|
* @description Enables Iterations for the current workspace
|
|
581
614
|
*
|
|
@@ -584,7 +617,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
584
617
|
* @request PUT:/api/v3/iterations/enable
|
|
585
618
|
* @secure
|
|
586
619
|
*/
|
|
587
|
-
enableIterations: (params?: RequestParams) => Promise<
|
|
620
|
+
enableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
588
621
|
/**
|
|
589
622
|
* No description
|
|
590
623
|
*
|
|
@@ -593,7 +626,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
593
626
|
* @request GET:/api/v3/iterations/{iteration-public-id}
|
|
594
627
|
* @secure
|
|
595
628
|
*/
|
|
596
|
-
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
629
|
+
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
597
630
|
/**
|
|
598
631
|
* No description
|
|
599
632
|
*
|
|
@@ -602,7 +635,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
602
635
|
* @request PUT:/api/v3/iterations/{iteration-public-id}
|
|
603
636
|
* @secure
|
|
604
637
|
*/
|
|
605
|
-
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<
|
|
638
|
+
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
606
639
|
/**
|
|
607
640
|
* No description
|
|
608
641
|
*
|
|
@@ -611,7 +644,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
611
644
|
* @request DELETE:/api/v3/iterations/{iteration-public-id}
|
|
612
645
|
* @secure
|
|
613
646
|
*/
|
|
614
|
-
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
647
|
+
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
615
648
|
/**
|
|
616
649
|
* @description Get a list of all Stories in an Iteration.
|
|
617
650
|
*
|
|
@@ -623,7 +656,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
623
656
|
listIterationStories: (iterationPublicId: number, query?: {
|
|
624
657
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
625
658
|
includes_description?: boolean;
|
|
626
|
-
}, params?: RequestParams) => Promise<
|
|
659
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
627
660
|
/**
|
|
628
661
|
* @description Get Key Result returns information about a chosen Key Result.
|
|
629
662
|
*
|
|
@@ -632,7 +665,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
632
665
|
* @request GET:/api/v3/key-results/{key-result-public-id}
|
|
633
666
|
* @secure
|
|
634
667
|
*/
|
|
635
|
-
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<
|
|
668
|
+
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any, {}>>;
|
|
636
669
|
/**
|
|
637
670
|
* @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
|
|
638
671
|
*
|
|
@@ -641,7 +674,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
641
674
|
* @request PUT:/api/v3/key-results/{key-result-public-id}
|
|
642
675
|
* @secure
|
|
643
676
|
*/
|
|
644
|
-
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<
|
|
677
|
+
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any, {}>>;
|
|
645
678
|
/**
|
|
646
679
|
* @description List Labels returns a list of all Labels and their attributes.
|
|
647
680
|
*
|
|
@@ -653,7 +686,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
653
686
|
listLabels: (query?: {
|
|
654
687
|
/** A true/false boolean indicating if the slim versions of the Label should be returned. */
|
|
655
688
|
slim?: boolean;
|
|
656
|
-
}, params?: RequestParams) => Promise<
|
|
689
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Label[], any, {}>>;
|
|
657
690
|
/**
|
|
658
691
|
* @description Create Label allows you to create a new Label in Shortcut.
|
|
659
692
|
*
|
|
@@ -662,7 +695,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
662
695
|
* @request POST:/api/v3/labels
|
|
663
696
|
* @secure
|
|
664
697
|
*/
|
|
665
|
-
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<
|
|
698
|
+
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
666
699
|
/**
|
|
667
700
|
* @description Get Label returns information about the selected Label.
|
|
668
701
|
*
|
|
@@ -671,7 +704,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
671
704
|
* @request GET:/api/v3/labels/{label-public-id}
|
|
672
705
|
* @secure
|
|
673
706
|
*/
|
|
674
|
-
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
707
|
+
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
675
708
|
/**
|
|
676
709
|
* @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
710
|
*
|
|
@@ -680,7 +713,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
680
713
|
* @request PUT:/api/v3/labels/{label-public-id}
|
|
681
714
|
* @secure
|
|
682
715
|
*/
|
|
683
|
-
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<
|
|
716
|
+
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
684
717
|
/**
|
|
685
718
|
* @description Delete Label can be used to delete any Label.
|
|
686
719
|
*
|
|
@@ -689,7 +722,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
689
722
|
* @request DELETE:/api/v3/labels/{label-public-id}
|
|
690
723
|
* @secure
|
|
691
724
|
*/
|
|
692
|
-
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
725
|
+
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
693
726
|
/**
|
|
694
727
|
* @description List all of the Epics with the Label.
|
|
695
728
|
*
|
|
@@ -698,7 +731,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
698
731
|
* @request GET:/api/v3/labels/{label-public-id}/epics
|
|
699
732
|
* @secure
|
|
700
733
|
*/
|
|
701
|
-
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
734
|
+
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
702
735
|
/**
|
|
703
736
|
* @description List all of the Stories with the Label.
|
|
704
737
|
*
|
|
@@ -710,7 +743,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
710
743
|
listLabelStories: (labelPublicId: number, query?: {
|
|
711
744
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
712
745
|
includes_description?: boolean;
|
|
713
|
-
}, params?: RequestParams) => Promise<
|
|
746
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
714
747
|
/**
|
|
715
748
|
* @description List Linked Files returns a list of all Linked-Files and their attributes.
|
|
716
749
|
*
|
|
@@ -719,7 +752,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
719
752
|
* @request GET:/api/v3/linked-files
|
|
720
753
|
* @secure
|
|
721
754
|
*/
|
|
722
|
-
listLinkedFiles: (params?: RequestParams) => Promise<
|
|
755
|
+
listLinkedFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile[], any, {}>>;
|
|
723
756
|
/**
|
|
724
757
|
* @description Create Linked File allows you to create a new Linked File in Shortcut.
|
|
725
758
|
*
|
|
@@ -728,7 +761,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
728
761
|
* @request POST:/api/v3/linked-files
|
|
729
762
|
* @secure
|
|
730
763
|
*/
|
|
731
|
-
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<
|
|
764
|
+
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
732
765
|
/**
|
|
733
766
|
* @description Get File returns information about the selected Linked File.
|
|
734
767
|
*
|
|
@@ -737,7 +770,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
737
770
|
* @request GET:/api/v3/linked-files/{linked-file-public-id}
|
|
738
771
|
* @secure
|
|
739
772
|
*/
|
|
740
|
-
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
773
|
+
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
741
774
|
/**
|
|
742
775
|
* @description Updated Linked File allows you to update properties of a previously attached Linked-File.
|
|
743
776
|
*
|
|
@@ -746,7 +779,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
746
779
|
* @request PUT:/api/v3/linked-files/{linked-file-public-id}
|
|
747
780
|
* @secure
|
|
748
781
|
*/
|
|
749
|
-
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<
|
|
782
|
+
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
750
783
|
/**
|
|
751
784
|
* @description Delete Linked File can be used to delete any previously attached Linked-File.
|
|
752
785
|
*
|
|
@@ -755,7 +788,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
755
788
|
* @request DELETE:/api/v3/linked-files/{linked-file-public-id}
|
|
756
789
|
* @secure
|
|
757
790
|
*/
|
|
758
|
-
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
791
|
+
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
759
792
|
/**
|
|
760
793
|
* @description Returns information about the authenticated member.
|
|
761
794
|
*
|
|
@@ -764,7 +797,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
764
797
|
* @request GET:/api/v3/member
|
|
765
798
|
* @secure
|
|
766
799
|
*/
|
|
767
|
-
getCurrentMemberInfo: (params?: RequestParams) => Promise<
|
|
800
|
+
getCurrentMemberInfo: (params?: RequestParams) => Promise<axios0.AxiosResponse<MemberInfo, any, {}>>;
|
|
768
801
|
/**
|
|
769
802
|
* @description Returns information about members of the Workspace.
|
|
770
803
|
*
|
|
@@ -781,7 +814,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
781
814
|
"org-public-id"?: string;
|
|
782
815
|
/** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
|
|
783
816
|
disabled?: boolean;
|
|
784
|
-
}, params?: RequestParams) => Promise<
|
|
817
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Member[], any, {}>>;
|
|
785
818
|
/**
|
|
786
819
|
* @description Returns information about a Member.
|
|
787
820
|
*
|
|
@@ -796,7 +829,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
796
829
|
* @format uuid
|
|
797
830
|
*/
|
|
798
831
|
"org-public-id"?: string;
|
|
799
|
-
}, params?: RequestParams) => Promise<
|
|
832
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Member, any, {}>>;
|
|
800
833
|
/**
|
|
801
834
|
* @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
|
|
802
835
|
*
|
|
@@ -805,7 +838,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
805
838
|
* @request GET:/api/v3/milestones
|
|
806
839
|
* @secure
|
|
807
840
|
*/
|
|
808
|
-
listMilestones: (params?: RequestParams) => Promise<
|
|
841
|
+
listMilestones: (params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone[], any, {}>>;
|
|
809
842
|
/**
|
|
810
843
|
* @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
|
|
811
844
|
*
|
|
@@ -814,7 +847,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
814
847
|
* @request POST:/api/v3/milestones
|
|
815
848
|
* @secure
|
|
816
849
|
*/
|
|
817
|
-
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<
|
|
850
|
+
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
818
851
|
/**
|
|
819
852
|
* @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
|
|
820
853
|
*
|
|
@@ -823,7 +856,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
823
856
|
* @request GET:/api/v3/milestones/{milestone-public-id}
|
|
824
857
|
* @secure
|
|
825
858
|
*/
|
|
826
|
-
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
859
|
+
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
827
860
|
/**
|
|
828
861
|
* @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
|
|
829
862
|
*
|
|
@@ -832,7 +865,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
832
865
|
* @request PUT:/api/v3/milestones/{milestone-public-id}
|
|
833
866
|
* @secure
|
|
834
867
|
*/
|
|
835
|
-
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<
|
|
868
|
+
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
836
869
|
/**
|
|
837
870
|
* @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
|
|
838
871
|
*
|
|
@@ -841,7 +874,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
841
874
|
* @request DELETE:/api/v3/milestones/{milestone-public-id}
|
|
842
875
|
* @secure
|
|
843
876
|
*/
|
|
844
|
-
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
877
|
+
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
845
878
|
/**
|
|
846
879
|
* @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
|
|
847
880
|
*
|
|
@@ -850,7 +883,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
850
883
|
* @request GET:/api/v3/milestones/{milestone-public-id}/epics
|
|
851
884
|
* @secure
|
|
852
885
|
*/
|
|
853
|
-
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
886
|
+
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
854
887
|
/**
|
|
855
888
|
* @description List Objectives returns a list of all Objectives and their attributes.
|
|
856
889
|
*
|
|
@@ -859,7 +892,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
859
892
|
* @request GET:/api/v3/objectives
|
|
860
893
|
* @secure
|
|
861
894
|
*/
|
|
862
|
-
listObjectives: (params?: RequestParams) => Promise<
|
|
895
|
+
listObjectives: (params?: RequestParams) => Promise<axios0.AxiosResponse<Objective[], any, {}>>;
|
|
863
896
|
/**
|
|
864
897
|
* @description Create Objective allows you to create a new Objective in Shortcut.
|
|
865
898
|
*
|
|
@@ -868,7 +901,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
868
901
|
* @request POST:/api/v3/objectives
|
|
869
902
|
* @secure
|
|
870
903
|
*/
|
|
871
|
-
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<
|
|
904
|
+
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
872
905
|
/**
|
|
873
906
|
* @description Get Objective returns information about a chosen Objective.
|
|
874
907
|
*
|
|
@@ -877,7 +910,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
877
910
|
* @request GET:/api/v3/objectives/{objective-public-id}
|
|
878
911
|
* @secure
|
|
879
912
|
*/
|
|
880
|
-
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
913
|
+
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
881
914
|
/**
|
|
882
915
|
* @description Update Objective can be used to update Objective properties.
|
|
883
916
|
*
|
|
@@ -886,7 +919,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
886
919
|
* @request PUT:/api/v3/objectives/{objective-public-id}
|
|
887
920
|
* @secure
|
|
888
921
|
*/
|
|
889
|
-
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<
|
|
922
|
+
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
890
923
|
/**
|
|
891
924
|
* @description Delete Objective can be used to delete any Objective.
|
|
892
925
|
*
|
|
@@ -895,7 +928,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
895
928
|
* @request DELETE:/api/v3/objectives/{objective-public-id}
|
|
896
929
|
* @secure
|
|
897
930
|
*/
|
|
898
|
-
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
931
|
+
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
899
932
|
/**
|
|
900
933
|
* @description List all of the Epics within the Objective.
|
|
901
934
|
*
|
|
@@ -904,7 +937,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
904
937
|
* @request GET:/api/v3/objectives/{objective-public-id}/epics
|
|
905
938
|
* @secure
|
|
906
939
|
*/
|
|
907
|
-
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
940
|
+
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
908
941
|
/**
|
|
909
942
|
* @description List Projects returns a list of all Projects and their attributes.
|
|
910
943
|
*
|
|
@@ -913,7 +946,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
913
946
|
* @request GET:/api/v3/projects
|
|
914
947
|
* @secure
|
|
915
948
|
*/
|
|
916
|
-
listProjects: (params?: RequestParams) => Promise<
|
|
949
|
+
listProjects: (params?: RequestParams) => Promise<axios0.AxiosResponse<Project[], any, {}>>;
|
|
917
950
|
/**
|
|
918
951
|
* @description Create Project is used to create a new Shortcut Project.
|
|
919
952
|
*
|
|
@@ -922,7 +955,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
922
955
|
* @request POST:/api/v3/projects
|
|
923
956
|
* @secure
|
|
924
957
|
*/
|
|
925
|
-
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<
|
|
958
|
+
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
926
959
|
/**
|
|
927
960
|
* @description Get Project returns information about the selected Project.
|
|
928
961
|
*
|
|
@@ -931,7 +964,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
931
964
|
* @request GET:/api/v3/projects/{project-public-id}
|
|
932
965
|
* @secure
|
|
933
966
|
*/
|
|
934
|
-
getProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
967
|
+
getProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
935
968
|
/**
|
|
936
969
|
* @description Update Project can be used to change properties of a Project.
|
|
937
970
|
*
|
|
@@ -940,7 +973,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
940
973
|
* @request PUT:/api/v3/projects/{project-public-id}
|
|
941
974
|
* @secure
|
|
942
975
|
*/
|
|
943
|
-
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<
|
|
976
|
+
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
944
977
|
/**
|
|
945
978
|
* @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
979
|
*
|
|
@@ -949,7 +982,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
949
982
|
* @request DELETE:/api/v3/projects/{project-public-id}
|
|
950
983
|
* @secure
|
|
951
984
|
*/
|
|
952
|
-
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
985
|
+
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
953
986
|
/**
|
|
954
987
|
* @description List Stories returns a list of all Stories in a selected Project and their attributes.
|
|
955
988
|
*
|
|
@@ -961,7 +994,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
961
994
|
listStories: (projectPublicId: number, query?: {
|
|
962
995
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
963
996
|
includes_description?: boolean;
|
|
964
|
-
}, params?: RequestParams) => Promise<
|
|
997
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
965
998
|
/**
|
|
966
999
|
* @description List Repositories returns a list of all Repositories and their attributes.
|
|
967
1000
|
*
|
|
@@ -970,7 +1003,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
970
1003
|
* @request GET:/api/v3/repositories
|
|
971
1004
|
* @secure
|
|
972
1005
|
*/
|
|
973
|
-
listRepositories: (params?: RequestParams) => Promise<
|
|
1006
|
+
listRepositories: (params?: RequestParams) => Promise<axios0.AxiosResponse<Repository[], any, {}>>;
|
|
974
1007
|
/**
|
|
975
1008
|
* @description Get Repository returns information about the selected Repository.
|
|
976
1009
|
*
|
|
@@ -979,7 +1012,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
979
1012
|
* @request GET:/api/v3/repositories/{repo-public-id}
|
|
980
1013
|
* @secure
|
|
981
1014
|
*/
|
|
982
|
-
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<
|
|
1015
|
+
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Repository, any, {}>>;
|
|
983
1016
|
/**
|
|
984
1017
|
* @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
1018
|
*
|
|
@@ -1012,7 +1045,35 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1012
1045
|
next?: string;
|
|
1013
1046
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1014
1047
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1015
|
-
}, params?: RequestParams) => Promise<
|
|
1048
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
|
|
1049
|
+
/**
|
|
1050
|
+
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1051
|
+
*
|
|
1052
|
+
* @name SearchDocuments
|
|
1053
|
+
* @summary Search Documents
|
|
1054
|
+
* @request GET:/api/v3/search/documents
|
|
1055
|
+
* @secure
|
|
1056
|
+
*/
|
|
1057
|
+
searchDocuments: (query: {
|
|
1058
|
+
/**
|
|
1059
|
+
* Search text to match against document titles. Supports fuzzy matching. Required.
|
|
1060
|
+
* @minLength 1
|
|
1061
|
+
*/
|
|
1062
|
+
title: string;
|
|
1063
|
+
/** When true, find archived documents. When false, find non-archived documents. */
|
|
1064
|
+
archived?: boolean;
|
|
1065
|
+
/** When true, find documents created by the current user. When false, find documents NOT created by current user. */
|
|
1066
|
+
created_by_me?: boolean;
|
|
1067
|
+
/** When true, find documents that the current user is following. When false, find documents NOT followed. */
|
|
1068
|
+
followed_by_me?: boolean;
|
|
1069
|
+
/**
|
|
1070
|
+
* The number of search results to include in a page. Minimum of 1 and maximum of 250.
|
|
1071
|
+
* @format int64
|
|
1072
|
+
*/
|
|
1073
|
+
page_size?: number;
|
|
1074
|
+
/** The next page token. */
|
|
1075
|
+
next?: string;
|
|
1076
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSearchResults, any, {}>>;
|
|
1016
1077
|
/**
|
|
1017
1078
|
* @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
1079
|
*
|
|
@@ -1045,7 +1106,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1045
1106
|
next?: string;
|
|
1046
1107
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1047
1108
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1048
|
-
}, params?: RequestParams) => Promise<
|
|
1109
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSearchResults, any, {}>>;
|
|
1049
1110
|
/**
|
|
1050
1111
|
* @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
1112
|
*
|
|
@@ -1078,7 +1139,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1078
1139
|
next?: string;
|
|
1079
1140
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1080
1141
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1081
|
-
}, params?: RequestParams) => Promise<
|
|
1142
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSearchResults, any, {}>>;
|
|
1082
1143
|
/**
|
|
1083
1144
|
* @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
1145
|
*
|
|
@@ -1111,7 +1172,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1111
1172
|
next?: string;
|
|
1112
1173
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1113
1174
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1114
|
-
}, params?: RequestParams) => Promise<
|
|
1175
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1115
1176
|
/**
|
|
1116
1177
|
* @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
1178
|
*
|
|
@@ -1144,7 +1205,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1144
1205
|
next?: string;
|
|
1145
1206
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1146
1207
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1147
|
-
}, params?: RequestParams) => Promise<
|
|
1208
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1148
1209
|
/**
|
|
1149
1210
|
* @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
1211
|
*
|
|
@@ -1177,7 +1238,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1177
1238
|
next?: string;
|
|
1178
1239
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1179
1240
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1180
|
-
}, params?: RequestParams) => Promise<
|
|
1241
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySearchResults, any, {}>>;
|
|
1181
1242
|
/**
|
|
1182
1243
|
* @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
1244
|
*
|
|
@@ -1186,7 +1247,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1186
1247
|
* @request POST:/api/v3/stories
|
|
1187
1248
|
* @secure
|
|
1188
1249
|
*/
|
|
1189
|
-
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<
|
|
1250
|
+
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1190
1251
|
/**
|
|
1191
1252
|
* @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
1253
|
*
|
|
@@ -1195,7 +1256,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1195
1256
|
* @request POST:/api/v3/stories/bulk
|
|
1196
1257
|
* @secure
|
|
1197
1258
|
*/
|
|
1198
|
-
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<
|
|
1259
|
+
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1199
1260
|
/**
|
|
1200
1261
|
* @description Update Multiple Stories allows you to make changes to numerous stories at once.
|
|
1201
1262
|
*
|
|
@@ -1204,7 +1265,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1204
1265
|
* @request PUT:/api/v3/stories/bulk
|
|
1205
1266
|
* @secure
|
|
1206
1267
|
*/
|
|
1207
|
-
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<
|
|
1268
|
+
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1208
1269
|
/**
|
|
1209
1270
|
* @description Delete Multiple Stories allows you to delete multiple archived stories at once.
|
|
1210
1271
|
*
|
|
@@ -1213,7 +1274,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1213
1274
|
* @request DELETE:/api/v3/stories/bulk
|
|
1214
1275
|
* @secure
|
|
1215
1276
|
*/
|
|
1216
|
-
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<
|
|
1277
|
+
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1217
1278
|
/**
|
|
1218
1279
|
* @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
|
|
1219
1280
|
*
|
|
@@ -1222,7 +1283,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1222
1283
|
* @request POST:/api/v3/stories/from-template
|
|
1223
1284
|
* @secure
|
|
1224
1285
|
*/
|
|
1225
|
-
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<
|
|
1286
|
+
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1226
1287
|
/**
|
|
1227
1288
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1228
1289
|
*
|
|
@@ -1231,7 +1292,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1231
1292
|
* @request POST:/api/v3/stories/search
|
|
1232
1293
|
* @secure
|
|
1233
1294
|
*/
|
|
1234
|
-
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<
|
|
1295
|
+
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1235
1296
|
/**
|
|
1236
1297
|
* @description Get Story returns information about a chosen Story.
|
|
1237
1298
|
*
|
|
@@ -1240,7 +1301,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1240
1301
|
* @request GET:/api/v3/stories/{story-public-id}
|
|
1241
1302
|
* @secure
|
|
1242
1303
|
*/
|
|
1243
|
-
getStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1304
|
+
getStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1244
1305
|
/**
|
|
1245
1306
|
* @description Update Story can be used to update Story properties.
|
|
1246
1307
|
*
|
|
@@ -1249,7 +1310,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1249
1310
|
* @request PUT:/api/v3/stories/{story-public-id}
|
|
1250
1311
|
* @secure
|
|
1251
1312
|
*/
|
|
1252
|
-
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<
|
|
1313
|
+
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1253
1314
|
/**
|
|
1254
1315
|
* @description Delete Story can be used to delete any Story.
|
|
1255
1316
|
*
|
|
@@ -1258,7 +1319,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1258
1319
|
* @request DELETE:/api/v3/stories/{story-public-id}
|
|
1259
1320
|
* @secure
|
|
1260
1321
|
*/
|
|
1261
|
-
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1322
|
+
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1262
1323
|
/**
|
|
1263
1324
|
* @description Lists Comments associated with a Story
|
|
1264
1325
|
*
|
|
@@ -1267,7 +1328,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1267
1328
|
* @request GET:/api/v3/stories/{story-public-id}/comments
|
|
1268
1329
|
* @secure
|
|
1269
1330
|
*/
|
|
1270
|
-
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1331
|
+
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment[], any, {}>>;
|
|
1271
1332
|
/**
|
|
1272
1333
|
* @description Create Comment allows you to create a Comment on any Story.
|
|
1273
1334
|
*
|
|
@@ -1276,7 +1337,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1276
1337
|
* @request POST:/api/v3/stories/{story-public-id}/comments
|
|
1277
1338
|
* @secure
|
|
1278
1339
|
*/
|
|
1279
|
-
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<
|
|
1340
|
+
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1280
1341
|
/**
|
|
1281
1342
|
* @description Get Comment is used to get Comment information.
|
|
1282
1343
|
*
|
|
@@ -1285,7 +1346,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1285
1346
|
* @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1286
1347
|
* @secure
|
|
1287
1348
|
*/
|
|
1288
|
-
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1349
|
+
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1289
1350
|
/**
|
|
1290
1351
|
* @description Update Comment replaces the text of the existing Comment.
|
|
1291
1352
|
*
|
|
@@ -1294,7 +1355,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1294
1355
|
* @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1295
1356
|
* @secure
|
|
1296
1357
|
*/
|
|
1297
|
-
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<
|
|
1358
|
+
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1298
1359
|
/**
|
|
1299
1360
|
* @description Delete a Comment from any story.
|
|
1300
1361
|
*
|
|
@@ -1303,7 +1364,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1303
1364
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1304
1365
|
* @secure
|
|
1305
1366
|
*/
|
|
1306
|
-
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1367
|
+
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1307
1368
|
/**
|
|
1308
1369
|
* @description Create a reaction to a story comment.
|
|
1309
1370
|
*
|
|
@@ -1312,7 +1373,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1312
1373
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1313
1374
|
* @secure
|
|
1314
1375
|
*/
|
|
1315
|
-
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1376
|
+
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryReaction[], any, {}>>;
|
|
1316
1377
|
/**
|
|
1317
1378
|
* @description Delete a reaction from any story comment.
|
|
1318
1379
|
*
|
|
@@ -1321,7 +1382,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1321
1382
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1322
1383
|
* @secure
|
|
1323
1384
|
*/
|
|
1324
|
-
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1385
|
+
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1325
1386
|
/**
|
|
1326
1387
|
* @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
|
|
1327
1388
|
*
|
|
@@ -1330,7 +1391,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1330
1391
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
|
|
1331
1392
|
* @secure
|
|
1332
1393
|
*/
|
|
1333
|
-
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1394
|
+
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1334
1395
|
/**
|
|
1335
1396
|
* No description
|
|
1336
1397
|
*
|
|
@@ -1339,7 +1400,16 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1339
1400
|
* @request GET:/api/v3/stories/{story-public-id}/history
|
|
1340
1401
|
* @secure
|
|
1341
1402
|
*/
|
|
1342
|
-
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1403
|
+
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<History[], any, {}>>;
|
|
1404
|
+
/**
|
|
1405
|
+
* @description List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
|
|
1406
|
+
*
|
|
1407
|
+
* @name ListStorySubTasks
|
|
1408
|
+
* @summary List Story Sub tasks
|
|
1409
|
+
* @request GET:/api/v3/stories/{story-public-id}/sub-tasks
|
|
1410
|
+
* @secure
|
|
1411
|
+
*/
|
|
1412
|
+
listStorySubTasks: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1343
1413
|
/**
|
|
1344
1414
|
* @description Create Task is used to create a new task in a Story.
|
|
1345
1415
|
*
|
|
@@ -1348,7 +1418,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1348
1418
|
* @request POST:/api/v3/stories/{story-public-id}/tasks
|
|
1349
1419
|
* @secure
|
|
1350
1420
|
*/
|
|
1351
|
-
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<
|
|
1421
|
+
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1352
1422
|
/**
|
|
1353
1423
|
* @description Returns information about a chosen Task.
|
|
1354
1424
|
*
|
|
@@ -1357,7 +1427,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1357
1427
|
* @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1358
1428
|
* @secure
|
|
1359
1429
|
*/
|
|
1360
|
-
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1430
|
+
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1361
1431
|
/**
|
|
1362
1432
|
* @description Update Task can be used to update Task properties.
|
|
1363
1433
|
*
|
|
@@ -1366,7 +1436,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1366
1436
|
* @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1367
1437
|
* @secure
|
|
1368
1438
|
*/
|
|
1369
|
-
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<
|
|
1439
|
+
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1370
1440
|
/**
|
|
1371
1441
|
* @description Delete Task can be used to delete any previously created Task on a Story.
|
|
1372
1442
|
*
|
|
@@ -1375,7 +1445,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1375
1445
|
* @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1376
1446
|
* @secure
|
|
1377
1447
|
*/
|
|
1378
|
-
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1448
|
+
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1379
1449
|
/**
|
|
1380
1450
|
* @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
1451
|
*
|
|
@@ -1384,7 +1454,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1384
1454
|
* @request POST:/api/v3/story-links
|
|
1385
1455
|
* @secure
|
|
1386
1456
|
*/
|
|
1387
|
-
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<
|
|
1457
|
+
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1388
1458
|
/**
|
|
1389
1459
|
* @description Returns the stories and their relationship for the given Story Link.
|
|
1390
1460
|
*
|
|
@@ -1393,7 +1463,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1393
1463
|
* @request GET:/api/v3/story-links/{story-link-public-id}
|
|
1394
1464
|
* @secure
|
|
1395
1465
|
*/
|
|
1396
|
-
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1466
|
+
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1397
1467
|
/**
|
|
1398
1468
|
* @description Updates the stories and/or the relationship for the given Story Link.
|
|
1399
1469
|
*
|
|
@@ -1402,7 +1472,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1402
1472
|
* @request PUT:/api/v3/story-links/{story-link-public-id}
|
|
1403
1473
|
* @secure
|
|
1404
1474
|
*/
|
|
1405
|
-
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<
|
|
1475
|
+
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1406
1476
|
/**
|
|
1407
1477
|
* @description Removes the relationship between the stories for the given Story Link.
|
|
1408
1478
|
*
|
|
@@ -1411,7 +1481,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1411
1481
|
* @request DELETE:/api/v3/story-links/{story-link-public-id}
|
|
1412
1482
|
* @secure
|
|
1413
1483
|
*/
|
|
1414
|
-
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1484
|
+
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1415
1485
|
/**
|
|
1416
1486
|
* @description Returns a list of all Workflows in the Workspace.
|
|
1417
1487
|
*
|
|
@@ -1420,7 +1490,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1420
1490
|
* @request GET:/api/v3/workflows
|
|
1421
1491
|
* @secure
|
|
1422
1492
|
*/
|
|
1423
|
-
listWorkflows: (params?: RequestParams) => Promise<
|
|
1493
|
+
listWorkflows: (params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow[], any, {}>>;
|
|
1424
1494
|
/**
|
|
1425
1495
|
* @description Get Workflow returns information about a chosen Workflow.
|
|
1426
1496
|
*
|
|
@@ -1429,7 +1499,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1429
1499
|
* @request GET:/api/v3/workflows/{workflow-public-id}
|
|
1430
1500
|
* @secure
|
|
1431
1501
|
*/
|
|
1432
|
-
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<
|
|
1502
|
+
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow, any, {}>>;
|
|
1433
1503
|
}
|
|
1434
1504
|
//#endregion
|
|
1435
1505
|
export { Api };
|