shortcut_client_ruby 0.0.4 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (452) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +74 -0
  3. data/README.md +31 -1986
  4. data/Rakefile +2 -0
  5. data/bin/update.rb +8 -4
  6. data/config.json +2 -1
  7. data/docs/BasicWorkspaceInfo.md +16 -4
  8. data/docs/Branch.md +34 -13
  9. data/docs/Category.md +30 -11
  10. data/docs/Commit.md +38 -15
  11. data/docs/CreateCategory.md +20 -6
  12. data/docs/CreateCategoryParams.md +18 -5
  13. data/docs/CreateCommentComment.md +22 -7
  14. data/docs/CreateEntityTemplate.md +18 -5
  15. data/docs/CreateEpic.md +46 -19
  16. data/docs/CreateEpicComment.md +22 -7
  17. data/docs/CreateGroup.md +28 -10
  18. data/docs/CreateIteration.md +26 -9
  19. data/docs/CreateLabelParams.md +20 -6
  20. data/docs/CreateLinkedFile.md +30 -11
  21. data/docs/CreateMilestone.md +24 -8
  22. data/docs/CreateOrDeleteStoryReaction.md +14 -3
  23. data/docs/CreateProject.md +34 -13
  24. data/docs/CreateStories.md +14 -3
  25. data/docs/CreateStoryComment.md +22 -7
  26. data/docs/CreateStoryCommentParams.md +22 -7
  27. data/docs/CreateStoryContents.md +54 -23
  28. data/docs/CreateStoryLink.md +18 -5
  29. data/docs/CreateStoryLinkParams.md +18 -5
  30. data/docs/CreateStoryParams.md +66 -29
  31. data/docs/CreateTask.md +24 -8
  32. data/docs/CreateTaskParams.md +24 -8
  33. data/docs/DefaultApi.md +3569 -1641
  34. data/docs/DeleteStories.md +14 -3
  35. data/docs/EntityTemplate.md +28 -10
  36. data/docs/EntityTemplateTask.md +20 -6
  37. data/docs/Epic.md +88 -40
  38. data/docs/EpicSearchResults.md +20 -6
  39. data/docs/EpicSlim.md +86 -39
  40. data/docs/EpicState.md +30 -11
  41. data/docs/EpicStats.md +38 -15
  42. data/docs/EpicWorkflow.md +24 -8
  43. data/docs/GetEpicStories.md +14 -3
  44. data/docs/GetExternalLinkStoriesParams.md +14 -3
  45. data/docs/GetIterationStories.md +14 -3
  46. data/docs/GetLabelStories.md +14 -3
  47. data/docs/GetMember.md +14 -3
  48. data/docs/GetProjectStories.md +14 -3
  49. data/docs/Group.md +44 -18
  50. data/docs/History.md +30 -11
  51. data/docs/HistoryActionBranchCreate.md +22 -7
  52. data/docs/HistoryActionBranchMerge.md +22 -7
  53. data/docs/HistoryActionBranchPush.md +22 -7
  54. data/docs/HistoryActionLabelCreate.md +22 -7
  55. data/docs/HistoryActionLabelDelete.md +20 -6
  56. data/docs/HistoryActionLabelUpdate.md +18 -5
  57. data/docs/HistoryActionProjectUpdate.md +22 -7
  58. data/docs/HistoryActionPullRequest.md +24 -8
  59. data/docs/HistoryActionStoryCommentCreate.md +24 -8
  60. data/docs/HistoryActionStoryCreate.md +60 -26
  61. data/docs/HistoryActionStoryDelete.md +22 -7
  62. data/docs/HistoryActionStoryLinkCreate.md +24 -8
  63. data/docs/HistoryActionStoryLinkDelete.md +24 -8
  64. data/docs/HistoryActionStoryLinkUpdate.md +26 -9
  65. data/docs/HistoryActionStoryUpdate.md +26 -9
  66. data/docs/HistoryActionTaskCreate.md +30 -11
  67. data/docs/HistoryActionTaskDelete.md +20 -6
  68. data/docs/HistoryActionTaskUpdate.md +26 -9
  69. data/docs/HistoryChangesStory.md +60 -26
  70. data/docs/HistoryChangesStoryLink.md +18 -5
  71. data/docs/HistoryChangesTask.md +20 -6
  72. data/docs/HistoryReferenceBranch.md +20 -6
  73. data/docs/HistoryReferenceCommit.md +20 -6
  74. data/docs/HistoryReferenceEpic.md +20 -6
  75. data/docs/HistoryReferenceGeneral.md +18 -5
  76. data/docs/HistoryReferenceGroup.md +18 -5
  77. data/docs/HistoryReferenceIteration.md +20 -6
  78. data/docs/HistoryReferenceLabel.md +20 -6
  79. data/docs/HistoryReferenceProject.md +20 -6
  80. data/docs/HistoryReferenceStory.md +22 -7
  81. data/docs/HistoryReferenceStoryTask.md +18 -5
  82. data/docs/HistoryReferenceWorkflowState.md +20 -6
  83. data/docs/Icon.md +22 -7
  84. data/docs/Identity.md +18 -5
  85. data/docs/Iteration.md +48 -20
  86. data/docs/IterationSlim.md +46 -19
  87. data/docs/IterationStats.md +34 -13
  88. data/docs/Label.md +34 -13
  89. data/docs/LabelSlim.md +32 -12
  90. data/docs/LabelStats.md +42 -17
  91. data/docs/LinkedFile.md +44 -18
  92. data/docs/ListEpics.md +14 -3
  93. data/docs/ListGroupStories.md +16 -4
  94. data/docs/ListLabels.md +14 -3
  95. data/docs/ListMembers.md +14 -3
  96. data/docs/MaxSearchResultsExceededError.md +18 -5
  97. data/docs/Member.md +34 -13
  98. data/docs/MemberInfo.md +20 -6
  99. data/docs/Milestone.md +46 -19
  100. data/docs/MilestoneStats.md +18 -5
  101. data/docs/Profile.md +30 -11
  102. data/docs/Project.md +50 -21
  103. data/docs/ProjectStats.md +18 -5
  104. data/docs/PullRequest.md +56 -24
  105. data/docs/PullRequestLabel.md +22 -7
  106. data/docs/Repository.md +30 -11
  107. data/docs/Search.md +20 -6
  108. data/docs/SearchResults.md +16 -4
  109. data/docs/SearchStories.md +68 -30
  110. data/docs/Story.md +112 -52
  111. data/docs/StoryComment.md +40 -16
  112. data/docs/StoryContents.md +50 -21
  113. data/docs/StoryContentsTask.md +22 -7
  114. data/docs/StoryHistoryChangeAddsRemovesInt.md +16 -4
  115. data/docs/StoryHistoryChangeAddsRemovesUuid.md +16 -4
  116. data/docs/StoryHistoryChangeOldNewBool.md +16 -4
  117. data/docs/StoryHistoryChangeOldNewInt.md +16 -4
  118. data/docs/StoryHistoryChangeOldNewStr.md +16 -4
  119. data/docs/StoryHistoryChangeOldNewUuid.md +16 -4
  120. data/docs/StoryLink.md +28 -10
  121. data/docs/StoryReaction.md +16 -4
  122. data/docs/StorySearchResults.md +20 -6
  123. data/docs/StorySlim.md +108 -50
  124. data/docs/StoryStats.md +14 -3
  125. data/docs/Task.md +40 -16
  126. data/docs/ThreadedComment.md +38 -15
  127. data/docs/TypedStoryLink.md +30 -11
  128. data/docs/UnusableEntitlementError.md +18 -5
  129. data/docs/UpdateCategory.md +18 -5
  130. data/docs/UpdateComment.md +14 -3
  131. data/docs/UpdateEntityTemplate.md +16 -4
  132. data/docs/UpdateEpic.md +46 -19
  133. data/docs/UpdateFile.md +24 -8
  134. data/docs/UpdateGroup.md +30 -11
  135. data/docs/UpdateIteration.md +26 -9
  136. data/docs/UpdateLabel.md +20 -6
  137. data/docs/UpdateLinkedFile.md +28 -10
  138. data/docs/UpdateMilestone.md +28 -10
  139. data/docs/UpdateProject.md +30 -11
  140. data/docs/UpdateStories.md +54 -23
  141. data/docs/UpdateStory.md +64 -28
  142. data/docs/UpdateStoryComment.md +14 -3
  143. data/docs/UpdateStoryContents.md +54 -23
  144. data/docs/UpdateStoryLink.md +18 -5
  145. data/docs/UpdateTask.md +22 -7
  146. data/docs/UploadedFile.md +46 -19
  147. data/docs/Workflow.md +34 -13
  148. data/docs/WorkflowState.md +36 -14
  149. data/git_push.sh +11 -9
  150. data/lib/shortcut_client_ruby/api/default_api.rb +2119 -1248
  151. data/lib/shortcut_client_ruby/api_client.rb +143 -106
  152. data/lib/shortcut_client_ruby/api_error.rb +4 -4
  153. data/lib/shortcut_client_ruby/configuration.rb +163 -32
  154. data/lib/shortcut_client_ruby/models/basic_workspace_info.rb +26 -13
  155. data/lib/shortcut_client_ruby/models/branch.rb +35 -42
  156. data/lib/shortcut_client_ruby/models/category.rb +57 -28
  157. data/lib/shortcut_client_ruby/models/commit.rb +37 -44
  158. data/lib/shortcut_client_ruby/models/create_category.rb +90 -17
  159. data/lib/shortcut_client_ruby/models/create_category_params.rb +87 -14
  160. data/lib/shortcut_client_ruby/models/create_comment_comment.rb +57 -16
  161. data/lib/shortcut_client_ruby/models/create_entity_template.rb +46 -14
  162. data/lib/shortcut_client_ruby/models/create_epic.rb +86 -30
  163. data/lib/shortcut_client_ruby/models/create_epic_comment.rb +57 -16
  164. data/lib/shortcut_client_ruby/models/create_group.rb +104 -21
  165. data/lib/shortcut_client_ruby/models/create_iteration.rb +103 -18
  166. data/lib/shortcut_client_ruby/models/create_label_params.rb +97 -15
  167. data/lib/shortcut_client_ruby/models/create_linked_file.rb +110 -22
  168. data/lib/shortcut_client_ruby/models/create_milestone.rb +75 -19
  169. data/lib/shortcut_client_ruby/models/create_or_delete_story_reaction.rb +25 -12
  170. data/lib/shortcut_client_ruby/models/create_project.rb +104 -22
  171. data/lib/shortcut_client_ruby/models/create_stories.rb +25 -12
  172. data/lib/shortcut_client_ruby/models/create_story_comment.rb +48 -16
  173. data/lib/shortcut_client_ruby/models/create_story_comment_params.rb +48 -16
  174. data/lib/shortcut_client_ruby/models/create_story_contents.rb +57 -32
  175. data/lib/shortcut_client_ruby/models/create_story_link.rb +29 -16
  176. data/lib/shortcut_client_ruby/models/create_story_link_params.rb +29 -16
  177. data/lib/shortcut_client_ruby/models/create_story_params.rb +120 -40
  178. data/lib/shortcut_client_ruby/models/create_task.rb +30 -17
  179. data/lib/shortcut_client_ruby/models/create_task_params.rb +30 -17
  180. data/lib/shortcut_client_ruby/models/delete_stories.rb +35 -12
  181. data/lib/shortcut_client_ruby/models/entity_template.rb +32 -19
  182. data/lib/shortcut_client_ruby/models/entity_template_task.rb +28 -15
  183. data/lib/shortcut_client_ruby/models/epic.rb +62 -124
  184. data/lib/shortcut_client_ruby/models/epic_search_results.rb +28 -20
  185. data/lib/shortcut_client_ruby/models/epic_slim.rb +61 -123
  186. data/lib/shortcut_client_ruby/models/epic_state.rb +59 -20
  187. data/lib/shortcut_client_ruby/models/epic_stats.rb +37 -29
  188. data/lib/shortcut_client_ruby/models/epic_workflow.rb +30 -17
  189. data/lib/shortcut_client_ruby/models/get_epic_stories.rb +25 -12
  190. data/lib/shortcut_client_ruby/models/get_external_link_stories_params.rb +55 -12
  191. data/lib/shortcut_client_ruby/models/get_iteration_stories.rb +25 -12
  192. data/lib/shortcut_client_ruby/models/get_label_stories.rb +25 -12
  193. data/lib/shortcut_client_ruby/models/get_member.rb +25 -12
  194. data/lib/shortcut_client_ruby/models/get_project_stories.rb +25 -12
  195. data/lib/shortcut_client_ruby/models/group.rb +96 -37
  196. data/lib/shortcut_client_ruby/models/history.rb +35 -22
  197. data/lib/shortcut_client_ruby/models/history_action_branch_create.rb +31 -18
  198. data/lib/shortcut_client_ruby/models/history_action_branch_merge.rb +31 -18
  199. data/lib/shortcut_client_ruby/models/history_action_branch_push.rb +31 -18
  200. data/lib/shortcut_client_ruby/models/history_action_label_create.rb +61 -18
  201. data/lib/shortcut_client_ruby/models/history_action_label_delete.rb +30 -17
  202. data/lib/shortcut_client_ruby/models/history_action_label_update.rb +29 -16
  203. data/lib/shortcut_client_ruby/models/history_action_project_update.rb +61 -18
  204. data/lib/shortcut_client_ruby/models/history_action_pull_request.rb +62 -19
  205. data/lib/shortcut_client_ruby/models/history_action_story_comment_create.rb +62 -19
  206. data/lib/shortcut_client_ruby/models/history_action_story_create.rb +82 -39
  207. data/lib/shortcut_client_ruby/models/history_action_story_delete.rb +33 -20
  208. data/lib/shortcut_client_ruby/models/history_action_story_link_create.rb +34 -21
  209. data/lib/shortcut_client_ruby/models/history_action_story_link_delete.rb +34 -31
  210. data/lib/shortcut_client_ruby/models/history_action_story_link_update.rb +35 -22
  211. data/lib/shortcut_client_ruby/models/history_action_story_update.rb +65 -22
  212. data/lib/shortcut_client_ruby/models/history_action_task_create.rb +35 -22
  213. data/lib/shortcut_client_ruby/models/history_action_task_delete.rb +30 -17
  214. data/lib/shortcut_client_ruby/models/history_action_task_update.rb +33 -20
  215. data/lib/shortcut_client_ruby/models/history_changes_story.rb +48 -35
  216. data/lib/shortcut_client_ruby/models/history_changes_story_link.rb +27 -14
  217. data/lib/shortcut_client_ruby/models/history_changes_task.rb +28 -15
  218. data/lib/shortcut_client_ruby/models/history_reference_branch.rb +58 -15
  219. data/lib/shortcut_client_ruby/models/history_reference_commit.rb +58 -15
  220. data/lib/shortcut_client_ruby/models/history_reference_epic.rb +58 -15
  221. data/lib/shortcut_client_ruby/models/history_reference_general.rb +27 -14
  222. data/lib/shortcut_client_ruby/models/history_reference_group.rb +27 -14
  223. data/lib/shortcut_client_ruby/models/history_reference_iteration.rb +58 -15
  224. data/lib/shortcut_client_ruby/models/history_reference_label.rb +58 -15
  225. data/lib/shortcut_client_ruby/models/history_reference_project.rb +58 -15
  226. data/lib/shortcut_client_ruby/models/history_reference_story.rb +61 -18
  227. data/lib/shortcut_client_ruby/models/history_reference_story_task.rb +27 -14
  228. data/lib/shortcut_client_ruby/models/history_reference_workflow_state.rb +30 -17
  229. data/lib/shortcut_client_ruby/models/icon.rb +29 -16
  230. data/lib/shortcut_client_ruby/models/identity.rb +27 -24
  231. data/lib/shortcut_client_ruby/models/iteration.rb +42 -29
  232. data/lib/shortcut_client_ruby/models/iteration_slim.rb +41 -28
  233. data/lib/shortcut_client_ruby/models/iteration_stats.rb +35 -22
  234. data/lib/shortcut_client_ruby/models/label.rb +59 -45
  235. data/lib/shortcut_client_ruby/models/label_slim.rb +58 -44
  236. data/lib/shortcut_client_ruby/models/label_stats.rb +39 -26
  237. data/lib/shortcut_client_ruby/models/linked_file.rb +40 -47
  238. data/lib/shortcut_client_ruby/models/list_epics.rb +25 -12
  239. data/lib/shortcut_client_ruby/models/list_group_stories.rb +26 -13
  240. data/lib/shortcut_client_ruby/models/list_labels.rb +25 -12
  241. data/lib/shortcut_client_ruby/models/list_members.rb +25 -12
  242. data/lib/shortcut_client_ruby/models/max_search_results_exceeded_error.rb +31 -18
  243. data/lib/shortcut_client_ruby/models/member.rb +37 -34
  244. data/lib/shortcut_client_ruby/models/member_info.rb +28 -15
  245. data/lib/shortcut_client_ruby/models/milestone.rb +41 -48
  246. data/lib/shortcut_client_ruby/models/milestone_stats.rb +27 -14
  247. data/lib/shortcut_client_ruby/models/profile.rb +33 -35
  248. data/lib/shortcut_client_ruby/models/project.rb +67 -58
  249. data/lib/shortcut_client_ruby/models/project_stats.rb +27 -14
  250. data/lib/shortcut_client_ruby/models/pull_request.rb +46 -43
  251. data/lib/shortcut_client_ruby/models/pull_request_label.rb +59 -16
  252. data/lib/shortcut_client_ruby/models/repository.rb +33 -55
  253. data/lib/shortcut_client_ruby/models/search.rb +49 -17
  254. data/lib/shortcut_client_ruby/models/search_results.rb +26 -13
  255. data/lib/shortcut_client_ruby/models/search_stories.rb +105 -41
  256. data/lib/shortcut_client_ruby/models/story.rb +74 -131
  257. data/lib/shortcut_client_ruby/models/story_comment.rb +38 -40
  258. data/lib/shortcut_client_ruby/models/story_contents.rb +43 -30
  259. data/lib/shortcut_client_ruby/models/story_contents_task.rb +29 -16
  260. data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_int.rb +26 -13
  261. data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_uuid.rb +26 -13
  262. data/lib/shortcut_client_ruby/models/story_history_change_old_new_bool.rb +26 -13
  263. data/lib/shortcut_client_ruby/models/story_history_change_old_new_int.rb +26 -13
  264. data/lib/shortcut_client_ruby/models/story_history_change_old_new_str.rb +26 -13
  265. data/lib/shortcut_client_ruby/models/story_history_change_old_new_uuid.rb +26 -13
  266. data/lib/shortcut_client_ruby/models/story_link.rb +32 -19
  267. data/lib/shortcut_client_ruby/models/story_reaction.rb +26 -13
  268. data/lib/shortcut_client_ruby/models/story_search_results.rb +28 -20
  269. data/lib/shortcut_client_ruby/models/story_slim.rb +72 -129
  270. data/lib/shortcut_client_ruby/models/story_stats.rb +25 -12
  271. data/lib/shortcut_client_ruby/models/task.rb +38 -40
  272. data/lib/shortcut_client_ruby/models/threaded_comment.rb +37 -29
  273. data/lib/shortcut_client_ruby/models/typed_story_link.rb +33 -20
  274. data/lib/shortcut_client_ruby/models/unusable_entitlement_error.rb +85 -16
  275. data/lib/shortcut_client_ruby/models/update_category.rb +68 -14
  276. data/lib/shortcut_client_ruby/models/update_comment.rb +25 -12
  277. data/lib/shortcut_client_ruby/models/update_entity_template.rb +41 -13
  278. data/lib/shortcut_client_ruby/models/update_epic.rb +82 -30
  279. data/lib/shortcut_client_ruby/models/update_file.rb +54 -17
  280. data/lib/shortcut_client_ruby/models/update_group.rb +97 -22
  281. data/lib/shortcut_client_ruby/models/update_iteration.rb +91 -18
  282. data/lib/shortcut_client_ruby/models/update_label.rb +78 -15
  283. data/lib/shortcut_client_ruby/models/update_linked_file.rb +101 -21
  284. data/lib/shortcut_client_ruby/models/update_milestone.rb +73 -21
  285. data/lib/shortcut_client_ruby/models/update_project.rb +98 -20
  286. data/lib/shortcut_client_ruby/models/update_stories.rb +83 -36
  287. data/lib/shortcut_client_ruby/models/update_story.rb +135 -41
  288. data/lib/shortcut_client_ruby/models/update_story_comment.rb +44 -12
  289. data/lib/shortcut_client_ruby/models/update_story_contents.rb +57 -32
  290. data/lib/shortcut_client_ruby/models/update_story_link.rb +29 -16
  291. data/lib/shortcut_client_ruby/models/update_task.rb +29 -16
  292. data/lib/shortcut_client_ruby/models/uploaded_file.rb +41 -53
  293. data/lib/shortcut_client_ruby/models/workflow.rb +35 -22
  294. data/lib/shortcut_client_ruby/models/workflow_state.rb +60 -26
  295. data/lib/shortcut_client_ruby/version.rb +5 -4
  296. data/lib/shortcut_client_ruby.rb +4 -4
  297. data/openapi-generator-cli.jar +0 -0
  298. data/shortcut_client_ruby-0.0.4.gem +0 -0
  299. data/shortcut_client_ruby.gemspec +7 -6
  300. data/spec/api/default_api_spec.rb +64 -63
  301. data/spec/api_client_spec.rb +7 -44
  302. data/spec/configuration_spec.rb +7 -6
  303. data/spec/models/basic_workspace_info_spec.rb +8 -14
  304. data/spec/models/branch_spec.rb +8 -14
  305. data/spec/models/category_spec.rb +8 -14
  306. data/spec/models/commit_spec.rb +8 -14
  307. data/spec/models/create_category_params_spec.rb +8 -14
  308. data/spec/models/create_category_spec.rb +9 -15
  309. data/spec/models/create_comment_comment_spec.rb +8 -14
  310. data/spec/models/create_entity_template_spec.rb +8 -14
  311. data/spec/models/create_epic_comment_spec.rb +8 -14
  312. data/spec/models/create_epic_spec.rb +9 -15
  313. data/spec/models/create_group_spec.rb +9 -15
  314. data/spec/models/create_iteration_spec.rb +8 -14
  315. data/spec/models/create_label_params_spec.rb +8 -14
  316. data/spec/models/create_linked_file_spec.rb +9 -15
  317. data/spec/models/create_milestone_spec.rb +9 -15
  318. data/spec/models/create_or_delete_story_reaction_spec.rb +8 -14
  319. data/spec/models/create_project_spec.rb +8 -14
  320. data/spec/models/create_stories_spec.rb +8 -14
  321. data/spec/models/create_story_comment_params_spec.rb +8 -14
  322. data/spec/models/create_story_comment_spec.rb +8 -14
  323. data/spec/models/create_story_contents_spec.rb +8 -14
  324. data/spec/models/create_story_link_params_spec.rb +9 -15
  325. data/spec/models/create_story_link_spec.rb +9 -15
  326. data/spec/models/create_story_params_spec.rb +9 -15
  327. data/spec/models/create_task_params_spec.rb +8 -14
  328. data/spec/models/create_task_spec.rb +8 -14
  329. data/spec/models/delete_stories_spec.rb +8 -14
  330. data/spec/models/entity_template_spec.rb +8 -14
  331. data/spec/models/entity_template_task_spec.rb +8 -14
  332. data/spec/models/epic_search_results_spec.rb +8 -14
  333. data/spec/models/epic_slim_spec.rb +8 -14
  334. data/spec/models/epic_spec.rb +8 -14
  335. data/spec/models/epic_state_spec.rb +8 -14
  336. data/spec/models/epic_stats_spec.rb +8 -14
  337. data/spec/models/epic_workflow_spec.rb +8 -14
  338. data/spec/models/get_epic_stories_spec.rb +8 -14
  339. data/spec/models/get_external_link_stories_params_spec.rb +8 -14
  340. data/spec/models/get_iteration_stories_spec.rb +8 -14
  341. data/spec/models/get_label_stories_spec.rb +8 -14
  342. data/spec/models/get_member_spec.rb +8 -14
  343. data/spec/models/get_project_stories_spec.rb +8 -14
  344. data/spec/models/group_spec.rb +9 -15
  345. data/spec/models/history_action_branch_create_spec.rb +9 -15
  346. data/spec/models/history_action_branch_merge_spec.rb +9 -15
  347. data/spec/models/history_action_branch_push_spec.rb +9 -15
  348. data/spec/models/history_action_label_create_spec.rb +9 -15
  349. data/spec/models/history_action_label_delete_spec.rb +9 -15
  350. data/spec/models/history_action_label_update_spec.rb +9 -15
  351. data/spec/models/history_action_project_update_spec.rb +9 -15
  352. data/spec/models/history_action_pull_request_spec.rb +9 -15
  353. data/spec/models/history_action_story_comment_create_spec.rb +9 -15
  354. data/spec/models/history_action_story_create_spec.rb +10 -16
  355. data/spec/models/history_action_story_delete_spec.rb +10 -16
  356. data/spec/models/history_action_story_link_create_spec.rb +10 -16
  357. data/spec/models/history_action_story_link_delete_spec.rb +10 -16
  358. data/spec/models/history_action_story_link_update_spec.rb +10 -16
  359. data/spec/models/history_action_story_update_spec.rb +10 -16
  360. data/spec/models/history_action_task_create_spec.rb +9 -15
  361. data/spec/models/history_action_task_delete_spec.rb +9 -15
  362. data/spec/models/history_action_task_update_spec.rb +9 -15
  363. data/spec/models/history_changes_story_link_spec.rb +8 -14
  364. data/spec/models/history_changes_story_spec.rb +8 -14
  365. data/spec/models/history_changes_task_spec.rb +8 -14
  366. data/spec/models/history_reference_branch_spec.rb +8 -14
  367. data/spec/models/history_reference_commit_spec.rb +8 -14
  368. data/spec/models/history_reference_epic_spec.rb +8 -14
  369. data/spec/models/history_reference_general_spec.rb +8 -14
  370. data/spec/models/history_reference_group_spec.rb +8 -14
  371. data/spec/models/history_reference_iteration_spec.rb +8 -14
  372. data/spec/models/history_reference_label_spec.rb +8 -14
  373. data/spec/models/history_reference_project_spec.rb +8 -14
  374. data/spec/models/history_reference_story_spec.rb +9 -15
  375. data/spec/models/history_reference_story_task_spec.rb +8 -14
  376. data/spec/models/history_reference_workflow_state_spec.rb +9 -15
  377. data/spec/models/history_spec.rb +9 -15
  378. data/spec/models/icon_spec.rb +8 -14
  379. data/spec/models/identity_spec.rb +8 -14
  380. data/spec/models/iteration_slim_spec.rb +8 -14
  381. data/spec/models/iteration_spec.rb +8 -14
  382. data/spec/models/iteration_stats_spec.rb +8 -14
  383. data/spec/models/label_slim_spec.rb +8 -14
  384. data/spec/models/label_spec.rb +8 -14
  385. data/spec/models/label_stats_spec.rb +8 -14
  386. data/spec/models/linked_file_spec.rb +8 -14
  387. data/spec/models/list_epics_spec.rb +8 -14
  388. data/spec/models/list_group_stories_spec.rb +8 -14
  389. data/spec/models/list_labels_spec.rb +8 -14
  390. data/spec/models/list_members_spec.rb +8 -14
  391. data/spec/models/max_search_results_exceeded_error_spec.rb +11 -17
  392. data/spec/models/member_info_spec.rb +8 -14
  393. data/spec/models/member_spec.rb +9 -15
  394. data/spec/models/milestone_spec.rb +8 -14
  395. data/spec/models/milestone_stats_spec.rb +8 -14
  396. data/spec/models/profile_spec.rb +8 -14
  397. data/spec/models/project_spec.rb +8 -14
  398. data/spec/models/project_stats_spec.rb +8 -14
  399. data/spec/models/pull_request_label_spec.rb +8 -14
  400. data/spec/models/pull_request_spec.rb +8 -14
  401. data/spec/models/repository_spec.rb +8 -14
  402. data/spec/models/search_results_spec.rb +8 -14
  403. data/spec/models/search_spec.rb +9 -15
  404. data/spec/models/search_stories_spec.rb +10 -16
  405. data/spec/models/story_comment_spec.rb +8 -14
  406. data/spec/models/story_contents_spec.rb +8 -14
  407. data/spec/models/story_contents_task_spec.rb +8 -14
  408. data/spec/models/story_history_change_adds_removes_int_spec.rb +8 -14
  409. data/spec/models/story_history_change_adds_removes_uuid_spec.rb +8 -14
  410. data/spec/models/story_history_change_old_new_bool_spec.rb +8 -14
  411. data/spec/models/story_history_change_old_new_int_spec.rb +8 -14
  412. data/spec/models/story_history_change_old_new_str_spec.rb +8 -14
  413. data/spec/models/story_history_change_old_new_uuid_spec.rb +8 -14
  414. data/spec/models/story_link_spec.rb +8 -14
  415. data/spec/models/story_reaction_spec.rb +8 -14
  416. data/spec/models/story_search_results_spec.rb +8 -14
  417. data/spec/models/story_slim_spec.rb +8 -14
  418. data/spec/models/story_spec.rb +8 -14
  419. data/spec/models/story_stats_spec.rb +8 -14
  420. data/spec/models/task_spec.rb +8 -14
  421. data/spec/models/threaded_comment_spec.rb +8 -14
  422. data/spec/models/typed_story_link_spec.rb +8 -14
  423. data/spec/models/unusable_entitlement_error_spec.rb +9 -15
  424. data/spec/models/update_category_spec.rb +8 -14
  425. data/spec/models/update_comment_spec.rb +8 -14
  426. data/spec/models/update_entity_template_spec.rb +8 -14
  427. data/spec/models/update_epic_spec.rb +9 -15
  428. data/spec/models/update_file_spec.rb +8 -14
  429. data/spec/models/update_group_spec.rb +9 -15
  430. data/spec/models/update_iteration_spec.rb +8 -14
  431. data/spec/models/update_label_spec.rb +8 -14
  432. data/spec/models/update_linked_file_spec.rb +9 -15
  433. data/spec/models/update_milestone_spec.rb +9 -15
  434. data/spec/models/update_project_spec.rb +8 -14
  435. data/spec/models/update_stories_spec.rb +10 -16
  436. data/spec/models/update_story_comment_spec.rb +8 -14
  437. data/spec/models/update_story_contents_spec.rb +8 -14
  438. data/spec/models/update_story_link_spec.rb +9 -15
  439. data/spec/models/update_story_spec.rb +10 -16
  440. data/spec/models/update_task_spec.rb +8 -14
  441. data/spec/models/uploaded_file_spec.rb +8 -14
  442. data/spec/models/workflow_spec.rb +8 -14
  443. data/spec/models/workflow_state_spec.rb +8 -14
  444. data/spec/spec_helper.rb +4 -3
  445. metadata +18 -30
  446. data/docs/V3FilesBody.md +0 -11
  447. data/lib/shortcut/client/ruby/version.rb +0 -9
  448. data/lib/shortcut/client/ruby.rb +0 -12
  449. data/lib/shortcut_client_ruby/models/v3_files_body.rb +0 -252
  450. data/shortcut-client-ruby.gemspec +0 -36
  451. data/spec/base_object_spec.rb +0 -109
  452. data/spec/models/v3_files_body_spec.rb +0 -64
