Class EasyPostClient

java.lang.Object

com.easypost.service.EasyPostClient

public class EasyPostClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final AddressService	address
final ApiKeyService	apiKey
final BatchService	batch
final BetaRateService	betaRate
final BetaReferralCustomerService	betaReferralCustomer
final BillingService	billing
final CarrierAccountService	carrierAccount
final CarrierMetadataService	carrierMetadata
final CarrierTypeService	carrierType
final ClaimService	claim
final CustomerPortalService	customerPortal
final CustomsInfoService	customsInfo
final CustomsItemService	customsItem
final EmbeddableService	embeddable
final EndShipperService	endShipper
final EventService	event
final FedExRegistrationService	fedexRegistration
final InsuranceService	insurance
final LumaService	luma
final OrderService	order
final ParcelService	parcel
final PaymentMethodService	paymentMethod
final PickupService	pickup
final RateService	rate
final ReferralCustomerService	referralCustomer
final RefundService	refund
final ReportService	report
final ScanformService	scanForm
final ShipmentService	shipment
final SmartRateService	smartRate
final TrackerService	tracker
final UserService	user
final WebhookService	webhook

Constructor Summary

Constructors

Constructor	Description
EasyPostClient(String apiKey)	EasyPostClient constructor.
EasyPostClient(String apiKey, int connectTimeoutMilliseconds)	EasyPostClient constructor.
EasyPostClient(String apiKey, int connectTimeoutMilliseconds, int readTimeoutMilliseconds)	EasyPostClient constructor.
EasyPostClient(String apiKey, int connectTimeoutMilliseconds, int readTimeoutMilliseconds, String apiBase)	EasyPostClient constructor.
EasyPostClient(String apiKey, int connectTimeoutMilliseconds, String apiBase)	EasyPostClient constructor.
EasyPostClient(String apiKey, String apiBase)	EasyPostClient constructor.

Method Summary

Modifier and Type	Method	Description
String	getApiBase()	Get API base for this EasyPostClient object.
String	getApiKey()	Get API key for this EasyPostClient object.
String	getApiVersion()	Get API version for this EasyPostClient object.
int	getConnectionTimeoutMilliseconds()	Get connection timeout milliseconds for this EasyPostClient object.
int	getReadTimeoutMilliseconds()	Get read timeout milliseconds for this EasyPostClient object.
Map<String,Object>	makeApiCall(Requestor.RequestMethod method, String endpoint, Map<String,Object> params)	Make an API call to the EasyPost API.
void	subscribeToRequestHook(Function<RequestHookResponses, Object> function)	Subscribes to a request hook from the given function.
void	subscribeToResponseHook(Function<ResponseHookResponses, Object> function)	Subscribes to a response hook from the given function.
void	unsubscribeFromRequestHook(Function<RequestHookResponses, Object> function)	Unsubscribes to a request hook from the given function.
void	unsubscribeFromResponseHook(Function<ResponseHookResponses, Object> function)	Unubscribes to a response hook from the given function.

Methods inherited from class Object

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

Field Details

address

public final AddressService address

apiKey

public final ApiKeyService apiKey

batch

public final BatchService batch

betaRate

public final BetaRateService betaRate

betaReferralCustomer

public final BetaReferralCustomerService betaReferralCustomer

billing

public final BillingService billing

carrierAccount

public final CarrierAccountService carrierAccount

carrierMetadata

public final CarrierMetadataService carrierMetadata

fedexRegistration

public final FedExRegistrationService fedexRegistration

carrierType

public final CarrierTypeService carrierType

claim

public final ClaimService claim

customerPortal

public final CustomerPortalService customerPortal

customsInfo

public final CustomsInfoService customsInfo

customsItem

public final CustomsItemService customsItem

embeddable

public final EmbeddableService embeddable

endShipper

public final EndShipperService endShipper

event

public final EventService event

insurance

public final InsuranceService insurance

luma

public final LumaService luma

order

public final OrderService order

parcel

public final ParcelService parcel

paymentMethod

public final PaymentMethodService paymentMethod

pickup

public final PickupService pickup

rate

public final RateService rate

referralCustomer

public final ReferralCustomerService referralCustomer

