com.codepine.api.testrail

Class TestRail.Milestones

java.lang.Object

com.codepine.api.testrail.TestRail.Milestones

Enclosing class:

TestRail

public class TestRail.Milestones
extends Object

Request factories for "Milestones".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestRail.Milestones.Add
class	TestRail.Milestones.Delete
class	TestRail.Milestones.Get
class	TestRail.Milestones.List
class	TestRail.Milestones.Update

Constructor Summary

Constructors

Constructor and Description
Milestones()

Method Summary

Modifier and Type	Method and Description
TestRail.Milestones.Add	add(int projectId, Milestone milestone) Creates a new milestone.
TestRail.Milestones.Delete	delete(int milestoneId) Deletes an existing milestone.
TestRail.Milestones.Get	get(int milestoneId) Returns an existing milestone.
TestRail.Milestones.List	list(int projectId) Returns the list of milestones for a project.
TestRail.Milestones.Update	update(Milestone milestone) Updates an existing milestone.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Milestones

@Generated(value="lombok")
public Milestones()

Method Detail

get

public TestRail.Milestones.Get get(int milestoneId)

Returns an existing milestone.

Parameters:

milestoneId - the ID of the milestone

Returns:

the request

Throws:

IllegalArgumentException - if milestoneId is not positive

list

public TestRail.Milestones.List list(int projectId)

Returns the list of milestones for a project.

Parameters:

projectId - the ID of the project to get the milestones for

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

add

public TestRail.Milestones.Add add(int projectId,
                                   @NonNull
                                   Milestone milestone)

Creates a new milestone.

Parameters:

projectId - the ID of the project to add the milestone to

milestone - the milestone to be added

Returns:

the request

Throws:

IllegalArgumentException - if projectId is not positive

NullPointerException - if milestone is null

update

public TestRail.Milestones.Update update(@NonNull
                                         Milestone milestone)

Updates an existing milestone. Partial updates are supported, i.e. you can set and update specific fields only.

Parameters:

milestone - the milestone to be updated

Returns:

the request

Throws:

NullPointerException - if milestone is null

delete

public TestRail.Milestones.Delete delete(int milestoneId)

Deletes an existing milestone.

Parameters:

milestoneId - the ID of the milestone to be deleted

Returns:

the request

Throws:

IllegalArgumentException - if milestoneId is not positive