shortcut_client_ruby 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (453) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +21 -0
  4. data/README.md +2303 -0
  5. data/Rakefile +8 -0
  6. data/bin/console +15 -0
  7. data/bin/setup +8 -0
  8. data/bin/update.rb +34 -0
  9. data/config.json +7 -0
  10. data/docs/BasicWorkspaceInfo.md +8 -0
  11. data/docs/Branch.md +17 -0
  12. data/docs/Category.md +15 -0
  13. data/docs/Commit.md +19 -0
  14. data/docs/CreateCategory.md +10 -0
  15. data/docs/CreateCategoryParams.md +9 -0
  16. data/docs/CreateCommentComment.md +11 -0
  17. data/docs/CreateEntityTemplate.md +9 -0
  18. data/docs/CreateEpic.md +23 -0
  19. data/docs/CreateEpicComment.md +11 -0
  20. data/docs/CreateGroup.md +14 -0
  21. data/docs/CreateIteration.md +13 -0
  22. data/docs/CreateLabelParams.md +10 -0
  23. data/docs/CreateLinkedFile.md +15 -0
  24. data/docs/CreateMilestone.md +12 -0
  25. data/docs/CreateOrDeleteStoryReaction.md +7 -0
  26. data/docs/CreateProject.md +17 -0
  27. data/docs/CreateStories.md +7 -0
  28. data/docs/CreateStoryComment.md +11 -0
  29. data/docs/CreateStoryCommentParams.md +11 -0
  30. data/docs/CreateStoryContents.md +27 -0
  31. data/docs/CreateStoryLink.md +9 -0
  32. data/docs/CreateStoryLinkParams.md +9 -0
  33. data/docs/CreateStoryParams.md +33 -0
  34. data/docs/CreateTask.md +12 -0
  35. data/docs/CreateTaskParams.md +12 -0
  36. data/docs/DefaultApi.md +5632 -0
  37. data/docs/DeleteStories.md +7 -0
  38. data/docs/EntityTemplate.md +14 -0
  39. data/docs/EntityTemplateTask.md +10 -0
  40. data/docs/Epic.md +44 -0
  41. data/docs/EpicSearchResults.md +10 -0
  42. data/docs/EpicSlim.md +43 -0
  43. data/docs/EpicState.md +15 -0
  44. data/docs/EpicStats.md +19 -0
  45. data/docs/EpicWorkflow.md +12 -0
  46. data/docs/GetEpicStories.md +7 -0
  47. data/docs/GetExternalLinkStoriesParams.md +7 -0
  48. data/docs/GetIterationStories.md +7 -0
  49. data/docs/GetLabelStories.md +7 -0
  50. data/docs/GetMember.md +7 -0
  51. data/docs/GetProjectStories.md +7 -0
  52. data/docs/Group.md +22 -0
  53. data/docs/History.md +15 -0
  54. data/docs/HistoryActionBranchCreate.md +11 -0
  55. data/docs/HistoryActionBranchMerge.md +11 -0
  56. data/docs/HistoryActionBranchPush.md +11 -0
  57. data/docs/HistoryActionLabelCreate.md +11 -0
  58. data/docs/HistoryActionLabelDelete.md +10 -0
  59. data/docs/HistoryActionLabelUpdate.md +9 -0
  60. data/docs/HistoryActionProjectUpdate.md +11 -0
  61. data/docs/HistoryActionPullRequest.md +12 -0
  62. data/docs/HistoryActionStoryCommentCreate.md +12 -0
  63. data/docs/HistoryActionStoryCreate.md +30 -0
  64. data/docs/HistoryActionStoryDelete.md +11 -0
  65. data/docs/HistoryActionStoryLinkCreate.md +12 -0
  66. data/docs/HistoryActionStoryLinkDelete.md +12 -0
  67. data/docs/HistoryActionStoryLinkUpdate.md +13 -0
  68. data/docs/HistoryActionStoryUpdate.md +13 -0
  69. data/docs/HistoryActionTaskCreate.md +15 -0
  70. data/docs/HistoryActionTaskDelete.md +10 -0
  71. data/docs/HistoryActionTaskUpdate.md +13 -0
  72. data/docs/HistoryChangesStory.md +30 -0
  73. data/docs/HistoryChangesStoryLink.md +9 -0
  74. data/docs/HistoryChangesTask.md +10 -0
  75. data/docs/HistoryReferenceBranch.md +10 -0
  76. data/docs/HistoryReferenceCommit.md +10 -0
  77. data/docs/HistoryReferenceEpic.md +10 -0
  78. data/docs/HistoryReferenceGeneral.md +9 -0
  79. data/docs/HistoryReferenceGroup.md +9 -0
  80. data/docs/HistoryReferenceIteration.md +10 -0
  81. data/docs/HistoryReferenceLabel.md +10 -0
  82. data/docs/HistoryReferenceProject.md +10 -0
  83. data/docs/HistoryReferenceStory.md +11 -0
  84. data/docs/HistoryReferenceStoryTask.md +9 -0
  85. data/docs/HistoryReferenceWorkflowState.md +10 -0
  86. data/docs/Icon.md +11 -0
  87. data/docs/Identity.md +9 -0
  88. data/docs/Iteration.md +24 -0
  89. data/docs/IterationSlim.md +23 -0
  90. data/docs/IterationStats.md +17 -0
  91. data/docs/Label.md +17 -0
  92. data/docs/LabelSlim.md +16 -0
  93. data/docs/LabelStats.md +21 -0
  94. data/docs/LinkedFile.md +22 -0
  95. data/docs/ListEpics.md +7 -0
  96. data/docs/ListGroupStories.md +8 -0
  97. data/docs/ListLabels.md +7 -0
  98. data/docs/ListMembers.md +7 -0
  99. data/docs/MaxSearchResultsExceededError.md +9 -0
  100. data/docs/Member.md +17 -0
  101. data/docs/MemberInfo.md +10 -0
  102. data/docs/Milestone.md +23 -0
  103. data/docs/MilestoneStats.md +9 -0
  104. data/docs/Profile.md +15 -0
  105. data/docs/Project.md +25 -0
  106. data/docs/ProjectStats.md +9 -0
  107. data/docs/PullRequest.md +28 -0
  108. data/docs/PullRequestLabel.md +11 -0
  109. data/docs/Repository.md +15 -0
  110. data/docs/Search.md +10 -0
  111. data/docs/SearchResults.md +8 -0
  112. data/docs/SearchStories.md +34 -0
  113. data/docs/Story.md +56 -0
  114. data/docs/StoryComment.md +20 -0
  115. data/docs/StoryContents.md +25 -0
  116. data/docs/StoryContentsTask.md +11 -0
  117. data/docs/StoryHistoryChangeAddsRemovesInt.md +8 -0
  118. data/docs/StoryHistoryChangeAddsRemovesUuid.md +8 -0
  119. data/docs/StoryHistoryChangeOldNewBool.md +8 -0
  120. data/docs/StoryHistoryChangeOldNewInt.md +8 -0
  121. data/docs/StoryHistoryChangeOldNewStr.md +8 -0
  122. data/docs/StoryHistoryChangeOldNewUuid.md +8 -0
  123. data/docs/StoryLink.md +14 -0
  124. data/docs/StoryReaction.md +8 -0
  125. data/docs/StorySearchResults.md +10 -0
  126. data/docs/StorySlim.md +54 -0
  127. data/docs/StoryStats.md +7 -0
  128. data/docs/Task.md +20 -0
  129. data/docs/ThreadedComment.md +19 -0
  130. data/docs/TypedStoryLink.md +15 -0
  131. data/docs/UnusableEntitlementError.md +9 -0
  132. data/docs/UpdateCategory.md +9 -0
  133. data/docs/UpdateComment.md +7 -0
  134. data/docs/UpdateEntityTemplate.md +8 -0
  135. data/docs/UpdateEpic.md +23 -0
  136. data/docs/UpdateFile.md +12 -0
  137. data/docs/UpdateGroup.md +15 -0
  138. data/docs/UpdateIteration.md +13 -0
  139. data/docs/UpdateLabel.md +10 -0
  140. data/docs/UpdateLinkedFile.md +14 -0
  141. data/docs/UpdateMilestone.md +14 -0
  142. data/docs/UpdateProject.md +15 -0
  143. data/docs/UpdateStories.md +27 -0
  144. data/docs/UpdateStory.md +32 -0
  145. data/docs/UpdateStoryComment.md +7 -0
  146. data/docs/UpdateStoryContents.md +27 -0
  147. data/docs/UpdateStoryLink.md +9 -0
  148. data/docs/UpdateTask.md +11 -0
  149. data/docs/UploadedFile.md +23 -0
  150. data/docs/V3FilesBody.md +11 -0
  151. data/docs/Workflow.md +17 -0
  152. data/docs/WorkflowState.md +18 -0
  153. data/git_push.sh +55 -0
  154. data/lib/shortcut/client/ruby/version.rb +9 -0
  155. data/lib/shortcut/client/ruby.rb +12 -0
  156. data/lib/shortcut_client_ruby/api/default_api.rb +6091 -0
  157. data/lib/shortcut_client_ruby/api_client.rb +388 -0
  158. data/lib/shortcut_client_ruby/api_error.rb +57 -0
  159. data/lib/shortcut_client_ruby/configuration.rb +205 -0
  160. data/lib/shortcut_client_ruby/models/basic_workspace_info.rb +227 -0
  161. data/lib/shortcut_client_ruby/models/branch.rb +371 -0
  162. data/lib/shortcut_client_ruby/models/category.rb +335 -0
  163. data/lib/shortcut_client_ruby/models/commit.rb +398 -0
  164. data/lib/shortcut_client_ruby/models/create_category.rb +281 -0
  165. data/lib/shortcut_client_ruby/models/create_category_params.rb +233 -0
  166. data/lib/shortcut_client_ruby/models/create_comment_comment.rb +252 -0
  167. data/lib/shortcut_client_ruby/models/create_entity_template.rb +237 -0
  168. data/lib/shortcut_client_ruby/models/create_epic.rb +416 -0
  169. data/lib/shortcut_client_ruby/models/create_epic_comment.rb +252 -0
  170. data/lib/shortcut_client_ruby/models/create_group.rb +325 -0
  171. data/lib/shortcut_client_ruby/models/create_iteration.rb +288 -0
  172. data/lib/shortcut_client_ruby/models/create_label_params.rb +243 -0
  173. data/lib/shortcut_client_ruby/models/create_linked_file.rb +336 -0
  174. data/lib/shortcut_client_ruby/models/create_milestone.rb +298 -0
  175. data/lib/shortcut_client_ruby/models/create_or_delete_story_reaction.rb +212 -0
  176. data/lib/shortcut_client_ruby/models/create_project.rb +319 -0
  177. data/lib/shortcut_client_ruby/models/create_stories.rb +214 -0
  178. data/lib/shortcut_client_ruby/models/create_story_comment.rb +252 -0
  179. data/lib/shortcut_client_ruby/models/create_story_comment_params.rb +253 -0
  180. data/lib/shortcut_client_ruby/models/create_story_contents.rb +433 -0
  181. data/lib/shortcut_client_ruby/models/create_story_link.rb +276 -0
  182. data/lib/shortcut_client_ruby/models/create_story_link_params.rb +267 -0
  183. data/lib/shortcut_client_ruby/models/create_story_params.rb +532 -0
  184. data/lib/shortcut_client_ruby/models/create_task.rb +264 -0
  185. data/lib/shortcut_client_ruby/models/create_task_params.rb +265 -0
  186. data/lib/shortcut_client_ruby/models/delete_stories.rb +214 -0
  187. data/lib/shortcut_client_ruby/models/entity_template.rb +317 -0
  188. data/lib/shortcut_client_ruby/models/entity_template_task.rb +245 -0
  189. data/lib/shortcut_client_ruby/models/epic.rb +799 -0
  190. data/lib/shortcut_client_ruby/models/epic_search_results.rb +257 -0
  191. data/lib/shortcut_client_ruby/models/epic_slim.rb +777 -0
  192. data/lib/shortcut_client_ruby/models/epic_state.rb +328 -0
  193. data/lib/shortcut_client_ruby/models/epic_stats.rb +384 -0
  194. data/lib/shortcut_client_ruby/models/epic_workflow.rb +290 -0
  195. data/lib/shortcut_client_ruby/models/get_epic_stories.rb +207 -0
  196. data/lib/shortcut_client_ruby/models/get_external_link_stories_params.rb +212 -0
  197. data/lib/shortcut_client_ruby/models/get_iteration_stories.rb +207 -0
  198. data/lib/shortcut_client_ruby/models/get_label_stories.rb +207 -0
  199. data/lib/shortcut_client_ruby/models/get_member.rb +207 -0
  200. data/lib/shortcut_client_ruby/models/get_project_stories.rb +207 -0
  201. data/lib/shortcut_client_ruby/models/group.rb +479 -0
  202. data/lib/shortcut_client_ruby/models/history.rb +347 -0
  203. data/lib/shortcut_client_ruby/models/history_action_branch_create.rb +307 -0
  204. data/lib/shortcut_client_ruby/models/history_action_branch_merge.rb +307 -0
  205. data/lib/shortcut_client_ruby/models/history_action_branch_push.rb +307 -0
  206. data/lib/shortcut_client_ruby/models/history_action_label_create.rb +307 -0
  207. data/lib/shortcut_client_ruby/models/history_action_label_delete.rb +292 -0
  208. data/lib/shortcut_client_ruby/models/history_action_label_update.rb +277 -0
  209. data/lib/shortcut_client_ruby/models/history_action_project_update.rb +307 -0
  210. data/lib/shortcut_client_ruby/models/history_action_pull_request.rb +322 -0
  211. data/lib/shortcut_client_ruby/models/history_action_story_comment_create.rb +322 -0
  212. data/lib/shortcut_client_ruby/models/history_action_story_create.rb +527 -0
  213. data/lib/shortcut_client_ruby/models/history_action_story_delete.rb +319 -0
  214. data/lib/shortcut_client_ruby/models/history_action_story_link_create.rb +334 -0
  215. data/lib/shortcut_client_ruby/models/history_action_story_link_delete.rb +336 -0
  216. data/lib/shortcut_client_ruby/models/history_action_story_link_update.rb +348 -0
  217. data/lib/shortcut_client_ruby/models/history_action_story_update.rb +343 -0
  218. data/lib/shortcut_client_ruby/models/history_action_task_create.rb +353 -0
  219. data/lib/shortcut_client_ruby/models/history_action_task_delete.rb +292 -0
  220. data/lib/shortcut_client_ruby/models/history_action_task_update.rb +331 -0
  221. data/lib/shortcut_client_ruby/models/history_changes_story.rb +414 -0
  222. data/lib/shortcut_client_ruby/models/history_changes_story_link.rb +225 -0
  223. data/lib/shortcut_client_ruby/models/history_changes_task.rb +234 -0
  224. data/lib/shortcut_client_ruby/models/history_reference_branch.rb +258 -0
  225. data/lib/shortcut_client_ruby/models/history_reference_commit.rb +258 -0
  226. data/lib/shortcut_client_ruby/models/history_reference_epic.rb +258 -0
  227. data/lib/shortcut_client_ruby/models/history_reference_general.rb +243 -0
  228. data/lib/shortcut_client_ruby/models/history_reference_group.rb +243 -0
  229. data/lib/shortcut_client_ruby/models/history_reference_iteration.rb +258 -0
  230. data/lib/shortcut_client_ruby/models/history_reference_label.rb +258 -0
  231. data/lib/shortcut_client_ruby/models/history_reference_project.rb +258 -0
  232. data/lib/shortcut_client_ruby/models/history_reference_story.rb +307 -0
  233. data/lib/shortcut_client_ruby/models/history_reference_story_task.rb +243 -0
  234. data/lib/shortcut_client_ruby/models/history_reference_workflow_state.rb +292 -0
  235. data/lib/shortcut_client_ruby/models/icon.rb +273 -0
  236. data/lib/shortcut_client_ruby/models/identity.rb +245 -0
  237. data/lib/shortcut_client_ruby/models/iteration.rb +481 -0
  238. data/lib/shortcut_client_ruby/models/iteration_slim.rb +466 -0
  239. data/lib/shortcut_client_ruby/models/iteration_stats.rb +353 -0
  240. data/lib/shortcut_client_ruby/models/label.rb +362 -0
  241. data/lib/shortcut_client_ruby/models/label_slim.rb +353 -0
  242. data/lib/shortcut_client_ruby/models/label_stats.rb +423 -0
  243. data/lib/shortcut_client_ruby/models/linked_file.rb +450 -0
  244. data/lib/shortcut_client_ruby/models/list_epics.rb +207 -0
  245. data/lib/shortcut_client_ruby/models/list_group_stories.rb +217 -0
  246. data/lib/shortcut_client_ruby/models/list_labels.rb +207 -0
  247. data/lib/shortcut_client_ruby/models/list_members.rb +207 -0
  248. data/lib/shortcut_client_ruby/models/max_search_results_exceeded_error.rb +289 -0
  249. data/lib/shortcut_client_ruby/models/member.rb +395 -0
  250. data/lib/shortcut_client_ruby/models/member_info.rb +253 -0
  251. data/lib/shortcut_client_ruby/models/milestone.rb +453 -0
  252. data/lib/shortcut_client_ruby/models/milestone_stats.rb +233 -0
  253. data/lib/shortcut_client_ruby/models/profile.rb +330 -0
  254. data/lib/shortcut_client_ruby/models/project.rb +490 -0
  255. data/lib/shortcut_client_ruby/models/project_stats.rb +243 -0
  256. data/lib/shortcut_client_ruby/models/pull_request.rb +518 -0
  257. data/lib/shortcut_client_ruby/models/pull_request_label.rb +269 -0
  258. data/lib/shortcut_client_ruby/models/repository.rb +340 -0
  259. data/lib/shortcut_client_ruby/models/search.rb +275 -0
  260. data/lib/shortcut_client_ruby/models/search_results.rb +226 -0
  261. data/lib/shortcut_client_ruby/models/search_stories.rb +529 -0
  262. data/lib/shortcut_client_ruby/models/story.rb +985 -0
  263. data/lib/shortcut_client_ruby/models/story_comment.rb +419 -0
  264. data/lib/shortcut_client_ruby/models/story_contents.rb +404 -0
  265. data/lib/shortcut_client_ruby/models/story_contents_task.rb +255 -0
  266. data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_int.rb +222 -0
  267. data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_uuid.rb +222 -0
  268. data/lib/shortcut_client_ruby/models/story_history_change_old_new_bool.rb +218 -0
  269. data/lib/shortcut_client_ruby/models/story_history_change_old_new_int.rb +218 -0
  270. data/lib/shortcut_client_ruby/models/story_history_change_old_new_str.rb +218 -0
  271. data/lib/shortcut_client_ruby/models/story_history_change_old_new_uuid.rb +218 -0
  272. data/lib/shortcut_client_ruby/models/story_link.rb +318 -0
  273. data/lib/shortcut_client_ruby/models/story_reaction.rb +230 -0
  274. data/lib/shortcut_client_ruby/models/story_search_results.rb +257 -0
  275. data/lib/shortcut_client_ruby/models/story_slim.rb +944 -0
  276. data/lib/shortcut_client_ruby/models/story_stats.rb +213 -0
  277. data/lib/shortcut_client_ruby/models/task.rb +418 -0
  278. data/lib/shortcut_client_ruby/models/threaded_comment.rb +402 -0
  279. data/lib/shortcut_client_ruby/models/typed_story_link.rb +333 -0
  280. data/lib/shortcut_client_ruby/models/unusable_entitlement_error.rb +276 -0
  281. data/lib/shortcut_client_ruby/models/update_category.rb +228 -0
  282. data/lib/shortcut_client_ruby/models/update_comment.rb +212 -0
  283. data/lib/shortcut_client_ruby/models/update_entity_template.rb +217 -0
  284. data/lib/shortcut_client_ruby/models/update_epic.rb +413 -0
  285. data/lib/shortcut_client_ruby/models/update_file.rb +257 -0
  286. data/lib/shortcut_client_ruby/models/update_group.rb +328 -0
  287. data/lib/shortcut_client_ruby/models/update_iteration.rb +273 -0
  288. data/lib/shortcut_client_ruby/models/update_label.rb +238 -0
  289. data/lib/shortcut_client_ruby/models/update_linked_file.rb +311 -0
  290. data/lib/shortcut_client_ruby/models/update_milestone.rb +315 -0
  291. data/lib/shortcut_client_ruby/models/update_project.rb +289 -0
  292. data/lib/shortcut_client_ruby/models/update_stories.rb +480 -0
  293. data/lib/shortcut_client_ruby/models/update_story.rb +529 -0
  294. data/lib/shortcut_client_ruby/models/update_story_comment.rb +212 -0
  295. data/lib/shortcut_client_ruby/models/update_story_contents.rb +434 -0
  296. data/lib/shortcut_client_ruby/models/update_story_link.rb +261 -0
  297. data/lib/shortcut_client_ruby/models/update_task.rb +249 -0
  298. data/lib/shortcut_client_ruby/models/uploaded_file.rb +466 -0
  299. data/lib/shortcut_client_ruby/models/v3_files_body.rb +252 -0
  300. data/lib/shortcut_client_ruby/models/workflow.rb +367 -0
  301. data/lib/shortcut_client_ruby/models/workflow_state.rb +374 -0
  302. data/lib/shortcut_client_ruby/version.rb +14 -0
  303. data/lib/shortcut_client_ruby.rb +181 -0
  304. data/shortcut-client-ruby.gemspec +36 -0
  305. data/shortcut_client_ruby.gemspec +38 -0
  306. data/spec/api/default_api_spec.rb +1310 -0
  307. data/spec/api_client_spec.rb +225 -0
  308. data/spec/base_object_spec.rb +109 -0
  309. data/spec/configuration_spec.rb +41 -0
  310. data/spec/models/basic_workspace_info_spec.rb +46 -0
  311. data/spec/models/branch_spec.rb +100 -0
  312. data/spec/models/category_spec.rb +88 -0
  313. data/spec/models/commit_spec.rb +112 -0
  314. data/spec/models/create_category_params_spec.rb +52 -0
  315. data/spec/models/create_category_spec.rb +62 -0
  316. data/spec/models/create_comment_comment_spec.rb +64 -0
  317. data/spec/models/create_entity_template_spec.rb +52 -0
  318. data/spec/models/create_epic_comment_spec.rb +64 -0
  319. data/spec/models/create_epic_spec.rb +140 -0
  320. data/spec/models/create_group_spec.rb +86 -0
  321. data/spec/models/create_iteration_spec.rb +76 -0
  322. data/spec/models/create_label_params_spec.rb +58 -0
  323. data/spec/models/create_linked_file_spec.rb +92 -0
  324. data/spec/models/create_milestone_spec.rb +74 -0
  325. data/spec/models/create_or_delete_story_reaction_spec.rb +40 -0
  326. data/spec/models/create_project_spec.rb +100 -0
  327. data/spec/models/create_stories_spec.rb +40 -0
  328. data/spec/models/create_story_comment_params_spec.rb +64 -0
  329. data/spec/models/create_story_comment_spec.rb +64 -0
  330. data/spec/models/create_story_contents_spec.rb +160 -0
  331. data/spec/models/create_story_link_params_spec.rb +56 -0
  332. data/spec/models/create_story_link_spec.rb +56 -0
  333. data/spec/models/create_story_params_spec.rb +200 -0
  334. data/spec/models/create_task_params_spec.rb +70 -0
  335. data/spec/models/create_task_spec.rb +70 -0
  336. data/spec/models/delete_stories_spec.rb +40 -0
  337. data/spec/models/entity_template_spec.rb +82 -0
  338. data/spec/models/entity_template_task_spec.rb +58 -0
  339. data/spec/models/epic_search_results_spec.rb +58 -0
  340. data/spec/models/epic_slim_spec.rb +256 -0
  341. data/spec/models/epic_spec.rb +262 -0
  342. data/spec/models/epic_state_spec.rb +88 -0
  343. data/spec/models/epic_stats_spec.rb +112 -0
  344. data/spec/models/epic_workflow_spec.rb +70 -0
  345. data/spec/models/get_epic_stories_spec.rb +40 -0
  346. data/spec/models/get_external_link_stories_params_spec.rb +40 -0
  347. data/spec/models/get_iteration_stories_spec.rb +40 -0
  348. data/spec/models/get_label_stories_spec.rb +40 -0
  349. data/spec/models/get_member_spec.rb +40 -0
  350. data/spec/models/get_project_stories_spec.rb +40 -0
  351. data/spec/models/group_spec.rb +134 -0
  352. data/spec/models/history_action_branch_create_spec.rb +68 -0
  353. data/spec/models/history_action_branch_merge_spec.rb +68 -0
  354. data/spec/models/history_action_branch_push_spec.rb +68 -0
  355. data/spec/models/history_action_label_create_spec.rb +68 -0
  356. data/spec/models/history_action_label_delete_spec.rb +62 -0
  357. data/spec/models/history_action_label_update_spec.rb +56 -0
  358. data/spec/models/history_action_project_update_spec.rb +68 -0
  359. data/spec/models/history_action_pull_request_spec.rb +74 -0
  360. data/spec/models/history_action_story_comment_create_spec.rb +74 -0
  361. data/spec/models/history_action_story_create_spec.rb +186 -0
  362. data/spec/models/history_action_story_delete_spec.rb +72 -0
  363. data/spec/models/history_action_story_link_create_spec.rb +78 -0
  364. data/spec/models/history_action_story_link_delete_spec.rb +78 -0
  365. data/spec/models/history_action_story_link_update_spec.rb +84 -0
  366. data/spec/models/history_action_story_update_spec.rb +84 -0
  367. data/spec/models/history_action_task_create_spec.rb +92 -0
  368. data/spec/models/history_action_task_delete_spec.rb +62 -0
  369. data/spec/models/history_action_task_update_spec.rb +80 -0
  370. data/spec/models/history_changes_story_link_spec.rb +52 -0
  371. data/spec/models/history_changes_story_spec.rb +178 -0
  372. data/spec/models/history_changes_task_spec.rb +58 -0
  373. data/spec/models/history_reference_branch_spec.rb +58 -0
  374. data/spec/models/history_reference_commit_spec.rb +58 -0
  375. data/spec/models/history_reference_epic_spec.rb +58 -0
  376. data/spec/models/history_reference_general_spec.rb +52 -0
  377. data/spec/models/history_reference_group_spec.rb +52 -0
  378. data/spec/models/history_reference_iteration_spec.rb +58 -0
  379. data/spec/models/history_reference_label_spec.rb +58 -0
  380. data/spec/models/history_reference_project_spec.rb +58 -0
  381. data/spec/models/history_reference_story_spec.rb +68 -0
  382. data/spec/models/history_reference_story_task_spec.rb +52 -0
  383. data/spec/models/history_reference_workflow_state_spec.rb +62 -0
  384. data/spec/models/history_spec.rb +92 -0
  385. data/spec/models/icon_spec.rb +64 -0
  386. data/spec/models/identity_spec.rb +52 -0
  387. data/spec/models/iteration_slim_spec.rb +136 -0
  388. data/spec/models/iteration_spec.rb +142 -0
  389. data/spec/models/iteration_stats_spec.rb +100 -0
  390. data/spec/models/label_slim_spec.rb +94 -0
  391. data/spec/models/label_spec.rb +100 -0
  392. data/spec/models/label_stats_spec.rb +124 -0
  393. data/spec/models/linked_file_spec.rb +130 -0
  394. data/spec/models/list_epics_spec.rb +40 -0
  395. data/spec/models/list_group_stories_spec.rb +46 -0
  396. data/spec/models/list_labels_spec.rb +40 -0
  397. data/spec/models/list_members_spec.rb +40 -0
  398. data/spec/models/max_search_results_exceeded_error_spec.rb +60 -0
  399. data/spec/models/member_info_spec.rb +58 -0
  400. data/spec/models/member_spec.rb +104 -0
  401. data/spec/models/milestone_spec.rb +136 -0
  402. data/spec/models/milestone_stats_spec.rb +52 -0
  403. data/spec/models/profile_spec.rb +88 -0
  404. data/spec/models/project_spec.rb +148 -0
  405. data/spec/models/project_stats_spec.rb +52 -0
  406. data/spec/models/pull_request_label_spec.rb +64 -0
  407. data/spec/models/pull_request_spec.rb +166 -0
  408. data/spec/models/repository_spec.rb +88 -0
  409. data/spec/models/search_results_spec.rb +46 -0
  410. data/spec/models/search_spec.rb +62 -0
  411. data/spec/models/search_stories_spec.rb +210 -0
  412. data/spec/models/story_comment_spec.rb +118 -0
  413. data/spec/models/story_contents_spec.rb +148 -0
  414. data/spec/models/story_contents_task_spec.rb +64 -0
  415. data/spec/models/story_history_change_adds_removes_int_spec.rb +46 -0
  416. data/spec/models/story_history_change_adds_removes_uuid_spec.rb +46 -0
  417. data/spec/models/story_history_change_old_new_bool_spec.rb +46 -0
  418. data/spec/models/story_history_change_old_new_int_spec.rb +46 -0
  419. data/spec/models/story_history_change_old_new_str_spec.rb +46 -0
  420. data/spec/models/story_history_change_old_new_uuid_spec.rb +46 -0
  421. data/spec/models/story_link_spec.rb +82 -0
  422. data/spec/models/story_reaction_spec.rb +46 -0
  423. data/spec/models/story_search_results_spec.rb +58 -0
  424. data/spec/models/story_slim_spec.rb +322 -0
  425. data/spec/models/story_spec.rb +334 -0
  426. data/spec/models/story_stats_spec.rb +40 -0
  427. data/spec/models/task_spec.rb +118 -0
  428. data/spec/models/threaded_comment_spec.rb +112 -0
  429. data/spec/models/typed_story_link_spec.rb +88 -0
  430. data/spec/models/unusable_entitlement_error_spec.rb +56 -0
  431. data/spec/models/update_category_spec.rb +52 -0
  432. data/spec/models/update_comment_spec.rb +40 -0
  433. data/spec/models/update_entity_template_spec.rb +46 -0
  434. data/spec/models/update_epic_spec.rb +140 -0
  435. data/spec/models/update_file_spec.rb +70 -0
  436. data/spec/models/update_group_spec.rb +92 -0
  437. data/spec/models/update_iteration_spec.rb +76 -0
  438. data/spec/models/update_label_spec.rb +58 -0
  439. data/spec/models/update_linked_file_spec.rb +86 -0
  440. data/spec/models/update_milestone_spec.rb +86 -0
  441. data/spec/models/update_project_spec.rb +88 -0
  442. data/spec/models/update_stories_spec.rb +168 -0
  443. data/spec/models/update_story_comment_spec.rb +40 -0
  444. data/spec/models/update_story_contents_spec.rb +160 -0
  445. data/spec/models/update_story_link_spec.rb +56 -0
  446. data/spec/models/update_story_spec.rb +198 -0
  447. data/spec/models/update_task_spec.rb +64 -0
  448. data/spec/models/uploaded_file_spec.rb +136 -0
  449. data/spec/models/v3_files_body_spec.rb +64 -0
  450. data/spec/models/workflow_spec.rb +100 -0
  451. data/spec/models/workflow_state_spec.rb +106 -0
  452. data/spec/spec_helper.rb +110 -0
  453. metadata +701 -0
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "bundler/setup"
5
+ require "shortcut/client/ruby"
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require "irb"
15
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/bin/update.rb ADDED
@@ -0,0 +1,34 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "json"
4
+
5
+ SWAGGER_SOURCE = "https://raw.githubusercontent.com/useshortcut/shortcut-client-js/main/schema/shortcut.swagger.json"
6
+
7
+ def config
8
+ @config ||= JSON.parse(File.read("config.json"))
9
+ end
10
+
11
+ def next_version
12
+ @next_version ||= begin
13
+ major, minor, patch = config["gemVersion"].split(".")
14
+ case ARGV[0]
15
+ when "major" then major = major.to_i + 1
16
+ when "minor" then minor = minor.to_i + 1
17
+ when "patch" then patch = patch.to_i + 1
18
+ else
19
+ puts "you need to provide one argument: patch, minor, or major"
20
+ exit(0)
21
+ end
22
+
23
+ [major, minor, patch].join(".")
24
+ end
25
+ end
26
+
27
+ def rewrite_config
28
+ config["gemVersion"] = next_version
29
+ File.write("config.json", JSON.pretty_generate(config))
30
+ end
31
+
32
+ rewrite_config
33
+ puts "run swagger codegen"
34
+ `swagger-codegen generate -i #{SWAGGER_SOURCE} -l ruby -o . -c config.json`
data/config.json ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "gemName": "shortcut_client_ruby",
3
+ "moduleName": "Shortcut",
4
+ "gemVersion": "0.0.2",
5
+ "gitUserId": "ngouy",
6
+ "gitRepoId": "shortcut_client_ruby"
7
+ }
@@ -0,0 +1,8 @@
1
+ # Shortcut::BasicWorkspaceInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url_slug** | **String** | |
7
+ **estimate_scale** | **Array<Integer>** | |
8
+
data/docs/Branch.md ADDED
@@ -0,0 +1,17 @@
1
+ # Shortcut::Branch
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **entity_type** | **String** | A string description of this resource. |
7
+ **deleted** | **BOOLEAN** | A true/false boolean indicating if the Branch has been deleted. |
8
+ **name** | **String** | The name of the Branch. |
9
+ **persistent** | **BOOLEAN** | A true/false boolean indicating if the Branch is persistent; e.g. master. |
10
+ **updated_at** | **DateTime** | The time/date the Branch was updated. |
11
+ **pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of PullRequests attached to the Branch (there is usually only one). |
12
+ **merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Branch has been merged into. |
13
+ **id** | **Integer** | The unique ID of the Branch. |
14
+ **url** | **String** | The URL of the Branch. |
15
+ **repository_id** | **Integer** | The ID of the Repository that contains the Branch. |
16
+ **created_at** | **DateTime** | The time/date the Branch was created. |
17
+
data/docs/Category.md ADDED
@@ -0,0 +1,15 @@
1
+ # Shortcut::Category
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **archived** | **BOOLEAN** | A true/false boolean indicating if the Category has been archived. |
7
+ **entity_type** | **String** | A string description of this resource. |
8
+ **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). |
9
+ **name** | **String** | The name of the Category. |
10
+ **type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. |
11
+ **updated_at** | **DateTime** | The time/date that the Category was updated. |
12
+ **external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. |
13
+ **id** | **Integer** | The unique ID of the Category. |
14
+ **created_at** | **DateTime** | The time/date that the Category was created. |
15
+
data/docs/Commit.md ADDED
@@ -0,0 +1,19 @@
1
+ # Shortcut::Commit
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **entity_type** | **String** | A string description of this resource. |
7
+ **author_id** | **String** | The ID of the Member that authored the Commit, if known. |
8
+ **hash** | **String** | The Commit hash. |
9
+ **updated_at** | **DateTime** | The time/date the Commit was updated. |
10
+ **merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Commit has been merged into. |
11
+ **id** | **Integer** | The unique ID of the Commit. |
12
+ **url** | **String** | The URL of the Commit. |
13
+ **author_email** | **String** | The email address of the VCS user that authored the Commit. |
14
+ **timestamp** | **DateTime** | The time/date the Commit was pushed. |
15
+ **author_identity** | [**Identity**](Identity.md) | |
16
+ **repository_id** | **Integer** | The ID of the Repository that contains the Commit. |
17
+ **created_at** | **DateTime** | The time/date the Commit was created. |
18
+ **message** | **String** | The Commit message. |
19
+
@@ -0,0 +1,10 @@
1
+ # Shortcut::CreateCategory
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of the new Category. |
7
+ **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional]
8
+ **external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
9
+ **type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. |
10
+
@@ -0,0 +1,9 @@
1
+ # Shortcut::CreateCategoryParams
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of the new Category. |
7
+ **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional]
8
+ **external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
9
+
@@ -0,0 +1,11 @@
1
+ # Shortcut::CreateCommentComment
2
+
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]
11
+
@@ -0,0 +1,9 @@
1
+ # Shortcut::CreateEntityTemplate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of the new entity template |
7
+ **author_id** | **String** | The id of the user creating this template. | [optional]
8
+ **story_contents** | [**CreateStoryContents**](CreateStoryContents.md) | |
9
+
@@ -0,0 +1,23 @@
1
+ # Shortcut::CreateEpic
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **description** | **String** | The Epic's description. | [optional]
7
+ **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of Labels attached to the Epic. | [optional]
8
+ **completed_at_override** | **DateTime** | A manual override for the time/date the Epic was completed. | [optional]
9
+ **name** | **String** | The Epic's name. |
10
+ **planned_start_date** | **DateTime** | The Epic's planned start date. | [optional]
11
+ **state** | **String** | `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. | [optional]
12
+ **milestone_id** | **Integer** | The ID of the Milestone this Epic is related to. | [optional]
13
+ **requested_by_id** | **String** | The ID of the member that requested the epic. | [optional]
14
+ **epic_state_id** | **Integer** | The ID of the Epic State. | [optional]
15
+ **started_at_override** | **DateTime** | A manual override for the time/date the Epic was started. | [optional]
16
+ **group_id** | **String** | The ID of the group to associate with the epic. | [optional]
17
+ **updated_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional]
18
+ **follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this new Epic. | [optional]
19
+ **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | [optional]
20
+ **external_id** | **String** | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
21
+ **deadline** | **DateTime** | The Epic's deadline. | [optional]
22
+ **created_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional]
23
+
@@ -0,0 +1,11 @@
1
+ # Shortcut::CreateEpicComment
2
+
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]
11
+
@@ -0,0 +1,14 @@
1
+ # Shortcut::CreateGroup
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **description** | **String** | The description of the Group. | [optional]
7
+ **member_ids** | **Array<String>** | The Member ids to add to this Group. | [optional]
8
+ **workflow_ids** | **Array<Integer>** | The Workflow ids to add to the Group. | [optional]
9
+ **name** | **String** | The name of this Group. |
10
+ **mention_name** | **String** | The mention name of this Group. |
11
+ **color** | **String** | The color you wish to use for the Group in the system. | [optional]
12
+ **color_key** | **String** | The color key you wish to use for the Group in the system. | [optional]
13
+ **display_icon_id** | **String** | The Icon id for the avatar of this Group. | [optional]
14
+
@@ -0,0 +1,13 @@
1
+ # Shortcut::CreateIteration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers. | [optional]
7
+ **group_ids** | **Array<String>** | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. | [optional]
8
+ **labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of Labels attached to the Iteration. | [optional]
9
+ **description** | **String** | The description of the Iteration. | [optional]
10
+ **name** | **String** | The name of this Iteration. |
11
+ **start_date** | **String** | The date this Iteration begins, e.g. 2019-07-01. |
12
+ **end_date** | **String** | The date this Iteration ends, e.g. 2019-07-01. |
13
+
@@ -0,0 +1,10 @@
1
+ # Shortcut::CreateLabelParams
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of the new Label. |
7
+ **description** | **String** | The description of the new Label. | [optional]
8
+ **color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | [optional]
9
+ **external_id** | **String** | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. | [optional]
10
+
@@ -0,0 +1,15 @@
1
+ # Shortcut::CreateLinkedFile
2
+
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. |
15
+
@@ -0,0 +1,12 @@
1
+ # Shortcut::CreateMilestone
2
+
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]
12
+
@@ -0,0 +1,7 @@
1
+ # Shortcut::CreateOrDeleteStoryReaction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **emoji** | **String** | The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. |
7
+
@@ -0,0 +1,17 @@
1
+ # Shortcut::CreateProject
2
+
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]
17
+
@@ -0,0 +1,7 @@
1
+ # Shortcut::CreateStories
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **stories** | [**Array<CreateStoryParams>**](CreateStoryParams.md) | An array of stories to be created. |
7
+
@@ -0,0 +1,11 @@
1
+ # Shortcut::CreateStoryComment
2
+
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]
11
+
@@ -0,0 +1,11 @@
1
+ # Shortcut::CreateStoryCommentParams
2
+
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]
11
+
@@ -0,0 +1,27 @@
1
+ # Shortcut::CreateStoryContents
2
+
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]
27
+
@@ -0,0 +1,9 @@
1
+ # Shortcut::CreateStoryLink
2
+
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. |
9
+
@@ -0,0 +1,9 @@
1
+ # Shortcut::CreateStoryLinkParams
2
+
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]
9
+
@@ -0,0 +1,33 @@
1
+ # Shortcut::CreateStoryParams
2
+
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]
33
+
@@ -0,0 +1,12 @@
1
+ # Shortcut::CreateTask
2
+
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]
12
+
@@ -0,0 +1,12 @@
1
+ # Shortcut::CreateTaskParams
2
+
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]
12
+