Merge branch 'main' into lovisa/add-test-for-filtering

Author: biglovisa

CHANGELOG.md

@@ -5,6 +5,17 @@ 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.4.0] - 2021-02-15
+
+### Added
+
+- Adds Sustainable Development Goals (SDGs) field to projects
+- Adds the ability to filter Projects on country, type
+
+### Changed
+
+- vehicle estimates now support optional `make`, `model` and `year` fields.
+
 ## [1.3.1] - 2021-02-09
 
 ### Fixed

README.md

@@ -1,32 +1,38 @@
 # Patch Python SDK
+
 ![Test](https://github.com/patch-technology/patch-python/workflows/Test/badge.svg)
 [![PyPI version](https://badge.fury.io/py/patch-api.svg)](https://badge.fury.io/py/patch-api)
 [![Discord](https://img.shields.io/discord/733029448558837792)](https://discord.gg/AU8543D)
 
 The official Python library for the [Patch API](https://www.usepatch.com).
 
 ## Documentation
+
 For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/).
 
 ## Installation
 
 Add the library to your `requirements.txt` file:
+
 ```txt
-patch_api >= 1.3.1
+patch_api >= 1.4.0
 ```
 
 Then run:
+
 ```shell
 pip install -r requirements.txt
 ```
 
 Or install it directly with
+
 ```shell
 pip install patch-api
 ```
 
 ### Requirements
-- Python 3.6.0
+
+- Python 3.6.1
 
 ## Usage
 
@@ -42,6 +48,7 @@ orders = patch.orders.retrieve_orders()
 ```
 
 ### Orders
+
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
 
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass.
@@ -53,6 +60,7 @@ fulfill the order for you.
 [API Reference](https://docs.usepatch.com/#/?id=orders)
 
 #### Examples
+
 ```python
 import patch_api
 
@@ -94,11 +102,13 @@ patch.orders.retrieve_orders(page=page)
 ```
 
 ### Estimates
+
 Estimates allow API users to get a quote for the cost of compensating a certain amount of CO2. When creating an estimate, an order in the `draft` state will also be created, reserving the allocation of a project for 5 minutes. If you don't place your draft order within those 5 minutes, the order will automatically be cancelled.
 
 [API Reference](https://docs.usepatch.com/#/?id=estimates)
 
 #### Examples
+
 ```python
 import patch_api
 
@@ -139,6 +149,7 @@ 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:
@@ -148,6 +159,7 @@ When fetching projects, you can supply filters to the query to narrow your resul
 [API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
+
 ```python
 import patch_api
 
@@ -169,11 +181,13 @@ patch.projects.retrieve_projects(country="CA")
 ```
 
 ### Preferences
+
 Preferences are how you route your orders in Patch. If you don't have a preference, Patch will allocate your order to the least expensive option. If you do have a preference, all of your orders will be sent to that project. You can set your preferences via API, or through the [Patch Dashboard](https://dashboard.usepatch.com/projects).
 
 [API Reference](https://docs.usepatch.com/#/?id=preferences)
 
 #### Examples
+
 ```python
 import patch_api
 
@@ -202,23 +216,27 @@ patch.preferences.retrieve_preferences(page=page)
 ### Running tests
 
 Set up the required environment variable:
+
 ```
 $ export SANDBOX_API_KEY=<SANDBOX API KEY>
 ```
 
 Run tests:
+
 ```
 $ make test
 ```
 
 To run an individual test:
+
 ```
 $ python -m unittest
 ```
 
 ### Testing the built package locally
 
 To build the library locally, run:
+
 ```
 $ make build
 ```
@@ -231,11 +249,13 @@ $ pip install ../patch-python
 ```
 
 Set up the required environment variable:
+
 ```
 $ export SANDBOX_API_KEY=<SANDBOX API KEY>
 ```
 
 To test the package locally, create a python file in a sibling directory and add the following:
+
 ```python
 import os
 import patch_api

patch_api/__init__.py

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

patch_api/api/estimates_api.py

@@ -40,8 +40,6 @@ class EstimatesApi(object):
         "model",
         "make",
         "year",
-        "type",
-        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -121,8 +119,6 @@ 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:
@@ -266,8 +262,6 @@ 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:
@@ -411,8 +405,6 @@ 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:
@@ -556,8 +548,6 @@ 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:
@@ -695,8 +685,6 @@ 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:
@@ -824,8 +812,6 @@ 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,8 +40,6 @@ class OrdersApi(object):
         "model",
         "make",
         "year",
-        "type",
-        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -115,8 +113,6 @@ 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:
@@ -246,8 +242,6 @@ 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:
@@ -385,8 +379,6 @@ 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:
@@ -514,8 +506,6 @@ 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:
@@ -643,8 +633,6 @@ 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,8 +40,6 @@ class PreferencesApi(object):
         "model",
         "make",
         "year",
-        "type",
-        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -119,8 +117,6 @@ 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:
@@ -258,8 +254,6 @@ 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:
@@ -387,8 +381,6 @@ 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:
@@ -516,8 +508,6 @@ 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,8 +40,6 @@ class ProjectsApi(object):
         "model",
         "make",
         "year",
-        "type",
-        "country",
     ]
 
     def __init__(self, api_client=None):
@@ -115,8 +113,6 @@ 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:
@@ -187,6 +183,8 @@ def retrieve_projects(self, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param int page:
+        :param str country:
+        :param str type:
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -212,6 +210,8 @@ def retrieve_projects_with_http_info(self, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param int page:
+        :param str country:
+        :param str type:
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -228,7 +228,7 @@ def retrieve_projects_with_http_info(self, **kwargs):  # noqa: E501
 
         local_var_params = locals()
 
-        all_params = ["page"]  # noqa: E501
+        all_params = ["page", "country", "type"]  # noqa: E501
         all_params.append("async_req")
         all_params.append("_return_http_data_only")
         all_params.append("_preload_content")
@@ -244,8 +244,6 @@ 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:
@@ -265,6 +263,10 @@ def retrieve_projects_with_http_info(self, **kwargs):  # noqa: E501
             query_params.append([key, kwargs.get(key)])
         if "page" in local_var_params:
             query_params.append(("page", local_var_params["page"]))  # noqa: E501
+        if "country" in local_var_params:
+            query_params.append(("country", local_var_params["country"]))  # noqa: E501
+        if "type" in local_var_params:
+            query_params.append(("type", local_var_params["type"]))  # noqa: E501
 
         header_params = {}