@useshortcut/client 2.3.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -191,7 +191,7 @@ var Api = class extends require_http_client.HttpClient {
191
191
  ...params
192
192
  });
193
193
  /**
194
- * @description Creates a new Doc.
194
+ * @description Creates a new Doc. Supports markdown or HTML input via content_format parameter.
195
195
  *
196
196
  * @name CreateDoc
197
197
  * @summary Create Doc
@@ -697,9 +697,10 @@ var Api = class extends require_http_client.HttpClient {
697
697
  * @request GET:/api/v3/groups
698
698
  * @secure
699
699
  */
700
- listGroups = (params = {}) => this.request({
700
+ listGroups = (query, params = {}) => this.request({
701
701
  path: `/api/v3/groups`,
702
702
  method: "GET",
703
+ query,
703
704
  secure: true,
704
705
  format: "json",
705
706
  ...params
@@ -1914,6 +1915,21 @@ var Api = class extends require_http_client.HttpClient {
1914
1915
  ...params
1915
1916
  });
1916
1917
  /**
1918
+ * @description List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
1919
+ *
1920
+ * @name ListStorySubTasks
1921
+ * @summary List Story Sub tasks
1922
+ * @request GET:/api/v3/stories/{story-public-id}/sub-tasks
1923
+ * @secure
1924
+ */
1925
+ listStorySubTasks = (storyPublicId, params = {}) => this.request({
1926
+ path: `/api/v3/stories/${storyPublicId}/sub-tasks`,
1927
+ method: "GET",
1928
+ secure: true,
1929
+ format: "json",
1930
+ ...params
1931
+ });
1932
+ /**
1917
1933
  * @description Create Task is used to create a new task in a Story.
1918
1934
  *
1919
1935
  * @name CreateTask
@@ -191,7 +191,7 @@ var Api = class extends HttpClient {
191
191
  ...params
192
192
  });
193
193
  /**
194
- * @description Creates a new Doc.
194
+ * @description Creates a new Doc. Supports markdown or HTML input via content_format parameter.
195
195
  *
196
196
  * @name CreateDoc
197
197
  * @summary Create Doc
@@ -697,9 +697,10 @@ var Api = class extends HttpClient {
697
697
  * @request GET:/api/v3/groups
698
698
  * @secure
699
699
  */
700
- listGroups = (params = {}) => this.request({
700
+ listGroups = (query, params = {}) => this.request({
701
701
  path: `/api/v3/groups`,
702
702
  method: "GET",
703
+ query,
703
704
  secure: true,
704
705
  format: "json",
705
706
  ...params
@@ -1914,6 +1915,21 @@ var Api = class extends HttpClient {
1914
1915
  ...params
1915
1916
  });
1916
1917
  /**
1918
+ * @description List Story Sub tasks returns a list of all Sub-task Stories for a given parent Story.
1919
+ *
1920
+ * @name ListStorySubTasks
1921
+ * @summary List Story Sub tasks
1922
+ * @request GET:/api/v3/stories/{story-public-id}/sub-tasks
1923
+ * @secure
1924
+ */
1925
+ listStorySubTasks = (storyPublicId, params = {}) => this.request({
1926
+ path: `/api/v3/stories/${storyPublicId}/sub-tasks`,
1927
+ method: "GET",
1928
+ secure: true,
1929
+ format: "json",
1930
+ ...params
1931
+ });
1932
+ /**
1917
1933
  * @description Create Task is used to create a new task in a Story.
1918
1934
  *
1919
1935
  * @name CreateTask
@@ -224,13 +224,15 @@ interface CreateCommentComment {
224
224
  }
225
225
  interface CreateDoc {
226
226
  /**
227
- * The title for the new document
227
+ * The title for the new document.
228
228
  * @minLength 1
229
229
  * @maxLength 256
230
230
  */
231
231
  title: string;
232
- /** The content for the new document */
232
+ /** The content for the new document. */
233
233
  content: string;
234
+ /** Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you're sending. */
235
+ content_format?: "markdown" | "html";
234
236
  }
235
237
  /** Request parameters for creating an entirely new entity template. */
236
238
  interface CreateEntityTemplate {
@@ -733,7 +735,10 @@ interface CreateStoryContents {
733
735
  epic_id?: number | null;
734
736
  /** An array of external links to be populated. */
735
737
  external_links?: string[];
736
- /** An array of sub-tasks connected to the story */
738
+ /**
739
+ * An array of maps specifying the sub-tasks to create and link to the story.
740
+ * Field only applicable when Sub-task feature is enabled.
741
+ */
737
742
  sub_tasks?: CreateSubTaskParams[];
738
743
  /**
739
744
  * The ID of the iteration the to be populated.
@@ -856,7 +861,10 @@ interface CreateStoryFromTemplateParams {
856
861
  * @uniqueItems true
857
862
  */
858
863
  follower_ids_remove?: string[];
859
- /** A list of either params to create a new sub-task or link an existing story as a sub-task */
864
+ /**
865
+ * An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story.
866
+ * Field only applicable when Sub-task feature is enabled.
867
+ */
860
868
  sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
861
869
  /**
862
870
  * An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`
@@ -921,7 +929,8 @@ interface CreateStoryFromTemplateParams {
921
929
  */
922
930
  external_id?: string;
923
931
  /**
924
- * The id of the parent story to associate with this story.
932
+ * The ID of the parent story to associate with this story (making the created story a sub-task).
933
+ * Field only applicable when Sub-task feature is enabled.
925
934
  * @format int64
926
935
  */
927
936
  parent_story_id?: number | null;
@@ -1064,7 +1073,10 @@ interface CreateStoryParams {
1064
1073
  story_template_id?: string | null;
1065
1074
  /** An array of External Links associated with this story. */
1066
1075
  external_links?: string[];
1067
- /** A list of either params to create a new sub-task or link an existing story as a sub-task */
1076
+ /**
1077
+ * An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story.
1078
+ * Field only applicable when Sub-task feature is enabled.
1079
+ */
1068
1080
  sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
1069
1081
  /**
1070
1082
  * The ID of the member that requested the story.
@@ -1114,7 +1126,8 @@ interface CreateStoryParams {
1114
1126
  */
1115
1127
  external_id?: string;
1116
1128
  /**
1117
- * The id of the parent story to associate with this story.
1129
+ * The ID of the parent story to associate with this story (making the created story a sub-task).
1130
+ * Field only applicable when Sub-task feature is enabled.
1118
1131
  * @format int64
1119
1132
  */
1120
1133
  parent_story_id?: number | null;
@@ -4108,6 +4121,10 @@ interface Story {
4108
4121
  * @format int64
4109
4122
  */
4110
4123
  iteration_id?: number | null;
4124
+ /**
4125
+ * The Story IDs of Sub-tasks attached to the Story
4126
+ * Field only applicable when Sub-task feature is enabled.
4127
+ */
4111
4128
  sub_task_story_ids?: number[];
4112
4129
  /** An array of tasks connected to the story. */
4113
4130
  tasks: Task[];
@@ -4155,7 +4172,11 @@ interface Story {
4155
4172
  * @format int64
4156
4173
  */
4157
4174
  lead_time?: number;
4158
- /** @format int64 */
4175
+ /**
4176
+ * The ID of the parent story to this story (making this story a sub-task).
4177
+ * Field only applicable when Sub-task feature is enabled.
4178
+ * @format int64
4179
+ */
4159
4180
  parent_story_id?: number | null;
4160
4181
  /**
4161
4182
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4286,7 +4307,10 @@ interface StoryContents {
4286
4307
  epic_id?: number;
4287
4308
  /** An array of external links connected to the story. */
4288
4309
  external_links?: string[];
4289
- /** An array of sub-tasks connected to the story */
4310
+ /**
4311
+ * An array of maps specifying the sub-tasks to create and link to the story.
4312
+ * Field only applicable when Sub-task feature is enabled.
4313
+ */
4290
4314
  sub_tasks?: CreateSubTaskParams[];
4291
4315
  /**
4292
4316
  * The ID of the iteration the story belongs to.
@@ -4548,6 +4572,10 @@ interface StorySearchResult {
4548
4572
  * @format int64
4549
4573
  */
4550
4574
  iteration_id?: number | null;
4575
+ /**
4576
+ * The Story IDs of Sub-tasks attached to the Story
4577
+ * Field only applicable when Sub-task feature is enabled.
4578
+ */
4551
4579
  sub_task_story_ids?: number[];
4552
4580
  /** An array of tasks connected to the story. */
4553
4581
  tasks?: Task[];
@@ -4595,7 +4623,11 @@ interface StorySearchResult {
4595
4623
  * @format int64
4596
4624
  */
4597
4625
  lead_time?: number;
4598
- /** @format int64 */
4626
+ /**
4627
+ * The ID of the parent story to this story (making this story a sub-task).
4628
+ * Field only applicable when Sub-task feature is enabled.
4629
+ * @format int64
4630
+ */
4599
4631
  parent_story_id?: number | null;
4600
4632
  /**
4601
4633
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4743,6 +4775,10 @@ interface StorySlim {
4743
4775
  * @format int64
4744
4776
  */
4745
4777
  iteration_id?: number | null;
4778
+ /**
4779
+ * The Story IDs of Sub-tasks attached to the Story
4780
+ * Field only applicable when Sub-task feature is enabled.
4781
+ */
4746
4782
  sub_task_story_ids?: number[];
4747
4783
  /** The formatted branch name for this story. */
4748
4784
  formatted_vcs_branch_name?: string | null;
@@ -4786,7 +4822,11 @@ interface StorySlim {
4786
4822
  * @format int64
4787
4823
  */
4788
4824
  lead_time?: number;
4789
- /** @format int64 */
4825
+ /**
4826
+ * The ID of the parent story to this story (making this story a sub-task).
4827
+ * Field only applicable when Sub-task feature is enabled.
4828
+ * @format int64
4829
+ */
4790
4830
  parent_story_id?: number | null;
4791
4831
  /**
4792
4832
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4977,6 +5017,9 @@ interface TypedStoryLink {
4977
5017
  */
4978
5018
  created_at: string;
4979
5019
  }
5020
+ interface UnprocessableError {
5021
+ message: string;
5022
+ }
4980
5023
  interface UnusableEntitlementError {
4981
5024
  /** The tag for violating an entitlement action. */
4982
5025
  reason_tag: "entitlement-violation";
@@ -5610,6 +5653,8 @@ interface UpdateStory {
5610
5653
  * @uniqueItems true
5611
5654
  */
5612
5655
  commit_ids?: number[];
5656
+ /** An array of story IDs to attach to this story as sub-tasks. This list represents the final state of the parent's sub-tasks - missing stories will be unlinked, new stories will be linked, and the input order reflects sub-task positions. */
5657
+ sub_tasks?: LinkSubTaskParams[];
5613
5658
  /**
5614
5659
  * The ID of the member that requested the story.
5615
5660
  * @format uuid
@@ -5712,7 +5757,10 @@ interface UpdateStoryContents {
5712
5757
  epic_id?: number | null;
5713
5758
  /** An array of external links to be populated. */
5714
5759
  external_links?: string[];
5715
- /** An array of sub-tasks connected to the story */
5760
+ /**
5761
+ * An array of maps specifying the sub-tasks to create and link to the story.
5762
+ * Field only applicable when Sub-task feature is enabled.
5763
+ */
5716
5764
  sub_tasks?: CreateSubTaskParams[];
5717
5765
  /**
5718
5766
  * The ID of the iteration the to be populated.
@@ -5936,4 +5984,4 @@ interface WorkflowState {
5936
5984
  created_at: string;
5937
5985
  }
5938
5986
  //#endregion
5939
- 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, 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 };
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 };
@@ -224,13 +224,15 @@ interface CreateCommentComment {
224
224
  }
225
225
  interface CreateDoc {
226
226
  /**
227
- * The title for the new document
227
+ * The title for the new document.
228
228
  * @minLength 1
229
229
  * @maxLength 256
230
230
  */
231
231
  title: string;
232
- /** The content for the new document */
232
+ /** The content for the new document. */
233
233
  content: string;
234
+ /** Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you're sending. */
235
+ content_format?: "markdown" | "html";
234
236
  }
235
237
  /** Request parameters for creating an entirely new entity template. */
236
238
  interface CreateEntityTemplate {
@@ -733,7 +735,10 @@ interface CreateStoryContents {
733
735
  epic_id?: number | null;
734
736
  /** An array of external links to be populated. */
735
737
  external_links?: string[];
736
- /** An array of sub-tasks connected to the story */
738
+ /**
739
+ * An array of maps specifying the sub-tasks to create and link to the story.
740
+ * Field only applicable when Sub-task feature is enabled.
741
+ */
737
742
  sub_tasks?: CreateSubTaskParams[];
738
743
  /**
739
744
  * The ID of the iteration the to be populated.
@@ -856,7 +861,10 @@ interface CreateStoryFromTemplateParams {
856
861
  * @uniqueItems true
857
862
  */
858
863
  follower_ids_remove?: string[];
859
- /** A list of either params to create a new sub-task or link an existing story as a sub-task */
864
+ /**
865
+ * An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story.
866
+ * Field only applicable when Sub-task feature is enabled.
867
+ */
860
868
  sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
861
869
  /**
862
870
  * An array of IDs of linked files removed from files from the template. Cannot be used in conjunction with `linked_files.`
@@ -921,7 +929,8 @@ interface CreateStoryFromTemplateParams {
921
929
  */
922
930
  external_id?: string;
923
931
  /**
924
- * The id of the parent story to associate with this story.
932
+ * The ID of the parent story to associate with this story (making the created story a sub-task).
933
+ * Field only applicable when Sub-task feature is enabled.
925
934
  * @format int64
926
935
  */
927
936
  parent_story_id?: number | null;
@@ -1064,7 +1073,10 @@ interface CreateStoryParams {
1064
1073
  story_template_id?: string | null;
1065
1074
  /** An array of External Links associated with this story. */
1066
1075
  external_links?: string[];
1067
- /** A list of either params to create a new sub-task or link an existing story as a sub-task */
1076
+ /**
1077
+ * An array of maps specifying sub-tasks to be associated with the created story. Each map can either link to an existing story or create a new sub-task story to be linked to the created story.
1078
+ * Field only applicable when Sub-task feature is enabled.
1079
+ */
1068
1080
  sub_tasks?: (LinkSubTaskParams | CreateSubTaskParams)[];
1069
1081
  /**
1070
1082
  * The ID of the member that requested the story.
@@ -1114,7 +1126,8 @@ interface CreateStoryParams {
1114
1126
  */
1115
1127
  external_id?: string;
1116
1128
  /**
1117
- * The id of the parent story to associate with this story.
1129
+ * The ID of the parent story to associate with this story (making the created story a sub-task).
1130
+ * Field only applicable when Sub-task feature is enabled.
1118
1131
  * @format int64
1119
1132
  */
1120
1133
  parent_story_id?: number | null;
@@ -4108,6 +4121,10 @@ interface Story {
4108
4121
  * @format int64
4109
4122
  */
4110
4123
  iteration_id?: number | null;
4124
+ /**
4125
+ * The Story IDs of Sub-tasks attached to the Story
4126
+ * Field only applicable when Sub-task feature is enabled.
4127
+ */
4111
4128
  sub_task_story_ids?: number[];
4112
4129
  /** An array of tasks connected to the story. */
4113
4130
  tasks: Task[];
@@ -4155,7 +4172,11 @@ interface Story {
4155
4172
  * @format int64
4156
4173
  */
4157
4174
  lead_time?: number;
4158
- /** @format int64 */
4175
+ /**
4176
+ * The ID of the parent story to this story (making this story a sub-task).
4177
+ * Field only applicable when Sub-task feature is enabled.
4178
+ * @format int64
4179
+ */
4159
4180
  parent_story_id?: number | null;
4160
4181
  /**
4161
4182
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4286,7 +4307,10 @@ interface StoryContents {
4286
4307
  epic_id?: number;
4287
4308
  /** An array of external links connected to the story. */
4288
4309
  external_links?: string[];
4289
- /** An array of sub-tasks connected to the story */
4310
+ /**
4311
+ * An array of maps specifying the sub-tasks to create and link to the story.
4312
+ * Field only applicable when Sub-task feature is enabled.
4313
+ */
4290
4314
  sub_tasks?: CreateSubTaskParams[];
4291
4315
  /**
4292
4316
  * The ID of the iteration the story belongs to.
@@ -4548,6 +4572,10 @@ interface StorySearchResult {
4548
4572
  * @format int64
4549
4573
  */
4550
4574
  iteration_id?: number | null;
4575
+ /**
4576
+ * The Story IDs of Sub-tasks attached to the Story
4577
+ * Field only applicable when Sub-task feature is enabled.
4578
+ */
4551
4579
  sub_task_story_ids?: number[];
4552
4580
  /** An array of tasks connected to the story. */
4553
4581
  tasks?: Task[];
@@ -4595,7 +4623,11 @@ interface StorySearchResult {
4595
4623
  * @format int64
4596
4624
  */
4597
4625
  lead_time?: number;
4598
- /** @format int64 */
4626
+ /**
4627
+ * The ID of the parent story to this story (making this story a sub-task).
4628
+ * Field only applicable when Sub-task feature is enabled.
4629
+ * @format int64
4630
+ */
4599
4631
  parent_story_id?: number | null;
4600
4632
  /**
4601
4633
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4743,6 +4775,10 @@ interface StorySlim {
4743
4775
  * @format int64
4744
4776
  */
4745
4777
  iteration_id?: number | null;
4778
+ /**
4779
+ * The Story IDs of Sub-tasks attached to the Story
4780
+ * Field only applicable when Sub-task feature is enabled.
4781
+ */
4746
4782
  sub_task_story_ids?: number[];
4747
4783
  /** The formatted branch name for this story. */
4748
4784
  formatted_vcs_branch_name?: string | null;
@@ -4786,7 +4822,11 @@ interface StorySlim {
4786
4822
  * @format int64
4787
4823
  */
4788
4824
  lead_time?: number;
4789
- /** @format int64 */
4825
+ /**
4826
+ * The ID of the parent story to this story (making this story a sub-task).
4827
+ * Field only applicable when Sub-task feature is enabled.
4828
+ * @format int64
4829
+ */
4790
4830
  parent_story_id?: number | null;
4791
4831
  /**
4792
4832
  * The numeric point estimate of the story. Can also be null, which means unestimated.
@@ -4977,6 +5017,9 @@ interface TypedStoryLink {
4977
5017
  */
4978
5018
  created_at: string;
4979
5019
  }
5020
+ interface UnprocessableError {
5021
+ message: string;
5022
+ }
4980
5023
  interface UnusableEntitlementError {
4981
5024
  /** The tag for violating an entitlement action. */
4982
5025
  reason_tag: "entitlement-violation";
@@ -5610,6 +5653,8 @@ interface UpdateStory {
5610
5653
  * @uniqueItems true
5611
5654
  */
5612
5655
  commit_ids?: number[];
5656
+ /** An array of story IDs to attach to this story as sub-tasks. This list represents the final state of the parent's sub-tasks - missing stories will be unlinked, new stories will be linked, and the input order reflects sub-task positions. */
5657
+ sub_tasks?: LinkSubTaskParams[];
5613
5658
  /**
5614
5659
  * The ID of the member that requested the story.
5615
5660
  * @format uuid
@@ -5712,7 +5757,10 @@ interface UpdateStoryContents {
5712
5757
  epic_id?: number | null;
5713
5758
  /** An array of external links to be populated. */
5714
5759
  external_links?: string[];
5715
- /** An array of sub-tasks connected to the story */
5760
+ /**
5761
+ * An array of maps specifying the sub-tasks to create and link to the story.
5762
+ * Field only applicable when Sub-task feature is enabled.
5763
+ */
5716
5764
  sub_tasks?: CreateSubTaskParams[];
5717
5765
  /**
5718
5766
  * The ID of the iteration the to be populated.
@@ -5936,4 +5984,4 @@ interface WorkflowState {
5936
5984
  created_at: string;
5937
5985
  }
5938
5986
  //#endregion
5939
- 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, 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 };
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 };
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, 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, 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";
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, 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, 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 };
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, 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, 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";
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, 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, 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@useshortcut/client",
3
- "version": "2.3.1",
3
+ "version": "3.0.0",
4
4
  "description": "A library for interacting with the Shortcut REST API",
5
5
  "homepage": "https://github.com/useshortcut/shortcut-client-js",
6
6
  "bugs": {