v6.0.0-rc1

Breaking Changes

• Library is now thread-safe
  • Initialize an EasyPostClient object with an API key. Optionally set connection and readtime params
  • All methods (i.e. create, retrieve, all) exist in services, accessed via property of the client (eg: client.shipment.create())
    • E.g. Static method -> Shipment shipment = client.address.create(params)
    • E.g. Instance methods are now static -> Shipment boughtShipment = client.shipment.buy(shipmentID, lowestRate)
  • All functions are now taking object ID instead of an object, which means the functions are returning the response value directly instead of updating the current object
    • E.g. Shipment boughtShipment = client.shipment.buy(shipmentID, lowestRate)
• Improves error exception handling
  • Specific error types for each category of error
  • API error message may be an array rather than a string. Arrays will be concatenated (by comma) and returned as a string.
• Removes createAndVerifyWithCarrier function
• Removes verifyWithCarrier function
• Removes getUpdate and setUpdate from Tracker class
• Removes all beta features and corrsponding unit tests
• Removes serviceCode from Rate class since this value is internal use only
• Removes invalid function User.create() since creating a child-user requires a name
• Removes deprecated class CreditCard and its associated classes PrimaryPaymentMethod, SecondaryPaymentMethod, and BaseCreditCard, please use alternative Billing class
• Removes all the setters of each object
• Removes the refresh() function in all classes, please use retrieve() function instead
• Removes invalid functions that allow users to make an API request without providing required parameters
• Changes the type of Insurance Amount from Float to String
• Changes the type hasMore in ReferralCustomerCollection from boolean to Boolean
• Renames some getters
  • Pickup class: getPickoutRates() -> getPickupRates()
  • PaymentMethod class: getPrimaryPaymentMethodObject() -> getPrimaryPaymentMethod()
  • PaymentMethod class: getSecondaryPaymentMethodObject() -> getSecondaryPaymentMethod()
• Converts return type from a boolean to void when we receive an empty response body from the API
  • fundWallet() and deletePaymentMethod() in Billing class
  • createList() in Tracker class
  • updateEmail() in ReferralCustomer class
• Changes the type result of Event from EasyPostResource to Map<String, Object>

Bug Fixes

• Adds two missing attributes in the Event class: pendingUrls and completedUrls
• AppEngine default timeout is now the same as connection timeout

v5.10.0

• Adds support to pass an EndShipper ID when buying a shipment
• Removes the unusable overload shipment buy functions that did not contain a rate parameter
• Add White Label support:
  • Create a referral customer
  • Update a referral customer's email address
  • List all referral customers
  • Add a credit card to a referral customer's account

v5.9.0

• Moves EndShipper out of beta into the general library namespace
• Removes the unusable ParcelCollection and all function of the Parcel object

v5.8.1

• Fixes a bug where an erroneous API call to retrieve smartrates would be made behind the scenes whenever a shipment object was updated locally from the API (such as when regenerating rates) due to the deprecated function name being called getSmartrates and the library assuming this was a getter and attempting to use it to update the shipment data

v5.8.0

• Adds Carbon Offset support
  • Adds the ability to create a shipment with carbon offset
  • Adds the ability to buy a shipment with carbon offset
  • Adds the ability to one-call-buy a shipment with carbon offset
  • Adds the ability to re-rate a shipment with carbon offset
• Adds validateWebhook function that returns your webhook or raises an error if there is a webhook secret mismatch

v5.7.0

• Adds ability to generate a shipment form via generate_form() function

v5.6.0

• Adds Billing.retrievePaymentMethods(), Billing.fundWallet(), and Billing.deletePaymentMethod() functions
• Deprecates some existing payment method and credit card functions and features (repleaced by new Billing functions):
  • Deprecates CreditCard.fund() and CreditCard.delete() functions
  • Deprecates PaymentMethod.all() function
  • Deprecates certain PaymentMethod object functions
• Some getX functions have been deprecated and renamed to simply X to avoid confusion with proper getter/setter
  functions.
  • getSmartrates() -> smartrates()
  • getLowestSmartRate() -> findLowestSmartrate()
• Adds OS specific details to the user-agent header

v4.0.5

• Backports user-agent header changes

v5.5.0

• Adds billingType attribute to Rate and CarrierAccount classes.
• Adds missing attributes to the CarrierAcccount object (closes #145)

v5.4.0

• Adds PaymentMethod.all(), CreditCard.fund(), and CreditCard.delete() functions.
• Fixes a bug that did not merge local and remote objects correctly on update (eg: User, Referral)