com.codepine.api.testrail

Class TestRail.Users

java.lang.Object

com.codepine.api.testrail.TestRail.Users

Enclosing class:

TestRail

public class TestRail.Users
extends Object

Request factories for "Users".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestRail.Users.Get
class	TestRail.Users.GetByEmail
class	TestRail.Users.List

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

Modifier and Type	Method and Description
TestRail.Users.Get	get(int userId) Returns an existing user.
TestRail.Users.GetByEmail	getByEmail(String email) Returns an existing user by his/her email address.
TestRail.Users.List	list() Returns a list of users.

Methods inherited from class java.lang.Object

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

Constructor Detail

Users

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

Method Detail

get

public TestRail.Users.Get get(int userId)

Returns an existing user.

Parameters:

userId - the ID of the user

Returns:

the request

Throws:

IllegalArgumentException - if userId is not positive

getByEmail

public TestRail.Users.GetByEmail getByEmail(@NonNull
                                            String email)

Returns an existing user by his/her email address.

Parameters:

email - the email address to get the user for

Returns:

the request

Throws:

NullPointerException - if email is null

IllegalArgumentException - if email is empty

list

public TestRail.Users.List list()

Returns a list of users.

Returns:

the request