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
@@ -1,15 +1,34 @@
1
1
  # Shortcut::CreateLinkedFile
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The description of the file. | [optional]
7
- **story_id** | **Integer** | The ID of the linked story. | [optional]
8
- **name** | **String** | The name of the file. |
9
- **thumbnail_url** | **String** | The URL of the thumbnail, if the integration provided it. | [optional]
10
- **type** | **String** | The integration type of the file (e.g. google, dropbox, box). |
11
- **size** | **Integer** | The filesize, if the integration provided it. | [optional]
12
- **uploader_id** | **String** | The UUID of the member that uploaded the file. | [optional]
13
- **content_type** | **String** | The content type of the image (e.g. txt/plain). | [optional]
14
- **url** | **String** | The URL of linked file. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The description of the file. | [optional] |
8
+ | **story_id** | **Integer** | The ID of the linked story. | [optional] |
9
+ | **name** | **String** | The name of the file. | |
10
+ | **thumbnail_url** | **String** | The URL of the thumbnail, if the integration provided it. | [optional] |
11
+ | **type** | **String** | The integration type of the file (e.g. google, dropbox, box). | |
12
+ | **size** | **Integer** | The filesize, if the integration provided it. | [optional] |
13
+ | **uploader_id** | **String** | The UUID of the member that uploaded the file. | [optional] |
14
+ | **content_type** | **String** | The content type of the image (e.g. txt/plain). | [optional] |
15
+ | **url** | **String** | The URL of linked file. | |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'shortcut_client_ruby'
21
+
22
+ instance = Shortcut::CreateLinkedFile.new(
23
+ description: null,
24
+ story_id: null,
25
+ name: null,
26
+ thumbnail_url: null,
27
+ type: null,
28
+ size: null,
29
+ uploader_id: null,
30
+ content_type: null,
31
+ url: null
32
+ )
33
+ ```
15
34
 
@@ -1,12 +1,28 @@
1
1
  # Shortcut::CreateMilestone
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | The name of the Milestone. |
7
- **description** | **String** | The Milestone's description. | [optional]
8
- **state** | **String** | The workflow state that the Milestone is in. | [optional]
9
- **started_at_override** | **DateTime** | A manual override for the time/date the Milestone was started. | [optional]
10
- **completed_at_override** | **DateTime** | A manual override for the time/date the Milestone was completed. | [optional]
11
- **categories** | [**Array<CreateCategoryParams>**](CreateCategoryParams.md) | An array of IDs of Categories attached to the Milestone. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the Milestone. | |
8
+ | **description** | **String** | The Milestone's description. | [optional] |
9
+ | **state** | **String** | The workflow state that the Milestone is in. | [optional] |
10
+ | **started_at_override** | **Time** | A manual override for the time/date the Milestone was started. | [optional] |
11
+ | **completed_at_override** | **Time** | A manual override for the time/date the Milestone was completed. | [optional] |
12
+ | **categories** | [**Array<CreateCategoryParams>**](CreateCategoryParams.md) | An array of IDs of Categories attached to the Milestone. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'shortcut_client_ruby'
18
+
19
+ instance = Shortcut::CreateMilestone.new(
20
+ name: null,
21
+ description: null,
22
+ state: null,
23
+ started_at_override: null,
24
+ completed_at_override: null,
25
+ categories: null
26
+ )
27
+ ```
12
28
 
