|
1 | 1 | # CHANGELOG
|
2 | 2 |
|
3 |
| -## V6 (Next release) |
| 3 | +## v6.0.0-rc1 (2022-11-30) |
| 4 | + |
| 5 | +### Breaking Changes |
4 | 6 |
|
5 | 7 | - Library is now thread-safe
|
6 |
| - - Initialize a `EasyPostClient` object with an API key, connection and readtime milliseconds are optional, otherwise it will be set to default. |
7 |
| - - All methods (i.e. `create`, `retrieve`, retrieve `all` of a resource) exist in services, accessed via property of the client |
| 8 | + - Initialize an `EasyPostClient` object with an API key. Optionally set connection and readtime params |
| 9 | + - All methods (i.e. `create`, `retrieve`, `all`) exist in services, accessed via property of the client (eg: `client.shipment.create()`) |
8 | 10 | - E.g. Static method -> `Shipment shipment = client.address.create(params)`
|
9 |
| - - E.g. Instance method -> `Shipment boughtShipment = client.shipment.buy(shipmentID, lowestRate)` |
| 11 | + - E.g. Instance methods are now static -> `Shipment boughtShipment = client.shipment.buy(shipmentID, lowestRate)` |
10 | 12 | - 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
|
11 | 13 | - E.g. `Shipment boughtShipment = client.shipment.buy(shipmentID, lowestRate)`
|
12 | 14 | - Improves error exception handling
|
13 | 15 | - Specific error types for each category of error
|
14 | 16 | - API error message may be an array rather than a string. Arrays will be concatenated (by comma) and returned as a string.
|
15 | 17 | - Removes `createAndVerifyWithCarrier` function
|
16 | 18 | - Removes `verifyWithCarrier` function
|
17 |
| -- Changes the type of Insurance `Amount` from Float to String |
18 | 19 | - Removes `getUpdate` and `setUpdate` from Tracker class
|
19 | 20 | - Removes all beta features and corrsponding unit tests
|
20 | 21 | - Removes `serviceCode` from `Rate` class since this value is internal use only
|
21 |
| -- Converts return type from boolean to void in empty response body functions |
22 |
| - - `fundWallet()` and `deletePaymentMethod()` in Billing class |
23 |
| - - `createList()` in Tracker class |
24 |
| - - `updateEmail()` in ReferralCustomer class |
25 |
| -- Adds two missing attributes in the Event class: `pendingUrls` and `completedUrls` |
26 |
| -- Changes the type `result` of Event from `EasyPostResource` to `Map<String, Object>` |
27 |
| -- AppEngine default timeout is now the same as connection timeout |
28 | 22 | - Removes invalid function `User.create()` since creating a child-user requires a name
|
29 | 23 | - Removes deprecated class `CreditCard` and its associated classes `PrimaryPaymentMethod`, `SecondaryPaymentMethod`, and `BaseCreditCard`, please use alternative `Billing` class
|
30 | 24 | - Removes all the setters of each object
|
31 |
| -- Setters are now available via lombok and aren't explicitly in the code anymore |
| 25 | +- Removes the `refresh()` function in all classes, please use `retrieve()` function instead |
| 26 | +- Removes invalid functions that allow users to make an API request without providing required parameters |
| 27 | +- Changes the type of Insurance `Amount` from Float to String |
32 | 28 | - Changes the type `hasMore` in ReferralCustomerCollection from `boolean` to `Boolean`
|
33 | 29 | - Renames some getters
|
34 | 30 | - Pickup class: `getPickoutRates()` -> `getPickupRates()`
|
35 | 31 | - PaymentMethod class: `getPrimaryPaymentMethodObject()` -> `getPrimaryPaymentMethod()`
|
36 | 32 | - PaymentMethod class: `getSecondaryPaymentMethodObject()` -> `getSecondaryPaymentMethod()`
|
37 |
| -- Removes the `refresh()` function in all classes, please use `retrieve()` function instead |
38 |
| -- Removes invalid functions that allow users to make an API request without providing required parameters |
| 33 | +- Converts return type from a boolean to void when we receive an empty response body from the API |
| 34 | + - `fundWallet()` and `deletePaymentMethod()` in Billing class |
| 35 | + - `createList()` in Tracker class |
| 36 | + - `updateEmail()` in ReferralCustomer class |
| 37 | +- Changes the type `result` of Event from `EasyPostResource` to `Map<String, Object>` |
| 38 | + |
| 39 | +### Bug Fixes |
| 40 | + |
| 41 | +- Adds two missing attributes in the Event class: `pendingUrls` and `completedUrls` |
| 42 | +- AppEngine default timeout is now the same as connection timeout |
39 | 43 |
|
40 | 44 | ## v5.10.0 (2022-09-21)
|
41 | 45 |
|
|
0 commit comments