data/docs/PullRequest.md CHANGED
@@ -1,28 +1,60 @@
1
1
  # Shortcut::PullRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **entity_type** | **String** | A string description of this resource. |
7
- **closed** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request has been closed. |
8
- **merged** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request has been merged. |
9
- **num_added** | **Integer** | Number of lines added in the pull request, according to VCS. |
10
- **branch_id** | **Integer** | The ID of the branch for the particular pull request. |
11
- **number** | **Integer** | The pull request's unique number ID in VCS. |
12
- **branch_name** | **String** | The name of the branch for the particular pull request. |
13
- **target_branch_name** | **String** | The name of the target branch for the particular pull request. |
14
- **num_commits** | **Integer** | The number of commits on the pull request. |
15
- **title** | **String** | The title of the pull request. |
16
- **updated_at** | **DateTime** | The time/date the pull request was created. |
17
- **draft** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request is in the draft state. |
18
- **id** | **Integer** | The unique ID associated with the pull request in Shortcut. |
19
- **vcs_labels** | [**Array<PullRequestLabel>**](PullRequestLabel.md) | An array of PullRequestLabels attached to the PullRequest. | [optional]
20
- **url** | **String** | The URL for the pull request. |
21
- **num_removed** | **Integer** | Number of lines removed in the pull request, according to VCS. |
22
- **review_status** | **String** | The status of the review for the pull request. | [optional]
23
- **num_modified** | **Integer** | Number of lines modified in the pull request, according to VCS. |
24
- **build_status** | **String** | The status of the Continuous Integration workflow for the pull request. | [optional]
25
- **target_branch_id** | **Integer** | The ID of the target branch for the particular pull request. |
26
- **repository_id** | **Integer** | The ID of the repository for the particular pull request. |
27
- **created_at** | **DateTime** | The time/date the pull request was created. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **entity_type** | **String** | A string description of this resource. | |
8
+ | **closed** | **Boolean** | True/False boolean indicating whether the VCS pull request has been closed. | |
9
+ | **merged** | **Boolean** | True/False boolean indicating whether the VCS pull request has been merged. | |
10
+ | **num_added** | **Integer** | Number of lines added in the pull request, according to VCS. | |
11
+ | **branch_id** | **Integer** | The ID of the branch for the particular pull request. | |
12
+ | **number** | **Integer** | The pull request's unique number ID in VCS. | |
13
+ | **branch_name** | **String** | The name of the branch for the particular pull request. | |
14
+ | **target_branch_name** | **String** | The name of the target branch for the particular pull request. | |
15
+ | **num_commits** | **Integer** | The number of commits on the pull request. | |
16
+ | **title** | **String** | The title of the pull request. | |
17
+ | **updated_at** | **Time** | The time/date the pull request was created. | |
18
+ | **draft** | **Boolean** | True/False boolean indicating whether the VCS pull request is in the draft state. | |
19
+ | **id** | **Integer** | The unique ID associated with the pull request in Shortcut. | |
20
+ | **vcs_labels** | [**Array<PullRequestLabel>**](PullRequestLabel.md) | An array of PullRequestLabels attached to the PullRequest. | [optional] |
21
+ | **url** | **String** | The URL for the pull request. | |
22
+ | **num_removed** | **Integer** | Number of lines removed in the pull request, according to VCS. | |
23
+ | **review_status** | **String** | The status of the review for the pull request. | [optional] |
24
+ | **num_modified** | **Integer** | Number of lines modified in the pull request, according to VCS. | |
25
+ | **build_status** | **String** | The status of the Continuous Integration workflow for the pull request. | [optional] |
26
+ | **target_branch_id** | **Integer** | The ID of the target branch for the particular pull request. | |
27
+ | **repository_id** | **Integer** | The ID of the repository for the particular pull request. | |
28
+ | **created_at** | **Time** | The time/date the pull request was created. | |
29
+
30
+ ## Example
31
+
32
+ ```ruby
33
+ require 'shortcut_client_ruby'
34
+
35
+ instance = Shortcut::PullRequest.new(
36
+ entity_type: null,
37
+ closed: null,
38
+ merged: null,
39
+ num_added: null,
40
+ branch_id: null,
41
+ number: null,
42
+ branch_name: null,
43
+ target_branch_name: null,
44
+ num_commits: null,
45
+ title: null,
46
+ updated_at: null,
47
+ draft: null,
48
+ id: null,
49
+ vcs_labels: null,
50
+ url: null,
51
+ num_removed: null,
52
+ review_status: null,
53
+ num_modified: null,
54
+ build_status: null,
55
+ target_branch_id: null,
56
+ repository_id: null,
57
+ created_at: null
58
+ )
59
+ ```
28
60
 
