Class CarrierMetadataService

java.lang.Object

com.easypost.service.CarrierMetadataService

public class CarrierMetadataService
extends Object

Method Summary

Modifier and Type	Method	Description
CarrierMetadata	retrieve()	Retrieves all carrier metadata.
CarrierMetadata	retrieve(List<String> carriers)	Retrieves carrier metadata for given carriers.
CarrierMetadata	retrieve(List<String> carriers, List<String> types)	Retrieves carrier metadata for given carriers and types.

Methods inherited from class java.lang.Object

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

Method Details

retrieve

public CarrierMetadata retrieve()
                         throws EasyPostException

Retrieves all carrier metadata.

Returns:

CarrierMetadata object

Throws:

EasyPostException - When the request fails.

retrieve

public CarrierMetadata retrieve(List<String> carriers)
                         throws EasyPostException

Retrieves carrier metadata for given carriers.

Parameters:

carriers - The list of carriers in string.

Returns:

CarrierMetadata object

Throws:

EasyPostException - When the request fails.

retrieve

public CarrierMetadata retrieve(List<String> carriers,
 List<String> types)
                         throws EasyPostException

Retrieves carrier metadata for given carriers and types.

Parameters:

carriers - The list of carriers in string.

types - The list of types in string.

Returns:

CarrierMetadata object

Throws:

EasyPostException - When the request fails.