@@ -1,7 +1,18 @@
1
1
  # Shortcut::CreateOrDeleteStoryReaction
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **emoji** | **String** | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **emoji** | **String** | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'shortcut_client_ruby'
13
+
14
+ instance = Shortcut::CreateOrDeleteStoryReaction.new(
15
+ emoji: null
16
+ )
17
+ ```
7
18
 
@@ -1,17 +1,38 @@
1
1
  # Shortcut::CreateProject
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The Project description. | [optional]
7
- **color** | **String** | The color you wish to use for the Project in the system. | [optional]
8
- **name** | **String** | The name of the Project. |
9
- **start_time** | **DateTime** | The date at which the Project was started. | [optional]
10
- **updated_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional]
11
- **follower_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | [optional]
12
- **external_id** | **String** | This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
13
- **team_id** | **Integer** | The ID of the team the project belongs to. |
14
- **iteration_length** | **Integer** | The number of weeks per iteration in this Project. | [optional]
15
- **abbreviation** | **String** | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | [optional]
16
- **created_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The Project description. | [optional] |
8
+ | **color** | **String** | The color you wish to use for the Project in the system. | [optional] |
9
+ | **name** | **String** | The name of the Project. | |
10
+ | **start_time** | **Time** | The date at which the Project was started. | [optional] |
11
+ | **updated_at** | **Time** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] |
12
+ | **follower_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | [optional] |
13
+ | **external_id** | **String** | This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
14
+ | **team_id** | **Integer** | The ID of the team the project belongs to. | |
15
+ | **iteration_length** | **Integer** | The number of weeks per iteration in this Project. | [optional] |
16
+ | **abbreviation** | **String** | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | [optional] |
17
+ | **created_at** | **Time** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'shortcut_client_ruby'
23
+
24
+ instance = Shortcut::CreateProject.new(
25
+ description: null,
26
+ color: null,
27
+ name: null,
28
+ start_time: null,
29
+ updated_at: null,
30
+ follower_ids: null,
31
+ external_id: null,
32
+ team_id: null,
33
+ iteration_length: null,
34
+ abbreviation: null,
35
+ created_at: null
36
+ )
37
+ ```
17
38
 
@@ -1,7 +1,18 @@
1
1
  # Shortcut::CreateStories
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **stories** | [**Array<CreateStoryParams>**](CreateStoryParams.md) | An array of stories to be created. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **stories** | [**Array<CreateStoryParams>**](CreateStoryParams.md) | An array of stories to be created. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'shortcut_client_ruby'
13
+
14
+ instance = Shortcut::CreateStories.new(
15
+ stories: null
16
+ )
17
+ ```
7
18
 
@@ -1,11 +1,26 @@
1
1
  # Shortcut::CreateStoryComment
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **text** | **String** | The comment text. |
7
- **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional]
8
- **created_at** | **DateTime** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional]
9
- **updated_at** | **DateTime** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional]
10
- **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. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | The comment text. | |
8
+ | **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] |
9
+ | **created_at** | **Time** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] |
10
+ | **updated_at** | **Time** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] |
11
+ | **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. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'shortcut_client_ruby'
17
+
18
+ instance = Shortcut::CreateStoryComment.new(
19
+ text: null,
20
+ author_id: null,
21
+ created_at: null,
22
+ updated_at: null,
23
+ external_id: null
24
+ )
25
+ ```
11
26
 
