com.codepine.api.testrail

Class TestRail

java.lang.Object

com.codepine.api.testrail.TestRail

public class TestRail
extends Object

Client for Test Rail API. Configure and use it to create requests for the API.

See Also:

TestRail API v2 Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestRail.Builder Builder for TestRail.
class	TestRail.CaseFields Request factories for "Case Fields".
class	TestRail.Cases Request factories for "Cases".
class	TestRail.CaseTypes Request factories for "Case Types".
class	TestRail.Configurations Request factories for "Configurations".
class	TestRail.Milestones Request factories for "Milestones".
class	TestRail.Plans Request factories for "Plans".
class	TestRail.Priorities Request factories for "Priorities".
class	TestRail.Projects Request factories for "Projects".
class	TestRail.ResultFields Request factories for "Result Fields".
class	TestRail.Results Request factories for "Results".
class	TestRail.Runs Request factories for "Runs".
class	TestRail.Sections Request factories for "Sections".
class	TestRail.Statuses Request factories for "Statuses".
class	TestRail.Suites Request factories for "Suites".
class	TestRail.Tests Request factories for "Tests".
class	TestRail.Users Request factories for "Users".

Method Summary

Modifier and Type	Method and Description
static TestRail.Builder	builder(String endPoint, String username, String password) Get a builder to build an instance of TestRail.
TestRail.CaseFields	caseFields() An accessor for creating requests for "Case Fields".
TestRail.Cases	cases() An accessor for creating requests for "Cases".
TestRail.CaseTypes	caseTypes() An accessor for creating requests for "Case Types".
TestRail.Configurations	configurations() An accessor for creating requests for "Configurations".
TestRail.Milestones	milestones() An accessor for creating requests for "Milestones".
TestRail.Plans	plans() An accessor for creating requests for "Plans".
TestRail.Priorities	priorities() An accessor for creating requests for "Priorities".
TestRail.Projects	projects() An accessor for creating requests for "Projects".
TestRail.ResultFields	resultFields() An accessor for creating requests for "Result Fields".
TestRail.Results	results() An accessor for creating requests for "Results".
TestRail.Runs	runs() An accessor for creating requests for "Runs".
TestRail.Sections	sections() An accessor for creating requests for "Sections".
TestRail.Statuses	statuses() An accessor for creating requests for "Statuses".
TestRail.Suites	suites() An accessor for creating requests for "Suites".
TestRail.Tests	tests() An accessor for creating requests for "Tests".
TestRail.Users	users() An accessor for creating requests for "Users".

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static TestRail.Builder builder(@NonNull
                                       String endPoint,
                                       @NonNull
                                       String username,
                                       @NonNull
                                       String password)

Get a builder to build an instance of TestRail.

Parameters:

endPoint - the URL end point where your TestRail is hosted, for e.g. https://example.com/testrail

username - the username of the TestRail user on behalf of which the communication with TestRail will happen

password - the password of the same TestRail user

Returns:

a builder to build TestRail instance

projects

public TestRail.Projects projects()

An accessor for creating requests for "Projects".

Returns:

a request factory

cases

public TestRail.Cases cases()

An accessor for creating requests for "Cases".

Returns:

a request factory

caseFields

public TestRail.CaseFields caseFields()

An accessor for creating requests for "Case Fields".

Returns:

a request factory

caseTypes

public TestRail.CaseTypes caseTypes()

An accessor for creating requests for "Case Types".

Returns:

a request factory

configurations

public TestRail.Configurations configurations()

An accessor for creating requests for "Configurations".

Returns:

a request factory

sections

public TestRail.Sections sections()

An accessor for creating requests for "Sections".

Returns:

a request factory

suites

public TestRail.Suites suites()

An accessor for creating requests for "Suites".

Returns:

a request factory

milestones

public TestRail.Milestones milestones()

An accessor for creating requests for "Milestones".

Returns:

a request factory

priorities

public TestRail.Priorities priorities()

An accessor for creating requests for "Priorities".

Returns:

a request factory

resultFields

public TestRail.ResultFields resultFields()

An accessor for creating requests for "Result Fields".

Returns:

a request factory

tests

public TestRail.Tests tests()

An accessor for creating requests for "Tests".

Returns:

a request factory

users

public TestRail.Users users()

An accessor for creating requests for "Users".

Returns:

a request factory

statuses

public TestRail.Statuses statuses()

An accessor for creating requests for "Statuses".

Returns:

a request factory

runs

public TestRail.Runs runs()

An accessor for creating requests for "Runs".

Returns:

a request factory

plans

public TestRail.Plans plans()

An accessor for creating requests for "Plans".

Returns:

a request factory

results

public TestRail.Results results()

An accessor for creating requests for "Results".

Returns:

a request factory