shortcut_client_ruby
Advanced tools
Shortcut - the Ruby gem for the Shortcut API
Shortcut API
This SDK is automatically generated by the OpenAPI Generator project:
To build the Ruby code into a gem:
gem build shortcut_client_ruby.gemspec
Then either install the gem locally:
gem install ./shortcut_client_ruby-0.1.2.gem
(for development, run gem install --dev ./shortcut_client_ruby-0.1.2.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'shortcut_client_ruby', '~> 0.1.2'
If the Ruby gem is hosted at a git repository: https://github.com/ngouy/shortcut_client_ruby, then add the following in the Gemfile:
gem 'shortcut_client_ruby', :git => 'https://github.com/ngouy/shortcut_client_ruby.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'shortcut_client_ruby'
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['api_token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['api_token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
create_category = Shortcut::CreateCategory.new({name: 'name_example', type: 'milestone'}) # CreateCategory |
begin
#Create Category
result = api_instance.create_category(create_category)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_category: #{e}"
end
All URIs are relative to https://api.app.shortcut.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Shortcut::DefaultApi | create_category | POST /api/v3/categories | Create Category |
| Shortcut::DefaultApi | create_entity_template | POST /api/v3/entity-templates | Create Entity Template |
| Shortcut::DefaultApi | create_epic | POST /api/v3/epics | Create Epic |
| Shortcut::DefaultApi | create_epic_comment | POST /api/v3/epics/{epic-public-id}/comments | Create Epic Comment |
| Shortcut::DefaultApi | create_epic_comment_comment | POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Create Epic Comment Comment |
| Shortcut::DefaultApi | create_group | POST /api/v3/groups | Create Group |
| Shortcut::DefaultApi | create_iteration | POST /api/v3/iterations | Create Iteration |
| Shortcut::DefaultApi | create_label | POST /api/v3/labels | Create Label |
| Shortcut::DefaultApi | create_linked_file | POST /api/v3/linked-files | Create Linked File |
| Shortcut::DefaultApi | create_milestone | POST /api/v3/milestones | Create Milestone |
| Shortcut::DefaultApi | create_multiple_stories | POST /api/v3/stories/bulk | Create Multiple Stories |
| Shortcut::DefaultApi | create_project | POST /api/v3/projects | Create Project |
| Shortcut::DefaultApi | create_story | POST /api/v3/stories | Create Story |
| Shortcut::DefaultApi | create_story_comment | POST /api/v3/stories/{story-public-id}/comments | Create Story Comment |
| Shortcut::DefaultApi | create_story_link | POST /api/v3/story-links | Create Story Link |
| Shortcut::DefaultApi | create_story_reaction | POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions | Create Story Reaction |
| Shortcut::DefaultApi | create_task | POST /api/v3/stories/{story-public-id}/tasks | Create Task |
| Shortcut::DefaultApi | delete_category | DELETE /api/v3/categories/{category-public-id} | Delete Category |
| Shortcut::DefaultApi | delete_entity_template | DELETE /api/v3/entity-templates/{entity-template-public-id} | Delete Entity Template |
| Shortcut::DefaultApi | delete_epic | DELETE /api/v3/epics/{epic-public-id} | Delete Epic |
| Shortcut::DefaultApi | delete_epic_comment | DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Delete Epic Comment |
| Shortcut::DefaultApi | delete_file | DELETE /api/v3/files/{file-public-id} | Delete File |
| Shortcut::DefaultApi | delete_iteration | DELETE /api/v3/iterations/{iteration-public-id} | Delete Iteration |
| Shortcut::DefaultApi | delete_label | DELETE /api/v3/labels/{label-public-id} | Delete Label |
| Shortcut::DefaultApi | delete_linked_file | DELETE /api/v3/linked-files/{linked-file-public-id} | Delete Linked File |
| Shortcut::DefaultApi | delete_milestone | DELETE /api/v3/milestones/{milestone-public-id} | Delete Milestone |
| Shortcut::DefaultApi | delete_multiple_stories | DELETE /api/v3/stories/bulk | Delete Multiple Stories |
| Shortcut::DefaultApi | delete_project | DELETE /api/v3/projects/{project-public-id} | Delete Project |
| Shortcut::DefaultApi | delete_story | DELETE /api/v3/stories/{story-public-id} | Delete Story |
| Shortcut::DefaultApi | delete_story_comment | DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Delete Story Comment |
| Shortcut::DefaultApi | delete_story_link | DELETE /api/v3/story-links/{story-link-public-id} | Delete Story Link |
| Shortcut::DefaultApi | delete_story_reaction | DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions | Delete Story Reaction |
| Shortcut::DefaultApi | delete_task | DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Delete Task |
| Shortcut::DefaultApi | disable_groups | PUT /api/v3/groups/disable | Disable Groups |
| Shortcut::DefaultApi | disable_iterations | PUT /api/v3/iterations/disable | Disable Iterations |
| Shortcut::DefaultApi | disable_story_templates | PUT /api/v3/entity-templates/disable | Disable Story Templates |
| Shortcut::DefaultApi | enable_groups | PUT /api/v3/groups/enable | Enable Groups |
| Shortcut::DefaultApi | enable_iterations | PUT /api/v3/iterations/enable | Enable Iterations |
| Shortcut::DefaultApi | enable_story_templates | PUT /api/v3/entity-templates/enable | Enable Story Templates |
| Shortcut::DefaultApi | get_category | GET /api/v3/categories/{category-public-id} | Get Category |
| Shortcut::DefaultApi | get_current_member_info | GET /api/v3/member | Get Current Member Info |
| Shortcut::DefaultApi | get_entity_template | GET /api/v3/entity-templates/{entity-template-public-id} | Get Entity Template |
| Shortcut::DefaultApi | get_epic | GET /api/v3/epics/{epic-public-id} | Get Epic |
| Shortcut::DefaultApi | get_epic_comment | GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Get Epic Comment |
| Shortcut::DefaultApi | get_epic_workflow | GET /api/v3/epic-workflow | Get Epic Workflow |
| Shortcut::DefaultApi | get_external_link_stories | GET /api/v3/external-link/stories | Get External Link Stories |
| Shortcut::DefaultApi | get_file | GET /api/v3/files/{file-public-id} | Get File |
| Shortcut::DefaultApi | get_group | GET /api/v3/groups/{group-public-id} | Get Group |
| Shortcut::DefaultApi | get_iteration | GET /api/v3/iterations/{iteration-public-id} | Get Iteration |
| Shortcut::DefaultApi | get_label | GET /api/v3/labels/{label-public-id} | Get Label |
| Shortcut::DefaultApi | get_linked_file | GET /api/v3/linked-files/{linked-file-public-id} | Get Linked File |
| Shortcut::DefaultApi | get_member | GET /api/v3/members/{member-public-id} | Get Member |
| Shortcut::DefaultApi | get_milestone | GET /api/v3/milestones/{milestone-public-id} | Get Milestone |
| Shortcut::DefaultApi | get_project | GET /api/v3/projects/{project-public-id} | Get Project |
| Shortcut::DefaultApi | get_repository | GET /api/v3/repositories/{repo-public-id} | Get Repository |
| Shortcut::DefaultApi | get_story | GET /api/v3/stories/{story-public-id} | Get Story |
| Shortcut::DefaultApi | get_story_comment | GET /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Get Story Comment |
| Shortcut::DefaultApi | get_story_link | GET /api/v3/story-links/{story-link-public-id} | Get Story Link |
| Shortcut::DefaultApi | get_task | GET /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Get Task |
| Shortcut::DefaultApi | get_workflow | GET /api/v3/workflows/{workflow-public-id} | Get Workflow |
| Shortcut::DefaultApi | list_categories | GET /api/v3/categories | List Categories |
| Shortcut::DefaultApi | list_category_milestones | GET /api/v3/categories/{category-public-id}/milestones | List Category Milestones |
| Shortcut::DefaultApi | list_entity_templates | GET /api/v3/entity-templates | List Entity Templates |
| Shortcut::DefaultApi | list_epic_comments | GET /api/v3/epics/{epic-public-id}/comments | List Epic Comments |
| Shortcut::DefaultApi | list_epic_stories | GET /api/v3/epics/{epic-public-id}/stories | List Epic Stories |
| Shortcut::DefaultApi | list_epics | GET /api/v3/epics | List Epics |
| Shortcut::DefaultApi | list_files | GET /api/v3/files | List Files |
| Shortcut::DefaultApi | list_group_stories | GET /api/v3/groups/{group-public-id}/stories | List Group Stories |
| Shortcut::DefaultApi | list_groups | GET /api/v3/groups | List Groups |
| Shortcut::DefaultApi | list_iteration_stories | GET /api/v3/iterations/{iteration-public-id}/stories | List Iteration Stories |
| Shortcut::DefaultApi | list_iterations | GET /api/v3/iterations | List Iterations |
| Shortcut::DefaultApi | list_label_epics | GET /api/v3/labels/{label-public-id}/epics | List Label Epics |
| Shortcut::DefaultApi | list_label_stories | GET /api/v3/labels/{label-public-id}/stories | List Label Stories |
| Shortcut::DefaultApi | list_labels | GET /api/v3/labels | List Labels |
| Shortcut::DefaultApi | list_linked_files | GET /api/v3/linked-files | List Linked Files |
| Shortcut::DefaultApi | list_members | GET /api/v3/members | List Members |
| Shortcut::DefaultApi | list_milestone_epics | GET /api/v3/milestones/{milestone-public-id}/epics | List Milestone Epics |
| Shortcut::DefaultApi | list_milestones | GET /api/v3/milestones | List Milestones |
| Shortcut::DefaultApi | list_projects | GET /api/v3/projects | List Projects |
| Shortcut::DefaultApi | list_repositories | GET /api/v3/repositories | List Repositories |
| Shortcut::DefaultApi | list_stories | GET /api/v3/projects/{project-public-id}/stories | List Stories |
| Shortcut::DefaultApi | list_workflows | GET /api/v3/workflows | List Workflows |
| Shortcut::DefaultApi | search | GET /api/v3/search | Search |
| Shortcut::DefaultApi | search_epics | GET /api/v3/search/epics | Search Epics |
| Shortcut::DefaultApi | search_stories | GET /api/v3/search/stories | Search Stories |
| Shortcut::DefaultApi | search_stories_old | POST /api/v3/stories/search | Search Stories (Old) |
| Shortcut::DefaultApi | story_history | GET /api/v3/stories/{story-public-id}/history | Story History |
| Shortcut::DefaultApi | unlink_productboard_from_epic | POST /api/v3/epics/{epic-public-id}/unlink-productboard | Unlink Productboard from Epic |
| Shortcut::DefaultApi | update_category | PUT /api/v3/categories/{category-public-id} | Update Category |
| Shortcut::DefaultApi | update_entity_template | PUT /api/v3/entity-templates/{entity-template-public-id} | Update Entity Template |
| Shortcut::DefaultApi | update_epic | PUT /api/v3/epics/{epic-public-id} | Update Epic |
| Shortcut::DefaultApi | update_epic_comment | PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Update Epic Comment |
| Shortcut::DefaultApi | update_file | PUT /api/v3/files/{file-public-id} | Update File |
| Shortcut::DefaultApi | update_group | PUT /api/v3/groups/{group-public-id} | Update Group |
| Shortcut::DefaultApi | update_iteration | PUT /api/v3/iterations/{iteration-public-id} | Update Iteration |
| Shortcut::DefaultApi | update_label | PUT /api/v3/labels/{label-public-id} | Update Label |
| Shortcut::DefaultApi | update_linked_file | PUT /api/v3/linked-files/{linked-file-public-id} | Update Linked File |
| Shortcut::DefaultApi | update_milestone | PUT /api/v3/milestones/{milestone-public-id} | Update Milestone |
| Shortcut::DefaultApi | update_multiple_stories | PUT /api/v3/stories/bulk | Update Multiple Stories |
| Shortcut::DefaultApi | update_project | PUT /api/v3/projects/{project-public-id} | Update Project |
| Shortcut::DefaultApi | update_story | PUT /api/v3/stories/{story-public-id} | Update Story |
| Shortcut::DefaultApi | update_story_comment | PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Update Story Comment |
| Shortcut::DefaultApi | update_story_link | PUT /api/v3/story-links/{story-link-public-id} | Update Story Link |
| Shortcut::DefaultApi | update_task | PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Update Task |
| Shortcut::DefaultApi | upload_files | POST /api/v3/files | Upload Files |
FAQs
Unknown package
We found that shortcut_client_ruby demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.