@useshortcut/client 1.0.0 → 2.0.0

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