Module: Shortcut

Defined in:
lib/shortcut_client_ruby/version.rb,
lib/shortcut_client_ruby.rb,
lib/shortcut_client_ruby/api_error.rb,
lib/shortcut_client_ruby/api_client.rb,
lib/shortcut_client_ruby/models/epic.rb,
lib/shortcut_client_ruby/models/icon.rb,
lib/shortcut_client_ruby/models/task.rb,
lib/shortcut_client_ruby/models/group.rb,
lib/shortcut_client_ruby/models/label.rb,
lib/shortcut_client_ruby/models/story.rb,
lib/shortcut_client_ruby/configuration.rb,
lib/shortcut_client_ruby/models/branch.rb,
lib/shortcut_client_ruby/models/commit.rb,
lib/shortcut_client_ruby/models/member.rb,
lib/shortcut_client_ruby/models/search.rb,
lib/shortcut_client_ruby/models/history.rb,
lib/shortcut_client_ruby/models/profile.rb,
lib/shortcut_client_ruby/models/project.rb,
lib/shortcut_client_ruby/api/default_api.rb,
lib/shortcut_client_ruby/models/category.rb,
lib/shortcut_client_ruby/models/identity.rb,
lib/shortcut_client_ruby/models/workflow.rb,
lib/shortcut_client_ruby/models/epic_slim.rb,
lib/shortcut_client_ruby/models/iteration.rb,
lib/shortcut_client_ruby/models/milestone.rb,
lib/shortcut_client_ruby/models/epic_state.rb,
lib/shortcut_client_ruby/models/epic_stats.rb,
lib/shortcut_client_ruby/models/get_member.rb,
lib/shortcut_client_ruby/models/label_slim.rb,
lib/shortcut_client_ruby/models/list_epics.rb,
lib/shortcut_client_ruby/models/repository.rb,
lib/shortcut_client_ruby/models/story_link.rb,
lib/shortcut_client_ruby/models/story_slim.rb,
lib/shortcut_client_ruby/models/create_epic.rb,
lib/shortcut_client_ruby/models/create_task.rb,
lib/shortcut_client_ruby/models/label_stats.rb,
lib/shortcut_client_ruby/models/linked_file.rb,
lib/shortcut_client_ruby/models/list_labels.rb,
lib/shortcut_client_ruby/models/member_info.rb,
lib/shortcut_client_ruby/models/story_stats.rb,
lib/shortcut_client_ruby/models/update_epic.rb,
lib/shortcut_client_ruby/models/update_file.rb,
lib/shortcut_client_ruby/models/update_task.rb,
lib/shortcut_client_ruby/models/create_group.rb,
lib/shortcut_client_ruby/models/list_members.rb,
lib/shortcut_client_ruby/models/pull_request.rb,
lib/shortcut_client_ruby/models/update_group.rb,
lib/shortcut_client_ruby/models/update_label.rb,
lib/shortcut_client_ruby/models/update_story.rb,
lib/shortcut_client_ruby/models/epic_workflow.rb,
lib/shortcut_client_ruby/models/project_stats.rb,
lib/shortcut_client_ruby/models/story_comment.rb,
lib/shortcut_client_ruby/models/uploaded_file.rb,
lib/shortcut_client_ruby/models/create_project.rb,
lib/shortcut_client_ruby/models/create_stories.rb,
lib/shortcut_client_ruby/models/delete_stories.rb,
lib/shortcut_client_ruby/models/iteration_slim.rb,
lib/shortcut_client_ruby/models/search_results.rb,
lib/shortcut_client_ruby/models/search_stories.rb,
lib/shortcut_client_ruby/models/story_contents.rb,
lib/shortcut_client_ruby/models/story_reaction.rb,
lib/shortcut_client_ruby/models/update_comment.rb,
lib/shortcut_client_ruby/models/update_project.rb,
lib/shortcut_client_ruby/models/update_stories.rb,
lib/shortcut_client_ruby/models/workflow_state.rb,
lib/shortcut_client_ruby/models/create_category.rb,
lib/shortcut_client_ruby/models/entity_template.rb,
lib/shortcut_client_ruby/models/iteration_stats.rb,
lib/shortcut_client_ruby/models/milestone_stats.rb,
lib/shortcut_client_ruby/models/update_category.rb,
lib/shortcut_client_ruby/models/create_iteration.rb,
lib/shortcut_client_ruby/models/create_milestone.rb,
lib/shortcut_client_ruby/models/get_epic_stories.rb,
lib/shortcut_client_ruby/models/threaded_comment.rb,
lib/shortcut_client_ruby/models/typed_story_link.rb,
lib/shortcut_client_ruby/models/update_iteration.rb,
lib/shortcut_client_ruby/models/update_milestone.rb,
lib/shortcut_client_ruby/models/create_story_link.rb,
lib/shortcut_client_ruby/models/get_label_stories.rb,
lib/shortcut_client_ruby/models/update_story_link.rb,
lib/shortcut_client_ruby/models/create_linked_file.rb,
lib/shortcut_client_ruby/models/create_task_params.rb,
lib/shortcut_client_ruby/models/list_group_stories.rb,
lib/shortcut_client_ruby/models/pull_request_label.rb,
lib/shortcut_client_ruby/models/update_linked_file.rb,
lib/shortcut_client_ruby/models/create_epic_comment.rb,
lib/shortcut_client_ruby/models/create_label_params.rb,
lib/shortcut_client_ruby/models/create_story_params.rb,
lib/shortcut_client_ruby/models/epic_search_results.rb,
lib/shortcut_client_ruby/models/get_project_stories.rb,
lib/shortcut_client_ruby/models/story_contents_task.rb,
lib/shortcut_client_ruby/models/basic_workspace_info.rb,
lib/shortcut_client_ruby/models/create_story_comment.rb,
lib/shortcut_client_ruby/models/entity_template_task.rb,
lib/shortcut_client_ruby/models/history_changes_task.rb,
lib/shortcut_client_ruby/models/story_search_results.rb,
lib/shortcut_client_ruby/models/update_story_comment.rb,
lib/shortcut_client_ruby/models/create_story_contents.rb,
lib/shortcut_client_ruby/models/get_iteration_stories.rb,
lib/shortcut_client_ruby/models/history_changes_story.rb,
lib/shortcut_client_ruby/models/update_story_contents.rb,
lib/shortcut_client_ruby/models/create_category_params.rb,
lib/shortcut_client_ruby/models/create_comment_comment.rb,
lib/shortcut_client_ruby/models/create_entity_template.rb,
lib/shortcut_client_ruby/models/history_reference_epic.rb,
lib/shortcut_client_ruby/models/update_entity_template.rb,
lib/shortcut_client_ruby/models/history_reference_group.rb,
lib/shortcut_client_ruby/models/history_reference_label.rb,
lib/shortcut_client_ruby/models/history_reference_story.rb,
lib/shortcut_client_ruby/models/create_story_link_params.rb,
lib/shortcut_client_ruby/models/history_reference_branch.rb,
lib/shortcut_client_ruby/models/history_reference_commit.rb,
lib/shortcut_client_ruby/models/history_reference_general.rb,
lib/shortcut_client_ruby/models/history_reference_project.rb,
lib/shortcut_client_ruby/models/history_action_branch_push.rb,
lib/shortcut_client_ruby/models/history_action_task_create.rb,
lib/shortcut_client_ruby/models/history_action_task_delete.rb,
lib/shortcut_client_ruby/models/history_action_task_update.rb,
lib/shortcut_client_ruby/models/history_changes_story_link.rb,
lib/shortcut_client_ruby/models/unusable_entitlement_error.rb,
lib/shortcut_client_ruby/models/create_story_comment_params.rb,
lib/shortcut_client_ruby/models/history_action_branch_merge.rb,
lib/shortcut_client_ruby/models/history_action_label_create.rb,
lib/shortcut_client_ruby/models/history_action_label_delete.rb,
lib/shortcut_client_ruby/models/history_action_label_update.rb,
lib/shortcut_client_ruby/models/history_action_pull_request.rb,
lib/shortcut_client_ruby/models/history_action_story_create.rb,
lib/shortcut_client_ruby/models/history_action_story_delete.rb,
lib/shortcut_client_ruby/models/history_action_story_update.rb,
lib/shortcut_client_ruby/models/history_reference_iteration.rb,
lib/shortcut_client_ruby/models/history_action_branch_create.rb,
lib/shortcut_client_ruby/models/history_reference_story_task.rb,
lib/shortcut_client_ruby/models/history_action_project_update.rb,
lib/shortcut_client_ruby/models/create_or_delete_story_reaction.rb,
lib/shortcut_client_ruby/models/get_external_link_stories_params.rb,
lib/shortcut_client_ruby/models/history_action_story_link_create.rb,
lib/shortcut_client_ruby/models/history_action_story_link_delete.rb,
lib/shortcut_client_ruby/models/history_action_story_link_update.rb,
lib/shortcut_client_ruby/models/history_reference_workflow_state.rb,
lib/shortcut_client_ruby/models/story_history_change_old_new_int.rb,
lib/shortcut_client_ruby/models/story_history_change_old_new_str.rb,
lib/shortcut_client_ruby/models/max_search_results_exceeded_error.rb,
lib/shortcut_client_ruby/models/story_history_change_old_new_bool.rb,
lib/shortcut_client_ruby/models/story_history_change_old_new_uuid.rb,
lib/shortcut_client_ruby/models/history_action_story_comment_create.rb,
lib/shortcut_client_ruby/models/story_history_change_adds_removes_int.rb,
lib/shortcut_client_ruby/models/story_history_change_adds_removes_uuid.rb

