@useshortcut/client 3.2.2 → 3.2.3
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 +10 -8
- package/lib/{ShortcutClient.js → ShortcutClient.cjs} +2 -4
- package/lib/{ShortcutClient.d.ts → ShortcutClient.d.cts} +2 -2
- package/lib/ShortcutClient.mjs +1 -3
- package/lib/_virtual/{rolldown_runtime.js → _rolldown/runtime.cjs} +2 -9
- package/lib/generated/{Api.js → Api.cjs} +50 -52
- package/lib/generated/{Api.d.ts → Api.d.cts} +170 -197
- package/lib/generated/Api.d.mts +168 -195
- package/lib/generated/Api.mjs +50 -52
- package/lib/generated/{http-client.js → http-client.cjs} +9 -18
- package/lib/generated/{http-client.d.ts → http-client.d.cts} +1 -1
- package/lib/generated/http-client.d.mts +1 -1
- package/lib/generated/http-client.mjs +6 -15
- package/lib/index.cjs +7 -0
- package/lib/{index.d.ts → index.d.cts} +2 -2
- package/lib/index.mjs +1 -2
- package/package.json +30 -49
- package/lib/index.js +0 -5
- /package/lib/generated/{data-contracts.d.ts → data-contracts.d.cts} +0 -0
|
@@ -1,9 +1,8 @@
|
|
|
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.
|
|
2
|
-
import { HttpClient, RequestParams } from "./http-client.
|
|
3
|
-
import * as
|
|
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.cjs";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client.cjs";
|
|
3
|
+
import * as _$axios from "axios";
|
|
4
4
|
|
|
5
5
|
//#region src/generated/Api.d.ts
|
|
6
|
-
|
|
7
6
|
/**
|
|
8
7
|
* Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
|
|
9
8
|
* @private
|
|
@@ -17,7 +16,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
17
16
|
* @request GET:/api/v3/categories
|
|
18
17
|
* @secure
|
|
19
18
|
*/
|
|
20
|
-
listCategories: (params?: RequestParams) => Promise<
|
|
19
|
+
listCategories: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Category[], any, {}>>;
|
|
21
20
|
/**
|
|
22
21
|
* @description Create Category allows you to create a new Category in Shortcut.
|
|
23
22
|
*
|
|
@@ -26,7 +25,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
26
25
|
* @request POST:/api/v3/categories
|
|
27
26
|
* @secure
|
|
28
27
|
*/
|
|
29
|
-
createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<
|
|
28
|
+
createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<_$axios.AxiosResponse<Category, any, {}>>;
|
|
30
29
|
/**
|
|
31
30
|
* @description Get Category returns information about the selected Category.
|
|
32
31
|
*
|
|
@@ -35,7 +34,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
35
34
|
* @request GET:/api/v3/categories/{category-public-id}
|
|
36
35
|
* @secure
|
|
37
36
|
*/
|
|
38
|
-
getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
37
|
+
getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Category, any, {}>>;
|
|
39
38
|
/**
|
|
40
39
|
* @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
40
|
*
|
|
@@ -44,7 +43,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
44
43
|
* @request PUT:/api/v3/categories/{category-public-id}
|
|
45
44
|
* @secure
|
|
46
45
|
*/
|
|
47
|
-
updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<
|
|
46
|
+
updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<_$axios.AxiosResponse<Category, any, {}>>;
|
|
48
47
|
/**
|
|
49
48
|
* @description Delete Category can be used to delete any Category.
|
|
50
49
|
*
|
|
@@ -53,7 +52,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
53
52
|
* @request DELETE:/api/v3/categories/{category-public-id}
|
|
54
53
|
* @secure
|
|
55
54
|
*/
|
|
56
|
-
deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
55
|
+
deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
57
56
|
/**
|
|
58
57
|
* @description List Category Milestones returns a list of all Milestones with the Category.
|
|
59
58
|
*
|
|
@@ -62,7 +61,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
62
61
|
* @request GET:/api/v3/categories/{category-public-id}/milestones
|
|
63
62
|
* @secure
|
|
64
63
|
*/
|
|
65
|
-
listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
64
|
+
listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone[], any, {}>>;
|
|
66
65
|
/**
|
|
67
66
|
* @description Returns a list of all Objectives with the Category.
|
|
68
67
|
*
|
|
@@ -71,7 +70,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
71
70
|
* @request GET:/api/v3/categories/{category-public-id}/objectives
|
|
72
71
|
* @secure
|
|
73
72
|
*/
|
|
74
|
-
listCategoryObjectives: (categoryPublicId: number, params?: RequestParams) => Promise<
|
|
73
|
+
listCategoryObjectives: (categoryPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone[], any, {}>>;
|
|
75
74
|
/**
|
|
76
75
|
* No description
|
|
77
76
|
*
|
|
@@ -80,7 +79,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
80
79
|
* @request GET:/api/v3/custom-fields
|
|
81
80
|
* @secure
|
|
82
81
|
*/
|
|
83
|
-
listCustomFields: (params?: RequestParams) => Promise<
|
|
82
|
+
listCustomFields: (params?: RequestParams) => Promise<_$axios.AxiosResponse<CustomField[], any, {}>>;
|
|
84
83
|
/**
|
|
85
84
|
* No description
|
|
86
85
|
*
|
|
@@ -89,7 +88,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
89
88
|
* @request GET:/api/v3/custom-fields/{custom-field-public-id}
|
|
90
89
|
* @secure
|
|
91
90
|
*/
|
|
92
|
-
getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<
|
|
91
|
+
getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<CustomField, any, {}>>;
|
|
93
92
|
/**
|
|
94
93
|
* @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
94
|
*
|
|
@@ -98,7 +97,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
98
97
|
* @request PUT:/api/v3/custom-fields/{custom-field-public-id}
|
|
99
98
|
* @secure
|
|
100
99
|
*/
|
|
101
|
-
updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<
|
|
100
|
+
updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<_$axios.AxiosResponse<CustomField, any, {}>>;
|
|
102
101
|
/**
|
|
103
102
|
* No description
|
|
104
103
|
*
|
|
@@ -107,7 +106,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
107
106
|
* @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
|
|
108
107
|
* @secure
|
|
109
108
|
*/
|
|
110
|
-
deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<
|
|
109
|
+
deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
111
110
|
/**
|
|
112
111
|
* @description List Docs returns a list of Doc that the current user can read.
|
|
113
112
|
*
|
|
@@ -116,7 +115,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
116
115
|
* @request GET:/api/v3/documents
|
|
117
116
|
* @secure
|
|
118
117
|
*/
|
|
119
|
-
listDocs: (params?: RequestParams) => Promise<
|
|
118
|
+
listDocs: (params?: RequestParams) => Promise<_$axios.AxiosResponse<DocSlim[], any, {}>>;
|
|
120
119
|
/**
|
|
121
120
|
* @description Creates a new Doc. Supports markdown or HTML input via content_format parameter.
|
|
122
121
|
*
|
|
@@ -125,7 +124,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
125
124
|
* @request POST:/api/v3/documents
|
|
126
125
|
* @secure
|
|
127
126
|
*/
|
|
128
|
-
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<
|
|
127
|
+
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<_$axios.AxiosResponse<DocSlim, any, {}>>;
|
|
129
128
|
/**
|
|
130
129
|
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
131
130
|
*
|
|
@@ -135,9 +134,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
135
134
|
* @secure
|
|
136
135
|
*/
|
|
137
136
|
getDoc: (docPublicId: string, query?: {
|
|
138
|
-
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
139
|
-
|
|
140
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
137
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */content_format?: "markdown" | "html";
|
|
138
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<Doc, any, {}>>;
|
|
141
139
|
/**
|
|
142
140
|
* @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
141
|
*
|
|
@@ -146,7 +144,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
146
144
|
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
147
145
|
* @secure
|
|
148
146
|
*/
|
|
149
|
-
updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<
|
|
147
|
+
updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<_$axios.AxiosResponse<Doc, any, {}>>;
|
|
150
148
|
/**
|
|
151
149
|
* @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
150
|
*
|
|
@@ -155,7 +153,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
155
153
|
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
156
154
|
* @secure
|
|
157
155
|
*/
|
|
158
|
-
deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<
|
|
156
|
+
deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
159
157
|
/**
|
|
160
158
|
* @description Get a list of all Epics related to this Document.
|
|
161
159
|
*
|
|
@@ -164,7 +162,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
164
162
|
* @request GET:/api/v3/documents/{doc-public-id}/epics
|
|
165
163
|
* @secure
|
|
166
164
|
*/
|
|
167
|
-
listDocumentEpics: (docPublicId: string, params?: RequestParams) => Promise<
|
|
165
|
+
listDocumentEpics: (docPublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSlim[], any, {}>>;
|
|
168
166
|
/**
|
|
169
167
|
* @description Create a relationship between a Document and an Epic.
|
|
170
168
|
*
|
|
@@ -173,7 +171,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
173
171
|
* @request PUT:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
174
172
|
* @secure
|
|
175
173
|
*/
|
|
176
|
-
linkDocumentToEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<
|
|
174
|
+
linkDocumentToEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
177
175
|
/**
|
|
178
176
|
* @description Remove a relationship between a Document and an Epic.
|
|
179
177
|
*
|
|
@@ -182,7 +180,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
182
180
|
* @request DELETE:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
183
181
|
* @secure
|
|
184
182
|
*/
|
|
185
|
-
unlinkDocumentFromEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<
|
|
183
|
+
unlinkDocumentFromEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
186
184
|
/**
|
|
187
185
|
* @description List all the entity templates for the Workspace.
|
|
188
186
|
*
|
|
@@ -191,7 +189,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
191
189
|
* @request GET:/api/v3/entity-templates
|
|
192
190
|
* @secure
|
|
193
191
|
*/
|
|
194
|
-
listEntityTemplates: (params?: RequestParams) => Promise<
|
|
192
|
+
listEntityTemplates: (params?: RequestParams) => Promise<_$axios.AxiosResponse<EntityTemplate[], any, {}>>;
|
|
195
193
|
/**
|
|
196
194
|
* @description Create a new entity template for the Workspace.
|
|
197
195
|
*
|
|
@@ -200,7 +198,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
200
198
|
* @request POST:/api/v3/entity-templates
|
|
201
199
|
* @secure
|
|
202
200
|
*/
|
|
203
|
-
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<
|
|
201
|
+
createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<_$axios.AxiosResponse<EntityTemplate, any, {}>>;
|
|
204
202
|
/**
|
|
205
203
|
* @description Disables the Story Template feature for the Workspace.
|
|
206
204
|
*
|
|
@@ -209,7 +207,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
209
207
|
* @request PUT:/api/v3/entity-templates/disable
|
|
210
208
|
* @secure
|
|
211
209
|
*/
|
|
212
|
-
disableStoryTemplates: (params?: RequestParams) => Promise<
|
|
210
|
+
disableStoryTemplates: (params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
213
211
|
/**
|
|
214
212
|
* @description Enables the Story Template feature for the Workspace.
|
|
215
213
|
*
|
|
@@ -218,7 +216,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
218
216
|
* @request PUT:/api/v3/entity-templates/enable
|
|
219
217
|
* @secure
|
|
220
218
|
*/
|
|
221
|
-
enableStoryTemplates: (params?: RequestParams) => Promise<
|
|
219
|
+
enableStoryTemplates: (params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
222
220
|
/**
|
|
223
221
|
* @description Get Entity Template returns information about a given entity template.
|
|
224
222
|
*
|
|
@@ -227,7 +225,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
227
225
|
* @request GET:/api/v3/entity-templates/{entity-template-public-id}
|
|
228
226
|
* @secure
|
|
229
227
|
*/
|
|
230
|
-
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
228
|
+
getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<EntityTemplate, any, {}>>;
|
|
231
229
|
/**
|
|
232
230
|
* @description Update an entity template's name or its contents.
|
|
233
231
|
*
|
|
@@ -236,7 +234,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
236
234
|
* @request PUT:/api/v3/entity-templates/{entity-template-public-id}
|
|
237
235
|
* @secure
|
|
238
236
|
*/
|
|
239
|
-
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<
|
|
237
|
+
updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<_$axios.AxiosResponse<EntityTemplate, any, {}>>;
|
|
240
238
|
/**
|
|
241
239
|
* No description
|
|
242
240
|
*
|
|
@@ -245,7 +243,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
245
243
|
* @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
|
|
246
244
|
* @secure
|
|
247
245
|
*/
|
|
248
|
-
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<
|
|
246
|
+
deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
249
247
|
/**
|
|
250
248
|
* @description Returns the Epic Workflow for the Workspace.
|
|
251
249
|
*
|
|
@@ -254,7 +252,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
254
252
|
* @request GET:/api/v3/epic-workflow
|
|
255
253
|
* @secure
|
|
256
254
|
*/
|
|
257
|
-
getEpicWorkflow: (params?: RequestParams) => Promise<
|
|
255
|
+
getEpicWorkflow: (params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicWorkflow, any, {}>>;
|
|
258
256
|
/**
|
|
259
257
|
* @description List Epics returns a list of all Epics and their attributes.
|
|
260
258
|
*
|
|
@@ -264,9 +262,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
264
262
|
* @secure
|
|
265
263
|
*/
|
|
266
264
|
listEpics: (query?: {
|
|
267
|
-
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
268
|
-
|
|
269
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
265
|
+
/** A true/false boolean indicating whether to return Epics with their descriptions. */includes_description?: boolean;
|
|
266
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSlim[], any, {}>>;
|
|
270
267
|
/**
|
|
271
268
|
* @description Create Epic allows you to create a new Epic in Shortcut.
|
|
272
269
|
*
|
|
@@ -275,7 +272,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
275
272
|
* @request POST:/api/v3/epics
|
|
276
273
|
* @secure
|
|
277
274
|
*/
|
|
278
|
-
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<
|
|
275
|
+
createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<_$axios.AxiosResponse<Epic, any, {}>>;
|
|
279
276
|
/**
|
|
280
277
|
* @description List Epics with pagination returns a paginated list of Epics and their attributes.
|
|
281
278
|
*
|
|
@@ -285,8 +282,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
285
282
|
* @secure
|
|
286
283
|
*/
|
|
287
284
|
listEpicsPaginated: (query?: {
|
|
288
|
-
/** A true/false boolean indicating whether to return Epics with their descriptions. */
|
|
289
|
-
includes_description?: boolean;
|
|
285
|
+
/** A true/false boolean indicating whether to return Epics with their descriptions. */includes_description?: boolean;
|
|
290
286
|
/**
|
|
291
287
|
* The page number to return, starting with 1. Defaults to 1.
|
|
292
288
|
* @format int64
|
|
@@ -297,7 +293,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
297
293
|
* @format int64
|
|
298
294
|
*/
|
|
299
295
|
page_size?: number;
|
|
300
|
-
}, params?: RequestParams) => Promise<
|
|
296
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicPaginatedResults, any, {}>>;
|
|
301
297
|
/**
|
|
302
298
|
* @description Get Epic returns information about the selected Epic.
|
|
303
299
|
*
|
|
@@ -306,7 +302,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
306
302
|
* @request GET:/api/v3/epics/{epic-public-id}
|
|
307
303
|
* @secure
|
|
308
304
|
*/
|
|
309
|
-
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
305
|
+
getEpic: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Epic, any, {}>>;
|
|
310
306
|
/**
|
|
311
307
|
* @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.
|
|
312
308
|
*
|
|
@@ -315,7 +311,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
315
311
|
* @request PUT:/api/v3/epics/{epic-public-id}
|
|
316
312
|
* @secure
|
|
317
313
|
*/
|
|
318
|
-
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<
|
|
314
|
+
updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<_$axios.AxiosResponse<Epic, any, {}>>;
|
|
319
315
|
/**
|
|
320
316
|
* @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
|
|
321
317
|
*
|
|
@@ -324,7 +320,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
324
320
|
* @request DELETE:/api/v3/epics/{epic-public-id}
|
|
325
321
|
* @secure
|
|
326
322
|
*/
|
|
327
|
-
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
323
|
+
deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
328
324
|
/**
|
|
329
325
|
* @description Get a list of all Comments on an Epic.
|
|
330
326
|
*
|
|
@@ -333,7 +329,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
333
329
|
* @request GET:/api/v3/epics/{epic-public-id}/comments
|
|
334
330
|
* @secure
|
|
335
331
|
*/
|
|
336
|
-
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
332
|
+
listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<ThreadedComment[], any, {}>>;
|
|
337
333
|
/**
|
|
338
334
|
* @description This endpoint allows you to create a threaded Comment on an Epic.
|
|
339
335
|
*
|
|
@@ -342,7 +338,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
342
338
|
* @request POST:/api/v3/epics/{epic-public-id}/comments
|
|
343
339
|
* @secure
|
|
344
340
|
*/
|
|
345
|
-
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<
|
|
341
|
+
createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<_$axios.AxiosResponse<ThreadedComment, any, {}>>;
|
|
346
342
|
/**
|
|
347
343
|
* @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
|
|
348
344
|
*
|
|
@@ -351,7 +347,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
351
347
|
* @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
352
348
|
* @secure
|
|
353
349
|
*/
|
|
354
|
-
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<
|
|
350
|
+
createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<_$axios.AxiosResponse<ThreadedComment, any, {}>>;
|
|
355
351
|
/**
|
|
356
352
|
* @description This endpoint returns information about the selected Epic Comment.
|
|
357
353
|
*
|
|
@@ -360,7 +356,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
360
356
|
* @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
361
357
|
* @secure
|
|
362
358
|
*/
|
|
363
|
-
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
359
|
+
getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<ThreadedComment, any, {}>>;
|
|
364
360
|
/**
|
|
365
361
|
* @description This endpoint allows you to update a threaded Comment on an Epic.
|
|
366
362
|
*
|
|
@@ -369,7 +365,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
369
365
|
* @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
370
366
|
* @secure
|
|
371
367
|
*/
|
|
372
|
-
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<
|
|
368
|
+
updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<_$axios.AxiosResponse<ThreadedComment, any, {}>>;
|
|
373
369
|
/**
|
|
374
370
|
* @description This endpoint allows you to delete a Comment from an Epic.
|
|
375
371
|
*
|
|
@@ -378,7 +374,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
378
374
|
* @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
379
375
|
* @secure
|
|
380
376
|
*/
|
|
381
|
-
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
377
|
+
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
382
378
|
/**
|
|
383
379
|
* @description Get a list of all Documents related to this Epic.
|
|
384
380
|
*
|
|
@@ -387,7 +383,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
387
383
|
* @request GET:/api/v3/epics/{epic-public-id}/documents
|
|
388
384
|
* @secure
|
|
389
385
|
*/
|
|
390
|
-
listEpicDocuments: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
386
|
+
listEpicDocuments: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<DocSlim[], any, {}>>;
|
|
391
387
|
/**
|
|
392
388
|
* @description Get the current health for the specified Epic.
|
|
393
389
|
*
|
|
@@ -396,7 +392,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
396
392
|
* @request GET:/api/v3/epics/{epic-public-id}/health
|
|
397
393
|
* @secure
|
|
398
394
|
*/
|
|
399
|
-
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
395
|
+
getEpicHealth: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Health, any, {}>>;
|
|
400
396
|
/**
|
|
401
397
|
* @description Create a new health status for the specified Epic.
|
|
402
398
|
*
|
|
@@ -405,7 +401,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
405
401
|
* @request POST:/api/v3/epics/{epic-public-id}/health
|
|
406
402
|
* @secure
|
|
407
403
|
*/
|
|
408
|
-
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<
|
|
404
|
+
createEpicHealth: (epicPublicId: number, CreateEpicHealth: CreateEpicHealth, params?: RequestParams) => Promise<_$axios.AxiosResponse<Health, any, {}>>;
|
|
409
405
|
/**
|
|
410
406
|
* @description List the history of health statuses for the specified Epic, most recent first.
|
|
411
407
|
*
|
|
@@ -414,7 +410,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
414
410
|
* @request GET:/api/v3/epics/{epic-public-id}/health-history
|
|
415
411
|
* @secure
|
|
416
412
|
*/
|
|
417
|
-
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
413
|
+
listEpicHealths: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Health[], any, {}>>;
|
|
418
414
|
/**
|
|
419
415
|
* @description Get a list of all Stories in an Epic.
|
|
420
416
|
*
|
|
@@ -424,9 +420,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
424
420
|
* @secure
|
|
425
421
|
*/
|
|
426
422
|
listEpicStories: (epicPublicId: number, query?: {
|
|
427
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
428
|
-
|
|
429
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
423
|
+
/** A true/false boolean indicating whether to return Stories with their descriptions. */includes_description?: boolean;
|
|
424
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
430
425
|
/**
|
|
431
426
|
* @description This endpoint allows you to unlink a productboard epic.
|
|
432
427
|
*
|
|
@@ -435,7 +430,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
435
430
|
* @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
|
|
436
431
|
* @secure
|
|
437
432
|
*/
|
|
438
|
-
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<
|
|
433
|
+
unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
439
434
|
/**
|
|
440
435
|
* @description Get Stories which have a given External Link associated with them.
|
|
441
436
|
*
|
|
@@ -451,7 +446,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
451
446
|
* @pattern ^https?://.+$
|
|
452
447
|
*/
|
|
453
448
|
external_link: string;
|
|
454
|
-
}, params?: RequestParams) => Promise<
|
|
449
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
455
450
|
/**
|
|
456
451
|
* @description List Files returns a list of all UploadedFiles in the workspace.
|
|
457
452
|
*
|
|
@@ -460,7 +455,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
460
455
|
* @request GET:/api/v3/files
|
|
461
456
|
* @secure
|
|
462
457
|
*/
|
|
463
|
-
listFiles: (params?: RequestParams) => Promise<
|
|
458
|
+
listFiles: (params?: RequestParams) => Promise<_$axios.AxiosResponse<UploadedFile[], any, {}>>;
|
|
464
459
|
/**
|
|
465
460
|
* @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.
|
|
466
461
|
*
|
|
@@ -495,7 +490,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
495
490
|
* @format binary
|
|
496
491
|
*/
|
|
497
492
|
file3?: File;
|
|
498
|
-
}, params?: RequestParams) => Promise<
|
|
493
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<UploadedFile[], any, {}>>;
|
|
499
494
|
/**
|
|
500
495
|
* @description Get File returns information about the selected UploadedFile.
|
|
501
496
|
*
|
|
@@ -504,7 +499,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
504
499
|
* @request GET:/api/v3/files/{file-public-id}
|
|
505
500
|
* @secure
|
|
506
501
|
*/
|
|
507
|
-
getFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
502
|
+
getFile: (filePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<UploadedFile, any, {}>>;
|
|
508
503
|
/**
|
|
509
504
|
* @description Update File updates the properties of an UploadedFile (but not its content).
|
|
510
505
|
*
|
|
@@ -513,7 +508,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
513
508
|
* @request PUT:/api/v3/files/{file-public-id}
|
|
514
509
|
* @secure
|
|
515
510
|
*/
|
|
516
|
-
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<
|
|
511
|
+
updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<_$axios.AxiosResponse<UploadedFile, any, {}>>;
|
|
517
512
|
/**
|
|
518
513
|
* @description Delete File deletes a previously uploaded file.
|
|
519
514
|
*
|
|
@@ -522,7 +517,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
522
517
|
* @request DELETE:/api/v3/files/{file-public-id}
|
|
523
518
|
* @secure
|
|
524
519
|
*/
|
|
525
|
-
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<
|
|
520
|
+
deleteFile: (filePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
526
521
|
/**
|
|
527
522
|
* @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.
|
|
528
523
|
*
|
|
@@ -532,9 +527,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
532
527
|
* @secure
|
|
533
528
|
*/
|
|
534
529
|
listGroups: (query?: {
|
|
535
|
-
/** Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups */
|
|
536
|
-
|
|
537
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Group[], any, {}>>;
|
|
530
|
+
/** Filter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups */archived?: boolean;
|
|
531
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<Group[], any, {}>>;
|
|
538
532
|
/**
|
|
539
533
|
* No description
|
|
540
534
|
*
|
|
@@ -543,7 +537,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
543
537
|
* @request POST:/api/v3/groups
|
|
544
538
|
* @secure
|
|
545
539
|
*/
|
|
546
|
-
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<
|
|
540
|
+
createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<_$axios.AxiosResponse<Group, any, {}>>;
|
|
547
541
|
/**
|
|
548
542
|
* No description
|
|
549
543
|
*
|
|
@@ -552,7 +546,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
552
546
|
* @request GET:/api/v3/groups/{group-public-id}
|
|
553
547
|
* @secure
|
|
554
548
|
*/
|
|
555
|
-
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<
|
|
549
|
+
getGroup: (groupPublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<Group, any, {}>>;
|
|
556
550
|
/**
|
|
557
551
|
* No description
|
|
558
552
|
*
|
|
@@ -561,7 +555,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
561
555
|
* @request PUT:/api/v3/groups/{group-public-id}
|
|
562
556
|
* @secure
|
|
563
557
|
*/
|
|
564
|
-
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<
|
|
558
|
+
updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<_$axios.AxiosResponse<Group, any, {}>>;
|
|
565
559
|
/**
|
|
566
560
|
* @description List the Stories assigned to the Group. (By default, limited to 1,000).
|
|
567
561
|
*
|
|
@@ -581,7 +575,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
581
575
|
* @format int64
|
|
582
576
|
*/
|
|
583
577
|
offset?: number;
|
|
584
|
-
}, params?: RequestParams) => Promise<
|
|
578
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
585
579
|
/**
|
|
586
580
|
* @description Update an existing health status by its ID.
|
|
587
581
|
*
|
|
@@ -590,7 +584,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
590
584
|
* @request PUT:/api/v3/health/{health-public-id}
|
|
591
585
|
* @secure
|
|
592
586
|
*/
|
|
593
|
-
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<
|
|
587
|
+
updateHealth: (healthPublicId: string, UpdateHealth: UpdateHealth, params?: RequestParams) => Promise<_$axios.AxiosResponse<Health, any, {}>>;
|
|
594
588
|
/**
|
|
595
589
|
* No description
|
|
596
590
|
*
|
|
@@ -599,7 +593,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
599
593
|
* @request POST:/api/v3/integrations/webhook
|
|
600
594
|
* @secure
|
|
601
595
|
*/
|
|
602
|
-
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<
|
|
596
|
+
createGenericIntegration: (CreateGenericIntegration: CreateGenericIntegration, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
603
597
|
/**
|
|
604
598
|
* No description
|
|
605
599
|
*
|
|
@@ -608,7 +602,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
608
602
|
* @request GET:/api/v3/integrations/webhook/{integration-public-id}
|
|
609
603
|
* @secure
|
|
610
604
|
*/
|
|
611
|
-
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
605
|
+
getGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
612
606
|
/**
|
|
613
607
|
* No description
|
|
614
608
|
*
|
|
@@ -617,7 +611,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
617
611
|
* @request DELETE:/api/v3/integrations/webhook/{integration-public-id}
|
|
618
612
|
* @secure
|
|
619
613
|
*/
|
|
620
|
-
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<
|
|
614
|
+
deleteGenericIntegration: (integrationPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
621
615
|
/**
|
|
622
616
|
* No description
|
|
623
617
|
*
|
|
@@ -626,7 +620,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
626
620
|
* @request GET:/api/v3/iterations
|
|
627
621
|
* @secure
|
|
628
622
|
*/
|
|
629
|
-
listIterations: (params?: RequestParams) => Promise<
|
|
623
|
+
listIterations: (params?: RequestParams) => Promise<_$axios.AxiosResponse<IterationSlim[], any, {}>>;
|
|
630
624
|
/**
|
|
631
625
|
* No description
|
|
632
626
|
*
|
|
@@ -635,7 +629,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
635
629
|
* @request POST:/api/v3/iterations
|
|
636
630
|
* @secure
|
|
637
631
|
*/
|
|
638
|
-
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<
|
|
632
|
+
createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<_$axios.AxiosResponse<Iteration, any, {}>>;
|
|
639
633
|
/**
|
|
640
634
|
* @description Disables Iterations for the current workspace
|
|
641
635
|
*
|
|
@@ -644,7 +638,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
644
638
|
* @request PUT:/api/v3/iterations/disable
|
|
645
639
|
* @secure
|
|
646
640
|
*/
|
|
647
|
-
disableIterations: (params?: RequestParams) => Promise<
|
|
641
|
+
disableIterations: (params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
648
642
|
/**
|
|
649
643
|
* @description Enables Iterations for the current workspace
|
|
650
644
|
*
|
|
@@ -653,7 +647,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
653
647
|
* @request PUT:/api/v3/iterations/enable
|
|
654
648
|
* @secure
|
|
655
649
|
*/
|
|
656
|
-
enableIterations: (params?: RequestParams) => Promise<
|
|
650
|
+
enableIterations: (params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
657
651
|
/**
|
|
658
652
|
* No description
|
|
659
653
|
*
|
|
@@ -662,7 +656,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
662
656
|
* @request GET:/api/v3/iterations/{iteration-public-id}
|
|
663
657
|
* @secure
|
|
664
658
|
*/
|
|
665
|
-
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
659
|
+
getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Iteration, any, {}>>;
|
|
666
660
|
/**
|
|
667
661
|
* No description
|
|
668
662
|
*
|
|
@@ -671,7 +665,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
671
665
|
* @request PUT:/api/v3/iterations/{iteration-public-id}
|
|
672
666
|
* @secure
|
|
673
667
|
*/
|
|
674
|
-
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<
|
|
668
|
+
updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<_$axios.AxiosResponse<Iteration, any, {}>>;
|
|
675
669
|
/**
|
|
676
670
|
* No description
|
|
677
671
|
*
|
|
@@ -680,7 +674,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
680
674
|
* @request DELETE:/api/v3/iterations/{iteration-public-id}
|
|
681
675
|
* @secure
|
|
682
676
|
*/
|
|
683
|
-
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<
|
|
677
|
+
deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
684
678
|
/**
|
|
685
679
|
* @description Get a list of all Stories in an Iteration.
|
|
686
680
|
*
|
|
@@ -690,9 +684,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
690
684
|
* @secure
|
|
691
685
|
*/
|
|
692
686
|
listIterationStories: (iterationPublicId: number, query?: {
|
|
693
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
694
|
-
|
|
695
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
687
|
+
/** A true/false boolean indicating whether to return Stories with their descriptions. */includes_description?: boolean;
|
|
688
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
696
689
|
/**
|
|
697
690
|
* @description Get Key Result returns information about a chosen Key Result.
|
|
698
691
|
*
|
|
@@ -701,7 +694,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
701
694
|
* @request GET:/api/v3/key-results/{key-result-public-id}
|
|
702
695
|
* @secure
|
|
703
696
|
*/
|
|
704
|
-
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<
|
|
697
|
+
getKeyResult: (keyResultPublicId: string, params?: RequestParams) => Promise<_$axios.AxiosResponse<KeyResult, any, {}>>;
|
|
705
698
|
/**
|
|
706
699
|
* @description Update Key Result allows updating a Key Result's name or initial, observed, or target values.
|
|
707
700
|
*
|
|
@@ -710,7 +703,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
710
703
|
* @request PUT:/api/v3/key-results/{key-result-public-id}
|
|
711
704
|
* @secure
|
|
712
705
|
*/
|
|
713
|
-
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<
|
|
706
|
+
updateKeyResult: (keyResultPublicId: string, UpdateKeyResult: UpdateKeyResult, params?: RequestParams) => Promise<_$axios.AxiosResponse<KeyResult, any, {}>>;
|
|
714
707
|
/**
|
|
715
708
|
* @description List Labels returns a list of all Labels and their attributes.
|
|
716
709
|
*
|
|
@@ -720,9 +713,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
720
713
|
* @secure
|
|
721
714
|
*/
|
|
722
715
|
listLabels: (query?: {
|
|
723
|
-
/** A true/false boolean indicating if the slim versions of the Label should be returned. */
|
|
724
|
-
|
|
725
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Label[], any, {}>>;
|
|
716
|
+
/** A true/false boolean indicating if the slim versions of the Label should be returned. */slim?: boolean;
|
|
717
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<Label[], any, {}>>;
|
|
726
718
|
/**
|
|
727
719
|
* @description Create Label allows you to create a new Label in Shortcut.
|
|
728
720
|
*
|
|
@@ -731,7 +723,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
731
723
|
* @request POST:/api/v3/labels
|
|
732
724
|
* @secure
|
|
733
725
|
*/
|
|
734
|
-
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<
|
|
726
|
+
createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<_$axios.AxiosResponse<Label, any, {}>>;
|
|
735
727
|
/**
|
|
736
728
|
* @description Get Label returns information about the selected Label.
|
|
737
729
|
*
|
|
@@ -740,7 +732,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
740
732
|
* @request GET:/api/v3/labels/{label-public-id}
|
|
741
733
|
* @secure
|
|
742
734
|
*/
|
|
743
|
-
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
735
|
+
getLabel: (labelPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Label, any, {}>>;
|
|
744
736
|
/**
|
|
745
737
|
* @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.
|
|
746
738
|
*
|
|
@@ -749,7 +741,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
749
741
|
* @request PUT:/api/v3/labels/{label-public-id}
|
|
750
742
|
* @secure
|
|
751
743
|
*/
|
|
752
|
-
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<
|
|
744
|
+
updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<_$axios.AxiosResponse<Label, any, {}>>;
|
|
753
745
|
/**
|
|
754
746
|
* @description Delete Label can be used to delete any Label.
|
|
755
747
|
*
|
|
@@ -758,7 +750,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
758
750
|
* @request DELETE:/api/v3/labels/{label-public-id}
|
|
759
751
|
* @secure
|
|
760
752
|
*/
|
|
761
|
-
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
753
|
+
deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
762
754
|
/**
|
|
763
755
|
* @description List all of the Epics with the Label.
|
|
764
756
|
*
|
|
@@ -767,7 +759,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
767
759
|
* @request GET:/api/v3/labels/{label-public-id}/epics
|
|
768
760
|
* @secure
|
|
769
761
|
*/
|
|
770
|
-
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<
|
|
762
|
+
listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSlim[], any, {}>>;
|
|
771
763
|
/**
|
|
772
764
|
* @description List all of the Stories with the Label.
|
|
773
765
|
*
|
|
@@ -777,9 +769,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
777
769
|
* @secure
|
|
778
770
|
*/
|
|
779
771
|
listLabelStories: (labelPublicId: number, query?: {
|
|
780
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
781
|
-
|
|
782
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
772
|
+
/** A true/false boolean indicating whether to return Stories with their descriptions. */includes_description?: boolean;
|
|
773
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
783
774
|
/**
|
|
784
775
|
* @description List Linked Files returns a list of all Linked-Files and their attributes.
|
|
785
776
|
*
|
|
@@ -788,7 +779,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
788
779
|
* @request GET:/api/v3/linked-files
|
|
789
780
|
* @secure
|
|
790
781
|
*/
|
|
791
|
-
listLinkedFiles: (params?: RequestParams) => Promise<
|
|
782
|
+
listLinkedFiles: (params?: RequestParams) => Promise<_$axios.AxiosResponse<LinkedFile[], any, {}>>;
|
|
792
783
|
/**
|
|
793
784
|
* @description Create Linked File allows you to create a new Linked File in Shortcut.
|
|
794
785
|
*
|
|
@@ -797,7 +788,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
797
788
|
* @request POST:/api/v3/linked-files
|
|
798
789
|
* @secure
|
|
799
790
|
*/
|
|
800
|
-
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<
|
|
791
|
+
createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<_$axios.AxiosResponse<LinkedFile, any, {}>>;
|
|
801
792
|
/**
|
|
802
793
|
* @description Get File returns information about the selected Linked File.
|
|
803
794
|
*
|
|
@@ -806,7 +797,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
806
797
|
* @request GET:/api/v3/linked-files/{linked-file-public-id}
|
|
807
798
|
* @secure
|
|
808
799
|
*/
|
|
809
|
-
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
800
|
+
getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<LinkedFile, any, {}>>;
|
|
810
801
|
/**
|
|
811
802
|
* @description Updated Linked File allows you to update properties of a previously attached Linked-File.
|
|
812
803
|
*
|
|
@@ -815,7 +806,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
815
806
|
* @request PUT:/api/v3/linked-files/{linked-file-public-id}
|
|
816
807
|
* @secure
|
|
817
808
|
*/
|
|
818
|
-
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<
|
|
809
|
+
updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<_$axios.AxiosResponse<LinkedFile, any, {}>>;
|
|
819
810
|
/**
|
|
820
811
|
* @description Delete Linked File can be used to delete any previously attached Linked-File.
|
|
821
812
|
*
|
|
@@ -824,7 +815,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
824
815
|
* @request DELETE:/api/v3/linked-files/{linked-file-public-id}
|
|
825
816
|
* @secure
|
|
826
817
|
*/
|
|
827
|
-
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<
|
|
818
|
+
deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
828
819
|
/**
|
|
829
820
|
* @description Returns information about the authenticated member.
|
|
830
821
|
*
|
|
@@ -833,7 +824,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
833
824
|
* @request GET:/api/v3/member
|
|
834
825
|
* @secure
|
|
835
826
|
*/
|
|
836
|
-
getCurrentMemberInfo: (params?: RequestParams) => Promise<
|
|
827
|
+
getCurrentMemberInfo: (params?: RequestParams) => Promise<_$axios.AxiosResponse<MemberInfo, any, {}>>;
|
|
837
828
|
/**
|
|
838
829
|
* @description Returns information about members of the Workspace.
|
|
839
830
|
*
|
|
@@ -847,10 +838,9 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
847
838
|
* The unique ID of the Organization to limit the list to.
|
|
848
839
|
* @format uuid
|
|
849
840
|
*/
|
|
850
|
-
"org-public-id"?: string;
|
|
851
|
-
/** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
|
|
841
|
+
"org-public-id"?: string; /** Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. */
|
|
852
842
|
disabled?: boolean;
|
|
853
|
-
}, params?: RequestParams) => Promise<
|
|
843
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<Member[], any, {}>>;
|
|
854
844
|
/**
|
|
855
845
|
* @description Returns information about a Member.
|
|
856
846
|
*
|
|
@@ -865,7 +855,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
865
855
|
* @format uuid
|
|
866
856
|
*/
|
|
867
857
|
"org-public-id"?: string;
|
|
868
|
-
}, params?: RequestParams) => Promise<
|
|
858
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<Member, any, {}>>;
|
|
869
859
|
/**
|
|
870
860
|
* @description (Deprecated: Use 'List Objectives') List Milestones returns a list of all Milestones and their attributes.
|
|
871
861
|
*
|
|
@@ -874,7 +864,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
874
864
|
* @request GET:/api/v3/milestones
|
|
875
865
|
* @secure
|
|
876
866
|
*/
|
|
877
|
-
listMilestones: (params?: RequestParams) => Promise<
|
|
867
|
+
listMilestones: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone[], any, {}>>;
|
|
878
868
|
/**
|
|
879
869
|
* @description (Deprecated: Use 'Create Objective') Create Milestone allows you to create a new Milestone in Shortcut.
|
|
880
870
|
*
|
|
@@ -883,7 +873,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
883
873
|
* @request POST:/api/v3/milestones
|
|
884
874
|
* @secure
|
|
885
875
|
*/
|
|
886
|
-
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<
|
|
876
|
+
createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone, any, {}>>;
|
|
887
877
|
/**
|
|
888
878
|
* @description (Deprecated: Use 'Get Objective') Get Milestone returns information about a chosen Milestone.
|
|
889
879
|
*
|
|
@@ -892,7 +882,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
892
882
|
* @request GET:/api/v3/milestones/{milestone-public-id}
|
|
893
883
|
* @secure
|
|
894
884
|
*/
|
|
895
|
-
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
885
|
+
getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone, any, {}>>;
|
|
896
886
|
/**
|
|
897
887
|
* @description (Deprecated: Use 'Update Objective') Update Milestone can be used to update Milestone properties.
|
|
898
888
|
*
|
|
@@ -901,7 +891,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
901
891
|
* @request PUT:/api/v3/milestones/{milestone-public-id}
|
|
902
892
|
* @secure
|
|
903
893
|
*/
|
|
904
|
-
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<
|
|
894
|
+
updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<_$axios.AxiosResponse<Milestone, any, {}>>;
|
|
905
895
|
/**
|
|
906
896
|
* @description (Deprecated: Use 'Delete Objective') Delete Milestone can be used to delete any Milestone.
|
|
907
897
|
*
|
|
@@ -910,7 +900,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
910
900
|
* @request DELETE:/api/v3/milestones/{milestone-public-id}
|
|
911
901
|
* @secure
|
|
912
902
|
*/
|
|
913
|
-
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
903
|
+
deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
914
904
|
/**
|
|
915
905
|
* @description (Deprecated: Use 'List Objective Epics') List all of the Epics within the Milestone.
|
|
916
906
|
*
|
|
@@ -919,7 +909,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
919
909
|
* @request GET:/api/v3/milestones/{milestone-public-id}/epics
|
|
920
910
|
* @secure
|
|
921
911
|
*/
|
|
922
|
-
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<
|
|
912
|
+
listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSlim[], any, {}>>;
|
|
923
913
|
/**
|
|
924
914
|
* @description List Objectives returns a list of all Objectives and their attributes.
|
|
925
915
|
*
|
|
@@ -928,7 +918,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
928
918
|
* @request GET:/api/v3/objectives
|
|
929
919
|
* @secure
|
|
930
920
|
*/
|
|
931
|
-
listObjectives: (params?: RequestParams) => Promise<
|
|
921
|
+
listObjectives: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Objective[], any, {}>>;
|
|
932
922
|
/**
|
|
933
923
|
* @description Create Objective allows you to create a new Objective in Shortcut.
|
|
934
924
|
*
|
|
@@ -937,7 +927,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
937
927
|
* @request POST:/api/v3/objectives
|
|
938
928
|
* @secure
|
|
939
929
|
*/
|
|
940
|
-
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<
|
|
930
|
+
createObjective: (CreateObjective: CreateObjective, params?: RequestParams) => Promise<_$axios.AxiosResponse<Objective, any, {}>>;
|
|
941
931
|
/**
|
|
942
932
|
* @description Get Objective returns information about a chosen Objective.
|
|
943
933
|
*
|
|
@@ -946,7 +936,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
946
936
|
* @request GET:/api/v3/objectives/{objective-public-id}
|
|
947
937
|
* @secure
|
|
948
938
|
*/
|
|
949
|
-
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
939
|
+
getObjective: (objectivePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Objective, any, {}>>;
|
|
950
940
|
/**
|
|
951
941
|
* @description Update Objective can be used to update Objective properties.
|
|
952
942
|
*
|
|
@@ -955,7 +945,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
955
945
|
* @request PUT:/api/v3/objectives/{objective-public-id}
|
|
956
946
|
* @secure
|
|
957
947
|
*/
|
|
958
|
-
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<
|
|
948
|
+
updateObjective: (objectivePublicId: number, UpdateObjective: UpdateObjective, params?: RequestParams) => Promise<_$axios.AxiosResponse<Objective, any, {}>>;
|
|
959
949
|
/**
|
|
960
950
|
* @description Delete Objective can be used to delete any Objective.
|
|
961
951
|
*
|
|
@@ -964,7 +954,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
964
954
|
* @request DELETE:/api/v3/objectives/{objective-public-id}
|
|
965
955
|
* @secure
|
|
966
956
|
*/
|
|
967
|
-
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
957
|
+
deleteObjective: (objectivePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
968
958
|
/**
|
|
969
959
|
* @description List all of the Epics within the Objective.
|
|
970
960
|
*
|
|
@@ -973,7 +963,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
973
963
|
* @request GET:/api/v3/objectives/{objective-public-id}/epics
|
|
974
964
|
* @secure
|
|
975
965
|
*/
|
|
976
|
-
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<
|
|
966
|
+
listObjectiveEpics: (objectivePublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSlim[], any, {}>>;
|
|
977
967
|
/**
|
|
978
968
|
* @description List Projects returns a list of all Projects and their attributes.
|
|
979
969
|
*
|
|
@@ -982,7 +972,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
982
972
|
* @request GET:/api/v3/projects
|
|
983
973
|
* @secure
|
|
984
974
|
*/
|
|
985
|
-
listProjects: (params?: RequestParams) => Promise<
|
|
975
|
+
listProjects: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Project[], any, {}>>;
|
|
986
976
|
/**
|
|
987
977
|
* @description Create Project is used to create a new Shortcut Project.
|
|
988
978
|
*
|
|
@@ -991,7 +981,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
991
981
|
* @request POST:/api/v3/projects
|
|
992
982
|
* @secure
|
|
993
983
|
*/
|
|
994
|
-
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<
|
|
984
|
+
createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<_$axios.AxiosResponse<Project, any, {}>>;
|
|
995
985
|
/**
|
|
996
986
|
* @description Get Project returns information about the selected Project.
|
|
997
987
|
*
|
|
@@ -1000,7 +990,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1000
990
|
* @request GET:/api/v3/projects/{project-public-id}
|
|
1001
991
|
* @secure
|
|
1002
992
|
*/
|
|
1003
|
-
getProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
993
|
+
getProject: (projectPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Project, any, {}>>;
|
|
1004
994
|
/**
|
|
1005
995
|
* @description Update Project can be used to change properties of a Project.
|
|
1006
996
|
*
|
|
@@ -1009,7 +999,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1009
999
|
* @request PUT:/api/v3/projects/{project-public-id}
|
|
1010
1000
|
* @secure
|
|
1011
1001
|
*/
|
|
1012
|
-
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<
|
|
1002
|
+
updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<_$axios.AxiosResponse<Project, any, {}>>;
|
|
1013
1003
|
/**
|
|
1014
1004
|
* @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.
|
|
1015
1005
|
*
|
|
@@ -1018,7 +1008,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1018
1008
|
* @request DELETE:/api/v3/projects/{project-public-id}
|
|
1019
1009
|
* @secure
|
|
1020
1010
|
*/
|
|
1021
|
-
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<
|
|
1011
|
+
deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1022
1012
|
/**
|
|
1023
1013
|
* @description List Stories returns a list of all Stories in a selected Project and their attributes.
|
|
1024
1014
|
*
|
|
@@ -1028,9 +1018,8 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1028
1018
|
* @secure
|
|
1029
1019
|
*/
|
|
1030
1020
|
listStories: (projectPublicId: number, query?: {
|
|
1031
|
-
/** A true/false boolean indicating whether to return Stories with their descriptions. */
|
|
1032
|
-
|
|
1033
|
-
}, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any, {}>>;
|
|
1021
|
+
/** A true/false boolean indicating whether to return Stories with their descriptions. */includes_description?: boolean;
|
|
1022
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
1034
1023
|
/**
|
|
1035
1024
|
* @description List Repositories returns a list of all Repositories and their attributes.
|
|
1036
1025
|
*
|
|
@@ -1039,7 +1028,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1039
1028
|
* @request GET:/api/v3/repositories
|
|
1040
1029
|
* @secure
|
|
1041
1030
|
*/
|
|
1042
|
-
listRepositories: (params?: RequestParams) => Promise<
|
|
1031
|
+
listRepositories: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Repository[], any, {}>>;
|
|
1043
1032
|
/**
|
|
1044
1033
|
* @description Get Repository returns information about the selected Repository.
|
|
1045
1034
|
*
|
|
@@ -1048,7 +1037,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1048
1037
|
* @request GET:/api/v3/repositories/{repo-public-id}
|
|
1049
1038
|
* @secure
|
|
1050
1039
|
*/
|
|
1051
|
-
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<
|
|
1040
|
+
getRepository: (repoPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Repository, any, {}>>;
|
|
1052
1041
|
/**
|
|
1053
1042
|
* @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.
|
|
1054
1043
|
*
|
|
@@ -1076,12 +1065,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1076
1065
|
* and only references related items by id.
|
|
1077
1066
|
* The default is "full".
|
|
1078
1067
|
*/
|
|
1079
|
-
detail?: "full" | "slim";
|
|
1080
|
-
/**
|
|
1081
|
-
next?: string;
|
|
1082
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1068
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1069
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1083
1070
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1084
|
-
}, params?: RequestParams) => Promise<
|
|
1071
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<SearchResults, any, {}>>;
|
|
1085
1072
|
/**
|
|
1086
1073
|
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1087
1074
|
*
|
|
@@ -1095,21 +1082,17 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1095
1082
|
* Search text to match against document titles. Supports fuzzy matching. Required.
|
|
1096
1083
|
* @minLength 1
|
|
1097
1084
|
*/
|
|
1098
|
-
title: string;
|
|
1099
|
-
/** When true, find
|
|
1100
|
-
|
|
1101
|
-
/** When true, find documents created by the current user. When false, find documents NOT created by current user. */
|
|
1102
|
-
created_by_me?: boolean;
|
|
1103
|
-
/** When true, find documents that the current user is following. When false, find documents NOT followed. */
|
|
1085
|
+
title: string; /** When true, find archived documents. When false, find non-archived documents. */
|
|
1086
|
+
archived?: boolean; /** When true, find documents created by the current user. When false, find documents NOT created by current user. */
|
|
1087
|
+
created_by_me?: boolean; /** When true, find documents that the current user is following. When false, find documents NOT followed. */
|
|
1104
1088
|
followed_by_me?: boolean;
|
|
1105
1089
|
/**
|
|
1106
1090
|
* The number of search results to include in a page. Minimum of 1 and maximum of 250.
|
|
1107
1091
|
* @format int64
|
|
1108
1092
|
*/
|
|
1109
|
-
page_size?: number;
|
|
1110
|
-
/** The next page token. */
|
|
1093
|
+
page_size?: number; /** The next page token. */
|
|
1111
1094
|
next?: string;
|
|
1112
|
-
}, params?: RequestParams) => Promise<
|
|
1095
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<DocSearchResults, any, {}>>;
|
|
1113
1096
|
/**
|
|
1114
1097
|
* @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.
|
|
1115
1098
|
*
|
|
@@ -1137,12 +1120,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1137
1120
|
* and only references related items by id.
|
|
1138
1121
|
* The default is "full".
|
|
1139
1122
|
*/
|
|
1140
|
-
detail?: "full" | "slim";
|
|
1141
|
-
/**
|
|
1142
|
-
next?: string;
|
|
1143
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1123
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1124
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1144
1125
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1145
|
-
}, params?: RequestParams) => Promise<
|
|
1126
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<EpicSearchResults, any, {}>>;
|
|
1146
1127
|
/**
|
|
1147
1128
|
* @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.
|
|
1148
1129
|
*
|
|
@@ -1170,12 +1151,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1170
1151
|
* and only references related items by id.
|
|
1171
1152
|
* The default is "full".
|
|
1172
1153
|
*/
|
|
1173
|
-
detail?: "full" | "slim";
|
|
1174
|
-
/**
|
|
1175
|
-
next?: string;
|
|
1176
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1154
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1155
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1177
1156
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1178
|
-
}, params?: RequestParams) => Promise<
|
|
1157
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<IterationSearchResults, any, {}>>;
|
|
1179
1158
|
/**
|
|
1180
1159
|
* @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.
|
|
1181
1160
|
*
|
|
@@ -1203,12 +1182,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1203
1182
|
* and only references related items by id.
|
|
1204
1183
|
* The default is "full".
|
|
1205
1184
|
*/
|
|
1206
|
-
detail?: "full" | "slim";
|
|
1207
|
-
/**
|
|
1208
|
-
next?: string;
|
|
1209
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1185
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1186
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1210
1187
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1211
|
-
}, params?: RequestParams) => Promise<
|
|
1188
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1212
1189
|
/**
|
|
1213
1190
|
* @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.
|
|
1214
1191
|
*
|
|
@@ -1236,12 +1213,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1236
1213
|
* and only references related items by id.
|
|
1237
1214
|
* The default is "full".
|
|
1238
1215
|
*/
|
|
1239
|
-
detail?: "full" | "slim";
|
|
1240
|
-
/**
|
|
1241
|
-
next?: string;
|
|
1242
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1216
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1217
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1243
1218
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1244
|
-
}, params?: RequestParams) => Promise<
|
|
1219
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<ObjectiveSearchResults, any, {}>>;
|
|
1245
1220
|
/**
|
|
1246
1221
|
* @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.
|
|
1247
1222
|
*
|
|
@@ -1269,12 +1244,10 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1269
1244
|
* and only references related items by id.
|
|
1270
1245
|
* The default is "full".
|
|
1271
1246
|
*/
|
|
1272
|
-
detail?: "full" | "slim";
|
|
1273
|
-
/**
|
|
1274
|
-
next?: string;
|
|
1275
|
-
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1247
|
+
detail?: "full" | "slim"; /** The next page token. */
|
|
1248
|
+
next?: string; /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1276
1249
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1277
|
-
}, params?: RequestParams) => Promise<
|
|
1250
|
+
}, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySearchResults, any, {}>>;
|
|
1278
1251
|
/**
|
|
1279
1252
|
* @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.
|
|
1280
1253
|
*
|
|
@@ -1283,7 +1256,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1283
1256
|
* @request POST:/api/v3/stories
|
|
1284
1257
|
* @secure
|
|
1285
1258
|
*/
|
|
1286
|
-
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<
|
|
1259
|
+
createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<_$axios.AxiosResponse<Story, any, {}>>;
|
|
1287
1260
|
/**
|
|
1288
1261
|
* @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).
|
|
1289
1262
|
*
|
|
@@ -1292,7 +1265,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1292
1265
|
* @request POST:/api/v3/stories/bulk
|
|
1293
1266
|
* @secure
|
|
1294
1267
|
*/
|
|
1295
|
-
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<
|
|
1268
|
+
createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
1296
1269
|
/**
|
|
1297
1270
|
* @description Update Multiple Stories allows you to make changes to numerous stories at once.
|
|
1298
1271
|
*
|
|
@@ -1301,7 +1274,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1301
1274
|
* @request PUT:/api/v3/stories/bulk
|
|
1302
1275
|
* @secure
|
|
1303
1276
|
*/
|
|
1304
|
-
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<
|
|
1277
|
+
updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
1305
1278
|
/**
|
|
1306
1279
|
* @description Delete Multiple Stories allows you to delete multiple archived stories at once.
|
|
1307
1280
|
*
|
|
@@ -1310,7 +1283,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1310
1283
|
* @request DELETE:/api/v3/stories/bulk
|
|
1311
1284
|
* @secure
|
|
1312
1285
|
*/
|
|
1313
|
-
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<
|
|
1286
|
+
deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1314
1287
|
/**
|
|
1315
1288
|
* @description Create Story From Template is used to add a new story derived from a template to your Shortcut Workspace.
|
|
1316
1289
|
*
|
|
@@ -1319,7 +1292,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1319
1292
|
* @request POST:/api/v3/stories/from-template
|
|
1320
1293
|
* @secure
|
|
1321
1294
|
*/
|
|
1322
|
-
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<
|
|
1295
|
+
createStoryFromTemplate: (CreateStoryFromTemplateParams: CreateStoryFromTemplateParams, params?: RequestParams) => Promise<_$axios.AxiosResponse<Story, any, {}>>;
|
|
1323
1296
|
/**
|
|
1324
1297
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1325
1298
|
*
|
|
@@ -1328,7 +1301,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1328
1301
|
* @request POST:/api/v3/stories/search
|
|
1329
1302
|
* @secure
|
|
1330
1303
|
*/
|
|
1331
|
-
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<
|
|
1304
|
+
queryStories: (SearchStories: SearchStories, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
1332
1305
|
/**
|
|
1333
1306
|
* @description Get Story returns information about a chosen Story.
|
|
1334
1307
|
*
|
|
@@ -1337,7 +1310,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1337
1310
|
* @request GET:/api/v3/stories/{story-public-id}
|
|
1338
1311
|
* @secure
|
|
1339
1312
|
*/
|
|
1340
|
-
getStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1313
|
+
getStory: (storyPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Story, any, {}>>;
|
|
1341
1314
|
/**
|
|
1342
1315
|
* @description Update Story can be used to update Story properties.
|
|
1343
1316
|
*
|
|
@@ -1346,7 +1319,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1346
1319
|
* @request PUT:/api/v3/stories/{story-public-id}
|
|
1347
1320
|
* @secure
|
|
1348
1321
|
*/
|
|
1349
|
-
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<
|
|
1322
|
+
updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<_$axios.AxiosResponse<Story, any, {}>>;
|
|
1350
1323
|
/**
|
|
1351
1324
|
* @description Delete Story can be used to delete any Story.
|
|
1352
1325
|
*
|
|
@@ -1355,7 +1328,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1355
1328
|
* @request DELETE:/api/v3/stories/{story-public-id}
|
|
1356
1329
|
* @secure
|
|
1357
1330
|
*/
|
|
1358
|
-
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1331
|
+
deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1359
1332
|
/**
|
|
1360
1333
|
* @description Lists Comments associated with a Story
|
|
1361
1334
|
*
|
|
@@ -1364,7 +1337,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1364
1337
|
* @request GET:/api/v3/stories/{story-public-id}/comments
|
|
1365
1338
|
* @secure
|
|
1366
1339
|
*/
|
|
1367
|
-
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1340
|
+
listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryComment[], any, {}>>;
|
|
1368
1341
|
/**
|
|
1369
1342
|
* @description Create Comment allows you to create a Comment on any Story.
|
|
1370
1343
|
*
|
|
@@ -1373,7 +1346,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1373
1346
|
* @request POST:/api/v3/stories/{story-public-id}/comments
|
|
1374
1347
|
* @secure
|
|
1375
1348
|
*/
|
|
1376
|
-
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<
|
|
1349
|
+
createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryComment, any, {}>>;
|
|
1377
1350
|
/**
|
|
1378
1351
|
* @description Get Comment is used to get Comment information.
|
|
1379
1352
|
*
|
|
@@ -1382,7 +1355,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1382
1355
|
* @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1383
1356
|
* @secure
|
|
1384
1357
|
*/
|
|
1385
|
-
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1358
|
+
getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryComment, any, {}>>;
|
|
1386
1359
|
/**
|
|
1387
1360
|
* @description Update Comment replaces the text of the existing Comment.
|
|
1388
1361
|
*
|
|
@@ -1391,7 +1364,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1391
1364
|
* @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1392
1365
|
* @secure
|
|
1393
1366
|
*/
|
|
1394
|
-
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<
|
|
1367
|
+
updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryComment, any, {}>>;
|
|
1395
1368
|
/**
|
|
1396
1369
|
* @description Delete a Comment from any story.
|
|
1397
1370
|
*
|
|
@@ -1400,7 +1373,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1400
1373
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1401
1374
|
* @secure
|
|
1402
1375
|
*/
|
|
1403
|
-
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1376
|
+
deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1404
1377
|
/**
|
|
1405
1378
|
* @description Create a reaction to a story comment.
|
|
1406
1379
|
*
|
|
@@ -1409,7 +1382,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1409
1382
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1410
1383
|
* @secure
|
|
1411
1384
|
*/
|
|
1412
|
-
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1385
|
+
createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryReaction[], any, {}>>;
|
|
1413
1386
|
/**
|
|
1414
1387
|
* @description Delete a reaction from any story comment.
|
|
1415
1388
|
*
|
|
@@ -1418,7 +1391,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1418
1391
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1419
1392
|
* @secure
|
|
1420
1393
|
*/
|
|
1421
|
-
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<
|
|
1394
|
+
deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1422
1395
|
/**
|
|
1423
1396
|
* @description Unlinks a Comment from its linked Slack thread (Comment replies and Slack replies will no longer be synced)
|
|
1424
1397
|
*
|
|
@@ -1427,7 +1400,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1427
1400
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
|
|
1428
1401
|
* @secure
|
|
1429
1402
|
*/
|
|
1430
|
-
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<
|
|
1403
|
+
unlinkCommentThreadFromSlack: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryComment, any, {}>>;
|
|
1431
1404
|
/**
|
|
1432
1405
|
* No description
|
|
1433
1406
|
*
|
|
@@ -1436,7 +1409,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1436
1409
|
* @request GET:/api/v3/stories/{story-public-id}/history
|
|
1437
1410
|
* @secure
|
|
1438
1411
|
*/
|
|
1439
|
-
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1412
|
+
storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<History[], any, {}>>;
|
|
1440
1413
|
/**
|
|
1441
1414
|
* @description List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
|
|
1442
1415
|
*
|
|
@@ -1445,7 +1418,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1445
1418
|
* @request GET:/api/v3/stories/{story-public-id}/sub-tasks
|
|
1446
1419
|
* @secure
|
|
1447
1420
|
*/
|
|
1448
|
-
listStorySubTasks: (storyPublicId: number, params?: RequestParams) => Promise<
|
|
1421
|
+
listStorySubTasks: (storyPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<StorySlim[], any, {}>>;
|
|
1449
1422
|
/**
|
|
1450
1423
|
* @description Create Task is used to create a new task in a Story.
|
|
1451
1424
|
*
|
|
@@ -1454,7 +1427,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1454
1427
|
* @request POST:/api/v3/stories/{story-public-id}/tasks
|
|
1455
1428
|
* @secure
|
|
1456
1429
|
*/
|
|
1457
|
-
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<
|
|
1430
|
+
createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<_$axios.AxiosResponse<Task, any, {}>>;
|
|
1458
1431
|
/**
|
|
1459
1432
|
* @description Returns information about a chosen Task.
|
|
1460
1433
|
*
|
|
@@ -1463,7 +1436,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1463
1436
|
* @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1464
1437
|
* @secure
|
|
1465
1438
|
*/
|
|
1466
|
-
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1439
|
+
getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Task, any, {}>>;
|
|
1467
1440
|
/**
|
|
1468
1441
|
* @description Update Task can be used to update Task properties.
|
|
1469
1442
|
*
|
|
@@ -1472,7 +1445,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1472
1445
|
* @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1473
1446
|
* @secure
|
|
1474
1447
|
*/
|
|
1475
|
-
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<
|
|
1448
|
+
updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<_$axios.AxiosResponse<Task, any, {}>>;
|
|
1476
1449
|
/**
|
|
1477
1450
|
* @description Delete Task can be used to delete any previously created Task on a Story.
|
|
1478
1451
|
*
|
|
@@ -1481,7 +1454,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1481
1454
|
* @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1482
1455
|
* @secure
|
|
1483
1456
|
*/
|
|
1484
|
-
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<
|
|
1457
|
+
deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1485
1458
|
/**
|
|
1486
1459
|
* @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”
|
|
1487
1460
|
*
|
|
@@ -1490,7 +1463,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1490
1463
|
* @request POST:/api/v3/story-links
|
|
1491
1464
|
* @secure
|
|
1492
1465
|
*/
|
|
1493
|
-
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<
|
|
1466
|
+
createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryLink, any, {}>>;
|
|
1494
1467
|
/**
|
|
1495
1468
|
* @description Returns the stories and their relationship for the given Story Link.
|
|
1496
1469
|
*
|
|
@@ -1499,7 +1472,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1499
1472
|
* @request GET:/api/v3/story-links/{story-link-public-id}
|
|
1500
1473
|
* @secure
|
|
1501
1474
|
*/
|
|
1502
|
-
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1475
|
+
getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryLink, any, {}>>;
|
|
1503
1476
|
/**
|
|
1504
1477
|
* @description Updates the stories and/or the relationship for the given Story Link.
|
|
1505
1478
|
*
|
|
@@ -1508,7 +1481,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1508
1481
|
* @request PUT:/api/v3/story-links/{story-link-public-id}
|
|
1509
1482
|
* @secure
|
|
1510
1483
|
*/
|
|
1511
|
-
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<
|
|
1484
|
+
updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<_$axios.AxiosResponse<StoryLink, any, {}>>;
|
|
1512
1485
|
/**
|
|
1513
1486
|
* @description Removes the relationship between the stories for the given Story Link.
|
|
1514
1487
|
*
|
|
@@ -1517,7 +1490,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1517
1490
|
* @request DELETE:/api/v3/story-links/{story-link-public-id}
|
|
1518
1491
|
* @secure
|
|
1519
1492
|
*/
|
|
1520
|
-
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<
|
|
1493
|
+
deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
1521
1494
|
/**
|
|
1522
1495
|
* @description Returns a list of all Workflows in the Workspace.
|
|
1523
1496
|
*
|
|
@@ -1526,7 +1499,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1526
1499
|
* @request GET:/api/v3/workflows
|
|
1527
1500
|
* @secure
|
|
1528
1501
|
*/
|
|
1529
|
-
listWorkflows: (params?: RequestParams) => Promise<
|
|
1502
|
+
listWorkflows: (params?: RequestParams) => Promise<_$axios.AxiosResponse<Workflow[], any, {}>>;
|
|
1530
1503
|
/**
|
|
1531
1504
|
* @description Get Workflow returns information about a chosen Workflow.
|
|
1532
1505
|
*
|
|
@@ -1535,7 +1508,7 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1535
1508
|
* @request GET:/api/v3/workflows/{workflow-public-id}
|
|
1536
1509
|
* @secure
|
|
1537
1510
|
*/
|
|
1538
|
-
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<
|
|
1511
|
+
getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<_$axios.AxiosResponse<Workflow, any, {}>>;
|
|
1539
1512
|
}
|
|
1540
1513
|
//#endregion
|
|
1541
1514
|
export { Api };
|