@useshortcut/client 3.0.0 → 3.1.0

package/lib/generated/Api.d.mts

@@ -1,4 +1,4 @@
-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";
+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";
 import { HttpClient, RequestParams } from "./http-client.mjs";
 import * as axios0 from "axios";
 
@@ -126,6 +126,36 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
    * @secure
    */
   createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim, any, {}>>;
+  /**
+   * @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
+   *
+   * @name GetDoc
+   * @summary Get Doc
+   * @request GET:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  getDoc: (docPublicId: string, query?: {
+    /** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
+    content_format?: "markdown" | "html";
+  }, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
+  /**
+   * @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.
+   *
+   * @name UpdateDoc
+   * @summary Update Doc
+   * @request PUT:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
+  /**
+   * @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.
+   *
+   * @name DeleteDoc
+   * @summary Delete Doc
+   * @request DELETE:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
   /**
    * @description List all the entity templates for the Workspace.
    *
@@ -1016,6 +1046,34 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
     /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
     entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
   }, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
+  /**
+   * @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
+   *
+   * @name SearchDocuments
+   * @summary Search Documents
+   * @request GET:/api/v3/search/documents
+   * @secure
+   */
+  searchDocuments: (query: {
+    /**
+     * Search text to match against document titles. Supports fuzzy matching. Required.
+     * @minLength 1
+     */
+    title: string;
+    /** When true, find archived documents. When false, find non-archived documents. */
+    archived?: boolean;
+    /** When true, find documents created by the current user. When false, find documents NOT created by current user. */
+    created_by_me?: boolean;
+    /** When true, find documents that the current user is following. When false, find documents NOT followed. */
+    followed_by_me?: boolean;
+    /**
+     * The number of search results to include in a page. Minimum of 1 and maximum of 250.
+     * @format int64
+     */
+    page_size?: number;
+    /** The next page token. */
+    next?: string;
+  }, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSearchResults, any, {}>>;
   /**
    * @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.
    *

package/lib/generated/Api.d.ts

@@ -1,4 +1,4 @@
-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";
+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";
 import { HttpClient, RequestParams } from "./http-client.js";
 import * as axios0 from "axios";
 
@@ -126,6 +126,36 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
    * @secure
    */
   createDoc: (CreateDoc: CreateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSlim, any, {}>>;
+  /**
+   * @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
+   *
+   * @name GetDoc
+   * @summary Get Doc
+   * @request GET:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  getDoc: (docPublicId: string, query?: {
+    /** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
+    content_format?: "markdown" | "html";
+  }, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
+  /**
+   * @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.
+   *
+   * @name UpdateDoc
+   * @summary Update Doc
+   * @request PUT:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  updateDoc: (docPublicId: string, UpdateDoc: UpdateDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<Doc, any, {}>>;
+  /**
+   * @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.
+   *
+   * @name DeleteDoc
+   * @summary Delete Doc
+   * @request DELETE:/api/v3/documents/{doc-public-id}
+   * @secure
+   */
+  deleteDoc: (docPublicId: string, GetDoc: GetDoc, params?: RequestParams) => Promise<axios0.AxiosResponse<void, any, {}>>;
   /**
    * @description List all the entity templates for the Workspace.
    *
@@ -1016,6 +1046,34 @@ declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataTyp
     /** A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, objective, story. */
     entity_types?: ("story" | "milestone" | "epic" | "iteration" | "objective")[];
   }, params?: RequestParams) => Promise<axios0.AxiosResponse<SearchResults, any, {}>>;