@@ -1,11 +1,26 @@
1
1
  # Shortcut::CreateStoryCommentParams
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **text** | **String** | The comment text. |
7
- **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional]
8
- **created_at** | **DateTime** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional]
9
- **updated_at** | **DateTime** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional]
10
- **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. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | The comment text. | |
8
+ | **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] |
9
+ | **created_at** | **Time** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] |
10
+ | **updated_at** | **Time** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] |
11
+ | **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. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'shortcut_client_ruby'
17
+
18
+ instance = Shortcut::CreateStoryCommentParams.new(
19
+ text: null,
20
+ author_id: null,
21
+ created_at: null,
22
+ updated_at: null,
23
+ external_id: null
24
+ )
25
+ ```
11
26
 
@@ -1,27 +1,58 @@
1
1
  # Shortcut::CreateStoryContents
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The description of the story. | [optional]
7
- **entity_type** | **String** | A string description of this resource. | [optional]
8
- **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels to be populated by the template. | [optional]
9
- **story_type** | **String** | The type of story (feature, bug, chore). | [optional]
10
- **linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | [optional]
11
- **file_ids** | **Array<Integer>** | An array of the attached file IDs to be populated. | [optional]
12
- **name** | **String** | The name of the story. | [optional]
13
- **epic_id** | **Integer** | The ID of the epic the to be populated. | [optional]
14
- **external_links** | **Array<String>** | An array of external links to be populated. | [optional]
15
- **iteration_id** | **Integer** | The ID of the iteration the to be populated. | [optional]
16
- **tasks** | [**Array<EntityTemplateTask>**](EntityTemplateTask.md) | An array of tasks to be populated by the template. | [optional]
17
- **label_ids** | **Array<Integer>** | An array of label ids attached to the story. | [optional]
18
- **group_id** | **String** | The ID of the group to be populated. | [optional]
19
- **workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | [optional]
20
- **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | [optional]
21
- **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional]
22
- **estimate** | **Integer** | The numeric point estimate to be populated. | [optional]
23
- **files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | [optional]
24
- **project_id** | **Integer** | The ID of the project the story belongs to. | [optional]
25
- **linked_file_ids** | **Array<Integer>** | An array of the linked file IDs to be populated. | [optional]
26
- **deadline** | **DateTime** | The due date of the story. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The description of the story. | [optional] |
8
+ | **entity_type** | **String** | A string description of this resource. | [optional] |
9
+ | **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels to be populated by the template. | [optional] |
10
+ | **story_type** | **String** | The type of story (feature, bug, chore). | [optional] |
11
+ | **linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | [optional] |
12
+ | **file_ids** | **Array<Integer>** | An array of the attached file IDs to be populated. | [optional] |
13
+ | **name** | **String** | The name of the story. | [optional] |
14
+ | **epic_id** | **Integer** | The ID of the epic the to be populated. | [optional] |
15
+ | **external_links** | **Array<String>** | An array of external links to be populated. | [optional] |
16
+ | **iteration_id** | **Integer** | The ID of the iteration the to be populated. | [optional] |
17
+ | **tasks** | [**Array<EntityTemplateTask>**](EntityTemplateTask.md) | An array of tasks to be populated by the template. | [optional] |
18
+ | **label_ids** | **Array<Integer>** | An array of label ids attached to the story. | [optional] |
19
+ | **group_id** | **String** | The ID of the group to be populated. | [optional] |
20
+ | **workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | [optional] |
21
+ | **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | [optional] |
22
+ | **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] |
23
+ | **estimate** | **Integer** | The numeric point estimate to be populated. | [optional] |
24
+ | **files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | [optional] |
25
+ | **project_id** | **Integer** | The ID of the project the story belongs to. | [optional] |
26
+ | **linked_file_ids** | **Array<Integer>** | An array of the linked file IDs to be populated. | [optional] |
27
+ | **deadline** | **Time** | The due date of the story. | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'shortcut_client_ruby'
33
+
34
+ instance = Shortcut::CreateStoryContents.new(
35
+ description: null,
36
+ entity_type: null,
37
+ labels: null,
38
+ story_type: null,
39
+ linked_files: null,
40
+ file_ids: null,
41
+ name: null,
42
+ epic_id: null,
43
+ external_links: null,
44
+ iteration_id: null,
45
+ tasks: null,
46
+ label_ids: null,
47
+ group_id: null,
48
+ workflow_state_id: null,
49
+ follower_ids: null,
50
+ owner_ids: null,
51
+ estimate: null,
52
+ files: null,
53
+ project_id: null,
54
+ linked_file_ids: null,
55
+ deadline: null
56
+ )
57
+ ```
27
58
 
@@ -1,9 +1,22 @@
1
1
  # Shortcut::CreateStoryLink
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **verb** | **String** | The type of link. |
7
- **subject_id** | **Integer** | The ID of the subject Story. |
8
- **object_id** | **Integer** | The ID of the object Story. |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verb** | **String** | The type of link. | |
8
+ | **subject_id** | **Integer** | The ID of the subject Story. | |
9
+ | **object_id** | **Integer** | The ID of the object Story. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'shortcut_client_ruby'
15
+
16
+ instance = Shortcut::CreateStoryLink.new(
17
+ verb: null,
18
+ subject_id: null,
19
+ object_id: null
20
+ )
21
+ ```
9
22
 
@@ -1,9 +1,22 @@
1
1
  # Shortcut::CreateStoryLinkParams
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **subject_id** | **Integer** | The unique ID of the Story defined as subject. | [optional]
7
- **verb** | **String** | How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\". |
8
- **object_id** | **Integer** | The unique ID of the Story defined as object. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subject_id** | **Integer** | The unique ID of the Story defined as subject. | [optional] |
8
+ | **verb** | **String** | How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\". | |
9
+ | **object_id** | **Integer** | The unique ID of the Story defined as object. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'shortcut_client_ruby'
15
+
16
+ instance = Shortcut::CreateStoryLinkParams.new(
17
+ subject_id: null,
18
+ verb: null,
19
+ object_id: null
20
+ )
21
+ ```
9
22
 
