NAME

WebService::PivotalTracker::Project - A single iteration in a project

VERSION

version 0.12

SYNOPSIS

DESCRIPTION

This class represents a single project iteration.

  my $iterations = $pt->project( project_id => 42 );

ATTRIBUTES

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

id

name

version

iteration_length

week_start_day

point_scale

point_scale_is_custom

automatic_planning

enable_tasks

start_date

This will be returned as a DateTime object.

time_zone

velocity_averaged_over

show_iterations_start_time

This will be returned as a DateTime object.

start_time

This will be returned as a DateTime object.

number_of_done_iterations_to_show

has_google_domain

description

profile_content

enable_incoming_emails

initial_velocity

project_type

public

atom_enabled

current_iteration_number

account_id

created_id

This will be returned as a DateTime object.

updated_at

This will be returned as a DateTime object.

kind

raw_content

The raw JSON used to create this object.

METHODS

This class provides the following methods:

$project->memberships(...)

This method returns an array reference of WebService::PivotalTracker::ProjectMembership objects, one for each member of the project.

$project->stories(...)

This method returns an array of WebService::PivotalTracker::Story objects, one for each story in the project.

$project->iterations(...)

This method returns an array reference of WebService::PivotalTracker::ProjectIteration objects based on the provided arguments.

This method accepts the following arguments:

  • label

    A label on which to filter the stories contained in each iteration object.

  • limit

    The number of items to be returned. If not specified the default number of iterations will be returned.

  • offset

    The offset at which to start returning results.

  • scope

    The scope of the iterations to return. This can be one of the following strings:

    done
    current
    backlog
    current_backlog
    done_current

    By default all iterations are returned, including done iterations.

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)