Add country/type filtering for Projects

Author: biglovisa

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.2] - 2021-02-16
+
+### Added
+
+- Adds filtering on type/country for Projects.
+
+
 ## [1.3.1] - 2021-02-09
 
 ### Fixed

README.md

@@ -141,6 +141,10 @@ patch.estimates.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 supply filters to the query to narrow your result. Currently supported filters are:
+- `country`
+- `type`
+
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
@@ -156,6 +160,12 @@ patch.projects.retrieve_project(id=project_id)
 # Retrieve a list of projects
 page = 1 # Pass in which page of projects you'd like
 patch.projects.retrieve_projects(page=page)
+
+# Retrieve a list of biomass projects
+patch.projects.retrieve_projects(type="biomass")
+
+# Retrieve a list of projects from Canada
+patch.projects.retrieve_projects(country="CA")
 ```
 
 ### Preferences

patch_api/__init__.py

@@ -15,7 +15,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.3.1"
+__version__ = "1.3.2"
 
 # import ApiClient
 from patch_api.api_client import ApiClient

patch_api/api/estimates_api.py

@@ -40,6 +40,8 @@ class EstimatesApi(object):
         "model",
         "make",
         "year",
+        "type",
+        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -119,6 +121,8 @@ def create_flight_estimate_with_http_info(
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -262,6 +266,8 @@ def create_mass_estimate_with_http_info(
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -405,6 +411,8 @@ def create_shipping_estimate_with_http_info(
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -548,6 +556,8 @@ def create_vehicle_estimate_with_http_info(
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -685,6 +695,8 @@ def retrieve_estimate_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -812,6 +824,8 @@ def retrieve_estimates_with_http_info(self, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:

patch_api/api/orders_api.py

@@ -40,6 +40,8 @@ class OrdersApi(object):
         "model",
         "make",
         "year",
+        "type",
+        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -113,6 +115,8 @@ def cancel_order_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -242,6 +246,8 @@ def create_order_with_http_info(self, create_order_request, **kwargs):  # noqa:
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -379,6 +385,8 @@ def place_order_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -506,6 +514,8 @@ def retrieve_order_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -633,6 +643,8 @@ def retrieve_orders_with_http_info(self, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:

patch_api/api/preferences_api.py

@@ -40,6 +40,8 @@ class PreferencesApi(object):
         "model",
         "make",
         "year",
+        "type",
+        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -117,6 +119,8 @@ def create_preference_with_http_info(
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -254,6 +258,8 @@ def delete_preference_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -381,6 +387,8 @@ def retrieve_preference_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -508,6 +516,8 @@ def retrieve_preferences_with_http_info(self, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:

patch_api/api/projects_api.py

@@ -40,6 +40,8 @@ class ProjectsApi(object):
         "model",
         "make",
         "year",
+        "type",
+        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -113,6 +115,8 @@ def retrieve_project_with_http_info(self, id, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:
@@ -240,6 +244,8 @@ def retrieve_projects_with_http_info(self, **kwargs):  # noqa: E501
         all_params.append("make")
         all_params.append("model")
         all_params.append("year")
+        all_params.append("type")
+        all_params.append("country")
 
         for key, val in six.iteritems(local_var_params["kwargs"]):
             if key not in all_params:

patch_api/api_client.py

@@ -91,7 +91,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = "OpenAPI-Generator/1.3.1/python"
+        self.user_agent = "OpenAPI-Generator/1.3.2/python"
 
     def __del__(self):
         if self._pool:

patch_api/models/project.py

@@ -45,6 +45,7 @@ class Project(object):
         "average_price_per_tonne_cents_usd": "int",
         "remaining_mass_g": "int",
         "standard": "Standard",
+        "sdgs": "list[Sdg]",
     }
 
     attribute_map = {
@@ -59,6 +60,7 @@ class Project(object):
         "average_price_per_tonne_cents_usd": "average_price_per_tonne_cents_usd",
         "remaining_mass_g": "remaining_mass_g",
         "standard": "standard",
+        "sdgs": "sdgs",
     }
 
     def __init__(
@@ -74,6 +76,7 @@ def __init__(
         average_price_per_tonne_cents_usd=None,
         remaining_mass_g=None,
         standard=None,
+        sdgs=None,
         local_vars_configuration=None,
     ):  # noqa: E501
         """Project - a model defined in OpenAPI"""  # noqa: E501
@@ -92,6 +95,7 @@ def __init__(
         self._average_price_per_tonne_cents_usd = None
         self._remaining_mass_g = None
         self._standard = None
+        self._sdgs = None
         self.discriminator = None
 
         self.id = id
@@ -106,6 +110,7 @@ def __init__(
         self.average_price_per_tonne_cents_usd = average_price_per_tonne_cents_usd
         self.remaining_mass_g = remaining_mass_g
         self.standard = standard
+        self.sdgs = sdgs
 
     @property
     def id(self):
@@ -425,6 +430,29 @@ def standard(self, standard):
 
         self._standard = standard
 
+    @property
+    def sdgs(self):
+        """Gets the sdgs of this Project.  # noqa: E501
+
+        An array returning the UN Sustainable Development Goals associated with this project.  # noqa: E501
+
+        :return: The sdgs of this Project.  # noqa: E501
+        :rtype: list[Sdg]
+        """
+        return self._sdgs
+
+    @sdgs.setter
+    def sdgs(self, sdgs):
+        """Sets the sdgs of this Project.
+
+        An array returning the UN Sustainable Development Goals associated with this project.  # noqa: E501
+
+        :param sdgs: The sdgs of this Project.  # noqa: E501
+        :type: list[Sdg]
+        """
+
+        self._sdgs = sdgs
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}