ch.aaap.harvestclient.api

Interface UsersApi

All Known Implementing Classes:

UsersApiImpl

public interface UsersApi

Method Summary

Modifier and Type	Method and Description
User	create(UserCreationInfo userCreationInfo) Create a new User.
void	delete(Reference<User> userReference) Delete a user.
User	get(Reference<User> userReference) Retrieve an existing user
User	getSelf() Retrieve the currently authenticated user
default List<User>	list() Returns a list of your users.
List<User>	list(Boolean isActive, Instant updatedSince) Return a list of users, filtered by activity and update date, newest user first.
User	update(Reference<User> user, User toChange) Change an existing user.

Method Detail

list

default List<User> list()

Returns a list of your users. The users are returned sorted by creation date, with the most recently created users appearing first. This method does not filter results. Same as list(null, null);

Returns:

a list of all users

list

List<User> list(Boolean isActive,
                Instant updatedSince)

Return a list of users, filtered by activity and update date, newest user first.

Parameters:

isActive - if true, return only active users. Set to null to disable filtering

updatedSince - return only users that have been updated at least 1 second after updatedSince. Set to null to disable filtering.

Returns:

a list of all users, filtered accordingly

create

User create(UserCreationInfo userCreationInfo)

Create a new User. First name, last name and email are required.

Parameters:

userCreationInfo - a user creation object with the wanted properties. Null fields will get a default value according to the Harvest docs

Returns:

the User that was just created

getSelf

User getSelf()

Retrieve the currently authenticated user

Returns:

the currently authenticated user

get

User get(Reference<User> userReference)

Retrieve an existing user

Parameters:

userReference - a reference to an existing User

Returns:

the full User object

update

User update(Reference<User> user,
            User toChange)

Change an existing user.

Parameters:

user - a reference to an existing User

toChange - A user object with the properties to be changed. Null fields will be left as is.

Returns:

the updated User

delete

void delete(Reference<User> userReference)

Delete a user. Deleting a user is only possible if they have no time entries or expenses associated with them

Parameters:

userReference - a reference to an existing User to be deleted