+  /**
+   * @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
+   *
+   * @name SearchDocuments
+   * @summary Search Documents
+   * @request GET:/api/v3/search/documents
+   * @secure
+   */
+  searchDocuments: (query: {
+    /**
+     * Search text to match against document titles. Supports fuzzy matching. Required.
+     * @minLength 1
+     */
+    title: string;
+    /** When true, find archived documents. When false, find non-archived documents. */
+    archived?: boolean;
+    /** When true, find documents created by the current user. When false, find documents NOT created by current user. */
+    created_by_me?: boolean;
+    /** When true, find documents that the current user is following. When false, find documents NOT followed. */
+    followed_by_me?: boolean;
+    /**
+     * The number of search results to include in a page. Minimum of 1 and maximum of 250.
+     * @format int64
+     */
+    page_size?: number;
+    /** The next page token. */
+    next?: string;
+  }, params?: RequestParams) => Promise<axios0.AxiosResponse<DocSearchResults, any, {}>>;
   /**
    * @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.
    *

package/lib/generated/Api.js

@@ -208,6 +208,55 @@ var Api = class extends require_http_client.HttpClient {
 		...params
 	});
 	/**
+	* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
+	*
+	* @name GetDoc
+	* @summary Get Doc
+	* @request GET:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	getDoc = (docPublicId, query, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "GET",
+		query,
+		secure: true,
+		format: "json",
+		...params
+	});
+	/**
+	* @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.
+	*
+	* @name UpdateDoc
+	* @summary Update Doc
+	* @request PUT:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	updateDoc = (docPublicId, UpdateDoc, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "PUT",
+		body: UpdateDoc,
+		secure: true,
+		type: require_http_client.ContentType.Json,
+		format: "json",
+		...params
+	});
+	/**
+	* @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.
+	*
+	* @name DeleteDoc
+	* @summary Delete Doc
+	* @request DELETE:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	deleteDoc = (docPublicId, GetDoc, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "DELETE",
+		body: GetDoc,
+		secure: true,
+		type: require_http_client.ContentType.Json,
+		...params
+	});
+	/**
 	* @description List all the entity templates for the Workspace.
 	*
 	* @name ListEntityTemplates
@@ -1547,6 +1596,22 @@ var Api = class extends require_http_client.HttpClient {
 		...params
 	});
 	/**
+	* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
+	*
+	* @name SearchDocuments
+	* @summary Search Documents
+	* @request GET:/api/v3/search/documents
+	* @secure
+	*/
+	searchDocuments = (query, params = {}) => this.request({
+		path: `/api/v3/search/documents`,
+		method: "GET",
+		query,
+		secure: true,
+		format: "json",
+		...params
+	});
+	/**
 	* @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.
 	*
 	* @name SearchEpics

package/lib/generated/Api.mjs

@@ -208,6 +208,55 @@ var Api = class extends HttpClient {
 		...params
 	});
 	/**
+	* @description Get a Doc by its public ID with content. Use content_format=html query parameter to include HTML content.
+	*
+	* @name GetDoc
+	* @summary Get Doc
+	* @request GET:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	getDoc = (docPublicId, query, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "GET",
+		query,
+		secure: true,
+		format: "json",
+		...params
+	});
+	/**
+	* @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.
+	*
+	* @name UpdateDoc
+	* @summary Update Doc
+	* @request PUT:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	updateDoc = (docPublicId, UpdateDoc, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "PUT",
+		body: UpdateDoc,
+		secure: true,
+		type: ContentType.Json,
+		format: "json",
+		...params
+	});
+	/**
+	* @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.
+	*
+	* @name DeleteDoc
+	* @summary Delete Doc
+	* @request DELETE:/api/v3/documents/{doc-public-id}
+	* @secure
+	*/
+	deleteDoc = (docPublicId, GetDoc, params = {}) => this.request({
+		path: `/api/v3/documents/${docPublicId}`,
+		method: "DELETE",
+		body: GetDoc,
+		secure: true,
+		type: ContentType.Json,
+		...params
+	});
+	/**
 	* @description List all the entity templates for the Workspace.
 	*
 	* @name ListEntityTemplates
@@ -1547,6 +1596,22 @@ var Api = class extends HttpClient {
 		...params
 	});
 	/**
+	* @description Search Documents lets you search Documents based on desired parameters. Supports structured filters: title, archived, created_by_me, followed_by_me.
+	*
+	* @name SearchDocuments
+	* @summary Search Documents
+	* @request GET:/api/v3/search/documents
+	* @secure
+	*/
+	searchDocuments = (query, params = {}) => this.request({
+		path: `/api/v3/search/documents`,
+		method: "GET",
+		query,
+		secure: true,
+		format: "json",
+		...params
+	});
+	/**
 	* @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.
 	*
 	* @name SearchEpics

package/lib/generated/data-contracts.d.mts

@@ -1341,6 +1341,45 @@ interface DisabledFeatureError {
   /** The message explaining the error */
   message: string;
 }
+interface Doc {
+  /**
+   * The public id of the Doc
+   * @format uuid
+   */
+  id: string;
+  /** The Doc's title */
+  title?: string | null;
+  /** The Doc's content in Markdown format (converted from HTML storage). */
+  content_markdown?: string | null;
+  /** The Doc's content in HTML format (as stored in S3). Only included when include_html=true query parameter is provided. */
+  content_html?: string | null;
+  /** The Shortcut application url for the Doc */
+  app_url: string;
+  /**
+   * The time/date the Doc was created
+   * @format date-time
+   */
+  created_at: string;
+  /**
+   * The time/date the Doc was last updated
+   * @format date-time
+   */
+  updated_at: string;
+  /** Whether the Doc is archived */
+  archived: boolean;
+}
+/** The results of the Document search query. */
+interface DocSearchResults {
+  /**
+   * The total number of matches for the search query. The first 1000 matches can be paged through via the API.
+   * @format int64
+   */
+  total: number;
+  /** A list of document search results. */
+  data: DocSlim[];
+  /** The URL path and query string for the next page of search results. */
+  next?: string | null;
+}
 interface DocSlim {
   /**
    * The public id of the Doc
@@ -1972,6 +2011,10 @@ interface EpicWorkflow {
   /** A map of the Epic States in this Epic Workflow. */
   epic_states: EpicState[];
 }
