License: MIT
To install:
npm install pivotal
var Pivotal = require("pivotal");
var pivotal = new Pivotal("myToken");
You can also retrieve the token initially by using the pivotal.getToken function
When making changes to the library, please run make doc
before submitting pull requests.
Tests are located in test/ directory. To run them you need to install the required dependencies
npm install
and either set your pivotal api-token as a variable
export token=xxxxxxxxxxxxxx
or your username and password (which will result in an additional test for creating the token)
export username=tester
export password=testpw
for testing against a specific project/story/member
export project_id=123456
export story_id=9876546
export member_id=192837
finally run the tests using:
make test
For examples see tests/test.js
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#retrieve_token_post
Arguments
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#get_all_activity
Arguments
{
project (int) : project id
limit : maximum return entries
occurred_since_date : earliest date for return entries
newer_than_version : allows restricting the activity feed to only those items that have a greater than supplied version
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_project_activity
Arguments
{
limit : maximum return entries
occurred_since_date : earliest date for return entries
newer_than_version : allows restricting the activity feed to only those items that have a greater than supplied version
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_project_all_projects
ref: https://www.pivotaltracker.com/help/api?version=v3#get_project_info
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#add_project
Arguments
{
name (string) : The project's name
iteration_length (int) : Iteration length
no_owner (boolean, optional) : Does the project have an owner?
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_memberships
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#get_membership_info
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#add_membership
Arguments
{
role : Member or Owner
person : Personal information {
name : Person's full name
initials : Name's initials
email : E-mail
}
}
Note: The user does not have to be in the system already. He will receieve an email asking him to join if he does not have a project already.
ref: https://www.pivotaltracker.com/help/api?version=v3#remove_membership
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#get_iterations
Arguments
{
group : filter by iteration type [done|current|backlog|current_backlog]
limit : maximum return entries
offset : start from story num. N in the list
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_iterations
Arguments
{
limit : maximum return entries
offset : start from story num. N in the list
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_iterations
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#get_iterations
Arguments
{
limit : maximum return entries
offset : start from story num. N in the list
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_iterations
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#get_all_stories
Arguments
{
limit : maximum return entries
offset : start from story num. N in the list
filter : search string to use (ex: filter=label:"needs feedback" type:bug)
}
ref: https://www.pivotaltracker.com/help/api?version=v3#get_story
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#add_story
and
https://www.pivotaltracker.com/help/api?version=v3#link_story
Arguments
{
name : Name of this story
story_type : bug, feature, chore, release
estimate (int) : number which indicates the level of difficulty of the story
description : description,
labels : Comma-separated list of labels
requested_by : Name of the requester
(should be an existing member person name,
but I dont know if this is an actual limitation)
}
ref: https://www.pivotaltracker.com/help/api?version=v3#upload_attachment
Arguments
{
name : filename of the file after upload
path : path to the file on disk
data : if no path is provided, one may
simply put the data of the file in there instead
}
ref: https://www.pivotaltracker.com/help/api?version=v3#add_note
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#update_story
Arguments
{
project_id : Id of the project
name : Name of this story
story_type : bug, feature, chore, release
estimate (int) : number which indicates the level of difficulty of the story
description : description,
labels : Comma-separated list of labels
requested_by : Name of the requester
(should be an existing member person name,
but I dont know if this is an actual limitation)
}
ref: https://www.pivotaltracker.com/help/api?version=v3#move_stories
Arguments
{
target : Id of the destination story
move : before or after (the target story)
}
ref: https://www.pivotaltracker.com/help/api?version=v3#delete_story
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#deliver_all_finished
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#view_task
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#view_task
Arguments
ref: https://www.pivotaltracker.com/help/api?version=v3#add_task
Arguments
{
description : text of the task
complete : true of false
}
ref: https://www.pivotaltracker.com/help/api?version=v3#update_task
Arguments
{
description : text of the task
complete : true of false
}
ref: https://www.pivotaltracker.com/help/api?version=v3#delete_task
Arguments