Filter projects (#24)

Author: biglovisa

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Adds Sustainable Development Goals (SDGs) field to projects
+- Adds filtering to Projects on type, country
 
 ### Changed
 

README.md

@@ -141,6 +141,11 @@ patch.estimates.retrieveEstimates({ page });
 
 Projects are the ways Patch takes CO2 out of the air. They can represent reforestation, enhanced weathering, direct air carbon capture, etc. When you place an order via Patch, it is allocated to a project.
 
+When fetching Projects, you can add filters to the query to narrow the result. Currently supported filters are:
+
+- `country`
+- `type`
+
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
@@ -153,6 +158,14 @@ patch.projects.retrieveProject(projectId);
 // Retrieve a list of projects
 const page = 1; // Pass in which page of projects you'd like
 patch.projects.retrieveProjects({ page });
+
+// Retrieve a filtered list of projects
+const country = 'CA'; // Pass in the country you'd like to get projects from
+patch.projects.retrieveProjects({ country });
+
+// Retrieve a filtered list of projects
+const type = 'biomass'; // Pass in the project type you'd like to filter by
+patch.projects.retrieveProjects({ type });
 ```
 
 ### Preferences

package-lock.json

@@ -71,7 +71,11 @@ export default class ProjectsApi {
 
     let pathParams = {};
     let queryParams = {
-      page: opts['page']
+      page: opts['page'],
+
+      country: opts['country'],
+
+      type: opts['type']
     };
     let headerParams = {};
     let formParams = {};

src/api/ProjectsApi.js

@@ -0,0 +1,43 @@
+/**
+ * Patch API V1
+ * The core API used to integrate with Patch's service
+ *
+ * Contact: [email protected]
+ */
+
+import ApiClient from '../ApiClient';
+
+class ProjectListRequest {
+  constructor() {
+    ProjectListRequest.initialize(this);
+  }
+
+  static initialize(obj) {}
+
+  static constructFromObject(data, obj) {
+    if (data) {
+      obj = obj || new ProjectListRequest();
+
+      if (data.hasOwnProperty('page')) {
+        obj['page'] = ApiClient.convertToType(data['page'], 'Number');
+      }
+
+      if (data.hasOwnProperty('country')) {
+        obj['country'] = ApiClient.convertToType(data['country'], 'String');
+      }
+
+      if (data.hasOwnProperty('type')) {
+        obj['type'] = ApiClient.convertToType(data['type'], 'String');
+      }
+    }
+    return obj;
+  }
+}
+
+ProjectListRequest.prototype['page'] = undefined;
+
+ProjectListRequest.prototype['country'] = undefined;
+
+ProjectListRequest.prototype['type'] = undefined;
+
+export default ProjectListRequest;

src/model/ProjectListRequest.js

@@ -26,7 +26,7 @@ describe('Orders Integration', function () {
     expect(parseFloat(createOrderResponse.data.price_cents_usd)).to.be.closeTo(
       500,
       1
-    )
+    );
     expect(createOrderResponse.data.patch_fee_cents_usd).to.equal('0.0');
     expect(createOrderResponse.data.mass_g).to.equal(500000);
   });

test/integration/orders.test.js

@@ -14,4 +14,20 @@ describe('Project Integration', function () {
     const projectResponse = await patch.projects.retrieveProject(projectId);
     expect(projectResponse.data.id).to.equal(projectId);
   });
+
+  it('supports fetching all projects from the United States', async function () {
+    const country = 'US';
+    const { data } = await patch.projects.retrieveProjects({ country });
+    data.map((project) => {
+      expect(project.country).to.equal(country);
+    });
+  });
+
+  it('supports fetching all biomass projects', async function () {
+    const type = 'biomass';
+    const { data } = await patch.projects.retrieveProjects({ type });
+    data.map((project) => {
+      expect(project.type).to.equal(type);
+    });
+  });
 });