@shortcut/client 2.3.1 → 3.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/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 +146 -134
- package/lib/generated/Api.d.ts +146 -134
- package/lib/generated/Api.js +18 -2
- package/lib/generated/Api.mjs +18 -2
- package/lib/generated/data-contracts.d.mts +61 -13
- package/lib/generated/data-contracts.d.ts +61 -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
1
|
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
|
|
2
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,16 @@ 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
129
|
/**
|
|
130
130
|
* @description List all the entity templates for the Workspace.
|
|
131
131
|
*
|
|
@@ -134,7 +134,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
134
134
|
* @request GET:/api/v3/entity-templates
|
|
135
135
|
* @secure
|
|
136
136
|
*/
|
|
137
|
-
listEntityTemplates: (params?: RequestParams) => Promise<
|
|
137
|
+
listEntityTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate[], any, {}>>;
|
|
138
138
|
/**
|
|
139
139
|
* @description Create a new entity template for the Workspace.
|
|
140
140
|
*
|
|
@@ -143,7 +143,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
143
143
|
* @request POST:/api/v3/entity-templates
|
|
144
144
|
* @secure
|
|
145
145
|
*/
|
|
146
|
-
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<
|
|
146
|
+
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
147
147
|
/**
|
|
148
148
|
* @description Disables the Story Template feature for the Workspace.
|
|
149
149
|
*
|
|
@@ -152,7 +152,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
152
152
|
* @request PUT:/api/v3/entity-templates/disable
|
|
153
153
|
* @secure
|
|
154
154
|
*/
|
|
155
|
-
disableStoryTemplates: (params?: RequestParams) => Promise<
|
|
155
|
+
disableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
156
156
|
/**
|
|
157
157
|
* @description Enables the Story Template feature for the Workspace.
|
|
158
158
|
*
|
|
@@ -161,7 +161,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
161
161
|
* @request PUT:/api/v3/entity-templates/enable
|
|
162
162
|
* @secure
|
|
163
163
|
*/
|
|
164
|
-
enableStoryTemplates: (params?: RequestParams) => Promise<
|
|
164
|
+
enableStoryTemplates: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
165
165
|
/**
|
|
166
166
|
* @description Get Entity Template returns information about a given entity template.
|
|
167
167
|
*
|
|
@@ -170,7 +170,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
170
170
|
* @request GET:/api/v3/entity-templates/{entity-template-public-id}
|
|
171
171
|
* @secure
|
|
172
172
|
*/
|
|
173
|
-
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
173
|
+
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
174
174
|
/**
|
|
175
175
|
* @description Update an entity template's name or its contents.
|
|
176
176
|
*
|
|
@@ -179,7 +179,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
179
179
|
* @request PUT:/api/v3/entity-templates/{entity-template-public-id}
|
|
180
180
|
* @secure
|
|
181
181
|
*/
|
|
182
|
-
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<
|
|
182
|
+
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<axios0.AxiosResponse<EntityTemplate, any, {}>>;
|
|
183
183
|
/**
|
|
184
184
|
* No description
|
|
185
185
|
*
|
|
@@ -188,7 +188,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
188
188
|
* @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
|
|
189
189
|
* @secure
|
|
190
190
|
*/
|
|
191
|
-
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
191
|
+
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
192
192
|
/**
|
|
193
193
|
* @description Returns the Epic Workflow for the Workspace.
|
|
194
194
|
*
|
|
@@ -197,7 +197,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
197
197
|
* @request GET:/api/v3/epic-workflow
|
|
198
198
|
* @secure
|
|
199
199
|
*/
|
|
200
|
-
getEpicWorkflow: (params?: RequestParams) => Promise<
|
|
200
|
+
getEpicWorkflow: (params?: RequestParams) => Promise<axios0.AxiosResponse<EpicWorkflow, any, {}>>;
|
|
201
201
|
/**
|
|
202
202
|
* @description List Epics returns a list of all Epics and their attributes.
|
|
203
203
|
*
|
|
@@ -209,7 +209,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
209
209
|
listEpics: (query?: {
|
|
210
210
|
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
211
211
|
includes_description?: boolean;
|
|
212
|
-
}, params?: RequestParams) => Promise<
|
|
212
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
213
213
|
/**
|
|
214
214
|
* @description Create Epic allows you to create a new Epic in Shortcut.
|
|
215
215
|
*
|
|
@@ -218,7 +218,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
218
218
|
* @request POST:/api/v3/epics
|
|
219
219
|
* @secure
|
|
220
220
|
*/
|
|
221
|
-
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<
|
|
221
|
+
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
222
222
|
/**
|
|
223
223
|
* @description List Epics with pagination returns a paginated list of Epics and their attributes.
|
|
224
224
|
*
|
|
@@ -240,7 +240,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
240
240
|
* @format int64
|
|
241
241
|
*/
|
|
242
242
|
page_size?: number;
|
|
243
|
-
}, params?: RequestParams) => Promise<
|
|
243
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicPaginatedResults, any, {}>>;
|
|
244
244
|
/**
|
|
245
245
|
* @description Get Epic returns information about the selected Epic.
|
|
246
246
|
*
|
|
@@ -249,7 +249,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
249
249
|
* @request GET:/api/v3/epics/{epic-public-id}
|
|
250
250
|
* @secure
|
|
251
251
|
*/
|
|
252
|
-
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
252
|
+
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
253
253
|
/**
|
|
254
254
|
* @description Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
|
|
255
255
|
*
|
|
@@ -258,7 +258,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
258
258
|
* @request PUT:/api/v3/epics/{epic-public-id}
|
|
259
259
|
* @secure
|
|
260
260
|
*/
|
|
261
|
-
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<
|
|
261
|
+
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<axios0.AxiosResponse<Epic, any, {}>>;
|
|
262
262
|
/**
|
|
263
263
|
* @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
|
|
264
264
|
*
|
|
@@ -267,7 +267,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
267
267
|
* @request DELETE:/api/v3/epics/{epic-public-id}
|
|
268
268
|
* @secure
|
|
269
269
|
*/
|
|
270
|
-
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
270
|
+
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
271
271
|
/**
|
|
272
272
|
* @description Get a list of all Comments on an Epic.
|
|
273
273
|
*
|
|
@@ -276,7 +276,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
276
276
|
* @request GET:/api/v3/epics/{epic-public-id}/comments
|
|
277
277
|
* @secure
|
|
278
278
|
*/
|
|
279
|
-
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
279
|
+
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment[], any, {}>>;
|
|
280
280
|
/**
|
|
281
281
|
* @description This endpoint allows you to create a threaded Comment on an Epic.
|
|
282
282
|
*
|
|
@@ -285,7 +285,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
285
285
|
* @request POST:/api/v3/epics/{epic-public-id}/comments
|
|
286
286
|
* @secure
|
|
287
287
|
*/
|
|
288
|
-
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<
|
|
288
|
+
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
289
289
|
/**
|
|
290
290
|
* @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
|
|
291
291
|
*
|
|
@@ -294,7 +294,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
294
294
|
* @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
295
295
|
* @secure
|
|
296
296
|
*/
|
|
297
|
-
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<
|
|
297
|
+
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
298
298
|
/**
|
|
299
299
|
* @description This endpoint returns information about the selected Epic Comment.
|
|
300
300
|
*
|
|
@@ -303,7 +303,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
303
303
|
* @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
304
304
|
* @secure
|
|
305
305
|
*/
|
|
306
|
-
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
306
|
+
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
307
307
|
/**
|
|
308
308
|
* @description This endpoint allows you to update a threaded Comment on an Epic.
|
|
309
309
|
*
|
|
@@ -312,7 +312,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
312
312
|
* @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
313
313
|
* @secure
|
|
314
314
|
*/
|
|
315
|
-
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<
|
|
315
|
+
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<axios0.AxiosResponse<ThreadedComment, any, {}>>;
|
|
316
316
|
/**
|
|
317
317
|
* @description This endpoint allows you to delete a Comment from an Epic.
|
|
318
318
|
*
|
|
@@ -321,7 +321,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
321
321
|
* @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
322
322
|
* @secure
|
|
323
323
|
*/
|
|
324
|
-
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
324
|
+
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
325
325
|
/**
|
|
326
326
|
* @description Get the current health for the specified Epic.
|
|
327
327
|
*
|
|
@@ -330,7 +330,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
330
330
|
* @request GET:/api/v3/epics/{epic-public-id}/health
|
|
331
331
|
* @secure
|
|
332
332
|
*/
|
|
333
|
-
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
333
|
+
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
334
334
|
/**
|
|
335
335
|
* @description Create a new health status for the specified Epic.
|
|
336
336
|
*
|
|
@@ -339,7 +339,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
339
339
|
* @request POST:/api/v3/epics/{epic-public-id}/health
|
|
340
340
|
* @secure
|
|
341
341
|
*/
|
|
342
|
-
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<
|
|
342
|
+
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
343
343
|
/**
|
|
344
344
|
* @description List the history of health statuses for the specified Epic, most recent first.
|
|
345
345
|
*
|
|
@@ -348,7 +348,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
348
348
|
* @request GET:/api/v3/epics/{epic-public-id}/health-history
|
|
349
349
|
* @secure
|
|
350
350
|
*/
|
|
351
|
-
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
351
|
+
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Health[], any, {}>>;
|
|
352
352
|
/**
|
|
353
353
|
* @description Get a list of all Stories in an Epic.
|
|
354
354
|
*
|
|
@@ -360,7 +360,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
360
360
|
listEpicStories: (epicPublicId: number, query?: {
|
|
361
361
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
362
362
|
includes_description?: boolean;
|
|
363
|
-
}, params?: RequestParams) => Promise<
|
|
363
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
364
364
|
/**
|
|
365
365
|
* @description This endpoint allows you to unlink a productboard epic.
|
|
366
366
|
*
|
|
@@ -369,7 +369,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
369
369
|
* @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
|
|
370
370
|
* @secure
|
|
371
371
|
*/
|
|
372
|
-
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
372
|
+
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
373
373
|
/**
|
|
374
374
|
* @description Get Stories which have a given External Link associated with them.
|
|
375
375
|
*
|
|
@@ -385,7 +385,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
385
385
|
* @pattern ^https?://.+$
|
|
386
386
|
*/
|
|
387
387
|
external_link: string;
|
|
388
|
-
}, params?: RequestParams) => Promise<
|
|
388
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
389
389
|
/**
|
|
390
390
|
* @description List Files returns a list of all UploadedFiles in the workspace.
|
|
391
391
|
*
|
|
@@ -394,7 +394,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
394
394
|
* @request GET:/api/v3/files
|
|
395
395
|
* @secure
|
|
396
396
|
*/
|
|
397
|
-
listFiles: (params?: RequestParams) => Promise<
|
|
397
|
+
listFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any, {}>>;
|
|
398
398
|
/**
|
|
399
399
|
* @description Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.
|
|
400
400
|
*
|
|
@@ -429,7 +429,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
429
429
|
* @format binary
|
|
430
430
|
*/
|
|
431
431
|
file3?: File;
|
|
432
|
-
}, params?: RequestParams) => Promise<
|
|
432
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile[], any, {}>>;
|
|
433
433
|
/**
|
|
434
434
|
* @description Get File returns information about the selected UploadedFile.
|
|
435
435
|
*
|
|
@@ -438,7 +438,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
438
438
|
* @request GET:/api/v3/files/{file-public-id}
|
|
439
439
|
* @secure
|
|
440
440
|
*/
|
|
441
|
-
getFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
441
|
+
getFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any, {}>>;
|
|
442
442
|
/**
|
|
443
443
|
* @description Update File updates the properties of an UploadedFile (but not its content).
|
|
444
444
|
*
|
|
@@ -447,7 +447,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
447
447
|
* @request PUT:/api/v3/files/{file-public-id}
|
|
448
448
|
* @secure
|
|
449
449
|
*/
|
|
450
|
-
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<
|
|
450
|
+
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<axios0.AxiosResponse<UploadedFile, any, {}>>;
|
|
451
451
|
/**
|
|
452
452
|
* @description Delete File deletes a previously uploaded file.
|
|
453
453
|
*
|
|
@@ -456,7 +456,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
456
456
|
* @request DELETE:/api/v3/files/{file-public-id}
|
|
457
457
|
* @secure
|
|
458
458
|
*/
|
|
459
|
-
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
459
|
+
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
460
460
|
/**
|
|
461
461
|
* @description A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
|
|
462
462
|
*
|
|
@@ -465,7 +465,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
465
465
|
* @request GET:/api/v3/groups
|
|
466
466
|
* @secure
|
|
467
467
|
*/
|
|
468
|
-
listGroups: (
|
|
468
|
+
listGroups: (query?: {
|
|
469
|
+
/** Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups */
|
|
470
|
+
archived?: boolean;
|
|
471
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Group[], any, {}>>;
|
|
469
472
|
/**
|
|
470
473
|
* No description
|
|
471
474
|
*
|
|
@@ -474,7 +477,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
474
477
|
* @request POST:/api/v3/groups
|
|
475
478
|
* @secure
|
|
476
479
|
*/
|
|
477
|
-
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<
|
|
480
|
+
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
478
481
|
/**
|
|
479
482
|
* No description
|
|
480
483
|
*
|
|
@@ -483,7 +486,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
483
486
|
* @request GET:/api/v3/groups/{group-public-id}
|
|
484
487
|
* @secure
|
|
485
488
|
*/
|
|
486
|
-
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<
|
|
489
|
+
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
487
490
|
/**
|
|
488
491
|
* No description
|
|
489
492
|
*
|
|
@@ -492,7 +495,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
492
495
|
* @request PUT:/api/v3/groups/{group-public-id}
|
|
493
496
|
* @secure
|
|
494
497
|
*/
|
|
495
|
-
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<
|
|
498
|
+
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<axios0.AxiosResponse<Group, any, {}>>;
|
|
496
499
|
/**
|
|
497
500
|
* @description List the Stories assigned to the Group. (By default, limited to 1,000).
|
|
498
501
|
*
|
|
@@ -512,7 +515,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
512
515
|
* @format int64
|
|
513
516
|
*/
|
|
514
517
|
offset?: number;
|
|
515
|
-
}, params?: RequestParams) => Promise<
|
|
518
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
516
519
|
/**
|
|
517
520
|
* @description Update an existing health status by its ID.
|
|
518
521
|
*
|
|
@@ -521,7 +524,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
521
524
|
* @request PUT:/api/v3/health/{health-public-id}
|
|
522
525
|
* @secure
|
|
523
526
|
*/
|
|
524
|
-
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<
|
|
527
|
+
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<axios0.AxiosResponse<Health, any, {}>>;
|
|
525
528
|
/**
|
|
526
529
|
* No description
|
|
527
530
|
*
|
|
@@ -530,7 +533,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
530
533
|
* @request POST:/api/v3/integrations/webhook
|
|
531
534
|
* @secure
|
|
532
535
|
*/
|
|
533
|
-
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<
|
|
536
|
+
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
534
537
|
/**
|
|
535
538
|
* No description
|
|
536
539
|
*
|
|
@@ -539,7 +542,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
539
542
|
* @request GET:/api/v3/integrations/webhook/{integration-public-id}
|
|
540
543
|
* @secure
|
|
541
544
|
*/
|
|
542
|
-
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
545
|
+
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
543
546
|
/**
|
|
544
547
|
* No description
|
|
545
548
|
*
|
|
@@ -548,7 +551,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
548
551
|
* @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
|
|
549
552
|
* @secure
|
|
550
553
|
*/
|
|
551
|
-
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
554
|
+
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
552
555
|
/**
|
|
553
556
|
* No description
|
|
554
557
|
*
|
|
@@ -557,7 +560,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
557
560
|
* @request GET:/api/v3/iterations
|
|
558
561
|
* @secure
|
|
559
562
|
*/
|
|
560
|
-
listIterations: (params?: RequestParams) => Promise<
|
|
563
|
+
listIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSlim[], any, {}>>;
|
|
561
564
|
/**
|
|
562
565
|
* No description
|
|
563
566
|
*
|
|
@@ -566,7 +569,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
566
569
|
* @request POST:/api/v3/iterations
|
|
567
570
|
* @secure
|
|
568
571
|
*/
|
|
569
|
-
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<
|
|
572
|
+
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
570
573
|
/**
|
|
571
574
|
* @description Disables Iterations for the current workspace
|
|
572
575
|
*
|
|
@@ -575,7 +578,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
575
578
|
* @request PUT:/api/v3/iterations/disable
|
|
576
579
|
* @secure
|
|
577
580
|
*/
|
|
578
|
-
disableIterations: (params?: RequestParams) => Promise<
|
|
581
|
+
disableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
579
582
|
/**
|
|
580
583
|
* @description Enables Iterations for the current workspace
|
|
581
584
|
*
|
|
@@ -584,7 +587,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
584
587
|
* @request PUT:/api/v3/iterations/enable
|
|
585
588
|
* @secure
|
|
586
589
|
*/
|
|
587
|
-
enableIterations: (params?: RequestParams) => Promise<
|
|
590
|
+
enableIterations: (params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
588
591
|
/**
|
|
589
592
|
* No description
|
|
590
593
|
*
|
|
@@ -593,7 +596,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
593
596
|
* @request GET:/api/v3/iterations/{iteration-public-id}
|
|
594
597
|
* @secure
|
|
595
598
|
*/
|
|
596
|
-
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
599
|
+
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
597
600
|
/**
|
|
598
601
|
* No description
|
|
599
602
|
*
|
|
@@ -602,7 +605,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
602
605
|
* @request PUT:/api/v3/iterations/{iteration-public-id}
|
|
603
606
|
* @secure
|
|
604
607
|
*/
|
|
605
|
-
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<
|
|
608
|
+
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<axios0.AxiosResponse<Iteration, any, {}>>;
|
|
606
609
|
/**
|
|
607
610
|
* No description
|
|
608
611
|
*
|
|
@@ -611,7 +614,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
611
614
|
* @request DELETE:/api/v3/iterations/{iteration-public-id}
|
|
612
615
|
* @secure
|
|
613
616
|
*/
|
|
614
|
-
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
617
|
+
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
615
618
|
/**
|
|
616
619
|
* @description Get a list of all Stories in an Iteration.
|
|
617
620
|
*
|
|
@@ -623,7 +626,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
623
626
|
listIterationStories: (iterationPublicId: number, query?: {
|
|
624
627
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
625
628
|
includes_description?: boolean;
|
|
626
|
-
}, params?: RequestParams) => Promise<
|
|
629
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
627
630
|
/**
|
|
628
631
|
* @description Get Key Result returns information about a chosen Key Result.
|
|
629
632
|
*
|
|
@@ -632,7 +635,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
632
635
|
* @request GET:/api/v3/key-results/{key-result-public-id}
|
|
633
636
|
* @secure
|
|
634
637
|
*/
|
|
635
|
-
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<
|
|
638
|
+
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any, {}>>;
|
|
636
639
|
/**
|
|
637
640
|
* @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
|
|
638
641
|
*
|
|
@@ -641,7 +644,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
641
644
|
* @request PUT:/api/v3/key-results/{key-result-public-id}
|
|
642
645
|
* @secure
|
|
643
646
|
*/
|
|
644
|
-
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<
|
|
647
|
+
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<axios0.AxiosResponse<KeyResult, any, {}>>;
|
|
645
648
|
/**
|
|
646
649
|
* @description List Labels returns a list of all Labels and their attributes.
|
|
647
650
|
*
|
|
@@ -653,7 +656,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
653
656
|
listLabels: (query?: {
|
|
654
657
|
/** A true/false boolean indicating if the slim versions of the Label should be returned. */
|
|
655
658
|
slim?: boolean;
|
|
656
|
-
}, params?: RequestParams) => Promise<
|
|
659
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Label[], any, {}>>;
|
|
657
660
|
/**
|
|
658
661
|
* @description Create Label allows you to create a new Label in Shortcut.
|
|
659
662
|
*
|
|
@@ -662,7 +665,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
662
665
|
* @request POST:/api/v3/labels
|
|
663
666
|
* @secure
|
|
664
667
|
*/
|
|
665
|
-
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<
|
|
668
|
+
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
666
669
|
/**
|
|
667
670
|
* @description Get Label returns information about the selected Label.
|
|
668
671
|
*
|
|
@@ -671,7 +674,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
671
674
|
* @request GET:/api/v3/labels/{label-public-id}
|
|
672
675
|
* @secure
|
|
673
676
|
*/
|
|
674
|
-
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
677
|
+
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
675
678
|
/**
|
|
676
679
|
* @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
680
|
*
|
|
@@ -680,7 +683,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
680
683
|
* @request PUT:/api/v3/labels/{label-public-id}
|
|
681
684
|
* @secure
|
|
682
685
|
*/
|
|
683
|
-
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<
|
|
686
|
+
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<axios0.AxiosResponse<Label, any, {}>>;
|
|
684
687
|
/**
|
|
685
688
|
* @description Delete Label can be used to delete any Label.
|
|
686
689
|
*
|
|
@@ -689,7 +692,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
689
692
|
* @request DELETE:/api/v3/labels/{label-public-id}
|
|
690
693
|
* @secure
|
|
691
694
|
*/
|
|
692
|
-
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
695
|
+
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
693
696
|
/**
|
|
694
697
|
* @description List all of the Epics with the Label.
|
|
695
698
|
*
|
|
@@ -698,7 +701,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
698
701
|
* @request GET:/api/v3/labels/{label-public-id}/epics
|
|
699
702
|
* @secure
|
|
700
703
|
*/
|
|
701
|
-
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
704
|
+
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
702
705
|
/**
|
|
703
706
|
* @description List all of the Stories with the Label.
|
|
704
707
|
*
|
|
@@ -710,7 +713,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
710
713
|
listLabelStories: (labelPublicId: number, query?: {
|
|
711
714
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
712
715
|
includes_description?: boolean;
|
|
713
|
-
}, params?: RequestParams) => Promise<
|
|
716
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
714
717
|
/**
|
|
715
718
|
* @description List Linked Files returns a list of all Linked-Files and their attributes.
|
|
716
719
|
*
|
|
@@ -719,7 +722,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
719
722
|
* @request GET:/api/v3/linked-files
|
|
720
723
|
* @secure
|
|
721
724
|
*/
|
|
722
|
-
listLinkedFiles: (params?: RequestParams) => Promise<
|
|
725
|
+
listLinkedFiles: (params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile[], any, {}>>;
|
|
723
726
|
/**
|
|
724
727
|
* @description Create Linked File allows you to create a new Linked File in Shortcut.
|
|
725
728
|
*
|
|
@@ -728,7 +731,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
728
731
|
* @request POST:/api/v3/linked-files
|
|
729
732
|
* @secure
|
|
730
733
|
*/
|
|
731
|
-
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<
|
|
734
|
+
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
732
735
|
/**
|
|
733
736
|
* @description Get File returns information about the selected Linked File.
|
|
734
737
|
*
|
|
@@ -737,7 +740,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
737
740
|
* @request GET:/api/v3/linked-files/{linked-file-public-id}
|
|
738
741
|
* @secure
|
|
739
742
|
*/
|
|
740
|
-
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
743
|
+
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
741
744
|
/**
|
|
742
745
|
* @description Updated Linked File allows you to update properties of a previously attached Linked-File.
|
|
743
746
|
*
|
|
@@ -746,7 +749,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
746
749
|
* @request PUT:/api/v3/linked-files/{linked-file-public-id}
|
|
747
750
|
* @secure
|
|
748
751
|
*/
|
|
749
|
-
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<
|
|
752
|
+
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<axios0.AxiosResponse<LinkedFile, any, {}>>;
|
|
750
753
|
/**
|
|
751
754
|
* @description Delete Linked File can be used to delete any previously attached Linked-File.
|
|
752
755
|
*
|
|
@@ -755,7 +758,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
755
758
|
* @request DELETE:/api/v3/linked-files/{linked-file-public-id}
|
|
756
759
|
* @secure
|
|
757
760
|
*/
|
|
758
|
-
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
761
|
+
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
759
762
|
/**
|
|
760
763
|
* @description Returns information about the authenticated member.
|
|
761
764
|
*
|
|
@@ -764,7 +767,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
764
767
|
* @request GET:/api/v3/member
|
|
765
768
|
* @secure
|
|
766
769
|
*/
|
|
767
|
-
getCurrentMemberInfo: (params?: RequestParams) => Promise<
|
|
770
|
+
getCurrentMemberInfo: (params?: RequestParams) => Promise<axios0.AxiosResponse<MemberInfo, any, {}>>;
|
|
768
771
|
/**
|
|
769
772
|
* @description Returns information about members of the Workspace.
|
|
770
773
|
*
|
|
@@ -781,7 +784,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
781
784
|
"org-public-id"?: string;
|
|
782
785
|
/** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
|
|
783
786
|
disabled?: boolean;
|
|
784
|
-
}, params?: RequestParams) => Promise<
|
|
787
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Member[], any, {}>>;
|
|
785
788
|
/**
|
|
786
789
|
* @description Returns information about a Member.
|
|
787
790
|
*
|
|
@@ -796,7 +799,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
796
799
|
* @format uuid
|
|
797
800
|
*/
|
|
798
801
|
"org-public-id"?: string;
|
|
799
|
-
}, params?: RequestParams) => Promise<
|
|
802
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Member, any, {}>>;
|
|
800
803
|
/**
|
|
801
804
|
* @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
|
|
802
805
|
*
|
|
@@ -805,7 +808,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
805
808
|
* @request GET:/api/v3/milestones
|
|
806
809
|
* @secure
|
|
807
810
|
*/
|
|
808
|
-
listMilestones: (params?: RequestParams) => Promise<
|
|
811
|
+
listMilestones: (params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone[], any, {}>>;
|
|
809
812
|
/**
|
|
810
813
|
* @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
|
|
811
814
|
*
|
|
@@ -814,7 +817,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
814
817
|
* @request POST:/api/v3/milestones
|
|
815
818
|
* @secure
|
|
816
819
|
*/
|
|
817
|
-
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<
|
|
820
|
+
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
818
821
|
/**
|
|
819
822
|
* @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
|
|
820
823
|
*
|
|
@@ -823,7 +826,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
823
826
|
* @request GET:/api/v3/milestones/{milestone-public-id}
|
|
824
827
|
* @secure
|
|
825
828
|
*/
|
|
826
|
-
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
829
|
+
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
827
830
|
/**
|
|
828
831
|
* @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
|
|
829
832
|
*
|
|
@@ -832,7 +835,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
832
835
|
* @request PUT:/api/v3/milestones/{milestone-public-id}
|
|
833
836
|
* @secure
|
|
834
837
|
*/
|
|
835
|
-
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<
|
|
838
|
+
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<axios0.AxiosResponse<Milestone, any, {}>>;
|
|
836
839
|
/**
|
|
837
840
|
* @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
|
|
838
841
|
*
|
|
@@ -841,7 +844,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
841
844
|
* @request DELETE:/api/v3/milestones/{milestone-public-id}
|
|
842
845
|
* @secure
|
|
843
846
|
*/
|
|
844
|
-
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
847
|
+
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
845
848
|
/**
|
|
846
849
|
* @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
|
|
847
850
|
*
|
|
@@ -850,7 +853,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
850
853
|
* @request GET:/api/v3/milestones/{milestone-public-id}/epics
|
|
851
854
|
* @secure
|
|
852
855
|
*/
|
|
853
|
-
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
856
|
+
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
854
857
|
/**
|
|
855
858
|
* @description List Objectives returns a list of all Objectives and their attributes.
|
|
856
859
|
*
|
|
@@ -859,7 +862,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
859
862
|
* @request GET:/api/v3/objectives
|
|
860
863
|
* @secure
|
|
861
864
|
*/
|
|
862
|
-
listObjectives: (params?: RequestParams) => Promise<
|
|
865
|
+
listObjectives: (params?: RequestParams) => Promise<axios0.AxiosResponse<Objective[], any, {}>>;
|
|
863
866
|
/**
|
|
864
867
|
* @description Create Objective allows you to create a new Objective in Shortcut.
|
|
865
868
|
*
|
|
@@ -868,7 +871,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
868
871
|
* @request POST:/api/v3/objectives
|
|
869
872
|
* @secure
|
|
870
873
|
*/
|
|
871
|
-
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<
|
|
874
|
+
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
872
875
|
/**
|
|
873
876
|
* @description Get Objective returns information about a chosen Objective.
|
|
874
877
|
*
|
|
@@ -877,7 +880,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
877
880
|
* @request GET:/api/v3/objectives/{objective-public-id}
|
|
878
881
|
* @secure
|
|
879
882
|
*/
|
|
880
|
-
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
883
|
+
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
881
884
|
/**
|
|
882
885
|
* @description Update Objective can be used to update Objective properties.
|
|
883
886
|
*
|
|
@@ -886,7 +889,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
886
889
|
* @request PUT:/api/v3/objectives/{objective-public-id}
|
|
887
890
|
* @secure
|
|
888
891
|
*/
|
|
889
|
-
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<
|
|
892
|
+
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<axios0.AxiosResponse<Objective, any, {}>>;
|
|
890
893
|
/**
|
|
891
894
|
* @description Delete Objective can be used to delete any Objective.
|
|
892
895
|
*
|
|
@@ -895,7 +898,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
895
898
|
* @request DELETE:/api/v3/objectives/{objective-public-id}
|
|
896
899
|
* @secure
|
|
897
900
|
*/
|
|
898
|
-
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
901
|
+
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
899
902
|
/**
|
|
900
903
|
* @description List all of the Epics within the Objective.
|
|
901
904
|
*
|
|
@@ -904,7 +907,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
904
907
|
* @request GET:/api/v3/objectives/{objective-public-id}/epics
|
|
905
908
|
* @secure
|
|
906
909
|
*/
|
|
907
|
-
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
910
|
+
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
908
911
|
/**
|
|
909
912
|
* @description List Projects returns a list of all Projects and their attributes.
|
|
910
913
|
*
|
|
@@ -913,7 +916,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
913
916
|
* @request GET:/api/v3/projects
|
|
914
917
|
* @secure
|
|
915
918
|
*/
|
|
916
|
-
listProjects: (params?: RequestParams) => Promise<
|
|
919
|
+
listProjects: (params?: RequestParams) => Promise<axios0.AxiosResponse<Project[], any, {}>>;
|
|
917
920
|
/**
|
|
918
921
|
* @description Create Project is used to create a new Shortcut Project.
|
|
919
922
|
*
|
|
@@ -922,7 +925,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
922
925
|
* @request POST:/api/v3/projects
|
|
923
926
|
* @secure
|
|
924
927
|
*/
|
|
925
|
-
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<
|
|
928
|
+
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
926
929
|
/**
|
|
927
930
|
* @description Get Project returns information about the selected Project.
|
|
928
931
|
*
|
|
@@ -931,7 +934,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
931
934
|
* @request GET:/api/v3/projects/{project-public-id}
|
|
932
935
|
* @secure
|
|
933
936
|
*/
|
|
934
|
-
getProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
937
|
+
getProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
935
938
|
/**
|
|
936
939
|
* @description Update Project can be used to change properties of a Project.
|
|
937
940
|
*
|
|
@@ -940,7 +943,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
940
943
|
* @request PUT:/api/v3/projects/{project-public-id}
|
|
941
944
|
* @secure
|
|
942
945
|
*/
|
|
943
|
-
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<
|
|
946
|
+
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<axios0.AxiosResponse<Project, any, {}>>;
|
|
944
947
|
/**
|
|
945
948
|
* @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
949
|
*
|
|
@@ -949,7 +952,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
949
952
|
* @request DELETE:/api/v3/projects/{project-public-id}
|
|
950
953
|
* @secure
|
|
951
954
|
*/
|
|
952
|
-
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
955
|
+
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
953
956
|
/**
|
|
954
957
|
* @description List Stories returns a list of all Stories in a selected Project and their attributes.
|
|
955
958
|
*
|
|
@@ -961,7 +964,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
961
964
|
listStories: (projectPublicId: number, query?: {
|
|
962
965
|
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
963
966
|
includes_description?: boolean;
|
|
964
|
-
}, params?: RequestParams) => Promise<
|
|
967
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
965
968
|
/**
|
|
966
969
|
* @description List Repositories returns a list of all Repositories and their attributes.
|
|
967
970
|
*
|
|
@@ -970,7 +973,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
970
973
|
* @request GET:/api/v3/repositories
|
|
971
974
|
* @secure
|
|
972
975
|
*/
|
|
973
|
-
listRepositories: (params?: RequestParams) => Promise<
|
|
976
|
+
listRepositories: (params?: RequestParams) => Promise<axios0.AxiosResponse<Repository[], any, {}>>;
|
|
974
977
|
/**
|
|
975
978
|
* @description Get Repository returns information about the selected Repository.
|
|
976
979
|
*
|
|
@@ -979,7 +982,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
979
982
|
* @request GET:/api/v3/repositories/{repo-public-id}
|
|
980
983
|
* @secure
|
|
981
984
|
*/
|
|
982
|
-
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<
|
|
985
|
+
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Repository, any, {}>>;
|
|
983
986
|
/**
|
|
984
987
|
* @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
988
|
*
|
|
@@ -1012,7 +1015,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1012
1015
|
next?: string;
|
|
1013
1016
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1014
1017
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1015
|
-
}, params?: RequestParams) => Promise<
|
|
1018
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
|
|
1016
1019
|
/**
|
|
1017
1020
|
* @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
1021
|
*
|
|
@@ -1045,7 +1048,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1045
1048
|
next?: string;
|
|
1046
1049
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1047
1050
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1048
|
-
}, params?: RequestParams) => Promise<
|
|
1051
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSearchResults, any, {}>>;
|
|
1049
1052
|
/**
|
|
1050
1053
|
* @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
1054
|
*
|
|
@@ -1078,7 +1081,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1078
1081
|
next?: string;
|
|
1079
1082
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1080
1083
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1081
|
-
}, params?: RequestParams) => Promise<
|
|
1084
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<IterationSearchResults, any, {}>>;
|
|
1082
1085
|
/**
|
|
1083
1086
|
* @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
1087
|
*
|
|
@@ -1111,7 +1114,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1111
1114
|
next?: string;
|
|
1112
1115
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1113
1116
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1114
|
-
}, params?: RequestParams) => Promise<
|
|
1117
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1115
1118
|
/**
|
|
1116
1119
|
* @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
1120
|
*
|
|
@@ -1144,7 +1147,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1144
1147
|
next?: string;
|
|
1145
1148
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1146
1149
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1147
|
-
}, params?: RequestParams) => Promise<
|
|
1150
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1148
1151
|
/**
|
|
1149
1152
|
* @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
1153
|
*
|
|
@@ -1177,7 +1180,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1177
1180
|
next?: string;
|
|
1178
1181
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1179
1182
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1180
|
-
}, params?: RequestParams) => Promise<
|
|
1183
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySearchResults, any, {}>>;
|
|
1181
1184
|
/**
|
|
1182
1185
|
* @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
1186
|
*
|
|
@@ -1186,7 +1189,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1186
1189
|
* @request POST:/api/v3/stories
|
|
1187
1190
|
* @secure
|
|
1188
1191
|
*/
|
|
1189
|
-
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<
|
|
1192
|
+
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1190
1193
|
/**
|
|
1191
1194
|
* @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
1195
|
*
|
|
@@ -1195,7 +1198,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1195
1198
|
* @request POST:/api/v3/stories/bulk
|
|
1196
1199
|
* @secure
|
|
1197
1200
|
*/
|
|
1198
|
-
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<
|
|
1201
|
+
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1199
1202
|
/**
|
|
1200
1203
|
* @description Update Multiple Stories allows you to make changes to numerous stories at once.
|
|
1201
1204
|
*
|
|
@@ -1204,7 +1207,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1204
1207
|
* @request PUT:/api/v3/stories/bulk
|
|
1205
1208
|
* @secure
|
|
1206
1209
|
*/
|
|
1207
|
-
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<
|
|
1210
|
+
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1208
1211
|
/**
|
|
1209
1212
|
* @description Delete Multiple Stories allows you to delete multiple archived stories at once.
|
|
1210
1213
|
*
|
|
@@ -1213,7 +1216,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1213
1216
|
* @request DELETE:/api/v3/stories/bulk
|
|
1214
1217
|
* @secure
|
|
1215
1218
|
*/
|
|
1216
|
-
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<
|
|
1219
|
+
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1217
1220
|
/**
|
|
1218
1221
|
* @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
|
|
1219
1222
|
*
|
|
@@ -1222,7 +1225,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1222
1225
|
* @request POST:/api/v3/stories/from-template
|
|
1223
1226
|
* @secure
|
|
1224
1227
|
*/
|
|
1225
|
-
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<
|
|
1228
|
+
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1226
1229
|
/**
|
|
1227
1230
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1228
1231
|
*
|
|
@@ -1231,7 +1234,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1231
1234
|
* @request POST:/api/v3/stories/search
|
|
1232
1235
|
* @secure
|
|
1233
1236
|
*/
|
|
1234
|
-
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<
|
|
1237
|
+
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1235
1238
|
/**
|
|
1236
1239
|
* @description Get Story returns information about a chosen Story.
|
|
1237
1240
|
*
|
|
@@ -1240,7 +1243,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1240
1243
|
* @request GET:/api/v3/stories/{story-public-id}
|
|
1241
1244
|
* @secure
|
|
1242
1245
|
*/
|
|
1243
|
-
getStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1246
|
+
getStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1244
1247
|
/**
|
|
1245
1248
|
* @description Update Story can be used to update Story properties.
|
|
1246
1249
|
*
|
|
@@ -1249,7 +1252,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1249
1252
|
* @request PUT:/api/v3/stories/{story-public-id}
|
|
1250
1253
|
* @secure
|
|
1251
1254
|
*/
|
|
1252
|
-
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<
|
|
1255
|
+
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<axios0.AxiosResponse<Story, any, {}>>;
|
|
1253
1256
|
/**
|
|
1254
1257
|
* @description Delete Story can be used to delete any Story.
|
|
1255
1258
|
*
|
|
@@ -1258,7 +1261,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1258
1261
|
* @request DELETE:/api/v3/stories/{story-public-id}
|
|
1259
1262
|
* @secure
|
|
1260
1263
|
*/
|
|
1261
|
-
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1264
|
+
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1262
1265
|
/**
|
|
1263
1266
|
* @description Lists Comments associated with a Story
|
|
1264
1267
|
*
|
|
@@ -1267,7 +1270,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1267
1270
|
* @request GET:/api/v3/stories/{story-public-id}/comments
|
|
1268
1271
|
* @secure
|
|
1269
1272
|
*/
|
|
1270
|
-
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1273
|
+
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment[], any, {}>>;
|
|
1271
1274
|
/**
|
|
1272
1275
|
* @description Create Comment allows you to create a Comment on any Story.
|
|
1273
1276
|
*
|
|
@@ -1276,7 +1279,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1276
1279
|
* @request POST:/api/v3/stories/{story-public-id}/comments
|
|
1277
1280
|
* @secure
|
|
1278
1281
|
*/
|
|
1279
|
-
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<
|
|
1282
|
+
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1280
1283
|
/**
|
|
1281
1284
|
* @description Get Comment is used to get Comment information.
|
|
1282
1285
|
*
|
|
@@ -1285,7 +1288,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1285
1288
|
* @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1286
1289
|
* @secure
|
|
1287
1290
|
*/
|
|
1288
|
-
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1291
|
+
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1289
1292
|
/**
|
|
1290
1293
|
* @description Update Comment replaces the text of the existing Comment.
|
|
1291
1294
|
*
|
|
@@ -1294,7 +1297,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1294
1297
|
* @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1295
1298
|
* @secure
|
|
1296
1299
|
*/
|
|
1297
|
-
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<
|
|
1300
|
+
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1298
1301
|
/**
|
|
1299
1302
|
* @description Delete a Comment from any story.
|
|
1300
1303
|
*
|
|
@@ -1303,7 +1306,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1303
1306
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1304
1307
|
* @secure
|
|
1305
1308
|
*/
|
|
1306
|
-
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1309
|
+
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1307
1310
|
/**
|
|
1308
1311
|
* @description Create a reaction to a story comment.
|
|
1309
1312
|
*
|
|
@@ -1312,7 +1315,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1312
1315
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1313
1316
|
* @secure
|
|
1314
1317
|
*/
|
|
1315
|
-
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1318
|
+
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryReaction[], any, {}>>;
|
|
1316
1319
|
/**
|
|
1317
1320
|
* @description Delete a reaction from any story comment.
|
|
1318
1321
|
*
|
|
@@ -1321,7 +1324,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1321
1324
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1322
1325
|
* @secure
|
|
1323
1326
|
*/
|
|
1324
|
-
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1327
|
+
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1325
1328
|
/**
|
|
1326
1329
|
* @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
|
|
1327
1330
|
*
|
|
@@ -1330,7 +1333,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1330
1333
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
|
|
1331
1334
|
* @secure
|
|
1332
1335
|
*/
|
|
1333
|
-
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1336
|
+
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryComment, any, {}>>;
|
|
1334
1337
|
/**
|
|
1335
1338
|
* No description
|
|
1336
1339
|
*
|
|
@@ -1339,7 +1342,16 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1339
1342
|
* @request GET:/api/v3/stories/{story-public-id}/history
|
|
1340
1343
|
* @secure
|
|
1341
1344
|
*/
|
|
1342
|
-
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1345
|
+
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<History[], any, {}>>;
|
|
1346
|
+
/**
|
|
1347
|
+
* @description List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
|
|
1348
|
+
*
|
|
1349
|
+
* @name ListStorySubTasks
|
|
1350
|
+
* @summary List Story Sub tasks
|
|
1351
|
+
* @request GET:/api/v3/stories/{story-public-id}/sub-tasks
|
|
1352
|
+
* @secure
|
|
1353
|
+
*/
|
|
1354
|
+
listStorySubTasks: (storyPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1343
1355
|
/**
|
|
1344
1356
|
* @description Create Task is used to create a new task in a Story.
|
|
1345
1357
|
*
|
|
@@ -1348,7 +1360,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1348
1360
|
* @request POST:/api/v3/stories/{story-public-id}/tasks
|
|
1349
1361
|
* @secure
|
|
1350
1362
|
*/
|
|
1351
|
-
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<
|
|
1363
|
+
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1352
1364
|
/**
|
|
1353
1365
|
* @description Returns information about a chosen Task.
|
|
1354
1366
|
*
|
|
@@ -1357,7 +1369,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1357
1369
|
* @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1358
1370
|
* @secure
|
|
1359
1371
|
*/
|
|
1360
|
-
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1372
|
+
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1361
1373
|
/**
|
|
1362
1374
|
* @description Update Task can be used to update Task properties.
|
|
1363
1375
|
*
|
|
@@ -1366,7 +1378,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1366
1378
|
* @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1367
1379
|
* @secure
|
|
1368
1380
|
*/
|
|
1369
|
-
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<
|
|
1381
|
+
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<axios0.AxiosResponse<Task, any, {}>>;
|
|
1370
1382
|
/**
|
|
1371
1383
|
* @description Delete Task can be used to delete any previously created Task on a Story.
|
|
1372
1384
|
*
|
|
@@ -1375,7 +1387,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1375
1387
|
* @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1376
1388
|
* @secure
|
|
1377
1389
|
*/
|
|
1378
|
-
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1390
|
+
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1379
1391
|
/**
|
|
1380
1392
|
* @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
1393
|
*
|
|
@@ -1384,7 +1396,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1384
1396
|
* @request POST:/api/v3/story-links
|
|
1385
1397
|
* @secure
|
|
1386
1398
|
*/
|
|
1387
|
-
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<
|
|
1399
|
+
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1388
1400
|
/**
|
|
1389
1401
|
* @description Returns the stories and their relationship for the given Story Link.
|
|
1390
1402
|
*
|
|
@@ -1393,7 +1405,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1393
1405
|
* @request GET:/api/v3/story-links/{story-link-public-id}
|
|
1394
1406
|
* @secure
|
|
1395
1407
|
*/
|
|
1396
|
-
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1408
|
+
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1397
1409
|
/**
|
|
1398
1410
|
* @description Updates the stories and/or the relationship for the given Story Link.
|
|
1399
1411
|
*
|
|
@@ -1402,7 +1414,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1402
1414
|
* @request PUT:/api/v3/story-links/{story-link-public-id}
|
|
1403
1415
|
* @secure
|
|
1404
1416
|
*/
|
|
1405
|
-
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<
|
|
1417
|
+
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<axios0.AxiosResponse<StoryLink, any, {}>>;
|
|
1406
1418
|
/**
|
|
1407
1419
|
* @description Removes the relationship between the stories for the given Story Link.
|
|
1408
1420
|
*
|
|
@@ -1411,7 +1423,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1411
1423
|
* @request DELETE:/api/v3/story-links/{story-link-public-id}
|
|
1412
1424
|
* @secure
|
|
1413
1425
|
*/
|
|
1414
|
-
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1426
|
+
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
1415
1427
|
/**
|
|
1416
1428
|
* @description Returns a list of all Workflows in the Workspace.
|
|
1417
1429
|
*
|
|
@@ -1420,7 +1432,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1420
1432
|
* @request GET:/api/v3/workflows
|
|
1421
1433
|
* @secure
|
|
1422
1434
|
*/
|
|
1423
|
-
listWorkflows: (params?: RequestParams) => Promise<
|
|
1435
|
+
listWorkflows: (params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow[], any, {}>>;
|
|
1424
1436
|
/**
|
|
1425
1437
|
* @description Get Workflow returns information about a chosen Workflow.
|
|
1426
1438
|
*
|
|
@@ -1429,7 +1441,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1429
1441
|
* @request GET:/api/v3/workflows/{workflow-public-id}
|
|
1430
1442
|
* @secure
|
|
1431
1443
|
*/
|
|
1432
|
-
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<
|
|
1444
|
+
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<Workflow, any, {}>>;
|
|
1433
1445
|
}
|
|
1434
1446
|
//#endregion
|
|
1435
1447
|
export { Api };
|