update filter name

Author: biglovisa

CHANGELOG.md

@@ -10,7 +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 by country, type, remaining inventory
+- Adds filtering to Projects by country, type, minimum_available_mass
 
 ### Changed
 

README.md

@@ -148,7 +148,7 @@ When fetching Projects, you can add filters to the query to narrow the result. C
 
 - `country`
 - `type`
-- `remaining_mass_g`
+- `minimum_available_mass`
 
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
@@ -163,16 +163,16 @@ 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
+country = 'US'
 Patch::Project.retrieve_projects(country: country)
 
 # Retrieve all biomass projects
-type = 'biomass' # Pass in the type of Projects you'd like to get
+type = 'biomass'
 Patch::Project.retrieve_projects(type: type)
 
 # Retrieve a list of projects with at least 100 grams of available offsets
-remaining_mass_g = 100 # Pass in the type of Projects you'd like to get
-Patch::Project.retrieve_projects(remaining_mass_g: remaining_mass_g)
+minimum_available_mass = 100
+Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
 ```
 
 ### Preferences

lib/patch_ruby/api/projects_api.rb

@@ -25,8 +25,8 @@ def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
     # Retrieves a project
-    # Retrieves a project available on Patch's platform.
-    # @param id [String]
+    # Retrieves a project available on Patch's platform. 
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [ProjectResponse]
     def retrieve_project(id, opts = {})
@@ -35,8 +35,8 @@ def retrieve_project(id, opts = {})
     end
 
     # Retrieves a project
-    # Retrieves a project available on Patch's platform.
-    # @param id [String]
+    # Retrieves a project available on Patch's platform. 
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
     def retrieve_project_with_http_info(id, opts = {})
@@ -62,10 +62,10 @@ def retrieve_project_with_http_info(id, opts = {})
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body]
+      post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ProjectResponse'
+      return_type = opts[:return_type] || 'ProjectResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['bearer_auth']
@@ -87,25 +87,25 @@ def retrieve_project_with_http_info(id, opts = {})
     end
 
     # Retrieves a list of projects
-    # Retrieves a list of projects available for purchase on Patch's platform.
+    # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page
-    # @option opts [String] :country
-    # @option opts [String] :type
-    # @option opts [Integer] :remainaing_mass_g
+    # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
       data
     end
 
     # Retrieves a list of projects
-    # Retrieves a list of projects available for purchase on Patch&#39;s platform.
+    # Retrieves a list of projects available for purchase on Patch&#39;s platform. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page
-    # @option opts [String] :country
-    # @option opts [String] :type
-    # @option opts [Integer] :remainaing_mass_g
+    # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @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
@@ -119,7 +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?
+      query_params[:'minimum_available_mass'] = opts[:'minimum_available_mass'] if !opts[:'minimum_available_mass'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -130,10 +130,10 @@ def retrieve_projects_with_http_info(opts = {})
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body]
+      post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ProjectListResponse'
+      return_type = opts[:return_type] || 'ProjectListResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['bearer_auth']

spec/integration/projects_spec.rb

@@ -35,10 +35,10 @@
       expect(project.type).to eq type
     end
 
-    remaining_mass_g = 100
-    projects = Patch::Project.retrieve_projects(remaining_mass_g: remaining_mass_g)
+    minimum_available_mass = 100
+    projects = Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
     projects.data.map do |project|
-      expect(project.remaining_mass_g >= remaining_mass_g).to be true
+      expect(project.remaining_mass_g >= minimum_available_mass).to be true
     end
   end