data/docs/PullRequestLabel.md CHANGED
@@ -1,11 +1,26 @@
1
1
  # Shortcut::PullRequestLabel
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **entity_type** | **String** | A string description of this resource. |
7
- **id** | **Integer** | The unique ID of the VCS Label. |
8
- **color** | **String** | The color of the VCS label. |
9
- **description** | **String** | The description of the VCS label. | [optional]
10
- **name** | **String** | The name of the VCS label. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **entity_type** | **String** | A string description of this resource. | |
8
+ | **id** | **Integer** | The unique ID of the VCS Label. | |
9
+ | **color** | **String** | The color of the VCS label. | |
10
+ | **description** | **String** | The description of the VCS label. | [optional] |
11
+ | **name** | **String** | The name of the VCS label. | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'shortcut_client_ruby'
17
+
18
+ instance = Shortcut::PullRequestLabel.new(
19
+ entity_type: null,
20
+ id: null,
21
+ color: null,
22
+ description: null,
23
+ name: null
24
+ )
25
+ ```
11
26
 
data/docs/Repository.md CHANGED
@@ -1,15 +1,34 @@
1
1
  # Shortcut::Repository
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **entity_type** | **String** | A string description of this resource. |
7
- **name** | **String** | The shorthand name of the VCS repository. |
8
- **type** | **String** | The type of Repository. Currently this can only be \"github\". |
9
- **updated_at** | **DateTime** | The time/date the Repository was updated. |
10
- **external_id** | **String** | The VCS unique identifier for the Repository. |
11
- **id** | **Integer** | The ID associated to the VCS repository in Shortcut. |
12
- **url** | **String** | The URL of the Repository. |
13
- **full_name** | **String** | The full name of the VCS repository. |
14
- **created_at** | **DateTime** | The time/date the Repository was created. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **entity_type** | **String** | A string description of this resource. | |
8
+ | **name** | **String** | The shorthand name of the VCS repository. | |
9
+ | **type** | **String** | The type of Repository. Currently this can only be \"github\". | |
10
+ | **updated_at** | **Time** | The time/date the Repository was updated. | |
11
+ | **external_id** | **String** | The VCS unique identifier for the Repository. | |
12
+ | **id** | **Integer** | The ID associated to the VCS repository in Shortcut. | |
13
+ | **url** | **String** | The URL of the Repository. | |
14
+ | **full_name** | **String** | The full name of the VCS repository. | |
15
+ | **created_at** | **Time** | The time/date the Repository was created. | |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'shortcut_client_ruby'
21
+
22
+ instance = Shortcut::Repository.new(
23
+ entity_type: null,
24
+ name: null,
25
+ type: null,
26
+ updated_at: null,
27
+ external_id: null,
28
+ id: null,
29
+ url: null,
30
+ full_name: null,
31
+ created_at: null
32
+ )
33
+ ```
15
34
 
