NAME

WebService::PivotalTracker::Story - A single story

VERSION

version 0.12

SYNOPSIS

DESCRIPTION

This class represents a single story.

my $iterations = $project->stories( ... );

ATTRIBUTES

This class provides the following attribute accessor methods. Each one corresponds to a property defined by the PT REST API V5 story resource docs.

id

project_id

name

description

The description in Markdown.

story_type

current_state

estimate

accepted_at

This will be returned as a DateTime object.

deadline

This will be returned as a DateTime object.

requested_by_id

owner_ids

An array reference.

task_ids

An array reference.

follower_ids

An array reference.

created_at

This will be returned as a DateTime object.

updated_at

This will be returned as a DateTime object.

url

This will be returned as a URI object.

kind

raw_content

The raw JSON used to create this object.

METHODS

This class provides the following methods:

$story->comments

This method returns an array reference of WebService::PivotalTracker::Comment objects.

$story->labels

This method returns an array reference of WebService::PivotalTracker::Label objects.

$story->requested_by

This method returns a WebService::PivotalTracker::Person representing the person who is the requester for the story.

$story->update( ... )

This method will update the story's properties as specified.

$story->add_comment( ... )

This method adds a comment to a story. It accepts two arguments:

• text

  The text of the comment in Markdown.

  This is required.

• person_id

  By default, the comment will be attributed to whoever owns the token, but you can use this to override that.

$story->add_label( ... )

This method accepts a single argument, name, which is the name of the label to add.

SUPPORT

Bugs may be submitted through https://github.com/maxmind/WebService-PivotalTracker/issues.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 - 2020 by MaxMind, Inc.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)