refund

public final RefundService refund

report

public final ReportService report

scanForm

public final ScanformService scanForm

shipment

public final ShipmentService shipment

smartRate

public final SmartRateService smartRate

tracker

public final TrackerService tracker

user

public final UserService user

webhook

public final WebhookService webhook

Constructor Details

EasyPostClient

public EasyPostClient(String apiKey)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

Throws:

MissingParameterError - When the request fails.

EasyPostClient

public EasyPostClient(String apiKey,
 String apiBase)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

apiBase - API base for API calls.

Throws:

MissingParameterError - When the request fails.

EasyPostClient

public EasyPostClient(String apiKey,
 int connectTimeoutMilliseconds)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

connectTimeoutMilliseconds - Timeout for connection.

Throws:

MissingParameterError - When the request fails.

EasyPostClient

public EasyPostClient(String apiKey,
 int connectTimeoutMilliseconds,
 String apiBase)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

connectTimeoutMilliseconds - Timeout for connection.

apiBase - API base for API calls.

Throws:

MissingParameterError - When the request fails.

EasyPostClient

public EasyPostClient(String apiKey,
 int connectTimeoutMilliseconds,
 int readTimeoutMilliseconds)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

connectTimeoutMilliseconds - Timeout for connection.

readTimeoutMilliseconds - Timeout for read.

Throws:

MissingParameterError - When the request fails.

EasyPostClient

public EasyPostClient(String apiKey,
 int connectTimeoutMilliseconds,
 int readTimeoutMilliseconds,
 String apiBase)
               throws MissingParameterError

EasyPostClient constructor.

Parameters:

apiKey - API key for API calls.

connectTimeoutMilliseconds - Timeout for connection.

readTimeoutMilliseconds - Timeout for read.

apiBase - API base for API calls.

Throws:

MissingParameterError - When the request fails.

Method Details

subscribeToRequestHook

public void subscribeToRequestHook(Function<RequestHookResponses, Object> function)

Subscribes to a request hook from the given function.

Parameters:

function - The function to be subscribed to the request hook

unsubscribeFromRequestHook

public void unsubscribeFromRequestHook(Function<RequestHookResponses, Object> function)

Unsubscribes to a request hook from the given function.

Parameters:

function - The function to be unsubscribed from the request hook

subscribeToResponseHook

public void subscribeToResponseHook(Function<ResponseHookResponses, Object> function)

Subscribes to a response hook from the given function.

Parameters:

function - The function to be subscribed to the response hook

unsubscribeFromResponseHook

public void unsubscribeFromResponseHook(Function<ResponseHookResponses, Object> function)

Unubscribes to a response hook from the given function.

Parameters:

function - The function to be unsubscribed from the response hook

getConnectionTimeoutMilliseconds

public int getConnectionTimeoutMilliseconds()

Get connection timeout milliseconds for this EasyPostClient object.

Returns:

the connection timeout for this EasyPostClient object

getReadTimeoutMilliseconds

public int getReadTimeoutMilliseconds()

Get read timeout milliseconds for this EasyPostClient object.

Returns:

the read timeout for this EasyPostClient object

getApiKey

public String getApiKey()

Get API key for this EasyPostClient object.

Returns:

the API key for this EasyPostClient object

getApiVersion

public String getApiVersion()

Get API version for this EasyPostClient object.

Returns:

the API version for this EasyPostClient object.

getApiBase

public String getApiBase()

Get API base for this EasyPostClient object.

Returns:

the API base for this EasyPostClient object.

makeApiCall

public Map<String,Object> makeApiCall(Requestor.RequestMethod method,
 String endpoint,
 Map<String,Object> params)
                               throws EasyPostException

Make an API call to the EasyPost API. This public, generic interface is useful for making arbitrary API calls to the EasyPost API that are not yet supported by the client library's services. When possible, the service for your use case should be used instead as it provides a more convenient and higher-level interface depending on the endpoint.

Parameters:

method - The HTTP method to use for the request.

endpoint - The endpoint to call (e.g., "/addresses").

params - The parameters to send with the request.

Returns:

A Map containing the API response.

Throws:

EasyPostException - when the request fails.