Class UserService

java.lang.Object

com.easypost.service.UserService

public class UserService
extends Object

Method Summary

Modifier and Type	Method	Description
ChildUserCollection	allChildren(Map<String,Object> params)	Retrieve the paginated list of child users for the authenticated user.
List<ApiKey>	apiKeys(String id)	Deprecated. Use ApiKeyService.retrieveApiKeysForUser(String) instead.
User	create(Map<String,Object> params)	Create a User object with a map of parameters.
void	delete(String id)	Delete this User.
ChildUserCollection	getNextPage(ChildUserCollection collection, Integer pageSize)	Get the next page of a ChildUserCollection.
User	retrieve(String id)	Retrieve a User from the API.
User	retrieveMe()	Retrieve your User from the API.
User	update(String id, Map<String,Object> params)	Update this User.
Brand	updateBrand(String id, Map<String,Object> params)	Update the user brand.

Methods inherited from class java.lang.Object

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

Method Details

retrieve

public User retrieve(String id)
              throws EasyPostException

Retrieve a User from the API.

Parameters:

id - The ID of the User to retrieve.

Returns:

User object.

Throws:

EasyPostException - when the request fails.

retrieveMe

public User retrieveMe()
                throws EasyPostException

Retrieve your User from the API.

Returns:

User object.

Throws:

EasyPostException - when the request fails.

create

public User create(Map<String,Object> params)
            throws EasyPostException

Create a User object with a map of parameters.

Parameters:

params - Map of User parameters.

Returns:

User object.

Throws:

EasyPostException - when the request fails.

update

public User update(String id,
 Map<String,Object> params)
            throws EasyPostException

Update this User.

Parameters:

id - The ID of user.

params - Map of User parameters.

Returns:

User object.

Throws:

EasyPostException - when the request fails.

delete

public void delete(String id)
            throws EasyPostException

Delete this User.

Parameters:

id - The ID of the user.

Throws:

EasyPostException - when the request fails.

apiKeys

public List<ApiKey> apiKeys(String id)
                     throws EasyPostException

Deprecated.

Use ApiKeyService.retrieveApiKeysForUser(String) instead.

Get this User's API keys.

Parameters:

id - The ID of the user.

Returns:

List of ApiKey objects.

Throws:

EasyPostException - when the request fails.

updateBrand

public Brand updateBrand(String id,
 Map<String,Object> params)
                  throws EasyPostException

Update the user brand.

Parameters:

id - The ID of user.

params - Map of parameters.

Returns:

Brand object.

Throws:

EasyPostException - when the request fails.

allChildren

public ChildUserCollection allChildren(Map<String,Object> params)
                                throws EasyPostException

Retrieve the paginated list of child users for the authenticated user.

Parameters:

params - Map of parameters.

Returns:

ChildUserCollection object.

Throws:

EasyPostException - when the request fails.

getNextPage

public ChildUserCollection getNextPage(ChildUserCollection collection,
 Integer pageSize)
                                throws EndOfPaginationError

Get the next page of a ChildUserCollection.

Parameters:

collection - ChildUserCollection to get next page of.

pageSize - The number of results to return on the next page.

Returns:

ChildUserCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.