Class CarrierAccountService

java.lang.Object

com.easypost.service.CarrierAccountService

public class CarrierAccountService
extends Object

Method Summary

Modifier and Type	Method	Description
List<CarrierAccount>	all()	List all carrier accounts.
List<CarrierAccount>	all(Map<String,Object> params)	List all carrier accounts.
CarrierAccount	create(Map<String,Object> params)	Create a carrier account.
void	delete(String id)	Delete this carrier account.
CarrierAccount	retrieve(String id)	Retrieve a carrier account from the API.
CarrierAccount	update(String id, Map<String,Object> params)	Update this carrier account.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Create a carrier account.

Parameters:

params - Map of parameters to create.

Returns:

created CarrierAccount object.

Throws:

EasyPostException - when the request fails.

retrieve

public CarrierAccount retrieve(String id)
                        throws EasyPostException

Retrieve a carrier account from the API.

Parameters:

id - id of the carrier account.

Returns:

CarrierAccount object.

Throws:

EasyPostException - when the request fails.

all

public List<CarrierAccount> all()
                         throws EasyPostException

List all carrier accounts.

Returns:

List of CarrierAccount objects.

Throws:

EasyPostException - when the request fails.

all

public List<CarrierAccount> all(Map<String,Object> params)
                         throws EasyPostException

List all carrier accounts.

Parameters:

params - filters to apply to the list.

Returns:

List of CarrierAccount objects.

Throws:

EasyPostException - when the request fails.

update

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

Update this carrier account.

Parameters:

id - The ID of carrier account

params - parameters to update.

Returns:

updated CarrierAccount object.

Throws:

EasyPostException - when the request fails.

delete

public void delete(String id)
            throws EasyPostException

Delete this carrier account.

Parameters:

id - The ID of carrier account.

Throws:

EasyPostException - when the request fails.