@useshortcut/client 3.0.0 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/generated/Api.d.mts +95 -1
- package/lib/generated/Api.d.ts +95 -1
- package/lib/generated/Api.js +123 -0
- package/lib/generated/Api.mjs +123 -0
- package/lib/generated/data-contracts.d.mts +56 -1
- package/lib/generated/data-contracts.d.ts +56 -1
- package/lib/index.d.mts +2 -2
- package/lib/index.d.ts +2 -2
- package/package.json +1 -1
package/lib/generated/Api.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.mjs";
|
|
1
|
+
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, GetDoc, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.mjs";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client.mjs";
|
|
3
3
|
import * as axios0 from "axios";
|
|
4
4
|
|
|
@@ -126,6 +126,63 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
126
126
|
* @secure
|
|
127
127
|
*/
|
|
128
128
|
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim, any, {}>>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
131
|
+
*
|
|
132
|
+
* @name GetDoc
|
|
133
|
+
* @summary Get Doc
|
|
134
|
+
* @request GET:/api/v3/documents/{doc-public-id}
|
|
135
|
+
* @secure
|
|
136
|
+
*/
|
|
137
|
+
getDoc: (docPublicId: string, query?: {
|
|
138
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
139
|
+
content_format?: "markdown" | "html";
|
|
140
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
141
|
+
/**
|
|
142
|
+
* @description Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. When a document is updated: (1) If users are connected, SSE events notify them to refresh their view. (2) If no users are connected, CKEditor cache is flushed to ensure fresh content.
|
|
143
|
+
*
|
|
144
|
+
* @name UpdateDoc
|
|
145
|
+
* @summary Update Doc
|
|
146
|
+
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
147
|
+
* @secure
|
|
148
|
+
*/
|
|
149
|
+
updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
150
|
+
/**
|
|
151
|
+
* @description Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
|
|
152
|
+
*
|
|
153
|
+
* @name DeleteDoc
|
|
154
|
+
* @summary Delete Doc
|
|
155
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
156
|
+
* @secure
|
|
157
|
+
*/
|
|
158
|
+
deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
159
|
+
/**
|
|
160
|
+
* @description Get a list of all Epics related to this Document.
|
|
161
|
+
*
|
|
162
|
+
* @name ListDocumentEpics
|
|
163
|
+
* @summary List Document Epics
|
|
164
|
+
* @request GET:/api/v3/documents/{doc-public-id}/epics
|
|
165
|
+
* @secure
|
|
166
|
+
*/
|
|
167
|
+
listDocumentEpics: (docPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
168
|
+
/**
|
|
169
|
+
* @description Create a relationship between a Document and an Epic.
|
|
170
|
+
*
|
|
171
|
+
* @name LinkDocumentToEpic
|
|
172
|
+
* @summary Link Document to Epic
|
|
173
|
+
* @request PUT:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
174
|
+
* @secure
|
|
175
|
+
*/
|
|
176
|
+
linkDocumentToEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
177
|
+
/**
|
|
178
|
+
* @description Remove a relationship between a Document and an Epic.
|
|
179
|
+
*
|
|
180
|
+
* @name UnlinkDocumentFromEpic
|
|
181
|
+
* @summary Unlink Document from Epic
|
|
182
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
183
|
+
* @secure
|
|
184
|
+
*/
|
|
185
|
+
unlinkDocumentFromEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
129
186
|
/**
|
|
130
187
|
* @description List all the entity templates for the Workspace.
|
|
131
188
|
*
|
|
@@ -322,6 +379,15 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
322
379
|
* @secure
|
|
323
380
|
*/
|
|
324
381
|
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
382
|
+
/**
|
|
383
|
+
* @description Get a list of all Documents related to this Epic.
|
|
384
|
+
*
|
|
385
|
+
* @name ListEpicDocuments
|
|
386
|
+
* @summary List Epic Documents
|
|
387
|
+
* @request GET:/api/v3/epics/{epic-public-id}/documents
|
|
388
|
+
* @secure
|
|
389
|
+
*/
|
|
390
|
+
listEpicDocuments: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim[], any, {}>>;
|
|
325
391
|
/**
|
|
326
392
|
* @description Get the current health for the specified Epic.
|
|
327
393
|
*
|
|
@@ -1016,6 +1082,34 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1016
1082
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1017
1083
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1018
1084
|
}, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
|
|
1085
|
+
/**
|
|
1086
|
+
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1087
|
+
*
|
|
1088
|
+
* @name SearchDocuments
|
|
1089
|
+
* @summary Search Documents
|
|
1090
|
+
* @request GET:/api/v3/search/documents
|
|
1091
|
+
* @secure
|
|
1092
|
+
*/
|
|
1093
|
+
searchDocuments: (query: {
|
|
1094
|
+
/**
|
|
1095
|
+
* Search text to match against document titles. Supports fuzzy matching. Required.
|
|
1096
|
+
* @minLength 1
|
|
1097
|
+
*/
|
|
1098
|
+
title: string;
|
|
1099
|
+
/** When true, find archived documents. When false, find non-archived documents. */
|
|
1100
|
+
archived?: boolean;
|
|
1101
|
+
/** When true, find documents created by the current user. When false, find documents NOT created by current user. */
|
|
1102
|
+
created_by_me?: boolean;
|
|
1103
|
+
/** When true, find documents that the current user is following. When false, find documents NOT followed. */
|
|
1104
|
+
followed_by_me?: boolean;
|
|
1105
|
+
/**
|
|
1106
|
+
* The number of search results to include in a page. Minimum of 1 and maximum of 250.
|
|
1107
|
+
* @format int64
|
|
1108
|
+
*/
|
|
1109
|
+
page_size?: number;
|
|
1110
|
+
/** The next page token. */
|
|
1111
|
+
next?: string;
|
|
1112
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSearchResults, any, {}>>;
|
|
1019
1113
|
/**
|
|
1020
1114
|
* @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.
|
|
1021
1115
|
*
|
package/lib/generated/Api.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
|
|
1
|
+
import { Category, CreateCategory, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicPaginatedResults, EpicSearchResults, EpicSlim, EpicWorkflow, GetDoc, Group, Health, History, Iteration, IterationSearchResults, IterationSlim, KeyResult, Label, LinkedFile, Member, MemberInfo, Milestone, Objective, ObjectiveSearchResults, Project, Repository, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from "./data-contracts.js";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client.js";
|
|
3
3
|
import * as axios0 from "axios";
|
|
4
4
|
|
|
@@ -126,6 +126,63 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
126
126
|
* @secure
|
|
127
127
|
*/
|
|
128
128
|
createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim, any, {}>>;
|
|
129
|
+
/**
|
|
130
|
+
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
131
|
+
*
|
|
132
|
+
* @name GetDoc
|
|
133
|
+
* @summary Get Doc
|
|
134
|
+
* @request GET:/api/v3/documents/{doc-public-id}
|
|
135
|
+
* @secure
|
|
136
|
+
*/
|
|
137
|
+
getDoc: (docPublicId: string, query?: {
|
|
138
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
139
|
+
content_format?: "markdown" | "html";
|
|
140
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
141
|
+
/**
|
|
142
|
+
* @description Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. When a document is updated: (1) If users are connected, SSE events notify them to refresh their view. (2) If no users are connected, CKEditor cache is flushed to ensure fresh content.
|
|
143
|
+
*
|
|
144
|
+
* @name UpdateDoc
|
|
145
|
+
* @summary Update Doc
|
|
146
|
+
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
147
|
+
* @secure
|
|
148
|
+
*/
|
|
149
|
+
updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
|
|
150
|
+
/**
|
|
151
|
+
* @description Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
|
|
152
|
+
*
|
|
153
|
+
* @name DeleteDoc
|
|
154
|
+
* @summary Delete Doc
|
|
155
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
156
|
+
* @secure
|
|
157
|
+
*/
|
|
158
|
+
deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
159
|
+
/**
|
|
160
|
+
* @description Get a list of all Epics related to this Document.
|
|
161
|
+
*
|
|
162
|
+
* @name ListDocumentEpics
|
|
163
|
+
* @summary List Document Epics
|
|
164
|
+
* @request GET:/api/v3/documents/{doc-public-id}/epics
|
|
165
|
+
* @secure
|
|
166
|
+
*/
|
|
167
|
+
listDocumentEpics: (docPublicId: string, params?: RequestParams) => Promise<axios0.AxiosResponse<EpicSlim[], any, {}>>;
|
|
168
|
+
/**
|
|
169
|
+
* @description Create a relationship between a Document and an Epic.
|
|
170
|
+
*
|
|
171
|
+
* @name LinkDocumentToEpic
|
|
172
|
+
* @summary Link Document to Epic
|
|
173
|
+
* @request PUT:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
174
|
+
* @secure
|
|
175
|
+
*/
|
|
176
|
+
linkDocumentToEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
177
|
+
/**
|
|
178
|
+
* @description Remove a relationship between a Document and an Epic.
|
|
179
|
+
*
|
|
180
|
+
* @name UnlinkDocumentFromEpic
|
|
181
|
+
* @summary Unlink Document from Epic
|
|
182
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
183
|
+
* @secure
|
|
184
|
+
*/
|
|
185
|
+
unlinkDocumentFromEpic: (docPublicId: string, epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
129
186
|
/**
|
|
130
187
|
* @description List all the entity templates for the Workspace.
|
|
131
188
|
*
|
|
@@ -322,6 +379,15 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
322
379
|
* @secure
|
|
323
380
|
*/
|
|
324
381
|
deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
|
|
382
|
+
/**
|
|
383
|
+
* @description Get a list of all Documents related to this Epic.
|
|
384
|
+
*
|
|
385
|
+
* @name ListEpicDocuments
|
|
386
|
+
* @summary List Epic Documents
|
|
387
|
+
* @request GET:/api/v3/epics/{epic-public-id}/documents
|
|
388
|
+
* @secure
|
|
389
|
+
*/
|
|
390
|
+
listEpicDocuments: (epicPublicId: number, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim[], any, {}>>;
|
|
325
391
|
/**
|
|
326
392
|
* @description Get the current health for the specified Epic.
|
|
327
393
|
*
|
|
@@ -1016,6 +1082,34 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
|
|
|
1016
1082
|
/** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
|
|
1017
1083
|
entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
|
|
1018
1084
|
}, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
|
|
1085
|
+
/**
|
|
1086
|
+
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1087
|
+
*
|
|
1088
|
+
* @name SearchDocuments
|
|
1089
|
+
* @summary Search Documents
|
|
1090
|
+
* @request GET:/api/v3/search/documents
|
|
1091
|
+
* @secure
|
|
1092
|
+
*/
|
|
1093
|
+
searchDocuments: (query: {
|
|
1094
|
+
/**
|
|
1095
|
+
* Search text to match against document titles. Supports fuzzy matching. Required.
|
|
1096
|
+
* @minLength 1
|
|
1097
|
+
*/
|
|
1098
|
+
title: string;
|
|
1099
|
+
/** When true, find archived documents. When false, find non-archived documents. */
|
|
1100
|
+
archived?: boolean;
|
|
1101
|
+
/** When true, find documents created by the current user. When false, find documents NOT created by current user. */
|
|
1102
|
+
created_by_me?: boolean;
|
|
1103
|
+
/** When true, find documents that the current user is following. When false, find documents NOT followed. */
|
|
1104
|
+
followed_by_me?: boolean;
|
|
1105
|
+
/**
|
|
1106
|
+
* The number of search results to include in a page. Minimum of 1 and maximum of 250.
|
|
1107
|
+
* @format int64
|
|
1108
|
+
*/
|
|
1109
|
+
page_size?: number;
|
|
1110
|
+
/** The next page token. */
|
|
1111
|
+
next?: string;
|
|
1112
|
+
}, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSearchResults, any, {}>>;
|
|
1019
1113
|
/**
|
|
1020
1114
|
* @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.
|
|
1021
1115
|
*
|
package/lib/generated/Api.js
CHANGED
|
@@ -208,6 +208,98 @@ var Api = class extends require_http_client.HttpClient {
|
|
|
208
208
|
...params
|
|
209
209
|
});
|
|
210
210
|
/**
|
|
211
|
+
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
212
|
+
*
|
|
213
|
+
* @name GetDoc
|
|
214
|
+
* @summary Get Doc
|
|
215
|
+
* @request GET:/api/v3/documents/{doc-public-id}
|
|
216
|
+
* @secure
|
|
217
|
+
*/
|
|
218
|
+
getDoc = (docPublicId, query, params = {}) => this.request({
|
|
219
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
220
|
+
method: "GET",
|
|
221
|
+
query,
|
|
222
|
+
secure: true,
|
|
223
|
+
format: "json",
|
|
224
|
+
...params
|
|
225
|
+
});
|
|
226
|
+
/**
|
|
227
|
+
* @description Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. When a document is updated: (1) If users are connected, SSE events notify them to refresh their view. (2) If no users are connected, CKEditor cache is flushed to ensure fresh content.
|
|
228
|
+
*
|
|
229
|
+
* @name UpdateDoc
|
|
230
|
+
* @summary Update Doc
|
|
231
|
+
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
232
|
+
* @secure
|
|
233
|
+
*/
|
|
234
|
+
updateDoc = (docPublicId, UpdateDoc, params = {}) => this.request({
|
|
235
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
236
|
+
method: "PUT",
|
|
237
|
+
body: UpdateDoc,
|
|
238
|
+
secure: true,
|
|
239
|
+
type: require_http_client.ContentType.Json,
|
|
240
|
+
format: "json",
|
|
241
|
+
...params
|
|
242
|
+
});
|
|
243
|
+
/**
|
|
244
|
+
* @description Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
|
|
245
|
+
*
|
|
246
|
+
* @name DeleteDoc
|
|
247
|
+
* @summary Delete Doc
|
|
248
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
249
|
+
* @secure
|
|
250
|
+
*/
|
|
251
|
+
deleteDoc = (docPublicId, GetDoc, params = {}) => this.request({
|
|
252
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
253
|
+
method: "DELETE",
|
|
254
|
+
body: GetDoc,
|
|
255
|
+
secure: true,
|
|
256
|
+
type: require_http_client.ContentType.Json,
|
|
257
|
+
...params
|
|
258
|
+
});
|
|
259
|
+
/**
|
|
260
|
+
* @description Get a list of all Epics related to this Document.
|
|
261
|
+
*
|
|
262
|
+
* @name ListDocumentEpics
|
|
263
|
+
* @summary List Document Epics
|
|
264
|
+
* @request GET:/api/v3/documents/{doc-public-id}/epics
|
|
265
|
+
* @secure
|
|
266
|
+
*/
|
|
267
|
+
listDocumentEpics = (docPublicId, params = {}) => this.request({
|
|
268
|
+
path: `/api/v3/documents/${docPublicId}/epics`,
|
|
269
|
+
method: "GET",
|
|
270
|
+
secure: true,
|
|
271
|
+
format: "json",
|
|
272
|
+
...params
|
|
273
|
+
});
|
|
274
|
+
/**
|
|
275
|
+
* @description Create a relationship between a Document and an Epic.
|
|
276
|
+
*
|
|
277
|
+
* @name LinkDocumentToEpic
|
|
278
|
+
* @summary Link Document to Epic
|
|
279
|
+
* @request PUT:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
280
|
+
* @secure
|
|
281
|
+
*/
|
|
282
|
+
linkDocumentToEpic = (docPublicId, epicPublicId, params = {}) => this.request({
|
|
283
|
+
path: `/api/v3/documents/${docPublicId}/epics/${epicPublicId}`,
|
|
284
|
+
method: "PUT",
|
|
285
|
+
secure: true,
|
|
286
|
+
...params
|
|
287
|
+
});
|
|
288
|
+
/**
|
|
289
|
+
* @description Remove a relationship between a Document and an Epic.
|
|
290
|
+
*
|
|
291
|
+
* @name UnlinkDocumentFromEpic
|
|
292
|
+
* @summary Unlink Document from Epic
|
|
293
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
294
|
+
* @secure
|
|
295
|
+
*/
|
|
296
|
+
unlinkDocumentFromEpic = (docPublicId, epicPublicId, params = {}) => this.request({
|
|
297
|
+
path: `/api/v3/documents/${docPublicId}/epics/${epicPublicId}`,
|
|
298
|
+
method: "DELETE",
|
|
299
|
+
secure: true,
|
|
300
|
+
...params
|
|
301
|
+
});
|
|
302
|
+
/**
|
|
211
303
|
* @description List all the entity templates for the Workspace.
|
|
212
304
|
*
|
|
213
305
|
* @name ListEntityTemplates
|
|
@@ -519,6 +611,21 @@ var Api = class extends require_http_client.HttpClient {
|
|
|
519
611
|
...params
|
|
520
612
|
});
|
|
521
613
|
/**
|
|
614
|
+
* @description Get a list of all Documents related to this Epic.
|
|
615
|
+
*
|
|
616
|
+
* @name ListEpicDocuments
|
|
617
|
+
* @summary List Epic Documents
|
|
618
|
+
* @request GET:/api/v3/epics/{epic-public-id}/documents
|
|
619
|
+
* @secure
|
|
620
|
+
*/
|
|
621
|
+
listEpicDocuments = (epicPublicId, params = {}) => this.request({
|
|
622
|
+
path: `/api/v3/epics/${epicPublicId}/documents`,
|
|
623
|
+
method: "GET",
|
|
624
|
+
secure: true,
|
|
625
|
+
format: "json",
|
|
626
|
+
...params
|
|
627
|
+
});
|
|
628
|
+
/**
|
|
522
629
|
* @description Get the current health for the specified Epic.
|
|
523
630
|
*
|
|
524
631
|
* @name GetEpicHealth
|
|
@@ -1547,6 +1654,22 @@ var Api = class extends require_http_client.HttpClient {
|
|
|
1547
1654
|
...params
|
|
1548
1655
|
});
|
|
1549
1656
|
/**
|
|
1657
|
+
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1658
|
+
*
|
|
1659
|
+
* @name SearchDocuments
|
|
1660
|
+
* @summary Search Documents
|
|
1661
|
+
* @request GET:/api/v3/search/documents
|
|
1662
|
+
* @secure
|
|
1663
|
+
*/
|
|
1664
|
+
searchDocuments = (query, params = {}) => this.request({
|
|
1665
|
+
path: `/api/v3/search/documents`,
|
|
1666
|
+
method: "GET",
|
|
1667
|
+
query,
|
|
1668
|
+
secure: true,
|
|
1669
|
+
format: "json",
|
|
1670
|
+
...params
|
|
1671
|
+
});
|
|
1672
|
+
/**
|
|
1550
1673
|
* @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.
|
|
1551
1674
|
*
|
|
1552
1675
|
* @name SearchEpics
|
package/lib/generated/Api.mjs
CHANGED
|
@@ -208,6 +208,98 @@ var Api = class extends HttpClient {
|
|
|
208
208
|
...params
|
|
209
209
|
});
|
|
210
210
|
/**
|
|
211
|
+
* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
|
|
212
|
+
*
|
|
213
|
+
* @name GetDoc
|
|
214
|
+
* @summary Get Doc
|
|
215
|
+
* @request GET:/api/v3/documents/{doc-public-id}
|
|
216
|
+
* @secure
|
|
217
|
+
*/
|
|
218
|
+
getDoc = (docPublicId, query, params = {}) => this.request({
|
|
219
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
220
|
+
method: "GET",
|
|
221
|
+
query,
|
|
222
|
+
secure: true,
|
|
223
|
+
format: "json",
|
|
224
|
+
...params
|
|
225
|
+
});
|
|
226
|
+
/**
|
|
227
|
+
* @description Updates an existing Doc's title and/or content. Supports markdown or HTML input via content_format parameter. When a document is updated: (1) If users are connected, SSE events notify them to refresh their view. (2) If no users are connected, CKEditor cache is flushed to ensure fresh content.
|
|
228
|
+
*
|
|
229
|
+
* @name UpdateDoc
|
|
230
|
+
* @summary Update Doc
|
|
231
|
+
* @request PUT:/api/v3/documents/{doc-public-id}
|
|
232
|
+
* @secure
|
|
233
|
+
*/
|
|
234
|
+
updateDoc = (docPublicId, UpdateDoc, params = {}) => this.request({
|
|
235
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
236
|
+
method: "PUT",
|
|
237
|
+
body: UpdateDoc,
|
|
238
|
+
secure: true,
|
|
239
|
+
type: ContentType.Json,
|
|
240
|
+
format: "json",
|
|
241
|
+
...params
|
|
242
|
+
});
|
|
243
|
+
/**
|
|
244
|
+
* @description Permanently deletes a Doc and its associated data. Requires admin access to the doc. When a document is deleted, connected clients will be notified via SSE events.
|
|
245
|
+
*
|
|
246
|
+
* @name DeleteDoc
|
|
247
|
+
* @summary Delete Doc
|
|
248
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}
|
|
249
|
+
* @secure
|
|
250
|
+
*/
|
|
251
|
+
deleteDoc = (docPublicId, GetDoc, params = {}) => this.request({
|
|
252
|
+
path: `/api/v3/documents/${docPublicId}`,
|
|
253
|
+
method: "DELETE",
|
|
254
|
+
body: GetDoc,
|
|
255
|
+
secure: true,
|
|
256
|
+
type: ContentType.Json,
|
|
257
|
+
...params
|
|
258
|
+
});
|
|
259
|
+
/**
|
|
260
|
+
* @description Get a list of all Epics related to this Document.
|
|
261
|
+
*
|
|
262
|
+
* @name ListDocumentEpics
|
|
263
|
+
* @summary List Document Epics
|
|
264
|
+
* @request GET:/api/v3/documents/{doc-public-id}/epics
|
|
265
|
+
* @secure
|
|
266
|
+
*/
|
|
267
|
+
listDocumentEpics = (docPublicId, params = {}) => this.request({
|
|
268
|
+
path: `/api/v3/documents/${docPublicId}/epics`,
|
|
269
|
+
method: "GET",
|
|
270
|
+
secure: true,
|
|
271
|
+
format: "json",
|
|
272
|
+
...params
|
|
273
|
+
});
|
|
274
|
+
/**
|
|
275
|
+
* @description Create a relationship between a Document and an Epic.
|
|
276
|
+
*
|
|
277
|
+
* @name LinkDocumentToEpic
|
|
278
|
+
* @summary Link Document to Epic
|
|
279
|
+
* @request PUT:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
280
|
+
* @secure
|
|
281
|
+
*/
|
|
282
|
+
linkDocumentToEpic = (docPublicId, epicPublicId, params = {}) => this.request({
|
|
283
|
+
path: `/api/v3/documents/${docPublicId}/epics/${epicPublicId}`,
|
|
284
|
+
method: "PUT",
|
|
285
|
+
secure: true,
|
|
286
|
+
...params
|
|
287
|
+
});
|
|
288
|
+
/**
|
|
289
|
+
* @description Remove a relationship between a Document and an Epic.
|
|
290
|
+
*
|
|
291
|
+
* @name UnlinkDocumentFromEpic
|
|
292
|
+
* @summary Unlink Document from Epic
|
|
293
|
+
* @request DELETE:/api/v3/documents/{doc-public-id}/epics/{epic-public-id}
|
|
294
|
+
* @secure
|
|
295
|
+
*/
|
|
296
|
+
unlinkDocumentFromEpic = (docPublicId, epicPublicId, params = {}) => this.request({
|
|
297
|
+
path: `/api/v3/documents/${docPublicId}/epics/${epicPublicId}`,
|
|
298
|
+
method: "DELETE",
|
|
299
|
+
secure: true,
|
|
300
|
+
...params
|
|
301
|
+
});
|
|
302
|
+
/**
|
|
211
303
|
* @description List all the entity templates for the Workspace.
|
|
212
304
|
*
|
|
213
305
|
* @name ListEntityTemplates
|
|
@@ -519,6 +611,21 @@ var Api = class extends HttpClient {
|
|
|
519
611
|
...params
|
|
520
612
|
});
|
|
521
613
|
/**
|
|
614
|
+
* @description Get a list of all Documents related to this Epic.
|
|
615
|
+
*
|
|
616
|
+
* @name ListEpicDocuments
|
|
617
|
+
* @summary List Epic Documents
|
|
618
|
+
* @request GET:/api/v3/epics/{epic-public-id}/documents
|
|
619
|
+
* @secure
|
|
620
|
+
*/
|
|
621
|
+
listEpicDocuments = (epicPublicId, params = {}) => this.request({
|
|
622
|
+
path: `/api/v3/epics/${epicPublicId}/documents`,
|
|
623
|
+
method: "GET",
|
|
624
|
+
secure: true,
|
|
625
|
+
format: "json",
|
|
626
|
+
...params
|
|
627
|
+
});
|
|
628
|
+
/**
|
|
522
629
|
* @description Get the current health for the specified Epic.
|
|
523
630
|
*
|
|
524
631
|
* @name GetEpicHealth
|
|
@@ -1547,6 +1654,22 @@ var Api = class extends HttpClient {
|
|
|
1547
1654
|
...params
|
|
1548
1655
|
});
|
|
1549
1656
|
/**
|
|
1657
|
+
* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
|
|
1658
|
+
*
|
|
1659
|
+
* @name SearchDocuments
|
|
1660
|
+
* @summary Search Documents
|
|
1661
|
+
* @request GET:/api/v3/search/documents
|
|
1662
|
+
* @secure
|
|
1663
|
+
*/
|
|
1664
|
+
searchDocuments = (query, params = {}) => this.request({
|
|
1665
|
+
path: `/api/v3/search/documents`,
|
|
1666
|
+
method: "GET",
|
|
1667
|
+
query,
|
|
1668
|
+
secure: true,
|
|
1669
|
+
format: "json",
|
|
1670
|
+
...params
|
|
1671
|
+
});
|
|
1672
|
+
/**
|
|
1550
1673
|
* @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.
|
|
1551
1674
|
*
|
|
1552
1675
|
* @name SearchEpics
|
|
@@ -1341,6 +1341,45 @@ interface DisabledFeatureError {
|
|
|
1341
1341
|
/** The message explaining the error */
|
|
1342
1342
|
message: string;
|
|
1343
1343
|
}
|
|
1344
|
+
interface Doc {
|
|
1345
|
+
/**
|
|
1346
|
+
* The public id of the Doc
|
|
1347
|
+
* @format uuid
|
|
1348
|
+
*/
|
|
1349
|
+
id: string;
|
|
1350
|
+
/** The Doc's title */
|
|
1351
|
+
title?: string | null;
|
|
1352
|
+
/** The Doc's content in Markdown format (converted from HTML storage). */
|
|
1353
|
+
content_markdown?: string | null;
|
|
1354
|
+
/** The Doc's content in HTML format (as stored in S3). Only included when include_html=true query parameter is provided. */
|
|
1355
|
+
content_html?: string | null;
|
|
1356
|
+
/** The Shortcut application url for the Doc */
|
|
1357
|
+
app_url: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* The time/date the Doc was created
|
|
1360
|
+
* @format date-time
|
|
1361
|
+
*/
|
|
1362
|
+
created_at: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* The time/date the Doc was last updated
|
|
1365
|
+
* @format date-time
|
|
1366
|
+
*/
|
|
1367
|
+
updated_at: string;
|
|
1368
|
+
/** Whether the Doc is archived */
|
|
1369
|
+
archived: boolean;
|
|
1370
|
+
}
|
|
1371
|
+
/** The results of the Document search query. */
|
|
1372
|
+
interface DocSearchResults {
|
|
1373
|
+
/**
|
|
1374
|
+
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
1375
|
+
* @format int64
|
|
1376
|
+
*/
|
|
1377
|
+
total: number;
|
|
1378
|
+
/** A list of document search results. */
|
|
1379
|
+
data: DocSlim[];
|
|
1380
|
+
/** The URL path and query string for the next page of search results. */
|
|
1381
|
+
next?: string | null;
|
|
1382
|
+
}
|
|
1344
1383
|
interface DocSlim {
|
|
1345
1384
|
/**
|
|
1346
1385
|
* The public id of the Doc
|
|
@@ -1972,6 +2011,10 @@ interface EpicWorkflow {
|
|
|
1972
2011
|
/** A map of the Epic States in this Epic Workflow. */
|
|
1973
2012
|
epic_states: EpicState[];
|
|
1974
2013
|
}
|
|
2014
|
+
interface GetDoc {
|
|
2015
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
2016
|
+
content_format?: "markdown" | "html";
|
|
2017
|
+
}
|
|
1975
2018
|
/** A Group. */
|
|
1976
2019
|
interface Group {
|
|
1977
2020
|
/** The Shortcut application url for the Group. */
|
|
@@ -5103,6 +5146,18 @@ interface UpdateCustomFieldEnumValue {
|
|
|
5103
5146
|
/** Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched. */
|
|
5104
5147
|
enabled?: boolean;
|
|
5105
5148
|
}
|
|
5149
|
+
interface UpdateDoc {
|
|
5150
|
+
/**
|
|
5151
|
+
* The new title for the document
|
|
5152
|
+
* @minLength 1
|
|
5153
|
+
* @maxLength 256
|
|
5154
|
+
*/
|
|
5155
|
+
title?: string;
|
|
5156
|
+
/** The new content for the document. */
|
|
5157
|
+
content?: string;
|
|
5158
|
+
/** Format of content. For input: specifies format of provided content (defaults to 'html'). For output: controls response format - 'markdown' (default) or 'html' to include HTML content. */
|
|
5159
|
+
content_format?: "markdown" | "html";
|
|
5160
|
+
}
|
|
5106
5161
|
/**
|
|
5107
5162
|
* Request parameters for changing either a template's name or any of
|
|
5108
5163
|
* the attributes it is designed to pre-populate.
|
|
@@ -5984,4 +6039,4 @@ interface WorkflowState {
|
|
|
5984
6039
|
created_at: string;
|
|
5985
6040
|
}
|
|
5986
6041
|
//#endregion
|
|
5987
|
-
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState };
|
|
6042
|
+
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState };
|
|
@@ -1341,6 +1341,45 @@ interface DisabledFeatureError {
|
|
|
1341
1341
|
/** The message explaining the error */
|
|
1342
1342
|
message: string;
|
|
1343
1343
|
}
|
|
1344
|
+
interface Doc {
|
|
1345
|
+
/**
|
|
1346
|
+
* The public id of the Doc
|
|
1347
|
+
* @format uuid
|
|
1348
|
+
*/
|
|
1349
|
+
id: string;
|
|
1350
|
+
/** The Doc's title */
|
|
1351
|
+
title?: string | null;
|
|
1352
|
+
/** The Doc's content in Markdown format (converted from HTML storage). */
|
|
1353
|
+
content_markdown?: string | null;
|
|
1354
|
+
/** The Doc's content in HTML format (as stored in S3). Only included when include_html=true query parameter is provided. */
|
|
1355
|
+
content_html?: string | null;
|
|
1356
|
+
/** The Shortcut application url for the Doc */
|
|
1357
|
+
app_url: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* The time/date the Doc was created
|
|
1360
|
+
* @format date-time
|
|
1361
|
+
*/
|
|
1362
|
+
created_at: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* The time/date the Doc was last updated
|
|
1365
|
+
* @format date-time
|
|
1366
|
+
*/
|
|
1367
|
+
updated_at: string;
|
|
1368
|
+
/** Whether the Doc is archived */
|
|
1369
|
+
archived: boolean;
|
|
1370
|
+
}
|
|
1371
|
+
/** The results of the Document search query. */
|
|
1372
|
+
interface DocSearchResults {
|
|
1373
|
+
/**
|
|
1374
|
+
* The total number of matches for the search query. The first 1000 matches can be paged through via the API.
|
|
1375
|
+
* @format int64
|
|
1376
|
+
*/
|
|
1377
|
+
total: number;
|
|
1378
|
+
/** A list of document search results. */
|
|
1379
|
+
data: DocSlim[];
|
|
1380
|
+
/** The URL path and query string for the next page of search results. */
|
|
1381
|
+
next?: string | null;
|
|
1382
|
+
}
|
|
1344
1383
|
interface DocSlim {
|
|
1345
1384
|
/**
|
|
1346
1385
|
* The public id of the Doc
|
|
@@ -1972,6 +2011,10 @@ interface EpicWorkflow {
|
|
|
1972
2011
|
/** A map of the Epic States in this Epic Workflow. */
|
|
1973
2012
|
epic_states: EpicState[];
|
|
1974
2013
|
}
|
|
2014
|
+
interface GetDoc {
|
|
2015
|
+
/** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
|
|
2016
|
+
content_format?: "markdown" | "html";
|
|
2017
|
+
}
|
|
1975
2018
|
/** A Group. */
|
|
1976
2019
|
interface Group {
|
|
1977
2020
|
/** The Shortcut application url for the Group. */
|
|
@@ -5103,6 +5146,18 @@ interface UpdateCustomFieldEnumValue {
|
|
|
5103
5146
|
/** Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched. */
|
|
5104
5147
|
enabled?: boolean;
|
|
5105
5148
|
}
|
|
5149
|
+
interface UpdateDoc {
|
|
5150
|
+
/**
|
|
5151
|
+
* The new title for the document
|
|
5152
|
+
* @minLength 1
|
|
5153
|
+
* @maxLength 256
|
|
5154
|
+
*/
|
|
5155
|
+
title?: string;
|
|
5156
|
+
/** The new content for the document. */
|
|
5157
|
+
content?: string;
|
|
5158
|
+
/** Format of content. For input: specifies format of provided content (defaults to 'html'). For output: controls response format - 'markdown' (default) or 'html' to include HTML content. */
|
|
5159
|
+
content_format?: "markdown" | "html";
|
|
5160
|
+
}
|
|
5106
5161
|
/**
|
|
5107
5162
|
* Request parameters for changing either a template's name or any of
|
|
5108
5163
|
* the attributes it is designed to pre-populate.
|
|
@@ -5984,4 +6039,4 @@ interface WorkflowState {
|
|
|
5984
6039
|
created_at: string;
|
|
5985
6040
|
}
|
|
5986
6041
|
//#endregion
|
|
5987
|
-
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState };
|
|
6042
|
+
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState };
|
package/lib/index.d.mts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState } from "./generated/data-contracts.mjs";
|
|
1
|
+
import { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState } from "./generated/data-contracts.mjs";
|
|
2
2
|
import { ShortcutClient } from "./ShortcutClient.mjs";
|
|
3
|
-
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, ShortcutClient, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState, ShortcutClient as default };
|
|
3
|
+
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, ShortcutClient, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState, ShortcutClient as default };
|
package/lib/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState } from "./generated/data-contracts.js";
|
|
1
|
+
import { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState } from "./generated/data-contracts.js";
|
|
2
2
|
import { ShortcutClient } from "./ShortcutClient.js";
|
|
3
|
-
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, ShortcutClient, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState, ShortcutClient as default };
|
|
3
|
+
export { BaseTaskParams, BasicWorkspaceInfo, Branch, Category, Commit, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateDoc, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateEpicHealth, CreateGenericIntegration, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateObjective, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryFromTemplateParams, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateSubTaskParams, CreateTask, CreateTaskParams, CustomField, CustomFieldEnumValue, CustomFieldValueParams, DataConflictError, DeleteStories, DisabledFeatureError, Doc, DocSearchResults, DocSlim, EntityTemplate, Epic, EpicAssociatedGroup, EpicPaginatedResults, EpicSearchResult, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetDoc, Group, Health, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryActionWorkspace2BulkUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceCustomFieldEnumValue, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationAssociatedGroup, IterationSearchResults, IterationSlim, IterationStats, KeyResult, KeyResultValue, Label, LabelSlim, LabelStats, LinkSubTaskParams, LinkedFile, MaxSearchResultsExceededError, Member, MemberInfo, MemberInfoOrganization2, Milestone, MilestoneStats, Objective, ObjectiveSearchResult, ObjectiveSearchResults, ObjectiveStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, RemoveCustomFieldParams, RemoveLabelParams, Repository, SearchResults, SearchStories, ShortcutClient, Story, StoryComment, StoryContents, StoryContentsTask, StoryCustomField, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResult, StorySearchResults, StorySlim, StoryStats, SyncedItem, Task, ThreadedComment, TypedStoryLink, UnprocessableError, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateCustomField, UpdateCustomFieldEnumValue, UpdateDoc, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateHealth, UpdateIteration, UpdateKeyResult, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateObjective, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState, ShortcutClient as default };
|