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.
- checksums.yaml +4 -4
- data/Gemfile.lock +74 -0
- data/README.md +31 -1986
- data/Rakefile +2 -0
- data/bin/update.rb +8 -4
- data/config.json +2 -1
- data/docs/BasicWorkspaceInfo.md +16 -4
- data/docs/Branch.md +34 -13
- data/docs/Category.md +30 -11
- data/docs/Commit.md +38 -15
- data/docs/CreateCategory.md +20 -6
- data/docs/CreateCategoryParams.md +18 -5
- data/docs/CreateCommentComment.md +22 -7
- data/docs/CreateEntityTemplate.md +18 -5
- data/docs/CreateEpic.md +46 -19
- data/docs/CreateEpicComment.md +22 -7
- data/docs/CreateGroup.md +28 -10
- data/docs/CreateIteration.md +26 -9
- data/docs/CreateLabelParams.md +20 -6
- data/docs/CreateLinkedFile.md +30 -11
- data/docs/CreateMilestone.md +24 -8
- data/docs/CreateOrDeleteStoryReaction.md +14 -3
- data/docs/CreateProject.md +34 -13
- data/docs/CreateStories.md +14 -3
- data/docs/CreateStoryComment.md +22 -7
- data/docs/CreateStoryCommentParams.md +22 -7
- data/docs/CreateStoryContents.md +54 -23
- data/docs/CreateStoryLink.md +18 -5
- data/docs/CreateStoryLinkParams.md +18 -5
- data/docs/CreateStoryParams.md +66 -29
- data/docs/CreateTask.md +24 -8
- data/docs/CreateTaskParams.md +24 -8
- data/docs/DefaultApi.md +3569 -1641
- data/docs/DeleteStories.md +14 -3
- data/docs/EntityTemplate.md +28 -10
- data/docs/EntityTemplateTask.md +20 -6
- data/docs/Epic.md +88 -40
- data/docs/EpicSearchResults.md +20 -6
- data/docs/EpicSlim.md +86 -39
- data/docs/EpicState.md +30 -11
- data/docs/EpicStats.md +38 -15
- data/docs/EpicWorkflow.md +24 -8
- data/docs/GetEpicStories.md +14 -3
- data/docs/GetExternalLinkStoriesParams.md +14 -3
- data/docs/GetIterationStories.md +14 -3
- data/docs/GetLabelStories.md +14 -3
- data/docs/GetMember.md +14 -3
- data/docs/GetProjectStories.md +14 -3
- data/docs/Group.md +44 -18
- data/docs/History.md +30 -11
- data/docs/HistoryActionBranchCreate.md +22 -7
- data/docs/HistoryActionBranchMerge.md +22 -7
- data/docs/HistoryActionBranchPush.md +22 -7
- data/docs/HistoryActionLabelCreate.md +22 -7
- data/docs/HistoryActionLabelDelete.md +20 -6
- data/docs/HistoryActionLabelUpdate.md +18 -5
- data/docs/HistoryActionProjectUpdate.md +22 -7
- data/docs/HistoryActionPullRequest.md +24 -8
- data/docs/HistoryActionStoryCommentCreate.md +24 -8
- data/docs/HistoryActionStoryCreate.md +60 -26
- data/docs/HistoryActionStoryDelete.md +22 -7
- data/docs/HistoryActionStoryLinkCreate.md +24 -8
- data/docs/HistoryActionStoryLinkDelete.md +24 -8
- data/docs/HistoryActionStoryLinkUpdate.md +26 -9
- data/docs/HistoryActionStoryUpdate.md +26 -9
- data/docs/HistoryActionTaskCreate.md +30 -11
- data/docs/HistoryActionTaskDelete.md +20 -6
- data/docs/HistoryActionTaskUpdate.md +26 -9
- data/docs/HistoryChangesStory.md +60 -26
- data/docs/HistoryChangesStoryLink.md +18 -5
- data/docs/HistoryChangesTask.md +20 -6
- data/docs/HistoryReferenceBranch.md +20 -6
- data/docs/HistoryReferenceCommit.md +20 -6
- data/docs/HistoryReferenceEpic.md +20 -6
- data/docs/HistoryReferenceGeneral.md +18 -5
- data/docs/HistoryReferenceGroup.md +18 -5
- data/docs/HistoryReferenceIteration.md +20 -6
- data/docs/HistoryReferenceLabel.md +20 -6
- data/docs/HistoryReferenceProject.md +20 -6
- data/docs/HistoryReferenceStory.md +22 -7
- data/docs/HistoryReferenceStoryTask.md +18 -5
- data/docs/HistoryReferenceWorkflowState.md +20 -6
- data/docs/Icon.md +22 -7
- data/docs/Identity.md +18 -5
- data/docs/Iteration.md +48 -20
- data/docs/IterationSlim.md +46 -19
- data/docs/IterationStats.md +34 -13
- data/docs/Label.md +34 -13
- data/docs/LabelSlim.md +32 -12
- data/docs/LabelStats.md +42 -17
- data/docs/LinkedFile.md +44 -18
- data/docs/ListEpics.md +14 -3
- data/docs/ListGroupStories.md +16 -4
- data/docs/ListLabels.md +14 -3
- data/docs/ListMembers.md +14 -3
- data/docs/MaxSearchResultsExceededError.md +18 -5
- data/docs/Member.md +34 -13
- data/docs/MemberInfo.md +20 -6
- data/docs/Milestone.md +46 -19
- data/docs/MilestoneStats.md +18 -5
- data/docs/Profile.md +30 -11
- data/docs/Project.md +50 -21
- data/docs/ProjectStats.md +18 -5
- data/docs/PullRequest.md +56 -24
- data/docs/PullRequestLabel.md +22 -7
- data/docs/Repository.md +30 -11
- data/docs/Search.md +20 -6
- data/docs/SearchResults.md +16 -4
- data/docs/SearchStories.md +68 -30
- data/docs/Story.md +112 -52
- data/docs/StoryComment.md +40 -16
- data/docs/StoryContents.md +50 -21
- data/docs/StoryContentsTask.md +22 -7
- data/docs/StoryHistoryChangeAddsRemovesInt.md +16 -4
- data/docs/StoryHistoryChangeAddsRemovesUuid.md +16 -4
- data/docs/StoryHistoryChangeOldNewBool.md +16 -4
- data/docs/StoryHistoryChangeOldNewInt.md +16 -4
- data/docs/StoryHistoryChangeOldNewStr.md +16 -4
- data/docs/StoryHistoryChangeOldNewUuid.md +16 -4
- data/docs/StoryLink.md +28 -10
- data/docs/StoryReaction.md +16 -4
- data/docs/StorySearchResults.md +20 -6
- data/docs/StorySlim.md +108 -50
- data/docs/StoryStats.md +14 -3
- data/docs/Task.md +40 -16
- data/docs/ThreadedComment.md +38 -15
- data/docs/TypedStoryLink.md +30 -11
- data/docs/UnusableEntitlementError.md +18 -5
- data/docs/UpdateCategory.md +18 -5
- data/docs/UpdateComment.md +14 -3
- data/docs/UpdateEntityTemplate.md +16 -4
- data/docs/UpdateEpic.md +46 -19
- data/docs/UpdateFile.md +24 -8
- data/docs/UpdateGroup.md +30 -11
- data/docs/UpdateIteration.md +26 -9
- data/docs/UpdateLabel.md +20 -6
- data/docs/UpdateLinkedFile.md +28 -10
- data/docs/UpdateMilestone.md +28 -10
- data/docs/UpdateProject.md +30 -11
- data/docs/UpdateStories.md +54 -23
- data/docs/UpdateStory.md +64 -28
- data/docs/UpdateStoryComment.md +14 -3
- data/docs/UpdateStoryContents.md +54 -23
- data/docs/UpdateStoryLink.md +18 -5
- data/docs/UpdateTask.md +22 -7
- data/docs/UploadedFile.md +46 -19
- data/docs/Workflow.md +34 -13
- data/docs/WorkflowState.md +36 -14
- data/git_push.sh +11 -9
- data/lib/shortcut_client_ruby/api/default_api.rb +2119 -1248
- data/lib/shortcut_client_ruby/api_client.rb +143 -106
- data/lib/shortcut_client_ruby/api_error.rb +4 -4
- data/lib/shortcut_client_ruby/configuration.rb +163 -32
- data/lib/shortcut_client_ruby/models/basic_workspace_info.rb +26 -13
- data/lib/shortcut_client_ruby/models/branch.rb +35 -42
- data/lib/shortcut_client_ruby/models/category.rb +57 -28
- data/lib/shortcut_client_ruby/models/commit.rb +37 -44
- data/lib/shortcut_client_ruby/models/create_category.rb +90 -17
- data/lib/shortcut_client_ruby/models/create_category_params.rb +87 -14
- data/lib/shortcut_client_ruby/models/create_comment_comment.rb +57 -16
- data/lib/shortcut_client_ruby/models/create_entity_template.rb +46 -14
- data/lib/shortcut_client_ruby/models/create_epic.rb +86 -30
- data/lib/shortcut_client_ruby/models/create_epic_comment.rb +57 -16
- data/lib/shortcut_client_ruby/models/create_group.rb +104 -21
- data/lib/shortcut_client_ruby/models/create_iteration.rb +103 -18
- data/lib/shortcut_client_ruby/models/create_label_params.rb +97 -15
- data/lib/shortcut_client_ruby/models/create_linked_file.rb +110 -22
- data/lib/shortcut_client_ruby/models/create_milestone.rb +75 -19
- data/lib/shortcut_client_ruby/models/create_or_delete_story_reaction.rb +25 -12
- data/lib/shortcut_client_ruby/models/create_project.rb +104 -22
- data/lib/shortcut_client_ruby/models/create_stories.rb +25 -12
- data/lib/shortcut_client_ruby/models/create_story_comment.rb +48 -16
- data/lib/shortcut_client_ruby/models/create_story_comment_params.rb +48 -16
- data/lib/shortcut_client_ruby/models/create_story_contents.rb +57 -32
- data/lib/shortcut_client_ruby/models/create_story_link.rb +29 -16
- data/lib/shortcut_client_ruby/models/create_story_link_params.rb +29 -16
- data/lib/shortcut_client_ruby/models/create_story_params.rb +120 -40
- data/lib/shortcut_client_ruby/models/create_task.rb +30 -17
- data/lib/shortcut_client_ruby/models/create_task_params.rb +30 -17
- data/lib/shortcut_client_ruby/models/delete_stories.rb +35 -12
- data/lib/shortcut_client_ruby/models/entity_template.rb +32 -19
- data/lib/shortcut_client_ruby/models/entity_template_task.rb +28 -15
- data/lib/shortcut_client_ruby/models/epic.rb +62 -124
- data/lib/shortcut_client_ruby/models/epic_search_results.rb +28 -20
- data/lib/shortcut_client_ruby/models/epic_slim.rb +61 -123
- data/lib/shortcut_client_ruby/models/epic_state.rb +59 -20
- data/lib/shortcut_client_ruby/models/epic_stats.rb +37 -29
- data/lib/shortcut_client_ruby/models/epic_workflow.rb +30 -17
- data/lib/shortcut_client_ruby/models/get_epic_stories.rb +25 -12
- data/lib/shortcut_client_ruby/models/get_external_link_stories_params.rb +55 -12
- data/lib/shortcut_client_ruby/models/get_iteration_stories.rb +25 -12
- data/lib/shortcut_client_ruby/models/get_label_stories.rb +25 -12
- data/lib/shortcut_client_ruby/models/get_member.rb +25 -12
- data/lib/shortcut_client_ruby/models/get_project_stories.rb +25 -12
- data/lib/shortcut_client_ruby/models/group.rb +96 -37
- data/lib/shortcut_client_ruby/models/history.rb +35 -22
- data/lib/shortcut_client_ruby/models/history_action_branch_create.rb +31 -18
- data/lib/shortcut_client_ruby/models/history_action_branch_merge.rb +31 -18
- data/lib/shortcut_client_ruby/models/history_action_branch_push.rb +31 -18
- data/lib/shortcut_client_ruby/models/history_action_label_create.rb +61 -18
- data/lib/shortcut_client_ruby/models/history_action_label_delete.rb +30 -17
- data/lib/shortcut_client_ruby/models/history_action_label_update.rb +29 -16
- data/lib/shortcut_client_ruby/models/history_action_project_update.rb +61 -18
- data/lib/shortcut_client_ruby/models/history_action_pull_request.rb +62 -19
- data/lib/shortcut_client_ruby/models/history_action_story_comment_create.rb +62 -19
- data/lib/shortcut_client_ruby/models/history_action_story_create.rb +82 -39
- data/lib/shortcut_client_ruby/models/history_action_story_delete.rb +33 -20
- data/lib/shortcut_client_ruby/models/history_action_story_link_create.rb +34 -21
- data/lib/shortcut_client_ruby/models/history_action_story_link_delete.rb +34 -31
- data/lib/shortcut_client_ruby/models/history_action_story_link_update.rb +35 -22
- data/lib/shortcut_client_ruby/models/history_action_story_update.rb +65 -22
- data/lib/shortcut_client_ruby/models/history_action_task_create.rb +35 -22
- data/lib/shortcut_client_ruby/models/history_action_task_delete.rb +30 -17
- data/lib/shortcut_client_ruby/models/history_action_task_update.rb +33 -20
- data/lib/shortcut_client_ruby/models/history_changes_story.rb +48 -35
- data/lib/shortcut_client_ruby/models/history_changes_story_link.rb +27 -14
- data/lib/shortcut_client_ruby/models/history_changes_task.rb +28 -15
- data/lib/shortcut_client_ruby/models/history_reference_branch.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_commit.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_epic.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_general.rb +27 -14
- data/lib/shortcut_client_ruby/models/history_reference_group.rb +27 -14
- data/lib/shortcut_client_ruby/models/history_reference_iteration.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_label.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_project.rb +58 -15
- data/lib/shortcut_client_ruby/models/history_reference_story.rb +61 -18
- data/lib/shortcut_client_ruby/models/history_reference_story_task.rb +27 -14
- data/lib/shortcut_client_ruby/models/history_reference_workflow_state.rb +30 -17
- data/lib/shortcut_client_ruby/models/icon.rb +29 -16
- data/lib/shortcut_client_ruby/models/identity.rb +27 -24
- data/lib/shortcut_client_ruby/models/iteration.rb +42 -29
- data/lib/shortcut_client_ruby/models/iteration_slim.rb +41 -28
- data/lib/shortcut_client_ruby/models/iteration_stats.rb +35 -22
- data/lib/shortcut_client_ruby/models/label.rb +59 -45
- data/lib/shortcut_client_ruby/models/label_slim.rb +58 -44
- data/lib/shortcut_client_ruby/models/label_stats.rb +39 -26
- data/lib/shortcut_client_ruby/models/linked_file.rb +40 -47
- data/lib/shortcut_client_ruby/models/list_epics.rb +25 -12
- data/lib/shortcut_client_ruby/models/list_group_stories.rb +26 -13
- data/lib/shortcut_client_ruby/models/list_labels.rb +25 -12
- data/lib/shortcut_client_ruby/models/list_members.rb +25 -12
- data/lib/shortcut_client_ruby/models/max_search_results_exceeded_error.rb +31 -18
- data/lib/shortcut_client_ruby/models/member.rb +37 -34
- data/lib/shortcut_client_ruby/models/member_info.rb +28 -15
- data/lib/shortcut_client_ruby/models/milestone.rb +41 -48
- data/lib/shortcut_client_ruby/models/milestone_stats.rb +27 -14
- data/lib/shortcut_client_ruby/models/profile.rb +33 -35
- data/lib/shortcut_client_ruby/models/project.rb +67 -58
- data/lib/shortcut_client_ruby/models/project_stats.rb +27 -14
- data/lib/shortcut_client_ruby/models/pull_request.rb +46 -43
- data/lib/shortcut_client_ruby/models/pull_request_label.rb +59 -16
- data/lib/shortcut_client_ruby/models/repository.rb +33 -55
- data/lib/shortcut_client_ruby/models/search.rb +49 -17
- data/lib/shortcut_client_ruby/models/search_results.rb +26 -13
- data/lib/shortcut_client_ruby/models/search_stories.rb +105 -41
- data/lib/shortcut_client_ruby/models/story.rb +74 -131
- data/lib/shortcut_client_ruby/models/story_comment.rb +38 -40
- data/lib/shortcut_client_ruby/models/story_contents.rb +43 -30
- data/lib/shortcut_client_ruby/models/story_contents_task.rb +29 -16
- data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_int.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_history_change_adds_removes_uuid.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_history_change_old_new_bool.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_history_change_old_new_int.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_history_change_old_new_str.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_history_change_old_new_uuid.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_link.rb +32 -19
- data/lib/shortcut_client_ruby/models/story_reaction.rb +26 -13
- data/lib/shortcut_client_ruby/models/story_search_results.rb +28 -20
- data/lib/shortcut_client_ruby/models/story_slim.rb +72 -129
- data/lib/shortcut_client_ruby/models/story_stats.rb +25 -12
- data/lib/shortcut_client_ruby/models/task.rb +38 -40
- data/lib/shortcut_client_ruby/models/threaded_comment.rb +37 -29
- data/lib/shortcut_client_ruby/models/typed_story_link.rb +33 -20
- data/lib/shortcut_client_ruby/models/unusable_entitlement_error.rb +85 -16
- data/lib/shortcut_client_ruby/models/update_category.rb +68 -14
- data/lib/shortcut_client_ruby/models/update_comment.rb +25 -12
- data/lib/shortcut_client_ruby/models/update_entity_template.rb +41 -13
- data/lib/shortcut_client_ruby/models/update_epic.rb +82 -30
- data/lib/shortcut_client_ruby/models/update_file.rb +54 -17
- data/lib/shortcut_client_ruby/models/update_group.rb +97 -22
- data/lib/shortcut_client_ruby/models/update_iteration.rb +91 -18
- data/lib/shortcut_client_ruby/models/update_label.rb +78 -15
- data/lib/shortcut_client_ruby/models/update_linked_file.rb +101 -21
- data/lib/shortcut_client_ruby/models/update_milestone.rb +73 -21
- data/lib/shortcut_client_ruby/models/update_project.rb +98 -20
- data/lib/shortcut_client_ruby/models/update_stories.rb +83 -36
- data/lib/shortcut_client_ruby/models/update_story.rb +135 -41
- data/lib/shortcut_client_ruby/models/update_story_comment.rb +44 -12
- data/lib/shortcut_client_ruby/models/update_story_contents.rb +57 -32
- data/lib/shortcut_client_ruby/models/update_story_link.rb +29 -16
- data/lib/shortcut_client_ruby/models/update_task.rb +29 -16
- data/lib/shortcut_client_ruby/models/uploaded_file.rb +41 -53
- data/lib/shortcut_client_ruby/models/workflow.rb +35 -22
- data/lib/shortcut_client_ruby/models/workflow_state.rb +60 -26
- data/lib/shortcut_client_ruby/version.rb +5 -4
- data/lib/shortcut_client_ruby.rb +4 -4
- data/openapi-generator-cli.jar +0 -0
- data/shortcut_client_ruby-0.0.4.gem +0 -0
- data/shortcut_client_ruby.gemspec +7 -6
- data/spec/api/default_api_spec.rb +64 -63
- data/spec/api_client_spec.rb +7 -44
- data/spec/configuration_spec.rb +7 -6
- data/spec/models/basic_workspace_info_spec.rb +8 -14
- data/spec/models/branch_spec.rb +8 -14
- data/spec/models/category_spec.rb +8 -14
- data/spec/models/commit_spec.rb +8 -14
- data/spec/models/create_category_params_spec.rb +8 -14
- data/spec/models/create_category_spec.rb +9 -15
- data/spec/models/create_comment_comment_spec.rb +8 -14
- data/spec/models/create_entity_template_spec.rb +8 -14
- data/spec/models/create_epic_comment_spec.rb +8 -14
- data/spec/models/create_epic_spec.rb +9 -15
- data/spec/models/create_group_spec.rb +9 -15
- data/spec/models/create_iteration_spec.rb +8 -14
- data/spec/models/create_label_params_spec.rb +8 -14
- data/spec/models/create_linked_file_spec.rb +9 -15
- data/spec/models/create_milestone_spec.rb +9 -15
- data/spec/models/create_or_delete_story_reaction_spec.rb +8 -14
- data/spec/models/create_project_spec.rb +8 -14
- data/spec/models/create_stories_spec.rb +8 -14
- data/spec/models/create_story_comment_params_spec.rb +8 -14
- data/spec/models/create_story_comment_spec.rb +8 -14
- data/spec/models/create_story_contents_spec.rb +8 -14
- data/spec/models/create_story_link_params_spec.rb +9 -15
- data/spec/models/create_story_link_spec.rb +9 -15
- data/spec/models/create_story_params_spec.rb +9 -15
- data/spec/models/create_task_params_spec.rb +8 -14
- data/spec/models/create_task_spec.rb +8 -14
- data/spec/models/delete_stories_spec.rb +8 -14
- data/spec/models/entity_template_spec.rb +8 -14
- data/spec/models/entity_template_task_spec.rb +8 -14
- data/spec/models/epic_search_results_spec.rb +8 -14
- data/spec/models/epic_slim_spec.rb +8 -14
- data/spec/models/epic_spec.rb +8 -14
- data/spec/models/epic_state_spec.rb +8 -14
- data/spec/models/epic_stats_spec.rb +8 -14
- data/spec/models/epic_workflow_spec.rb +8 -14
- data/spec/models/get_epic_stories_spec.rb +8 -14
- data/spec/models/get_external_link_stories_params_spec.rb +8 -14
- data/spec/models/get_iteration_stories_spec.rb +8 -14
- data/spec/models/get_label_stories_spec.rb +8 -14
- data/spec/models/get_member_spec.rb +8 -14
- data/spec/models/get_project_stories_spec.rb +8 -14
- data/spec/models/group_spec.rb +9 -15
- data/spec/models/history_action_branch_create_spec.rb +9 -15
- data/spec/models/history_action_branch_merge_spec.rb +9 -15
- data/spec/models/history_action_branch_push_spec.rb +9 -15
- data/spec/models/history_action_label_create_spec.rb +9 -15
- data/spec/models/history_action_label_delete_spec.rb +9 -15
- data/spec/models/history_action_label_update_spec.rb +9 -15
- data/spec/models/history_action_project_update_spec.rb +9 -15
- data/spec/models/history_action_pull_request_spec.rb +9 -15
- data/spec/models/history_action_story_comment_create_spec.rb +9 -15
- data/spec/models/history_action_story_create_spec.rb +10 -16
- data/spec/models/history_action_story_delete_spec.rb +10 -16
- data/spec/models/history_action_story_link_create_spec.rb +10 -16
- data/spec/models/history_action_story_link_delete_spec.rb +10 -16
- data/spec/models/history_action_story_link_update_spec.rb +10 -16
- data/spec/models/history_action_story_update_spec.rb +10 -16
- data/spec/models/history_action_task_create_spec.rb +9 -15
- data/spec/models/history_action_task_delete_spec.rb +9 -15
- data/spec/models/history_action_task_update_spec.rb +9 -15
- data/spec/models/history_changes_story_link_spec.rb +8 -14
- data/spec/models/history_changes_story_spec.rb +8 -14
- data/spec/models/history_changes_task_spec.rb +8 -14
- data/spec/models/history_reference_branch_spec.rb +8 -14
- data/spec/models/history_reference_commit_spec.rb +8 -14
- data/spec/models/history_reference_epic_spec.rb +8 -14
- data/spec/models/history_reference_general_spec.rb +8 -14
- data/spec/models/history_reference_group_spec.rb +8 -14
- data/spec/models/history_reference_iteration_spec.rb +8 -14
- data/spec/models/history_reference_label_spec.rb +8 -14
- data/spec/models/history_reference_project_spec.rb +8 -14
- data/spec/models/history_reference_story_spec.rb +9 -15
- data/spec/models/history_reference_story_task_spec.rb +8 -14
- data/spec/models/history_reference_workflow_state_spec.rb +9 -15
- data/spec/models/history_spec.rb +9 -15
- data/spec/models/icon_spec.rb +8 -14
- data/spec/models/identity_spec.rb +8 -14
- data/spec/models/iteration_slim_spec.rb +8 -14
- data/spec/models/iteration_spec.rb +8 -14
- data/spec/models/iteration_stats_spec.rb +8 -14
- data/spec/models/label_slim_spec.rb +8 -14
- data/spec/models/label_spec.rb +8 -14
- data/spec/models/label_stats_spec.rb +8 -14
- data/spec/models/linked_file_spec.rb +8 -14
- data/spec/models/list_epics_spec.rb +8 -14
- data/spec/models/list_group_stories_spec.rb +8 -14
- data/spec/models/list_labels_spec.rb +8 -14
- data/spec/models/list_members_spec.rb +8 -14
- data/spec/models/max_search_results_exceeded_error_spec.rb +11 -17
- data/spec/models/member_info_spec.rb +8 -14
- data/spec/models/member_spec.rb +9 -15
- data/spec/models/milestone_spec.rb +8 -14
- data/spec/models/milestone_stats_spec.rb +8 -14
- data/spec/models/profile_spec.rb +8 -14
- data/spec/models/project_spec.rb +8 -14
- data/spec/models/project_stats_spec.rb +8 -14
- data/spec/models/pull_request_label_spec.rb +8 -14
- data/spec/models/pull_request_spec.rb +8 -14
- data/spec/models/repository_spec.rb +8 -14
- data/spec/models/search_results_spec.rb +8 -14
- data/spec/models/search_spec.rb +9 -15
- data/spec/models/search_stories_spec.rb +10 -16
- data/spec/models/story_comment_spec.rb +8 -14
- data/spec/models/story_contents_spec.rb +8 -14
- data/spec/models/story_contents_task_spec.rb +8 -14
- data/spec/models/story_history_change_adds_removes_int_spec.rb +8 -14
- data/spec/models/story_history_change_adds_removes_uuid_spec.rb +8 -14
- data/spec/models/story_history_change_old_new_bool_spec.rb +8 -14
- data/spec/models/story_history_change_old_new_int_spec.rb +8 -14
- data/spec/models/story_history_change_old_new_str_spec.rb +8 -14
- data/spec/models/story_history_change_old_new_uuid_spec.rb +8 -14
- data/spec/models/story_link_spec.rb +8 -14
- data/spec/models/story_reaction_spec.rb +8 -14
- data/spec/models/story_search_results_spec.rb +8 -14
- data/spec/models/story_slim_spec.rb +8 -14
- data/spec/models/story_spec.rb +8 -14
- data/spec/models/story_stats_spec.rb +8 -14
- data/spec/models/task_spec.rb +8 -14
- data/spec/models/threaded_comment_spec.rb +8 -14
- data/spec/models/typed_story_link_spec.rb +8 -14
- data/spec/models/unusable_entitlement_error_spec.rb +9 -15
- data/spec/models/update_category_spec.rb +8 -14
- data/spec/models/update_comment_spec.rb +8 -14
- data/spec/models/update_entity_template_spec.rb +8 -14
- data/spec/models/update_epic_spec.rb +9 -15
- data/spec/models/update_file_spec.rb +8 -14
- data/spec/models/update_group_spec.rb +9 -15
- data/spec/models/update_iteration_spec.rb +8 -14
- data/spec/models/update_label_spec.rb +8 -14
- data/spec/models/update_linked_file_spec.rb +9 -15
- data/spec/models/update_milestone_spec.rb +9 -15
- data/spec/models/update_project_spec.rb +8 -14
- data/spec/models/update_stories_spec.rb +10 -16
- data/spec/models/update_story_comment_spec.rb +8 -14
- data/spec/models/update_story_contents_spec.rb +8 -14
- data/spec/models/update_story_link_spec.rb +9 -15
- data/spec/models/update_story_spec.rb +10 -16
- data/spec/models/update_task_spec.rb +8 -14
- data/spec/models/uploaded_file_spec.rb +8 -14
- data/spec/models/workflow_spec.rb +8 -14
- data/spec/models/workflow_state_spec.rb +8 -14
- data/spec/spec_helper.rb +4 -3
- metadata +18 -30
- data/docs/V3FilesBody.md +0 -11
- data/lib/shortcut/client/ruby/version.rb +0 -9
- data/lib/shortcut/client/ruby.rb +0 -12
- data/lib/shortcut_client_ruby/models/v3_files_body.rb +0 -252
- data/shortcut-client-ruby.gemspec +0 -36
- data/spec/base_object_spec.rb +0 -109
- data/spec/models/v3_files_body_spec.rb +0 -64
@@ -1,10 +1,24 @@
|
|
1
1
|
# Shortcut::HistoryReferenceIteration
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **app_url** | **String** | The application URL of the Iteration. | |
|
10
|
+
| **name** | **String** | The name of the entity referenced. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'shortcut_client_ruby'
|
16
|
+
|
17
|
+
instance = Shortcut::HistoryReferenceIteration.new(
|
18
|
+
id: null,
|
19
|
+
entity_type: null,
|
20
|
+
app_url: null,
|
21
|
+
name: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
@@ -1,10 +1,24 @@
|
|
1
1
|
# Shortcut::HistoryReferenceLabel
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **app_url** | **String** | The application URL of the Label. | |
|
10
|
+
| **name** | **String** | The name of the entity referenced. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'shortcut_client_ruby'
|
16
|
+
|
17
|
+
instance = Shortcut::HistoryReferenceLabel.new(
|
18
|
+
id: null,
|
19
|
+
entity_type: null,
|
20
|
+
app_url: null,
|
21
|
+
name: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
@@ -1,10 +1,24 @@
|
|
1
1
|
# Shortcut::HistoryReferenceProject
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **app_url** | **String** | The application URL of the Project. | |
|
10
|
+
| **name** | **String** | The name of the entity referenced. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'shortcut_client_ruby'
|
16
|
+
|
17
|
+
instance = Shortcut::HistoryReferenceProject.new(
|
18
|
+
id: null,
|
19
|
+
entity_type: null,
|
20
|
+
app_url: null,
|
21
|
+
name: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
@@ -1,11 +1,26 @@
|
|
1
1
|
# Shortcut::HistoryReferenceStory
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **app_url** | **String** | The application URL of the Story. | |
|
10
|
+
| **name** | **String** | The name of the entity referenced. | |
|
11
|
+
| **story_type** | **String** | If the referenced entity is a Story, either \"bug\", \"chore\", or \"feature\". | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'shortcut_client_ruby'
|
17
|
+
|
18
|
+
instance = Shortcut::HistoryReferenceStory.new(
|
19
|
+
id: null,
|
20
|
+
entity_type: null,
|
21
|
+
app_url: null,
|
22
|
+
name: null,
|
23
|
+
story_type: null
|
24
|
+
)
|
25
|
+
```
|
11
26
|
|
@@ -1,9 +1,22 @@
|
|
1
1
|
# Shortcut::HistoryReferenceStoryTask
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **description** | **String** | The description of the Story Task. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'shortcut_client_ruby'
|
15
|
+
|
16
|
+
instance = Shortcut::HistoryReferenceStoryTask.new(
|
17
|
+
id: null,
|
18
|
+
entity_type: null,
|
19
|
+
description: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
@@ -1,10 +1,24 @@
|
|
1
1
|
# Shortcut::HistoryReferenceWorkflowState
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the entity referenced. | |
|
8
|
+
| **entity_type** | **String** | The type of entity referenced. | |
|
9
|
+
| **type** | **String** | Either \"unstarted\", \"started\", or \"done\". | |
|
10
|
+
| **name** | **String** | The name of the entity referenced. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'shortcut_client_ruby'
|
16
|
+
|
17
|
+
instance = Shortcut::HistoryReferenceWorkflowState.new(
|
18
|
+
id: null,
|
19
|
+
entity_type: null,
|
20
|
+
type: null,
|
21
|
+
name: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
data/docs/Icon.md
CHANGED
@@ -1,11 +1,26 @@
|
|
1
1
|
# Shortcut::Icon
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **entity_type** | **String** | A string description of this resource. | |
|
8
|
+
| **id** | **String** | The unique ID of the Icon. | |
|
9
|
+
| **created_at** | **Time** | The time/date that the Icon was created. | |
|
10
|
+
| **updated_at** | **Time** | The time/date that the Icon was updated. | |
|
11
|
+
| **url** | **String** | The URL of the Icon. | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'shortcut_client_ruby'
|
17
|
+
|
18
|
+
instance = Shortcut::Icon.new(
|
19
|
+
entity_type: null,
|
20
|
+
id: null,
|
21
|
+
created_at: null,
|
22
|
+
updated_at: null,
|
23
|
+
url: null
|
24
|
+
)
|
25
|
+
```
|
11
26
|
|
data/docs/Identity.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# Shortcut::Identity
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **entity_type** | **String** | A string description of this resource. | |
|
8
|
+
| **name** | **String** | This is your login in VCS. | |
|
9
|
+
| **type** | **String** | The type of Identity; currently only type is github. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'shortcut_client_ruby'
|
15
|
+
|
16
|
+
instance = Shortcut::Identity.new(
|
17
|
+
entity_type: null,
|
18
|
+
name: null,
|
19
|
+
type: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
data/docs/Iteration.md
CHANGED
@@ -1,24 +1,52 @@
|
|
1
1
|
# Shortcut::Iteration
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
21
|
-
**
|
22
|
-
**
|
23
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **app_url** | **String** | The Shortcut application url for the Iteration. | |
|
8
|
+
| **description** | **String** | The description of the iteration. | |
|
9
|
+
| **entity_type** | **String** | A string description of this resource | |
|
10
|
+
| **labels** | [**Array<Label>**](Label.md) | An array of labels attached to the iteration. | |
|
11
|
+
| **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | |
|
12
|
+
| **member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in the Story description. | |
|
13
|
+
| **name** | **String** | The name of the iteration. | |
|
14
|
+
| **label_ids** | **Array<Integer>** | An array of label ids attached to the iteration. | |
|
15
|
+
| **updated_at** | **Time** | The instant when this iteration was last updated. | |
|
16
|
+
| **group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | |
|
17
|
+
| **end_date** | **Time** | The date this iteration begins. | |
|
18
|
+
| **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | |
|
19
|
+
| **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. | |
|
20
|
+
| **start_date** | **Time** | The date this iteration begins. | |
|
21
|
+
| **status** | **String** | The status of the iteration. Values are either \"unstarted\", \"started\", or \"done\". | |
|
22
|
+
| **id** | **Integer** | The ID of the iteration. | |
|
23
|
+
| **stats** | [**IterationStats**](IterationStats.md) | | |
|
24
|
+
| **created_at** | **Time** | The instant when this iteration was created. | |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'shortcut_client_ruby'
|
30
|
+
|
31
|
+
instance = Shortcut::Iteration.new(
|
32
|
+
app_url: null,
|
33
|
+
description: null,
|
34
|
+
entity_type: null,
|
35
|
+
labels: null,
|
36
|
+
mention_ids: null,
|
37
|
+
member_mention_ids: null,
|
38
|
+
name: null,
|
39
|
+
label_ids: null,
|
40
|
+
updated_at: null,
|
41
|
+
group_mention_ids: null,
|
42
|
+
end_date: null,
|
43
|
+
follower_ids: null,
|
44
|
+
group_ids: null,
|
45
|
+
start_date: null,
|
46
|
+
status: null,
|
47
|
+
id: null,
|
48
|
+
stats: null,
|
49
|
+
created_at: null
|
50
|
+
)
|
51
|
+
```
|
24
52
|
|
data/docs/IterationSlim.md
CHANGED
@@ -1,23 +1,50 @@
|
|
1
1
|
# Shortcut::IterationSlim
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
21
|
-
**
|
22
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **app_url** | **String** | The Shortcut application url for the Iteration. | |
|
8
|
+
| **entity_type** | **String** | A string description of this resource | |
|
9
|
+
| **labels** | [**Array<Label>**](Label.md) | An array of labels attached to the iteration. | |
|
10
|
+
| **mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | |
|
11
|
+
| **member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in the Story description. | |
|
12
|
+
| **name** | **String** | The name of the iteration. | |
|
13
|
+
| **label_ids** | **Array<Integer>** | An array of label ids attached to the iteration. | |
|
14
|
+
| **updated_at** | **Time** | The instant when this iteration was last updated. | |
|
15
|
+
| **group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | |
|
16
|
+
| **end_date** | **Time** | The date this iteration begins. | |
|
17
|
+
| **follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | |
|
18
|
+
| **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. | |
|
19
|
+
| **start_date** | **Time** | The date this iteration begins. | |
|
20
|
+
| **status** | **String** | The status of the iteration. Values are either \"unstarted\", \"started\", or \"done\". | |
|
21
|
+
| **id** | **Integer** | The ID of the iteration. | |
|
22
|
+
| **stats** | [**IterationStats**](IterationStats.md) | | |
|
23
|
+
| **created_at** | **Time** | The instant when this iteration was created. | |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'shortcut_client_ruby'
|
29
|
+
|
30
|
+
instance = Shortcut::IterationSlim.new(
|
31
|
+
app_url: null,
|
32
|
+
entity_type: null,
|
33
|
+
labels: null,
|
34
|
+
mention_ids: null,
|
35
|
+
member_mention_ids: null,
|
36
|
+
name: null,
|
37
|
+
label_ids: null,
|
38
|
+
updated_at: null,
|
39
|
+
group_mention_ids: null,
|
40
|
+
end_date: null,
|
41
|
+
follower_ids: null,
|
42
|
+
group_ids: null,
|
43
|
+
start_date: null,
|
44
|
+
status: null,
|
45
|
+
id: null,
|
46
|
+
stats: null,
|
47
|
+
created_at: null
|
48
|
+
)
|
49
|
+
```
|
23
50
|
|
data/docs/IterationStats.md
CHANGED
@@ -1,17 +1,38 @@
|
|
1
1
|
# Shortcut::IterationStats
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **num_points_done** | **Integer** | The total number of completed points in this Iteration. | |
|
8
|
+
| **num_related_documents** | **Integer** | The total number of documents related to an Iteration | |
|
9
|
+
| **average_cycle_time** | **Integer** | The average cycle time (in seconds) of completed stories in this Iteration. | [optional] |
|
10
|
+
| **num_stories_unstarted** | **Integer** | The total number of unstarted Stories in this Iteration. | |
|
11
|
+
| **num_points_started** | **Integer** | The total number of started points in this Iteration. | |
|
12
|
+
| **num_points_unstarted** | **Integer** | The total number of unstarted points in this Iteration. | |
|
13
|
+
| **num_stories_started** | **Integer** | The total number of started Stories in this Iteration. | |
|
14
|
+
| **num_stories_unestimated** | **Integer** | The total number of Stories with no point estimate. | |
|
15
|
+
| **average_lead_time** | **Integer** | The average lead time (in seconds) of completed stories in this Iteration. | [optional] |
|
16
|
+
| **num_points** | **Integer** | The total number of points in this Iteration. | |
|
17
|
+
| **num_stories_done** | **Integer** | The total number of done Stories in this Iteration. | |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'shortcut_client_ruby'
|
23
|
+
|
24
|
+
instance = Shortcut::IterationStats.new(
|
25
|
+
num_points_done: null,
|
26
|
+
num_related_documents: null,
|
27
|
+
average_cycle_time: null,
|
28
|
+
num_stories_unstarted: null,
|
29
|
+
num_points_started: null,
|
30
|
+
num_points_unstarted: null,
|
31
|
+
num_stories_started: null,
|
32
|
+
num_stories_unestimated: null,
|
33
|
+
average_lead_time: null,
|
34
|
+
num_points: null,
|
35
|
+
num_stories_done: null
|
36
|
+
)
|
37
|
+
```
|
17
38
|
|
data/docs/Label.md
CHANGED
@@ -1,17 +1,38 @@
|
|
1
1
|
# Shortcut::Label
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **app_url** | **String** | The Shortcut application url for the Label. | |
|
8
|
+
| **description** | **String** | The description of the Label. | |
|
9
|
+
| **archived** | **Boolean** | A true/false boolean indicating if the Label has been archived. | |
|
10
|
+
| **entity_type** | **String** | A string description of this resource. | |
|
11
|
+
| **color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | |
|
12
|
+
| **name** | **String** | The name of the Label. | |
|
13
|
+
| **updated_at** | **Time** | The time/date that the Label was updated. | |
|
14
|
+
| **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. | |
|
15
|
+
| **id** | **Integer** | The unique ID of the Label. | |
|
16
|
+
| **stats** | [**LabelStats**](LabelStats.md) | | [optional] |
|
17
|
+
| **created_at** | **Time** | The time/date that the Label was created. | |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'shortcut_client_ruby'
|
23
|
+
|
24
|
+
instance = Shortcut::Label.new(
|
25
|
+
app_url: null,
|
26
|
+
description: null,
|
27
|
+
archived: null,
|
28
|
+
entity_type: null,
|
29
|
+
color: null,
|
30
|
+
name: null,
|
31
|
+
updated_at: null,
|
32
|
+
external_id: null,
|
33
|
+
id: null,
|
34
|
+
stats: null,
|
35
|
+
created_at: null
|
36
|
+
)
|
37
|
+
```
|
17
38
|
|
data/docs/LabelSlim.md
CHANGED
@@ -1,16 +1,36 @@
|
|
1
1
|
# Shortcut::LabelSlim
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **app_url** | **String** | The Shortcut application url for the Label. | |
|
8
|
+
| **description** | **String** | The description of the Label. | |
|
9
|
+
| **archived** | **Boolean** | A true/false boolean indicating if the Label has been archived. | |
|
10
|
+
| **entity_type** | **String** | A string description of this resource. | |
|
11
|
+
| **color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | |
|
12
|
+
| **name** | **String** | The name of the Label. | |
|
13
|
+
| **updated_at** | **Time** | The time/date that the Label was updated. | |
|
14
|
+
| **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. | |
|
15
|
+
| **id** | **Integer** | The unique ID of the Label. | |
|
16
|
+
| **created_at** | **Time** | The time/date that the Label was created. | |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'shortcut_client_ruby'
|
22
|
+
|
23
|
+
instance = Shortcut::LabelSlim.new(
|
24
|
+
app_url: null,
|
25
|
+
description: null,
|
26
|
+
archived: null,
|
27
|
+
entity_type: null,
|
28
|
+
color: null,
|
29
|
+
name: null,
|
30
|
+
updated_at: null,
|
31
|
+
external_id: null,
|
32
|
+
id: null,
|
33
|
+
created_at: null
|
34
|
+
)
|
35
|
+
```
|
16
36
|
|
data/docs/LabelStats.md
CHANGED
@@ -1,21 +1,46 @@
|
|
1
1
|
# Shortcut::LabelStats
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **num_related_documents** | **Integer** | The total number of Documents associated this Label. | |
|
8
|
+
| **num_epics** | **Integer** | The total number of Epics with this Label. | |
|
9
|
+
| **num_stories_unstarted** | **Integer** | The total number of stories unstarted Stories with this Label. | |
|
10
|
+
| **num_stories_total** | **Integer** | The total number of Stories with this Label. | |
|
11
|
+
| **num_epics_unstarted** | **Integer** | The number of unstarted epics assoicated with this label. | |
|
12
|
+
| **num_epics_in_progress** | **Integer** | The number of in progress epics assoicated with this label. | |
|
13
|
+
| **num_points_unstarted** | **Integer** | The total number of unstarted points with this Label. | |
|
14
|
+
| **num_stories_unestimated** | **Integer** | The total number of Stories with no point estimate with this Label. | |
|
15
|
+
| **num_points_in_progress** | **Integer** | The total number of in-progress points with this Label. | |
|
16
|
+
| **num_epics_total** | **Integer** | The total number of Epics assoicated with this Label. | |
|
17
|
+
| **num_stories_completed** | **Integer** | The total number of completed Stories with this Label. | |
|
18
|
+
| **num_points_completed** | **Integer** | The total number of completed points with this Label. | |
|
19
|
+
| **num_points_total** | **Integer** | The total number of points with this Label. | |
|
20
|
+
| **num_stories_in_progress** | **Integer** | The total number of in-progress Stories with this Label. | |
|
21
|
+
| **num_epics_completed** | **Integer** | The number of completed Epics assoicated with this Label. | |
|
22
|
+
|
23
|
+
## Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'shortcut_client_ruby'
|
27
|
+
|
28
|
+
instance = Shortcut::LabelStats.new(
|
29
|
+
num_related_documents: null,
|
30
|
+
num_epics: null,
|
31
|
+
num_stories_unstarted: null,
|
32
|
+
num_stories_total: null,
|
33
|
+
num_epics_unstarted: null,
|
34
|
+
num_epics_in_progress: null,
|
35
|
+
num_points_unstarted: null,
|
36
|
+
num_stories_unestimated: null,
|
37
|
+
num_points_in_progress: null,
|
38
|
+
num_epics_total: null,
|
39
|
+
num_stories_completed: null,
|
40
|
+
num_points_completed: null,
|
41
|
+
num_points_total: null,
|
42
|
+
num_stories_in_progress: null,
|
43
|
+
num_epics_completed: null
|
44
|
+
)
|
45
|
+
```
|
21
46
|
|