+interface GetDoc {
+  /** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
+  content_format?: "markdown" | "html";
+}
 /** A Group. */
 interface Group {
   /** The Shortcut application url for the Group. */
@@ -5017,9 +5060,6 @@ interface TypedStoryLink {
    */
   created_at: string;
 }
-interface UnprocessableError {
-  message: string;
-}
 interface UnusableEntitlementError {
   /** The tag for violating an entitlement action. */
   reason_tag: "entitlement-violation";
@@ -5103,6 +5143,18 @@ interface UpdateCustomFieldEnumValue {
   /** Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched. */
   enabled?: boolean;
 }
+interface UpdateDoc {
+  /**
+   * The new title for the document
+   * @minLength 1
+   * @maxLength 256
+   */
+  title?: string;
+  /** The new content for the document. */
+  content?: string;
+  /** 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. */
+  content_format?: "markdown" | "html";
+}
 /**
  * Request parameters for changing either a template's name or any of
  *   the attributes it is designed to pre-populate.
@@ -5984,4 +6036,4 @@ interface WorkflowState {
   created_at: string;
 }
 //#endregion
-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 };
+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, 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/generated/data-contracts.d.ts

@@ -1341,6 +1341,45 @@ interface DisabledFeatureError {
   /** The message explaining the error */
   message: string;
 }
+interface Doc {
+  /**
+   * The public id of the Doc
+   * @format uuid
+   */
+  id: string;
+  /** The Doc's title */
+  title?: string | null;
+  /** The Doc's content in Markdown format (converted from HTML storage). */
+  content_markdown?: string | null;
+  /** The Doc's content in HTML format (as stored in S3). Only included when include_html=true query parameter is provided. */
+  content_html?: string | null;
+  /** The Shortcut application url for the Doc */
+  app_url: string;
+  /**
+   * The time/date the Doc was created
+   * @format date-time
+   */
+  created_at: string;
+  /**
+   * The time/date the Doc was last updated
+   * @format date-time
+   */
+  updated_at: string;
+  /** Whether the Doc is archived */
+  archived: boolean;
+}
+/** The results of the Document search query. */
+interface DocSearchResults {
+  /**
+   * The total number of matches for the search query. The first 1000 matches can be paged through via the API.
+   * @format int64
+   */
+  total: number;
+  /** A list of document search results. */
+  data: DocSlim[];
+  /** The URL path and query string for the next page of search results. */
+  next?: string | null;
+}
 interface DocSlim {
   /**
    * The public id of the Doc
@@ -1972,6 +2011,10 @@ interface EpicWorkflow {
   /** A map of the Epic States in this Epic Workflow. */
   epic_states: EpicState[];
 }
+interface GetDoc {
+  /** Format of the content to return. Defaults to 'markdown'. If 'html', includes HTML content in response. */
+  content_format?: "markdown" | "html";
+}
 /** A Group. */
 interface Group {
   /** The Shortcut application url for the Group. */
@@ -5017,9 +5060,6 @@ interface TypedStoryLink {
    */
   created_at: string;
 }
-interface UnprocessableError {
-  message: string;
-}
 interface UnusableEntitlementError {
   /** The tag for violating an entitlement action. */
   reason_tag: "entitlement-violation";
@@ -5103,6 +5143,18 @@ interface UpdateCustomFieldEnumValue {
   /** Whether this EnumValue is enabled for its CustomField or not. Leaving this key out of the request leaves the current enabled state untouched. */
   enabled?: boolean;
 }
+interface UpdateDoc {
+  /**
+   * The new title for the document
+   * @minLength 1
+   * @maxLength 256
+   */
+  title?: string;
+  /** The new content for the document. */
+  content?: string;
+  /** 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. */
+  content_format?: "markdown" | "html";
+}
 /**
  * Request parameters for changing either a template's name or any of
  *   the attributes it is designed to pre-populate.
@@ -5984,4 +6036,4 @@ interface WorkflowState {
   created_at: string;
 }
 //#endregion
-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 };
+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, 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

@@ -1,3 +1,3 @@
-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";
+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, 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";
 import { ShortcutClient } from "./ShortcutClient.mjs";
-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 };
+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, 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

@@ -1,3 +1,3 @@
-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";
+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, 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";
 import { ShortcutClient } from "./ShortcutClient.js";
-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 };
+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, 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useshortcut/client",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A library for interacting with the Shortcut REST API",
   "homepage": "https://github.com/useshortcut/shortcut-client-js",
   "bugs": {