data/docs/Search.md CHANGED
@@ -1,10 +1,24 @@
1
1
  # Shortcut::Search
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **query** | **String** | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) |
7
- **page_size** | **Integer** | The number of search results to include in a page. Minimum of 1 and maximum of 25. | [optional]
8
- **_next** | **String** | The next page token. | [optional]
9
- **include** | **String** | | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **query** | **String** | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | |
8
+ | **page_size** | **Integer** | The number of search results to include in a page. Minimum of 1 and maximum of 25. | [optional] |
9
+ | **_next** | **String** | The next page token. | [optional] |
10
+ | **include** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'shortcut_client_ruby'
16
+
17
+ instance = Shortcut::Search.new(
18
+ query: null,
19
+ page_size: null,
20
+ _next: null,
21
+ include: null
22
+ )
23
+ ```
10
24
 
data/docs/SearchResults.md CHANGED
@@ -1,8 +1,20 @@
1
1
  # Shortcut::SearchResults
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **epics** | [**EpicSearchResults**](EpicSearchResults.md) | |
7
- **stories** | [**StorySearchResults**](StorySearchResults.md) | |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **epics** | [**EpicSearchResults**](EpicSearchResults.md) | | |
8
+ | **stories** | [**StorySearchResults**](StorySearchResults.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'shortcut_client_ruby'
14
+
15
+ instance = Shortcut::SearchResults.new(
16
+ epics: null,
17
+ stories: null
18
+ )
19
+ ```
8
20
 
