@useshortcut/client 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +15 -13
  2. package/lib/ShortcutClient.js +5 -36
  3. package/lib/generated/Api.d.ts +201 -119
  4. package/lib/generated/Api.js +184 -466
  5. package/lib/generated/data-contracts.d.ts +1489 -609
  6. package/lib/generated/http-client.d.ts +14 -12
  7. package/lib/generated/http-client.js +50 -90
  8. package/lib/index.js +5 -1
  9. package/package.json +33 -31
  10. package/lib/ShortcutApi.d.ts +0 -5
  11. package/lib/ShortcutApi.js +0 -45
package/lib/generated/Api.d.ts CHANGED
@@ -1,10 +1,9 @@
1
- import { Category, CreateCategory, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryLink, CreateStoryParams, CreateTask, DeleteStories, EntityTemplate, Epic, EpicSearchResults, EpicSlim, EpicWorkflow, GetEpicStories, GetExternalLinkStoriesParams, GetIterationStories, GetLabelStories, GetMember, GetProjectStories, Group, History, Iteration, IterationSlim, Label, LinkedFile, ListEpics, ListGroupStories, ListLabels, ListMembers, Member, MemberInfo, Milestone, Project, Repository, Search, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateIteration, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts";
2
- import { HttpClient, RequestParams } from "./http-client";
1
+ import { Category, CreateCategory, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, EntityTemplate, Epic, EpicSearchResults, EpicSlim, EpicWorkflow, GetEpicStories, GetExternalLinkStoriesParams, GetIterationStories, GetLabelStories, GetMember, GetProjectStories, Group, History, Iteration, IterationSearchResults, IterationSlim, Label, LinkedFile, ListEpics, ListGroupStories, ListLabels, ListMembers, Member, MemberInfo, Milestone, MilestoneSearchResults, Project, Repository, Search, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateIteration, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from './data-contracts';
2
+ import { HttpClient, RequestParams } from './http-client';
3
3
  /**
4
- * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization.
5
- * @internal
6
- * @private
7
- */
4
+ * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
5
+ * @private
6
+ */
8
7
  export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
9
8
  /**
10
9
  * @description List Categories returns a list of all Categories and their attributes.
@@ -14,7 +13,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
14
13
  * @request GET:/api/v3/categories
15
14
  * @secure
16
15
  */
17
- listCategories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Category[]>>;
16
+ listCategories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Category[], any>>;
18
17
  /**
19
18
  * @description Create Category allows you to create a new Category in Shortcut.
20
19
  *
@@ -23,7 +22,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
23
22
  * @request POST:/api/v3/categories
24
23
  * @secure
25
24
  */
26
- createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category>>;
25
+ createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
27
26
  /**
28
27
  * @description Get Category returns information about the selected Category.
29
28
  *
@@ -32,7 +31,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
32
31
  * @request GET:/api/v3/categories/{category-public-id}
33
32
  * @secure
34
33
  */
35
- getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category>>;
34
+ getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
36
35
  /**
37
36
  * @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.
38
37
  *
@@ -41,7 +40,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
41
40
  * @request PUT:/api/v3/categories/{category-public-id}
42
41
  * @secure
43
42
  */
44
- updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category>>;
43
+ updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
45
44
  /**
46
45
  * @description Delete Category can be used to delete any Category.
47
46
  *
@@ -50,7 +49,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
50
49
  * @request DELETE:/api/v3/categories/{category-public-id}
51
50
  * @secure
52
51
  */
53
- deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
52
+ deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
54
53
  /**
55
54
  * @description List Category Milestones returns a list of all Milestones with the Category.
56
55
  *
@@ -59,43 +58,79 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
59
58
  * @request GET:/api/v3/categories/{category-public-id}/milestones
60
59
  * @secure
61
60
  */
62
- listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[]>>;
61
+ listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
63
62
  /**
64
- * @description List all the entity templates for an organization.
63
+ * No description
64
+ *
65
+ * @name ListCustomFields
66
+ * @summary List Custom Fields
67
+ * @request GET:/api/v3/custom-fields
68
+ * @secure
69
+ */
70
+ listCustomFields: (params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField[], any>>;
71
+ /**
72
+ * No description
73
+ *
74
+ * @name GetCustomField
75
+ * @summary Get Custom Field
76
+ * @request GET:/api/v3/custom-fields/{custom-field-public-id}
77
+ * @secure
78
+ */
79
+ getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
80
+ /**
81
+ * @description Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).
82
+ *
83
+ * @name UpdateCustomField
84
+ * @summary Update Custom Field
85
+ * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
86
+ * @secure
87
+ */
88
+ updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
89
+ /**
90
+ * No description
91
+ *
92
+ * @name DeleteCustomField
93
+ * @summary Delete Custom Field
94
+ * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
95
+ * @secure
96
+ */
97
+ deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
98
+ /**
99
+ * @description List all the entity templates for the Workspace.
65
100
  *
66
101
  * @name ListEntityTemplates
67
102
  * @summary List Entity Templates
68
103
  * @request GET:/api/v3/entity-templates
69
104
  * @secure
70
105
  */
71
- listEntityTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate[]>>;
106
+ listEntityTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate[], any>>;
72
107
  /**
73
- * @description Create a new entity template for your organization.
108
+ * @description Create a new entity template for the Workspace.
74
109
  *
75
110
  * @name CreateEntityTemplate
76
111
  * @summary Create Entity Template
77
112
  * @request POST:/api/v3/entity-templates
78
113
  * @secure
79
114
  */
80
- createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate>>;
115
+ createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
81
116
  /**
82
- * @description Disables the Story Template feature for the given Organization.
117
+ * @description Disables the Story Template feature for the Workspace.
83
118
  *
84
119
  * @name DisableStoryTemplates
85
120
  * @summary Disable Story Templates
86
121
  * @request PUT:/api/v3/entity-templates/disable
87
122
  * @secure
88
123
  */
89
- disableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
124
+ disableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
90
125
  /**
91
- * @description Enables the Story Template feature for the given Organization.
126
+ * @description Enables the Story Template feature for the Workspace.
92
127
  *
93
128
  * @name EnableStoryTemplates
94
129
  * @summary Enable Story Templates
95
130
  * @request PUT:/api/v3/entity-templates/enable
96
131
  * @secure
97
132
  */
98
- enableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
133
+ enableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
99
134
  /**
100
135
  * @description Get Entity Template returns information about a given entity template.
101
136
  *
@@ -104,7 +139,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
104
139
  * @request GET:/api/v3/entity-templates/{entity-template-public-id}
105
140
  * @secure
106
141
  */
107
- getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate>>;
142
+ getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
108
143
  /**
109
144
  * @description Update an entity template's name or its contents.
110
145
  *
@@ -113,7 +148,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
113
148
  * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
114
149
  * @secure
115
150
  */
116
- updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate>>;
151
+ updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
117
152
  /**
118
153
  * No description
119
154
  *
@@ -122,16 +157,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
122
157
  * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
123
158
  * @secure
124
159
  */
125
- deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
160
+ deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
126
161
  /**
127
- * @description Get Epic Workflow returns the Epic Workflow for the organization.
162
+ * @description Returns the Epic Workflow for the Workspace.
128
163
  *
129
164
  * @name GetEpicWorkflow
130
165
  * @summary Get Epic Workflow
131
166
  * @request GET:/api/v3/epic-workflow
132
167
  * @secure
133
168
  */
134
- getEpicWorkflow: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicWorkflow>>;
169
+ getEpicWorkflow: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicWorkflow, any>>;
135
170
  /**
136
171
  * @description List Epics returns a list of all Epics and their attributes.
137
172
  *
@@ -140,7 +175,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
140
175
  * @request GET:/api/v3/epics
141
176
  * @secure
142
177
  */
143
- listEpics: (ListEpics: ListEpics, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[]>>;
178
+ listEpics: (ListEpics: ListEpics, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
144
179
  /**
145
180
  * @description Create Epic allows you to create a new Epic in Shortcut.
146
181
  *
@@ -149,7 +184,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
149
184
  * @request POST:/api/v3/epics
150
185
  * @secure
151
186
  */
152
- createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic>>;
187
+ createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
153
188
  /**
154
189
  * @description Get Epic returns information about the selected Epic.
155
190
  *
@@ -158,7 +193,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
158
193
  * @request GET:/api/v3/epics/{epic-public-id}
159
194
  * @secure
160
195
  */
161
- getEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic>>;
196
+ getEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
162
197
  /**
163
198
  * @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.
164
199
  *
@@ -167,7 +202,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
167
202
  * @request PUT:/api/v3/epics/{epic-public-id}
168
203
  * @secure
169
204
  */
170
- updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic>>;
205
+ updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
171
206
  /**
172
207
  * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
173
208
  *
@@ -176,7 +211,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
176
211
  * @request DELETE:/api/v3/epics/{epic-public-id}
177
212
  * @secure
178
213
  */
179
- deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
214
+ deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
180
215
  /**
181
216
  * @description Get a list of all Comments on an Epic.
182
217
  *
@@ -185,7 +220,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
185
220
  * @request GET:/api/v3/epics/{epic-public-id}/comments
186
221
  * @secure
187
222
  */
188
- listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment[]>>;
223
+ listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment[], any>>;
189
224
  /**
190
225
  * @description This endpoint allows you to create a threaded Comment on an Epic.
191
226
  *
@@ -194,7 +229,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
194
229
  * @request POST:/api/v3/epics/{epic-public-id}/comments
195
230
  * @secure
196
231
  */
197
- createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment>>;
232
+ createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
198
233
  /**
199
234
  * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
200
235
  *
@@ -203,7 +238,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
203
238
  * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
204
239
  * @secure
205
240
  */
206
- createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment>>;
241
+ createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
207
242
  /**
208
243
  * @description This endpoint returns information about the selected Epic Comment.
209
244
  *
@@ -212,7 +247,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
212
247
  * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
213
248
  * @secure
214
249
  */
215
- getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment>>;
250
+ getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
216
251
  /**
217
252
  * @description This endpoint allows you to update a threaded Comment on an Epic.
218
253
  *
@@ -221,7 +256,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
221
256
  * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
222
257
  * @secure
223
258
  */
224
- updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment>>;
259
+ updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
225
260
  /**
226
261
  * @description This endpoint allows you to delete a Comment from an Epic.
227
262
  *
@@ -230,7 +265,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
230
265
  * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
231
266
  * @secure
232
267
  */
233
- deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
268
+ deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
234
269
  /**
235
270
  * @description Get a list of all Stories in an Epic.
236
271
  *
@@ -239,7 +274,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
239
274
  * @request GET:/api/v3/epics/{epic-public-id}/stories
240
275
  * @secure
241
276
  */
242
- listEpicStories: (epicPublicId: number, GetEpicStories: GetEpicStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
277
+ listEpicStories: (epicPublicId: number, GetEpicStories: GetEpicStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
243
278
  /**
244
279
  * @description This endpoint allows you to unlink a productboard epic.
245
280
  *
@@ -248,7 +283,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
248
283
  * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
249
284
  * @secure
250
285
  */
251
- unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
286
+ unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
252
287
  /**
253
288
  * @description Get Stories which have a given External Link associated with them.
254
289
  *
@@ -257,7 +292,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
257
292
  * @request GET:/api/v3/external-link/stories
258
293
  * @secure
259
294
  */
260
- getExternalLinkStories: (GetExternalLinkStoriesParams: GetExternalLinkStoriesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
295
+ getExternalLinkStories: (GetExternalLinkStoriesParams: GetExternalLinkStoriesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
261
296
  /**
262
297
  * @description List Files returns a list of all UploadedFiles in the workspace.
263
298
  *
@@ -266,7 +301,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
266
301
  * @request GET:/api/v3/files
267
302
  * @secure
268
303
  */
269
- listFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[]>>;
304
+ listFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
270
305
  /**
271
306
  * @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.
272
307
  *
@@ -276,12 +311,32 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
276
311
  * @secure
277
312
  */
278
313
  uploadFiles: (data: {
314
+ /**
315
+ * The story ID that these files will be associated with.
316
+ * @format int64
317
+ */
279
318
  story_id?: number;
319
+ /**
320
+ * A file upload. At least one is required.
321
+ * @format binary
322
+ */
280
323
  file0: File;
324
+ /**
325
+ * Optional additional files.
326
+ * @format binary
327
+ */
281
328
  file1?: File;
329
+ /**
330
+ * Optional additional files.
331
+ * @format binary
332
+ */
282
333
  file2?: File;
334
+ /**
335
+ * Optional additional files.
336
+ * @format binary
337
+ */
283
338
  file3?: File;
284
- }, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[]>>;
339
+ }, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
285
340
  /**
286
341
  * @description Get File returns information about the selected UploadedFile.
287
342
  *
@@ -290,7 +345,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
290
345
  * @request GET:/api/v3/files/{file-public-id}
291
346
  * @secure
292
347
  */
293
- getFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile>>;
348
+ getFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
294
349
  /**
295
350
  * @description Update File updates the properties of an UploadedFile (but not its content).
296
351
  *
@@ -299,7 +354,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
299
354
  * @request PUT:/api/v3/files/{file-public-id}
300
355
  * @secure
301
356
  */
302
- updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile>>;
357
+ updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
303
358
  /**
304
359
  * @description Delete File deletes a previously uploaded file.
305
360
  *
@@ -308,7 +363,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
308
363
  * @request DELETE:/api/v3/files/{file-public-id}
309
364
  * @secure
310
365
  */
311
- deleteFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
366
+ deleteFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
312
367
  /**
313
368
  * @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.
314
369
  *
@@ -317,7 +372,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
317
372
  * @request GET:/api/v3/groups
318
373
  * @secure
319
374
  */
320
- listGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Group[]>>;
375
+ listGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Group[], any>>;
321
376
  /**
322
377
  * No description
323
378
  *
@@ -326,7 +381,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
326
381
  * @request POST:/api/v3/groups
327
382
  * @secure
328
383
  */
329
- createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group>>;
384
+ createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
330
385
  /**
331
386
  * @description Disables Groups for the current workspace2
332
387
  *
@@ -335,7 +390,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
335
390
  * @request PUT:/api/v3/groups/disable
336
391
  * @secure
337
392
  */
338
- disableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
393
+ disableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
339
394
  /**
340
395
  * @description Enables Groups for the current workspace2
341
396
  *
@@ -344,7 +399,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
344
399
  * @request PUT:/api/v3/groups/enable
345
400
  * @secure
346
401
  */
347
- enableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
402
+ enableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
348
403
  /**
349
404
  * No description
350
405
  *
@@ -353,7 +408,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
353
408
  * @request GET:/api/v3/groups/{group-public-id}
354
409
  * @secure
355
410
  */
356
- getGroup: (groupPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group>>;
411
+ getGroup: (groupPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
357
412
  /**
358
413
  * No description
359
414
  *
@@ -362,7 +417,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
362
417
  * @request PUT:/api/v3/groups/{group-public-id}
363
418
  * @secure
364
419
  */
365
- updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group>>;
420
+ updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
366
421
  /**
367
422
  * @description List the Stories assigned to the Group. (By default, limited to 1,000).
368
423
  *
@@ -371,7 +426,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
371
426
  * @request GET:/api/v3/groups/{group-public-id}/stories
372
427
  * @secure
373
428
  */
374
- listGroupStories: (groupPublicId: string, ListGroupStories: ListGroupStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
429
+ listGroupStories: (groupPublicId: string, ListGroupStories: ListGroupStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
375
430
  /**
376
431
  * No description
377
432
  *
@@ -380,7 +435,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
380
435
  * @request GET:/api/v3/iterations
381
436
  * @secure
382
437
  */
383
- listIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSlim[]>>;
438
+ listIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSlim[], any>>;
384
439
  /**
385
440
  * No description
386
441
  *
@@ -389,7 +444,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
389
444
  * @request POST:/api/v3/iterations
390
445
  * @secure
391
446
  */
392
- createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration>>;
447
+ createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
393
448
  /**
394
449
  * @description Disables Iterations for the current workspace
395
450
  *
@@ -398,7 +453,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
398
453
  * @request PUT:/api/v3/iterations/disable
399
454
  * @secure
400
455
  */
401
- disableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
456
+ disableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
402
457
  /**
403
458
  * @description Enables Iterations for the current workspace
404
459
  *
@@ -407,7 +462,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
407
462
  * @request PUT:/api/v3/iterations/enable
408
463
  * @secure
409
464
  */
410
- enableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
465
+ enableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
411
466
  /**
412
467
  * No description
413
468
  *
@@ -416,7 +471,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
416
471
  * @request GET:/api/v3/iterations/{iteration-public-id}
417
472
  * @secure
418
473
  */
419
- getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration>>;
474
+ getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
420
475
  /**
421
476
  * No description
422
477
  *
@@ -425,7 +480,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
425
480
  * @request PUT:/api/v3/iterations/{iteration-public-id}
426
481
  * @secure
427
482
  */
428
- updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration>>;
483
+ updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
429
484
  /**
430
485
  * No description
431
486
  *
@@ -434,7 +489,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
434
489
  * @request DELETE:/api/v3/iterations/{iteration-public-id}
435
490
  * @secure
436
491
  */
437
- deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
492
+ deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
438
493
  /**
439
494
  * @description Get a list of all Stories in an Iteration.
440
495
  *
@@ -443,7 +498,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
443
498
  * @request GET:/api/v3/iterations/{iteration-public-id}/stories
444
499
  * @secure
445
500
  */
446
- listIterationStories: (iterationPublicId: number, GetIterationStories: GetIterationStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
501
+ listIterationStories: (iterationPublicId: number, GetIterationStories: GetIterationStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
447
502
  /**
448
503
  * @description List Labels returns a list of all Labels and their attributes.
449
504
  *
@@ -452,7 +507,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
452
507
  * @request GET:/api/v3/labels
453
508
  * @secure
454
509
  */
455
- listLabels: (ListLabels: ListLabels, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label[]>>;
510
+ listLabels: (ListLabels: ListLabels, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label[], any>>;
456
511
  /**
457
512
  * @description Create Label allows you to create a new Label in Shortcut.
458
513
  *
@@ -461,7 +516,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
461
516
  * @request POST:/api/v3/labels
462
517
  * @secure
463
518
  */
464
- createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label>>;
519
+ createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
465
520
  /**
466
521
  * @description Get Label returns information about the selected Label.
467
522
  *
@@ -470,7 +525,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
470
525
  * @request GET:/api/v3/labels/{label-public-id}
471
526
  * @secure
472
527
  */
473
- getLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label>>;
528
+ getLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
474
529
  /**
475
530
  * @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.
476
531
  *
@@ -479,7 +534,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
479
534
  * @request PUT:/api/v3/labels/{label-public-id}
480
535
  * @secure
481
536
  */
482
- updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label>>;
537
+ updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
483
538
  /**
484
539
  * @description Delete Label can be used to delete any Label.
485
540
  *
@@ -488,7 +543,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
488
543
  * @request DELETE:/api/v3/labels/{label-public-id}
489
544
  * @secure
490
545
  */
491
- deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
546
+ deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
492
547
  /**
493
548
  * @description List all of the Epics with the Label.
494
549
  *
@@ -497,7 +552,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
497
552
  * @request GET:/api/v3/labels/{label-public-id}/epics
498
553
  * @secure
499
554
  */
500
- listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[]>>;
555
+ listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
501
556
  /**
502
557
  * @description List all of the Stories with the Label.
503
558
  *
@@ -506,7 +561,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
506
561
  * @request GET:/api/v3/labels/{label-public-id}/stories
507
562
  * @secure
508
563
  */
509
- listLabelStories: (labelPublicId: number, GetLabelStories: GetLabelStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
564
+ listLabelStories: (labelPublicId: number, GetLabelStories: GetLabelStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
510
565
  /**
511
566
  * @description List Linked Files returns a list of all Linked-Files and their attributes.
512
567
  *
@@ -515,7 +570,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
515
570
  * @request GET:/api/v3/linked-files
516
571
  * @secure
517
572
  */
518
- listLinkedFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile[]>>;
573
+ listLinkedFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile[], any>>;
519
574
  /**
520
575
  * @description Create Linked File allows you to create a new Linked File in Shortcut.
521
576
  *
@@ -524,7 +579,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
524
579
  * @request POST:/api/v3/linked-files
525
580
  * @secure
526
581
  */
527
- createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile>>;
582
+ createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
528
583
  /**
529
584
  * @description Get File returns information about the selected Linked File.
530
585
  *
@@ -533,7 +588,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
533
588
  * @request GET:/api/v3/linked-files/{linked-file-public-id}
534
589
  * @secure
535
590
  */
536
- getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile>>;
591
+ getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
537
592
  /**
538
593
  * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
539
594
  *
@@ -542,7 +597,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
542
597
  * @request PUT:/api/v3/linked-files/{linked-file-public-id}
543
598
  * @secure
544
599
  */
545
- updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile>>;
600
+ updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
546
601
  /**
547
602
  * @description Delete Linked File can be used to delete any previously attached Linked-File.
548
603
  *
@@ -551,7 +606,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
551
606
  * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
552
607
  * @secure
553
608
  */
554
- deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
609
+ deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
555
610
  /**
556
611
  * @description Returns information about the authenticated member.
557
612
  *
@@ -560,16 +615,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
560
615
  * @request GET:/api/v3/member
561
616
  * @secure
562
617
  */
563
- getCurrentMemberInfo: (params?: RequestParams) => Promise<import("axios").AxiosResponse<MemberInfo>>;
618
+ getCurrentMemberInfo: (params?: RequestParams) => Promise<import("axios").AxiosResponse<MemberInfo, any>>;
564
619
  /**
565
- * @description List Members returns information about members of the organization.
620
+ * @description Returns information about members of the Workspace.
566
621
  *
567
622
  * @name ListMembers
568
623
  * @summary List Members
569
624
  * @request GET:/api/v3/members
570
625
  * @secure
571
626
  */
572
- listMembers: (ListMembers: ListMembers, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member[]>>;
627
+ listMembers: (ListMembers: ListMembers, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member[], any>>;
573
628
  /**
574
629
  * @description Returns information about a Member.
575
630
  *
@@ -578,7 +633,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
578
633
  * @request GET:/api/v3/members/{member-public-id}
579
634
  * @secure
580
635
  */
581
- getMember: (memberPublicId: string, GetMember: GetMember, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member>>;
636
+ getMember: (memberPublicId: string, GetMember: GetMember, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member, any>>;
582
637
  /**
583
638
  * @description List Milestones returns a list of all Milestones and their attributes.
584
639
  *
@@ -587,7 +642,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
587
642
  * @request GET:/api/v3/milestones
588
643
  * @secure
589
644
  */
590
- listMilestones: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[]>>;
645
+ listMilestones: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
591
646
  /**
592
647
  * @description Create Milestone allows you to create a new Milestone in Shortcut.
593
648
  *
@@ -596,7 +651,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
596
651
  * @request POST:/api/v3/milestones
597
652
  * @secure
598
653
  */
599
- createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone>>;
654
+ createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
600
655
  /**
601
656
  * @description Get Milestone returns information about a chosen Milestone.
602
657
  *
@@ -605,7 +660,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
605
660
  * @request GET:/api/v3/milestones/{milestone-public-id}
606
661
  * @secure
607
662
  */
608
- getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone>>;
663
+ getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
609
664
  /**
610
665
  * @description Update Milestone can be used to update Milestone properties.
611
666
  *
@@ -614,7 +669,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
614
669
  * @request PUT:/api/v3/milestones/{milestone-public-id}
615
670
  * @secure
616
671
  */
617
- updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone>>;
672
+ updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
618
673
  /**
619
674
  * @description Delete Milestone can be used to delete any Milestone.
620
675
  *
@@ -623,7 +678,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
623
678
  * @request DELETE:/api/v3/milestones/{milestone-public-id}
624
679
  * @secure
625
680
  */
626
- deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
681
+ deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
627
682
  /**
628
683
  * @description List all of the Epics within the Milestone.
629
684
  *
@@ -632,7 +687,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
632
687
  * @request GET:/api/v3/milestones/{milestone-public-id}/epics
633
688
  * @secure
634
689
  */
635
- listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[]>>;
690
+ listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
636
691
  /**
637
692
  * @description List Projects returns a list of all Projects and their attributes.
638
693
  *
@@ -641,7 +696,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
641
696
  * @request GET:/api/v3/projects
642
697
  * @secure
643
698
  */
644
- listProjects: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Project[]>>;
699
+ listProjects: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Project[], any>>;
645
700
  /**
646
701
  * @description Create Project is used to create a new Shortcut Project.
647
702
  *
@@ -650,7 +705,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
650
705
  * @request POST:/api/v3/projects
651
706
  * @secure
652
707
  */
653
- createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project>>;
708
+ createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
654
709
  /**
655
710
  * @description Get Project returns information about the selected Project.
656
711
  *
@@ -659,7 +714,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
659
714
  * @request GET:/api/v3/projects/{project-public-id}
660
715
  * @secure
661
716
  */
662
- getProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project>>;
717
+ getProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
663
718
  /**
664
719
  * @description Update Project can be used to change properties of a Project.
665
720
  *
@@ -668,7 +723,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
668
723
  * @request PUT:/api/v3/projects/{project-public-id}
669
724
  * @secure
670
725
  */
671
- updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project>>;
726
+ updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
672
727
  /**
673
728
  * @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.
674
729
  *
@@ -677,7 +732,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
677
732
  * @request DELETE:/api/v3/projects/{project-public-id}
678
733
  * @secure
679
734
  */
680
- deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
735
+ deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
681
736
  /**
682
737
  * @description List Stories returns a list of all Stories in a selected Project and their attributes.
683
738
  *
@@ -686,7 +741,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
686
741
  * @request GET:/api/v3/projects/{project-public-id}/stories
687
742
  * @secure
688
743
  */
689
- listStories: (projectPublicId: number, GetProjectStories: GetProjectStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
744
+ listStories: (projectPublicId: number, GetProjectStories: GetProjectStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
690
745
  /**
691
746
  * @description List Repositories returns a list of all Repositories and their attributes.
692
747
  *
@@ -695,7 +750,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
695
750
  * @request GET:/api/v3/repositories
696
751
  * @secure
697
752
  */
698
- listRepositories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository[]>>;
753
+ listRepositories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository[], any>>;
699
754
  /**
700
755
  * @description Get Repository returns information about the selected Repository.
701
756
  *
@@ -704,7 +759,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
704
759
  * @request GET:/api/v3/repositories/{repo-public-id}
705
760
  * @secure
706
761
  */
707
- getRepository: (repoPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository>>;
762
+ getRepository: (repoPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository, any>>;
708
763
  /**
709
764
  * @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.
710
765
  *
@@ -713,7 +768,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
713
768
  * @request GET:/api/v3/search
714
769
  * @secure
715
770
  */
716
- search: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<SearchResults>>;
771
+ search: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<SearchResults, any>>;
717
772
  /**
718
773
  * @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.
719
774
  *
@@ -722,7 +777,25 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
722
777
  * @request GET:/api/v3/search/epics
723
778
  * @secure
724
779
  */
725
- searchEpics: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSearchResults>>;
780
+ searchEpics: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSearchResults, any>>;
781
+ /**
782
+ * @description Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
783
+ *
784
+ * @name SearchIterations
785
+ * @summary Search Iterations
786
+ * @request GET:/api/v3/search/iterations
787
+ * @secure
788
+ */
789
+ searchIterations: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSearchResults, any>>;
790
+ /**
791
+ * @description Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
792
+ *
793
+ * @name SearchMilestones
794
+ * @summary Search Milestones
795
+ * @request GET:/api/v3/search/milestones
796
+ * @secure
797
+ */
798
+ searchMilestones: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<MilestoneSearchResults, any>>;
726
799
  /**
727
800
  * @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.
728
801
  *
@@ -731,7 +804,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
731
804
  * @request GET:/api/v3/search/stories
732
805
  * @secure
733
806
  */
734
- searchStories: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySearchResults>>;
807
+ searchStories: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySearchResults, any>>;
735
808
  /**
736
809
  * @description Create Story is used to add a new story to your Shortcut.
737
810
  *
@@ -740,16 +813,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
740
813
  * @request POST:/api/v3/stories
741
814
  * @secure
742
815
  */
743
- createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story>>;
816
+ createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
744
817
  /**
745
- * @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://shortcut.com/api/#create-story).
818
+ * @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).
746
819
  *
747
820
  * @name CreateMultipleStories
748
821
  * @summary Create Multiple Stories
749
822
  * @request POST:/api/v3/stories/bulk
750
823
  * @secure
751
824
  */
752
- createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
825
+ createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
753
826
  /**
754
827
  * @description Update Multiple Stories allows you to make changes to numerous stories at once.
755
828
  *
@@ -758,7 +831,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
758
831
  * @request PUT:/api/v3/stories/bulk
759
832
  * @secure
760
833
  */
761
- updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
834
+ updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
762
835
  /**
763
836
  * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
764
837
  *
@@ -767,7 +840,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
767
840
  * @request DELETE:/api/v3/stories/bulk
768
841
  * @secure
769
842
  */
770
- deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
843
+ deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
771
844
  /**
772
845
  * @description Search Stories lets you search Stories based on desired parameters.
773
846
  *
@@ -776,7 +849,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
776
849
  * @request POST:/api/v3/stories/search
777
850
  * @secure
778
851
  */
779
- searchStoriesOld: (SearchStories: SearchStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[]>>;
852
+ searchStoriesOld: (SearchStories: SearchStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
780
853
  /**
781
854
  * @description Get Story returns information about a chosen Story.
782
855
  *
@@ -785,7 +858,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
785
858
  * @request GET:/api/v3/stories/{story-public-id}
786
859
  * @secure
787
860
  */
788
- getStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story>>;
861
+ getStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
789
862
  /**
790
863
  * @description Update Story can be used to update Story properties.
791
864
  *
@@ -794,7 +867,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
794
867
  * @request PUT:/api/v3/stories/{story-public-id}
795
868
  * @secure
796
869
  */
797
- updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story>>;
870
+ updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
798
871
  /**
799
872
  * @description Delete Story can be used to delete any Story.
800
873
  *
@@ -803,7 +876,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
803
876
  * @request DELETE:/api/v3/stories/{story-public-id}
804
877
  * @secure
805
878
  */
806
- deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
879
+ deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
880
+ /**
881
+ * @description Lists Comments associated with a Story
882
+ *
883
+ * @name ListStoryComment
884
+ * @summary List Story Comment
885
+ * @request GET:/api/v3/stories/{story-public-id}/comments
886
+ * @secure
887
+ */
888
+ listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment[], any>>;
807
889
  /**
808
890
  * @description Create Comment allows you to create a Comment on any Story.
809
891
  *
@@ -812,7 +894,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
812
894
  * @request POST:/api/v3/stories/{story-public-id}/comments
813
895
  * @secure
814
896
  */
815
- createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment>>;
897
+ createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
816
898
  /**
817
899
  * @description Get Comment is used to get Comment information.
818
900
  *
@@ -821,7 +903,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
821
903
  * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
822
904
  * @secure
823
905
  */
824
- getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment>>;
906
+ getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
825
907
  /**
826
908
  * @description Update Comment replaces the text of the existing Comment.
827
909
  *
@@ -830,7 +912,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
830
912
  * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
831
913
  * @secure
832
914
  */
833
- updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment>>;
915
+ updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
834
916
  /**
835
917
  * @description Delete a Comment from any story.
836
918
  *
@@ -839,7 +921,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
839
921
  * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
840
922
  * @secure
841
923
  */
842
- deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
924
+ deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
843
925
  /**
844
926
  * @description Create a reaction to a story comment.
845
927
  *
@@ -848,7 +930,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
848
930
  * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
849
931
  * @secure
850
932
  */
851
- createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryReaction[]>>;
933
+ createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryReaction[], any>>;
852
934
  /**
853
935
  * @description Delete a reaction from any story comment.
854
936
  *
@@ -857,7 +939,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
857
939
  * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
858
940
  * @secure
859
941
  */
860
- deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
942
+ deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
861
943
  /**
862
944
  * No description
863
945
  *
@@ -866,7 +948,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
866
948
  * @request GET:/api/v3/stories/{story-public-id}/history
867
949
  * @secure
868
950
  */
869
- storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<History[]>>;
951
+ storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<History[], any>>;
870
952
  /**
871
953
  * @description Create Task is used to create a new task in a Story.
872
954
  *
@@ -875,7 +957,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
875
957
  * @request POST:/api/v3/stories/{story-public-id}/tasks
876
958
  * @secure
877
959
  */
878
- createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task>>;
960
+ createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
879
961
  /**
880
962
  * @description Returns information about a chosen Task.
881
963
  *
@@ -884,7 +966,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
884
966
  * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
885
967
  * @secure
886
968
  */
887
- getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task>>;
969
+ getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
888
970
  /**
889
971
  * @description Update Task can be used to update Task properties.
890
972
  *
@@ -893,7 +975,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
893
975
  * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
894
976
  * @secure
895
977
  */
896
- updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task>>;
978
+ updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
897
979
  /**
898
980
  * @description Delete Task can be used to delete any previously created Task on a Story.
899
981
  *
@@ -902,7 +984,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
902
984
  * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
903
985
  * @secure
904
986
  */
905
- deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
987
+ deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
906
988
  /**
907
989
  * @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”
908
990
  *
@@ -911,7 +993,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
911
993
  * @request POST:/api/v3/story-links
912
994
  * @secure
913
995
  */
914
- createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink>>;
996
+ createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
915
997
  /**
916
998
  * @description Returns the stories and their relationship for the given Story Link.
917
999
  *
@@ -920,7 +1002,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
920
1002
  * @request GET:/api/v3/story-links/{story-link-public-id}
921
1003
  * @secure
922
1004
  */
923
- getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink>>;
1005
+ getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
924
1006
  /**
925
1007
  * @description Updates the stories and/or the relationship for the given Story Link.
926
1008
  *
@@ -929,7 +1011,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
929
1011
  * @request PUT:/api/v3/story-links/{story-link-public-id}
930
1012
  * @secure
931
1013
  */
932
- updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink>>;
1014
+ updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
933
1015
  /**
934
1016
  * @description Removes the relationship between the stories for the given Story Link.
935
1017
  *
@@ -938,16 +1020,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
938
1020
  * @request DELETE:/api/v3/story-links/{story-link-public-id}
939
1021
  * @secure
940
1022
  */
941
- deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void>>;
1023
+ deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
942
1024
  /**
943
- * @description List Workflows returns a list of all Workflows in the organization.
1025
+ * @description Returns a list of all Workflows in the Workspace.
944
1026
  *
945
1027
  * @name ListWorkflows
946
1028
  * @summary List Workflows
947
1029
  * @request GET:/api/v3/workflows
948
1030
  * @secure
949
1031
  */
950
- listWorkflows: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow[]>>;
1032
+ listWorkflows: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow[], any>>;
951
1033
  /**
952
1034
  * @description Get Workflow returns information about a chosen Workflow.
953
1035
  *
@@ -956,5 +1038,5 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
956
1038
  * @request GET:/api/v3/workflows/{workflow-public-id}
957
1039
  * @secure
958
1040
  */
959
- getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow>>;
1041
+ getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
960
1042
  }