Overview

#Shortcut API

#Shortcut API

The version of the OpenAPI document: 3.0

Generated by: openapi-generator.tech OpenAPI Generator version: 6.2.1

Defined Under Namespace

Classes: ApiClient, ApiError, BasicWorkspaceInfo, Branch, Category, Commit, Configuration, CreateCategory, CreateCategoryParams, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryCommentParams, CreateStoryContents, CreateStoryLink, CreateStoryLinkParams, CreateStoryParams, CreateTask, CreateTaskParams, DefaultApi, DeleteStories, EntityTemplate, EntityTemplateTask, Epic, EpicSearchResults, EpicSlim, EpicState, EpicStats, EpicWorkflow, GetEpicStories, GetExternalLinkStoriesParams, GetIterationStories, GetLabelStories, GetMember, GetProjectStories, Group, History, HistoryActionBranchCreate, HistoryActionBranchMerge, HistoryActionBranchPush, HistoryActionLabelCreate, HistoryActionLabelDelete, HistoryActionLabelUpdate, HistoryActionProjectUpdate, HistoryActionPullRequest, HistoryActionStoryCommentCreate, HistoryActionStoryCreate, HistoryActionStoryDelete, HistoryActionStoryLinkCreate, HistoryActionStoryLinkDelete, HistoryActionStoryLinkUpdate, HistoryActionStoryUpdate, HistoryActionTaskCreate, HistoryActionTaskDelete, HistoryActionTaskUpdate, HistoryChangesStory, HistoryChangesStoryLink, HistoryChangesTask, HistoryReferenceBranch, HistoryReferenceCommit, HistoryReferenceEpic, HistoryReferenceGeneral, HistoryReferenceGroup, HistoryReferenceIteration, HistoryReferenceLabel, HistoryReferenceProject, HistoryReferenceStory, HistoryReferenceStoryTask, HistoryReferenceWorkflowState, Icon, Identity, Iteration, IterationSlim, IterationStats, Label, LabelSlim, LabelStats, LinkedFile, ListEpics, ListGroupStories, ListLabels, ListMembers, MaxSearchResultsExceededError, Member, MemberInfo, Milestone, MilestoneStats, Profile, Project, ProjectStats, PullRequest, PullRequestLabel, Repository, Search, SearchResults, SearchStories, Story, StoryComment, StoryContents, StoryContentsTask, StoryHistoryChangeAddsRemovesInt, StoryHistoryChangeAddsRemovesUuid, StoryHistoryChangeOldNewBool, StoryHistoryChangeOldNewInt, StoryHistoryChangeOldNewStr, StoryHistoryChangeOldNewUuid, StoryLink, StoryReaction, StorySearchResults, StorySlim, StoryStats, Task, ThreadedComment, TypedStoryLink, UnusableEntitlementError, UpdateCategory, UpdateComment, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateIteration, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryContents, UpdateStoryLink, UpdateTask, UploadedFile, Workflow, WorkflowState

Constant Summary collapse

VERSION = 
'0.1.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Shortcut.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



173
174
175
176
177
178
179
 
# File 'lib/shortcut_client_ruby.rb', line 173

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end