data/docs/SearchStories.md CHANGED
@@ -1,34 +1,72 @@
1
1
  # Shortcut::SearchStories
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **archived** | **BOOLEAN** | A true/false boolean indicating whether the Story is in archived state. | [optional]
7
- **owner_id** | **String** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional]
8
- **story_type** | **String** | The type of Stories that you want returned. | [optional]
9
- **epic_ids** | **Array<Integer>** | The Epic IDs that may be associated with the Stories. | [optional]
10
- **project_ids** | **Array<Integer>** | The IDs for the Projects the Stories may be assigned to. | [optional]
11
- **updated_at_end** | **DateTime** | Stories should have been updated before this date. | [optional]
12
- **completed_at_end** | **DateTime** | Stories should have been completed before this date. | [optional]
13
- **workflow_state_types** | **Array<String>** | The type of Workflow State the Stories may be in. | [optional]
14
- **deadline_end** | **DateTime** | Stories should have a deadline before this date. | [optional]
15
- **created_at_start** | **DateTime** | Stories should have been created after this date. | [optional]
16
- **epic_id** | **Integer** | The Epic IDs that may be associated with the Stories. | [optional]
17
- **label_name** | **String** | The name of any associated Labels. | [optional]
18
- **requested_by_id** | **String** | The UUID of any Users who may have requested the Stories. | [optional]
19
- **iteration_id** | **Integer** | The Iteration ID that may be associated with the Stories. | [optional]
20
- **label_ids** | **Array<Integer>** | The Label IDs that may be associated with the Stories. | [optional]
21
- **group_id** | **String** | The Group ID that is associated with the Stories | [optional]
22
- **workflow_state_id** | **Integer** | The unique IDs of the specific Workflow States that the Stories should be in. | [optional]
23
- **iteration_ids** | **Array<Integer>** | The Iteration IDs that may be associated with the Stories. | [optional]
24
- **created_at_end** | **DateTime** | Stories should have been created before this date. | [optional]
25
- **deadline_start** | **DateTime** | Stories should have a deadline after this date. | [optional]
26
- **group_ids** | **Array<String>** | The Group IDs that are associated with the Stories | [optional]
27
- **owner_ids** | **Array<String>** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional]
28
- **external_id** | **String** | An ID or URL that references an external resource. Useful during imports. | [optional]
29
- **includes_description** | **BOOLEAN** | Whether to include the story description in the response. | [optional]
30
- **estimate** | **Integer** | The number of estimate points associate with the Stories. | [optional]
31
- **project_id** | **Integer** | The IDs for the Projects the Stories may be assigned to. | [optional]
32
- **completed_at_start** | **DateTime** | Stories should have been competed after this date. | [optional]
33
- **updated_at_start** | **DateTime** | Stories should have been updated after this date. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **archived** | **Boolean** | A true/false boolean indicating whether the Story is in archived state. | [optional] |
8
+ | **owner_id** | **String** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional] |
9
+ | **story_type** | **String** | The type of Stories that you want returned. | [optional] |
10
+ | **epic_ids** | **Array<Integer>** | The Epic IDs that may be associated with the Stories. | [optional] |
11
+ | **project_ids** | **Array<Integer>** | The IDs for the Projects the Stories may be assigned to. | [optional] |
12
+ | **updated_at_end** | **Time** | Stories should have been updated before this date. | [optional] |
13
+ | **completed_at_end** | **Time** | Stories should have been completed before this date. | [optional] |
14
+ | **workflow_state_types** | **Array<String>** | The type of Workflow State the Stories may be in. | [optional] |
15
+ | **deadline_end** | **Time** | Stories should have a deadline before this date. | [optional] |
16
+ | **created_at_start** | **Time** | Stories should have been created after this date. | [optional] |
17
+ | **epic_id** | **Integer** | The Epic IDs that may be associated with the Stories. | [optional] |
18
+ | **label_name** | **String** | The name of any associated Labels. | [optional] |
19
+ | **requested_by_id** | **String** | The UUID of any Users who may have requested the Stories. | [optional] |
20
+ | **iteration_id** | **Integer** | The Iteration ID that may be associated with the Stories. | [optional] |
21
+ | **label_ids** | **Array<Integer>** | The Label IDs that may be associated with the Stories. | [optional] |
22
+ | **group_id** | **String** | The Group ID that is associated with the Stories | [optional] |
23
+ | **workflow_state_id** | **Integer** | The unique IDs of the specific Workflow States that the Stories should be in. | [optional] |
24
+ | **iteration_ids** | **Array<Integer>** | The Iteration IDs that may be associated with the Stories. | [optional] |
25
+ | **created_at_end** | **Time** | Stories should have been created before this date. | [optional] |
26
+ | **deadline_start** | **Time** | Stories should have a deadline after this date. | [optional] |
27
+ | **group_ids** | **Array<String>** | The Group IDs that are associated with the Stories | [optional] |
28
+ | **owner_ids** | **Array<String>** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional] |
29
+ | **external_id** | **String** | An ID or URL that references an external resource. Useful during imports. | [optional] |
30
+ | **includes_description** | **Boolean** | Whether to include the story description in the response. | [optional] |
31
+ | **estimate** | **Integer** | The number of estimate points associate with the Stories. | [optional] |
32
+ | **project_id** | **Integer** | The IDs for the Projects the Stories may be assigned to. | [optional] |
33
+ | **completed_at_start** | **Time** | Stories should have been competed after this date. | [optional] |
34
+ | **updated_at_start** | **Time** | Stories should have been updated after this date. | [optional] |
35
+
36
+ ## Example
37
+
38
+ ```ruby
39
+ require 'shortcut_client_ruby'
40
+
41
+ instance = Shortcut::SearchStories.new(
42
+ archived: null,
43
+ owner_id: null,
44
+ story_type: null,
45
+ epic_ids: null,
46
+ project_ids: null,
47
+ updated_at_end: null,
48
+ completed_at_end: null,
49
+ workflow_state_types: null,
50
+ deadline_end: null,
51
+ created_at_start: null,
52
+ epic_id: null,
53
+ label_name: null,
54
+ requested_by_id: null,
55
+ iteration_id: null,
56
+ label_ids: null,
57
+ group_id: null,
58
+ workflow_state_id: null,
59
+ iteration_ids: null,
60
+ created_at_end: null,
61
+ deadline_start: null,
62
+ group_ids: null,
63
+ owner_ids: null,
64
+ external_id: null,
65
+ includes_description: null,
66
+ estimate: null,
67
+ project_id: null,
68
+ completed_at_start: null,
69
+ updated_at_start: null
70
+ )
71
+ ```
34
72
 
