Filter by remaining mass g

Author: biglovisa

CHANGELOG.md

@@ -10,7 +10,8 @@ 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 by country, type, remaining inventory
+,
 ### Changed
 
 - vehicle estimates now support optional `make`, `model` and `year` fields.

README.md

@@ -144,6 +144,12 @@ Patch::Estimate.retrieve_estimates(page: page)
 ### Projects
 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`
+- `remaining_mass_g`
+
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
@@ -155,6 +161,18 @@ Patch::Project.retrieve_project(project_id)
 # Retrieve a list of projects
 page = 1 # Pass in which page of projects you'd like
 Patch::Project.retrieve_projects(page: page)
+
+# Retrieve all projects from the United States
+country = 'US' # Pass in the country code of the country you'd like to get Projects from
+Patch::Project.retrieve_projects(country: country)
+
+# Retrieve all biomass projects
+type = 'biomass' # Pass in the type of Projects you'd like to get
+Patch::Project.retrieve_projects(type: type)
+
+# Retrieve a list of projects with at least 100 grams of available offsets
+type = 'biomass' # Pass in the type of Projects you'd like to get
+Patch::Project.retrieve_projects(type: type)
 ```
 
 ### Preferences

lib/patch_ruby/api/projects_api.rb

@@ -91,7 +91,8 @@ def retrieve_project_with_http_info(id, opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
     # @option opts [String] :country 
-    # @option opts [Integer] :type 
+    # @option opts [String] :type 
+    # @option opts [Integer] :remainaing_mass_g 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
@@ -103,7 +104,8 @@ def retrieve_projects(opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
     # @option opts [String] :country 
-    # @option opts [Integer] :type 
+    # @option opts [String] :type 
+    # @option opts [Integer] :remainaing_mass_g 
     # @return [Array<(ProjectListResponse, Integer, Hash)>] ProjectListResponse data, response status code and response headers
     def retrieve_projects_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -117,6 +119,7 @@ def retrieve_projects_with_http_info(opts = {})
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'remainaing_mass_g'] = opts[:'remainaing_mass_g'] if !opts[:'remainaing_mass_g'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

spec/integration/projects_spec.rb

@@ -29,11 +29,17 @@
       expect(project.country).to eq country
     end
 
-    type = 'biomass'
+    type = 'dac'
     projects = Patch::Project.retrieve_projects(type: type)
     projects.data.map do |project|
       expect(project.type).to eq type
     end
+
+    remaining_mass_g = 100
+    projects = Patch::Project.retrieve_projects(remaining_mass_g: remaining_mass_g)
+    projects.data.map do |project|
+      expect(project.remaining_mass_g >= remaining_mass_g).to be true
+    end
   end
 
   describe 'returned fields' do