add retrieve all pickups function (#225)

Author: jchen293

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Next Release
+
+- Adds `all` function to `Pickup` to retrieve all pickups
+
 ## v6.1.0 (2023-01-11)
 
 - Adds new beta billing functionality for ReferralCustomer users

src/main/java/com/easypost/service/PickupService.java

@@ -4,6 +4,7 @@
 import com.easypost.http.Requestor;
 import com.easypost.http.Requestor.RequestMethod;
 import com.easypost.model.Pickup;
+import com.easypost.model.PickupCollection;
 import com.easypost.model.PickupRate;
 import com.easypost.utils.InternalUtilities;
 
@@ -22,6 +23,19 @@ public class PickupService {
         this.client = client;
     }
 
+    /**
+     * Get a list of all Pickup objects.
+     *
+     * @param params The options for the query.
+     * @return PickupCollection object
+     * @throws EasyPostException when the request fails.
+     */
+    public PickupCollection all(final Map<String, Object> params)
+            throws EasyPostException {
+        return Requestor.request(RequestMethod.GET, InternalUtilities.classURL(Pickup.class), params,
+            PickupCollection.class, client);
+    }
+
     /**
      * Create a new Pickup object from a map of parameters.
      *

src/test/cassettes/pickup/all.json

@@ -2,6 +2,7 @@
 
 import com.easypost.exception.EasyPostException;
 import com.easypost.model.Pickup;
+import com.easypost.model.PickupCollection;
 import com.easypost.model.PickupRate;
 import com.easypost.model.Shipment;
 import org.junit.jupiter.api.BeforeAll;
@@ -47,6 +48,27 @@ private static Pickup createBasicPickup() throws EasyPostException {
         return vcr.client.pickup.create(pickupData);
     }
 
+    /**
+     * Test retrieving all shipments.
+     *
+     * @throws EasyPostException when the request fails.
+     */
+    @Test
+    public void testAll() throws EasyPostException {
+        vcr.setUpTest("all");
+
+        Map<String, Object> params = new HashMap<String, Object>();
+        params.put("page_size", Fixtures.pageSize());
+
+        PickupCollection pickupCollection = vcr.client.pickup.all(params);
+
+        List<Pickup> pickups = pickupCollection.getPickups();
+
+        assertTrue(pickups.size() <= Fixtures.pageSize());
+        assertNotNull(pickupCollection.getHasMore());
+        assertTrue(pickups.stream().allMatch(pickup -> pickup instanceof Pickup));
+    }
+
     /**
      * Test creating a pickup.
      *