data/docs/Story.md CHANGED
@@ -1,56 +1,116 @@
1
1
  # Shortcut::Story
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **app_url** | **String** | The Shortcut application url for the Story. |
7
- **description** | **String** | The description of the story. |
8
- **archived** | **BOOLEAN** | True if the story has been archived or not. |
9
- **started** | **BOOLEAN** | A true/false boolean indicating if the Story has been started. |
10
- **story_links** | [**Array<TypedStoryLink>**](TypedStoryLink.md) | An array of story links attached to the Story. |
11
- **entity_type** | **String** | A string description of this resource. |
12
- **labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of labels attached to the story. |
13
- **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. |
14
- **member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in the Story description. |
15
- **story_type** | **String** | The type of story (feature, bug, chore). |
16
- **linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. |
17
- **workflow_id** | **Integer** | The ID of the workflow the story belongs to. |
18
- **completed_at_override** | **DateTime** | A manual override for the time/date the Story was completed. |
19
- **started_at** | **DateTime** | The time/date the Story was started. |
20
- **completed_at** | **DateTime** | The time/date the Story was completed. |
21
- **name** | **String** | The name of the story. |
22
- **completed** | **BOOLEAN** | A true/false boolean indicating if the Story has been completed. |
23
- **comments** | [**Array<StoryComment>**](StoryComment.md) | An array of comments attached to the story. |
24
- **blocker** | **BOOLEAN** | A true/false boolean indicating if the Story is currently a blocker of another story. |
25
- **branches** | [**Array<Branch>**](Branch.md) | An array of Git branches attached to the story. |
26
- **epic_id** | **Integer** | The ID of the epic the story belongs to. |
27
- **story_template_id** | **String** | The ID of the story template used to create this story, or null if not created using a template. |
28
- **external_links** | **Array<String>** | An array of external links (strings) associated with a Story |
29
- **previous_iteration_ids** | **Array<Integer>** | The IDs of the iteration the story belongs to. |
30
- **requested_by_id** | **String** | The ID of the Member that requested the story. |
31
- **iteration_id** | **Integer** | The ID of the iteration the story belongs to. |
32
- **tasks** | [**Array<Task>**](Task.md) | An array of tasks connected to the story. |
33
- **label_ids** | **Array<Integer>** | An array of label ids attached to the story. |
34
- **started_at_override** | **DateTime** | A manual override for the time/date the Story was started. |
35
- **group_id** | **String** | The ID of the group associated with the story. |
36
- **workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. |
37
- **updated_at** | **DateTime** | The time/date the Story was updated. |
38
- **pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of Pull/Merge Requests attached to the story. |
39
- **group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. |
40
- **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. |
41
- **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. |
42
- **external_id** | **String** | This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. |
43
- **id** | **Integer** | The unique ID of the Story. |
44
- **lead_time** | **Integer** | The lead time (in seconds) of this story when complete. | [optional]
45
- **estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. |
46
- **commits** | [**Array<Commit>**](Commit.md) | An array of commits attached to the story. |
47
- **files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. |
48
- **position** | **Integer** | A number representing the position of the story in relation to every other story in the current project. |
49
- **blocked** | **BOOLEAN** | A true/false boolean indicating if the Story is currently blocked. |
50
- **project_id** | **Integer** | The ID of the project the story belongs to. |
51
- **deadline** | **DateTime** | The due date of the story. |
52
- **stats** | [**StoryStats**](StoryStats.md) | |
53
- **cycle_time** | **Integer** | The cycle time (in seconds) of this story when complete. | [optional]
54
- **created_at** | **DateTime** | The time/date the Story was created. |
55
- **moved_at** | **DateTime** | The time/date the Story was last changed workflow-state. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **app_url** | **String** | The Shortcut application url for the Story. | |
8
+ | **description** | **String** | The description of the story. | |
9
+ | **archived** | **Boolean** | True if the story has been archived or not. | |
10
+ | **started** | **Boolean** | A true/false boolean indicating if the Story has been started. | |
11
+ | **story_links** | [**Array<TypedStoryLink>**](TypedStoryLink.md) | An array of story links attached to the Story. | |
12
+ | **entity_type** | **String** | A string description of this resource. | |
13
+ | **labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of labels attached to the story. | |
14
+ | **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | |
15
+ | **member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in the Story description. | |
16
+ | **story_type** | **String** | The type of story (feature, bug, chore). | |
17
+ | **linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | |
18
+ | **workflow_id** | **Integer** | The ID of the workflow the story belongs to. | |
19
+ | **completed_at_override** | **Time** | A manual override for the time/date the Story was completed. | |
20
+ | **started_at** | **Time** | The time/date the Story was started. | |
21
+ | **completed_at** | **Time** | The time/date the Story was completed. | |
22
+ | **name** | **String** | The name of the story. | |
23
+ | **completed** | **Boolean** | A true/false boolean indicating if the Story has been completed. | |
24
+ | **comments** | [**Array<StoryComment>**](StoryComment.md) | An array of comments attached to the story. | |
25
+ | **blocker** | **Boolean** | A true/false boolean indicating if the Story is currently a blocker of another story. | |
26
+ | **branches** | [**Array<Branch>**](Branch.md) | An array of Git branches attached to the story. | |
27
+ | **epic_id** | **Integer** | The ID of the epic the story belongs to. | |
28
+ | **story_template_id** | **String** | The ID of the story template used to create this story, or null if not created using a template. | |
29
+ | **external_links** | **Array<String>** | An array of external links (strings) associated with a Story | |
30
+ | **previous_iteration_ids** | **Array<Integer>** | The IDs of the iteration the story belongs to. | |
31
+ | **requested_by_id** | **String** | The ID of the Member that requested the story. | |
32
+ | **iteration_id** | **Integer** | The ID of the iteration the story belongs to. | |
33
+ | **tasks** | [**Array<Task>**](Task.md) | An array of tasks connected to the story. | |
34
+ | **label_ids** | **Array<Integer>** | An array of label ids attached to the story. | |
35
+ | **started_at_override** | **Time** | A manual override for the time/date the Story was started. | |
36
+ | **group_id** | **String** | The ID of the group associated with the story. | |
37
+ | **workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | |
38
+ | **updated_at** | **Time** | The time/date the Story was updated. | |
39
+ | **pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of Pull/Merge Requests attached to the story. | |
40
+ | **group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | |
41
+ | **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | |
42
+ | **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | |
43
+ | **external_id** | **String** | This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. | |
44
+ | **id** | **Integer** | The unique ID of the Story. | |
45
+ | **lead_time** | **Integer** | The lead time (in seconds) of this story when complete. | [optional] |
46
+ | **estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | |
47
+ | **commits** | [**Array<Commit>**](Commit.md) | An array of commits attached to the story. | |
48
+ | **files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | |
49
+ | **position** | **Integer** | A number representing the position of the story in relation to every other story in the current project. | |
50
+ | **blocked** | **Boolean** | A true/false boolean indicating if the Story is currently blocked. | |
51
+ | **project_id** | **Integer** | The ID of the project the story belongs to. | |
52
+ | **deadline** | **Time** | The due date of the story. | |
53
+ | **stats** | [**StoryStats**](StoryStats.md) | | |
54
+ | **cycle_time** | **Integer** | The cycle time (in seconds) of this story when complete. | [optional] |
55
+ | **created_at** | **Time** | The time/date the Story was created. | |
56
+ | **moved_at** | **Time** | The time/date the Story was last changed workflow-state. | |
57
+
58
+ ## Example
59
+
60
+ ```ruby
61
+ require 'shortcut_client_ruby'
62
+
63
+ instance = Shortcut::Story.new(
64
+ app_url: null,
65
+ description: null,
66
+ archived: null,
67
+ started: null,
68
+ story_links: null,
69
+ entity_type: null,
70
+ labels: null,
71
+ mention_ids: null,
72
+ member_mention_ids: null,
73
+ story_type: null,
74
+ linked_files: null,
75
+ workflow_id: null,
76
+ completed_at_override: null,
77
+ started_at: null,
78
+ completed_at: null,
79
+ name: null,
80
+ completed: null,
81
+ comments: null,
82
+ blocker: null,
83
+ branches: null,
84
+ epic_id: null,
85
+ story_template_id: null,
86
+ external_links: null,
87
+ previous_iteration_ids: null,
88
+ requested_by_id: null,
89
+ iteration_id: null,
90
+ tasks: null,
91
+ label_ids: null,
92
+ started_at_override: null,
93
+ group_id: null,
94
+ workflow_state_id: null,
95
+ updated_at: null,
96
+ pull_requests: null,
97
+ group_mention_ids: null,
98
+ follower_ids: null,
99
+ owner_ids: null,
100
+ external_id: null,
101
+ id: null,
102
+ lead_time: null,
103
+ estimate: null,
104
+ commits: null,
105
+ files: null,
106
+ position: null,
107
+ blocked: null,
108
+ project_id: null,
109
+ deadline: null,
110
+ stats: null,
111
+ cycle_time: null,
112
+ created_at: null,
113
+ moved_at: null
114
+ )
115
+ ```
56
116
 
