com.easypost.model.Shipment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of easypost-api-client Show documentation
EasyPost Java Client Library for the EasyPost Shipping API
There is a newer version: 5.5.0
package com.easypost.model;

import java.util.List;
import java.util.Map;
import java.util.HashMap;

import com.google.gson.reflect.TypeToken;

import com.easypost.exception.EasyPostException;
import com.easypost.net.EasyPostResource;

public class Shipment extends EasyPostResource {
	public String id;
	String mode;
	String reference;
	Boolean isReturn;
	Address toAddress;
	Address buyerAddress;
	Address fromAddress;
	Address returnAddress;
	Parcel parcel;
	CustomsInfo customsInfo;
	Rate selectedRate;
	List rates;
	PostageLabel postageLabel;
	ScanForm scanForm;
	String orderId;
	List forms;
	Tracker tracker;
	String insurance;
	String trackingCode;
	String status;
	String refundStatus;
	String batchStatus;
	String batchMessage;
	String uspsZone;
	Map options;
	List messages;

	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}

	public String getMode() {
		return mode;
	}
	public void setMode(String mode) {
		this.mode = mode;
	}

	public String getReference() {
		return reference;
	}
	public void setReference(String reference) {
		this.reference = reference;
	}

	public Boolean getIsReturn() {
		return isReturn;
	}
	public void setIsReturn(Boolean isReturn) {
		this.isReturn = isReturn;
	}

	public Address getToAddress() {
		return toAddress;
	}
	public void setToAddress(Address toAddress) {
		this.toAddress = toAddress;
	}

	public Address getBuyerAddress() {
		return buyerAddress;
	}
	public void setBuyerAddress(Address buyerAddress) {
		this.buyerAddress = buyerAddress;
	}

	public Address getFromAddress() {
		return fromAddress;
	}
	public void setFromAddress(Address fromAddress) {
		this.fromAddress = fromAddress;
	}

	public Address getReturnAddress() {
		return returnAddress;
	}
	public void setReturnAddress(Address returnAddress) {
		this.returnAddress = returnAddress;
	}

	public Parcel getParcel() {
		return parcel;
	}
	public void setParcel(Parcel parcel) {
		this.parcel = parcel;
	}

	public CustomsInfo getCustomsInfo() {
		return customsInfo;
	}
	public void setCustomsInfo(CustomsInfo customsInfo) {
		this.customsInfo = customsInfo;
	}

	public Rate getSelectedRate() {
		return selectedRate;
	}
	public void setSelectedRate(Rate selectedRate) {
		this.selectedRate = selectedRate;
	}

	public List getRates() {
		return rates;
	}
	public void setRates(List rates) {
		this.rates = rates;
	}

	public PostageLabel getPostageLabel() {
		return postageLabel;
	}
	public void setPostageLabel(PostageLabel postageLabel) {
		this.postageLabel = postageLabel;
	}

	public ScanForm getScanForm() {
		return scanForm;
	}
	public void setScanForm(ScanForm scanForm) {
		this.scanForm = scanForm;
	}

	public String getOrderId() {
		return orderId;
	}
	public void setOrderId(String orderId) {
		this.orderId = orderId;
	}

	public Tracker getTracker() {
		return tracker;
	}
	public void setTracker(Tracker tracker) {
		this.tracker = tracker;
	}

	public String getInsurance() {
		return insurance;
	}
	public void setInsurance(String insurance) {
		this.insurance = insurance;
	}

	public String getTrackingCode() {
		return trackingCode;
	}
	public void setTrackingCode(String trackingCode) {
		this.trackingCode = trackingCode;
	}

	public String getStatus() {
		return status;
	}
	public void setStatus(String status) {
		this.status = status;
	}

	public String getRefundStatus() {
		return refundStatus;
	}
	public void setRefundStatus(String refundStatus) {
		this.refundStatus = refundStatus;
	}

	public String getBatchStatus() {
		return batchStatus;
	}
	public void setBatchStatus(String batchStatus) {
		this.batchStatus = batchStatus;
	}

	public String getBatchMessage() {
		return batchMessage;
	}
	public void setBatchMessage(String batchMessage) {
		this.batchMessage = batchMessage;
	}

	public String getUspsZone() {
		return uspsZone;
	}
	public void setUspsZone(String uspsZone) {
		this.uspsZone = uspsZone;
	}

	public Map getOptions() {
		return options;
	}
	public void setOptions(Map options) {
		this.options = options;
	}

	public List getMessages() {
		return messages;
	}
	public void setMessages(List messages) {
		this.messages = messages;
	}

	public List getForms() {
		return forms;
	}
	public void setForms(List forms) {
		this.forms = forms;
	}


	// create
	public static Shipment create(Map params) throws EasyPostException {
		return create(params, null);
	}
	public static Shipment create(Map params, String apiKey) throws EasyPostException {
		Map wrappedParams = new HashMap();
		wrappedParams.put("shipment", params);

		return request(RequestMethod.POST, classURL(Shipment.class), wrappedParams, Shipment.class, apiKey);
	}

	// retrieve
	public static Shipment retrieve(String id) throws EasyPostException {
		return retrieve(id, null);
	}
	public static Shipment retrieve(String id, String apiKey) throws EasyPostException {
		return request(RequestMethod.GET, instanceURL(Shipment.class, id), null, Shipment.class, apiKey);
	}

	// all
	public static ShipmentCollection all(Map params) throws EasyPostException {
		return all(params, null);
	}
	public static ShipmentCollection all(Map params, String apiKey) throws EasyPostException {
		return request(RequestMethod.GET, classURL(Shipment.class), params, ShipmentCollection.class, apiKey);
	}

	// refresh
	public Shipment refresh() throws EasyPostException {
		return this.refresh(null, null);
	}
	public Shipment refresh(Map params) throws EasyPostException {
		return this.refresh(params, null);
	}
	public Shipment refresh(String apiKey) throws EasyPostException {
		return this.refresh((Map) null, apiKey);
	}
	public Shipment refresh(Map params, String apiKey) throws EasyPostException {
		return request(
			RequestMethod.GET,
			String.format("%s", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);
	}

	// get rates
	public Shipment newRates() throws EasyPostException {
		return this.newRates(null, null);
	}
	public Shipment newRates(Map params) throws EasyPostException {
		return this.newRates(params, null);
	}
	public Shipment newRates(String apiKey) throws EasyPostException {
		return this.newRates((Map) null, apiKey);
	}
	public Shipment newRates(Map params, String apiKey) throws EasyPostException {
		Shipment response = request(
			RequestMethod.GET,
			String.format("%s/rates", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);

		this.merge(this, response);
		return this;
	}

	// buy
	public Shipment buy() throws EasyPostException {
		return this.buy(null, null);
	}
	public Shipment buy(Map params) throws EasyPostException {
		return this.buy(params, null);
	}
	public Shipment buy(String apiKey) throws EasyPostException {
		return this.buy((Map) null, apiKey);
	}
	public Shipment buy(Rate rate) throws EasyPostException {
		Map params = new HashMap();
		params.put("rate", rate);

		return this.buy(params, null);
	}
	public Shipment buy(Map params, String apiKey) throws EasyPostException {
		Shipment response = request(
			RequestMethod.POST,
			String.format("%s/buy", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);

		this.merge(this, response);
		return this;
	}

	// refund
	public Shipment refund() throws EasyPostException {
		return this.refund(null, null);
	}
	public Shipment refund(Map params) throws EasyPostException {
		return this.refund(params, null);
	}
	public Shipment refund(String apiKey) throws EasyPostException {
		return this.refund((Map) null, apiKey);
	}
	public Shipment refund(Map params, String apiKey) throws EasyPostException {
		return request(
			RequestMethod.GET,
			String.format("%s/refund", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);
	}

	// label
	public Shipment label() throws EasyPostException {
		return this.label(null, null);
	}
	public Shipment label(Map params) throws EasyPostException {
		return this.label(params, null);
	}
	public Shipment label(String apiKey) throws EasyPostException {
		return this.label((Map) null, apiKey);
	}
	public Shipment label(Map params, String apiKey) throws EasyPostException {
		Shipment response = request(
			RequestMethod.GET,
			String.format("%s/label", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);

		this.merge(this, response);
		return this;
	}

	// insure
	public Shipment insure() throws EasyPostException {
		return this.insure(null, null);
	}
	public Shipment insure(Map params) throws EasyPostException {
		return this.insure(params, null);
	}
	public Shipment insure(String apiKey) throws EasyPostException {
		return this.insure((Map) null, apiKey);
	}
	public Shipment insure(Map params, String apiKey) throws EasyPostException {
		return request(
			RequestMethod.POST,
			String.format("%s/insure", instanceURL(Shipment.class, this.getId())), params, Shipment.class, apiKey);
	}

	// lowest rate
	public Rate lowestRate() throws EasyPostException {
		return this.lowestRate(null, null);
	}
	public Rate lowestRate(List carriers) throws EasyPostException {
		return this.lowestRate(carriers, null);
	}
	public Rate lowestRate(List carriers, List services) throws EasyPostException {
		Rate lowestRate = null;

		if (carriers != null) {
			for(int i=0; i < carriers.size(); i++) {
				carriers.set(i, carriers.get(i).toLowerCase());
			}
		}

		if (services != null) {
			for(int i=0; i < services.size(); i++) {
				services.set(i, services.get(i).toLowerCase());
			}
		}

		for(int i=0; i < this.rates.size(); i++) {
			if (carriers != null && carriers.size() > 0 && !carriers.contains(this.rates.get(i).carrier.toLowerCase()) && !carriers.contains(this.rates.get(i).serviceCode.toLowerCase())) {
				continue;
			}
			if (services != null && services.size() > 0 && !services.contains(this.rates.get(i).service.toLowerCase()) && !services.contains(this.rates.get(i).serviceCode.toLowerCase())) {
				continue;
			}

			if (lowestRate == null || lowestRate.rate > this.rates.get(i).rate) {
				lowestRate = this.rates.get(i);
			}
		}

		if(lowestRate == null) {
			throw new EasyPostException("Unable to find lowest rate matching required criteria.");
		}

		return lowestRate;
	}
}