@@ -1,33 +1,70 @@
1
1
  # Shortcut::CreateStoryParams
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The description of the story. | [optional]
7
- **archived** | **BOOLEAN** | Controls the story's archived state. | [optional]
8
- **story_links** | [**Array<CreateStoryLinkParams>**](CreateStoryLinkParams.md) | An array of story links attached to the story. | [optional]
9
- **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels attached to the story. | [optional]
10
- **story_type** | **String** | The type of story (feature, bug, chore). | [optional]
11
- **file_ids** | **Array<Integer>** | An array of IDs of files attached to the story. | [optional]
12
- **completed_at_override** | **DateTime** | A manual override for the time/date the Story was completed. | [optional]
13
- **name** | **String** | The name of the story. |
14
- **comments** | [**Array<CreateStoryCommentParams>**](CreateStoryCommentParams.md) | An array of comments to add to the story. | [optional]
15
- **epic_id** | **Integer** | The ID of the epic the story belongs to. | [optional]
16
- **story_template_id** | **String** | The id of the story template used to create this story, if applicable. | [optional]
17
- **external_links** | **Array<String>** | An array of External Links associated with this story. | [optional]
18
- **requested_by_id** | **String** | The ID of the member that requested the story. | [optional]
19
- **iteration_id** | **Integer** | The ID of the iteration the story belongs to. | [optional]
20
- **tasks** | [**Array<CreateTaskParams>**](CreateTaskParams.md) | An array of tasks connected to the story. | [optional]
21
- **started_at_override** | **DateTime** | A manual override for the time/date the Story was started. | [optional]
22
- **group_id** | **String** | The id of the group to associate with this story. | [optional]
23
- **workflow_state_id** | **Integer** | The ID of the workflow state the story will be in. | [optional]
24
- **updated_at** | **DateTime** | The time/date the Story was updated. | [optional]
25
- **follower_ids** | **Array<String>** | An array of UUIDs of the followers of this story. | [optional]
26
- **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional]
27
- **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. | [optional]
28
- **estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | [optional]
29
- **project_id** | **Integer** | The ID of the project the story belongs to. | [optional]
30
- **linked_file_ids** | **Array<Integer>** | An array of IDs of linked files attached to the story. | [optional]
31
- **deadline** | **DateTime** | The due date of the story. | [optional]
32
- **created_at** | **DateTime** | The time/date the Story was created. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The description of the story. | [optional] |
8
+ | **archived** | **Boolean** | Controls the story's archived state. | [optional] |
9
+ | **story_links** | [**Array<CreateStoryLinkParams>**](CreateStoryLinkParams.md) | An array of story links attached to the story. | [optional] |
10
+ | **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels attached to the story. | [optional] |
11
+ | **story_type** | **String** | The type of story (feature, bug, chore). | [optional] |
12
+ | **file_ids** | **Array<Integer>** | An array of IDs of files attached to the story. | [optional] |
13
+ | **completed_at_override** | **Time** | A manual override for the time/date the Story was completed. | [optional] |
14
+ | **name** | **String** | The name of the story. | |
15
+ | **comments** | [**Array<CreateStoryCommentParams>**](CreateStoryCommentParams.md) | An array of comments to add to the story. | [optional] |
16
+ | **epic_id** | **Integer** | The ID of the epic the story belongs to. | [optional] |
17
+ | **story_template_id** | **String** | The id of the story template used to create this story, if applicable. | [optional] |
18
+ | **external_links** | **Array<String>** | An array of External Links associated with this story. | [optional] |
19
+ | **requested_by_id** | **String** | The ID of the member that requested the story. | [optional] |
20
+ | **iteration_id** | **Integer** | The ID of the iteration the story belongs to. | [optional] |
21
+ | **tasks** | [**Array<CreateTaskParams>**](CreateTaskParams.md) | An array of tasks connected to the story. | [optional] |
22
+ | **started_at_override** | **Time** | A manual override for the time/date the Story was started. | [optional] |
23
+ | **group_id** | **String** | The id of the group to associate with this story. | [optional] |
24
+ | **workflow_state_id** | **Integer** | The ID of the workflow state the story will be in. | [optional] |
25
+ | **updated_at** | **Time** | The time/date the Story was updated. | [optional] |
26
+ | **follower_ids** | **Array<String>** | An array of UUIDs of the followers of this story. | [optional] |
27
+ | **owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] |
28
+ | **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. | [optional] |
29
+ | **estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | [optional] |
30
+ | **project_id** | **Integer** | The ID of the project the story belongs to. | [optional] |
31
+ | **linked_file_ids** | **Array<Integer>** | An array of IDs of linked files attached to the story. | [optional] |
32
+ | **deadline** | **Time** | The due date of the story. | [optional] |
33
+ | **created_at** | **Time** | The time/date the Story was created. | [optional] |
34
+
35
+ ## Example
36
+
37
+ ```ruby
38
+ require 'shortcut_client_ruby'
39
+
40
+ instance = Shortcut::CreateStoryParams.new(
41
+ description: null,
42
+ archived: null,
43
+ story_links: null,
44
+ labels: null,
45
+ story_type: null,
46
+ file_ids: null,
47
+ completed_at_override: null,
48
+ name: null,
49
+ comments: null,
50
+ epic_id: null,
51
+ story_template_id: null,
52
+ external_links: null,
53
+ requested_by_id: null,
54
+ iteration_id: null,
55
+ tasks: null,
56
+ started_at_override: null,
57
+ group_id: null,
58
+ workflow_state_id: null,
59
+ updated_at: null,
60
+ follower_ids: null,
61
+ owner_ids: null,
62
+ external_id: null,
63
+ estimate: null,
64
+ project_id: null,
65
+ linked_file_ids: null,
66
+ deadline: null,
67
+ created_at: null
68
+ )
69
+ ```
33
70
 