data/docs/StoryComment.md CHANGED
@@ -1,20 +1,44 @@
1
1
  # Shortcut::StoryComment
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **app_url** | **String** | The Shortcut application url for the Comment. |
7
- **entity_type** | **String** | A string description of this resource. |
8
- **story_id** | **Integer** | The ID of the Story on which the Comment appears. |
9
- **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. |
10
- **author_id** | **String** | The unique ID of the Member who is the Comment's author. |
11
- **member_mention_ids** | **Array<String>** | The unique IDs of the Member who are mentioned in the Comment. |
12
- **updated_at** | **DateTime** | The time/date when the Comment was updated. |
13
- **group_mention_ids** | **Array<String>** | The unique IDs of the Group who are mentioned in the Comment. |
14
- **external_id** | **String** | This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. |
15
- **id** | **Integer** | The unique ID of the Comment. |
16
- **position** | **Integer** | The Comments numerical position in the list from oldest to newest. |
17
- **reactions** | [**Array<StoryReaction>**](StoryReaction.md) | A set of Reactions to this Comment. |
18
- **created_at** | **DateTime** | The time/date when the Comment was created. |
19
- **text** | **String** | The text of the Comment. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **app_url** | **String** | The Shortcut application url for the Comment. | |
8
+ | **entity_type** | **String** | A string description of this resource. | |
9
+ | **story_id** | **Integer** | The ID of the Story on which the Comment appears. | |
10
+ | **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | |
11
+ | **author_id** | **String** | The unique ID of the Member who is the Comment's author. | |
12
+ | **member_mention_ids** | **Array<String>** | The unique IDs of the Member who are mentioned in the Comment. | |
13
+ | **updated_at** | **Time** | The time/date when the Comment was updated. | |
14
+ | **group_mention_ids** | **Array<String>** | The unique IDs of the Group who are mentioned in the Comment. | |
15
+ | **external_id** | **String** | This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. | |
16
+ | **id** | **Integer** | The unique ID of the Comment. | |
17
+ | **position** | **Integer** | The Comments numerical position in the list from oldest to newest. | |
18
+ | **reactions** | [**Array<StoryReaction>**](StoryReaction.md) | A set of Reactions to this Comment. | |
19
+ | **created_at** | **Time** | The time/date when the Comment was created. | |
20
+ | **text** | **String** | The text of the Comment. | |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'shortcut_client_ruby'
26
+
27
+ instance = Shortcut::StoryComment.new(
28
+ app_url: null,
29
+ entity_type: null,
30
+ story_id: null,
31
+ mention_ids: null,
32
+ author_id: null,
33
+ member_mention_ids: null,
34
+ updated_at: null,
35
+ group_mention_ids: null,
36
+ external_id: null,
37
+ id: null,
38
+ position: null,
39
+ reactions: null,
40
+ created_at: null,
41
+ text: null
42
+ )
43
+ ```
20
44