data/docs/CreateTask.md CHANGED
@@ -1,12 +1,28 @@
1
1
  # Shortcut::CreateTask
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The Task description. |
7
- **complete** | **BOOLEAN** | True/false boolean indicating whether the Task is completed. Defaults to false. | [optional]
8
- **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Task. | [optional]
9
- **created_at** | **DateTime** | Defaults to the time/date the Task is created but can be set to reflect another creation time/date. | [optional]
10
- **updated_at** | **DateTime** | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. | [optional]
11
- **external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The Task description. | |
8
+ | **complete** | **Boolean** | True/false boolean indicating whether the Task is completed. Defaults to false. | [optional] |
9
+ | **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Task. | [optional] |
10
+ | **created_at** | **Time** | Defaults to the time/date the Task is created but can be set to reflect another creation time/date. | [optional] |
11
+ | **updated_at** | **Time** | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. | [optional] |
12
+ | **external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'shortcut_client_ruby'
18
+
19
+ instance = Shortcut::CreateTask.new(
20
+ description: null,
21
+ complete: null,
22
+ owner_ids: null,
23
+ created_at: null,
24
+ updated_at: null,
25
+ external_id: null
26
+ )
27
+ ```
12
28
 
@@ -1,12 +1,28 @@
1
1
  # Shortcut::CreateTaskParams
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | The Task description. |
7
- **complete** | **BOOLEAN** | True/false boolean indicating whether the Task is completed. Defaults to false. | [optional]
8
- **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Task. | [optional]
9
- **created_at** | **DateTime** | Defaults to the time/date the Task is created but can be set to reflect another creation time/date. | [optional]
10
- **updated_at** | **DateTime** | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. | [optional]
11
- **external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The Task description. | |
8
+ | **complete** | **Boolean** | True/false boolean indicating whether the Task is completed. Defaults to false. | [optional] |
9
+ | **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Task. | [optional] |
10
+ | **created_at** | **Time** | Defaults to the time/date the Task is created but can be set to reflect another creation time/date. | [optional] |
11
+ | **updated_at** | **Time** | Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. | [optional] |
12
+ | **external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'shortcut_client_ruby'
18
+
19
+ instance = Shortcut::CreateTaskParams.new(
20
+ description: null,
21
+ complete: null,
22
+ owner_ids: null,
23
+ created_at: null,
24
+ updated_at: null,
25
+ external_id: null
26
+ )
27
+ ```
12
28