diff --git a/CHANGELOG.md b/CHANGELOG.md index 46dfff2..4153e06 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ 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.13.0] - 2021-09-10 + +### Added + +- Adds ability to create Bitcoin and Ethereum estimates using the daily balance held. + ## [1.12.0] - 2021-09-08 ### Added diff --git a/patch_api/__init__.py b/patch_api/__init__.py index 99d396d..e1b2831 100644 --- a/patch_api/__init__.py +++ b/patch_api/__init__.py @@ -15,7 +15,7 @@ from __future__ import absolute_import -__version__ = "1.12.0" +__version__ = "1.13.0" # import ApiClient from patch_api.api_client import ApiClient diff --git a/patch_api/api/estimates_api.py b/patch_api/api/estimates_api.py index 494c11d..8f42f75 100644 --- a/patch_api/api/estimates_api.py +++ b/patch_api/api/estimates_api.py @@ -41,8 +41,11 @@ class EstimatesApi(object): "make", "year", "transaction_value_btc_sats", - "timestamp", + "transaction_value_eth_gwei", "gas_used", + "average_daily_balance_btc_sats", + "average_daily_balance_eth_gwei", + "timestamp", "origin_aiport", "destination_aiport", "aircraft_code", @@ -128,8 +131,12 @@ def create_bitcoin_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -214,7 +221,7 @@ def create_bitcoin_estimate_with_http_info( def create_ethereum_estimate( self, create_ethereum_estimate_request={}, **kwargs ): # noqa: E501 - """Create an ethereum estimate given a timestamp and gas used # noqa: E501 + """Create an ethereum estimate # noqa: E501 Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -243,7 +250,7 @@ def create_ethereum_estimate( def create_ethereum_estimate_with_http_info( self, create_ethereum_estimate_request, **kwargs ): # noqa: E501 - """Create an ethereum estimate given a timestamp and gas used # noqa: E501 + """Create an ethereum estimate # noqa: E501 Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -286,8 +293,12 @@ def create_ethereum_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -444,8 +455,12 @@ def create_flight_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -602,8 +617,12 @@ def create_mass_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -760,8 +779,12 @@ def create_shipping_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -918,8 +941,12 @@ def create_vehicle_estimate_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -1070,8 +1097,12 @@ def retrieve_estimate_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -1212,8 +1243,12 @@ def retrieve_estimates_with_http_info(self, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") diff --git a/patch_api/api/orders_api.py b/patch_api/api/orders_api.py index 9986f6e..ee20417 100644 --- a/patch_api/api/orders_api.py +++ b/patch_api/api/orders_api.py @@ -41,8 +41,11 @@ class OrdersApi(object): "make", "year", "transaction_value_btc_sats", - "timestamp", + "transaction_value_eth_gwei", "gas_used", + "average_daily_balance_btc_sats", + "average_daily_balance_eth_gwei", + "timestamp", "origin_aiport", "destination_aiport", "aircraft_code", @@ -122,8 +125,12 @@ def cancel_order_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -266,8 +273,12 @@ def create_order_with_http_info(self, create_order_request, **kwargs): # noqa: all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -418,8 +429,12 @@ def place_order_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -560,8 +575,12 @@ def retrieve_order_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -713,8 +732,12 @@ def retrieve_orders_with_http_info(self, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") diff --git a/patch_api/api/preferences_api.py b/patch_api/api/preferences_api.py index 6c7d7d6..d6892a5 100644 --- a/patch_api/api/preferences_api.py +++ b/patch_api/api/preferences_api.py @@ -41,8 +41,11 @@ class PreferencesApi(object): "make", "year", "transaction_value_btc_sats", - "timestamp", + "transaction_value_eth_gwei", "gas_used", + "average_daily_balance_btc_sats", + "average_daily_balance_eth_gwei", + "timestamp", "origin_aiport", "destination_aiport", "aircraft_code", @@ -126,8 +129,12 @@ def create_preference_with_http_info( all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -278,8 +285,12 @@ def delete_preference_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -420,8 +431,12 @@ def retrieve_preference_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -562,8 +577,12 @@ def retrieve_preferences_with_http_info(self, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") diff --git a/patch_api/api/projects_api.py b/patch_api/api/projects_api.py index 4ba36c3..560e45a 100644 --- a/patch_api/api/projects_api.py +++ b/patch_api/api/projects_api.py @@ -41,8 +41,11 @@ class ProjectsApi(object): "make", "year", "transaction_value_btc_sats", - "timestamp", + "transaction_value_eth_gwei", "gas_used", + "average_daily_balance_btc_sats", + "average_daily_balance_eth_gwei", + "timestamp", "origin_aiport", "destination_aiport", "aircraft_code", @@ -122,8 +125,12 @@ def retrieve_project_with_http_info(self, id, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") @@ -270,8 +277,12 @@ def retrieve_projects_with_http_info(self, **kwargs): # noqa: E501 all_params.append("model") all_params.append("year") all_params.append("transaction_value_btc_sats") - all_params.append("timestamp") + all_params.append("transaction_value_eth_gwei") all_params.append("gas_used") + all_params.append("transaction_value_btc_sats") + all_params.append("average_daily_balance_btc_sats") + all_params.append("average_daily_balance_eth_gwei") + all_params.append("timestamp") all_params.append("origin_airport") all_params.append("destination_airport") all_params.append("aircraft_code") diff --git a/patch_api/api_client.py b/patch_api/api_client.py index ec0e433..5cdae55 100644 --- a/patch_api/api_client.py +++ b/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 = "patch-python/1.12.0" + self.user_agent = "patch-python/1.13.0" def __del__(self): if self._pool: diff --git a/patch_api/configuration.py b/patch_api/configuration.py index 66d2e8c..b1f950b 100644 --- a/patch_api/configuration.py +++ b/patch_api/configuration.py @@ -341,7 +341,7 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: v1\n" - "SDK Package Version: 1.12.0".format( + "SDK Package Version: 1.13.0".format( env=sys.platform, pyversion=sys.version ) ) diff --git a/patch_api/models/create_bitcoin_estimate_request.py b/patch_api/models/create_bitcoin_estimate_request.py index a4eb9d3..27e11c9 100644 --- a/patch_api/models/create_bitcoin_estimate_request.py +++ b/patch_api/models/create_bitcoin_estimate_request.py @@ -36,6 +36,7 @@ class CreateBitcoinEstimateRequest(object): openapi_types = { "timestamp": "datetime", "transaction_value_btc_sats": "int", + "average_daily_balance_btc_sats": "int", "project_id": "str", "create_order": "bool", } @@ -43,6 +44,7 @@ class CreateBitcoinEstimateRequest(object): attribute_map = { "timestamp": "timestamp", "transaction_value_btc_sats": "transaction_value_btc_sats", + "average_daily_balance_btc_sats": "average_daily_balance_btc_sats", "project_id": "project_id", "create_order": "create_order", } @@ -51,8 +53,9 @@ def __init__( self, timestamp=None, transaction_value_btc_sats=None, + average_daily_balance_btc_sats=None, project_id=None, - create_order=None, + create_order=False, local_vars_configuration=None, ): # noqa: E501 """CreateBitcoinEstimateRequest - a model defined in OpenAPI""" # noqa: E501 @@ -62,12 +65,14 @@ def __init__( self._timestamp = None self._transaction_value_btc_sats = None + self._average_daily_balance_btc_sats = None self._project_id = None self._create_order = None self.discriminator = None self.timestamp = timestamp self.transaction_value_btc_sats = transaction_value_btc_sats + self.average_daily_balance_btc_sats = average_daily_balance_btc_sats self.project_id = project_id self.create_order = create_order @@ -113,6 +118,27 @@ def transaction_value_btc_sats(self, transaction_value_btc_sats): self._transaction_value_btc_sats = transaction_value_btc_sats + @property + def average_daily_balance_btc_sats(self): + """Gets the average_daily_balance_btc_sats of this CreateBitcoinEstimateRequest. # noqa: E501 + + + :return: The average_daily_balance_btc_sats of this CreateBitcoinEstimateRequest. # noqa: E501 + :rtype: int + """ + return self._average_daily_balance_btc_sats + + @average_daily_balance_btc_sats.setter + def average_daily_balance_btc_sats(self, average_daily_balance_btc_sats): + """Sets the average_daily_balance_btc_sats of this CreateBitcoinEstimateRequest. + + + :param average_daily_balance_btc_sats: The average_daily_balance_btc_sats of this CreateBitcoinEstimateRequest. # noqa: E501 + :type: int + """ + + self._average_daily_balance_btc_sats = average_daily_balance_btc_sats + @property def project_id(self): """Gets the project_id of this CreateBitcoinEstimateRequest. # noqa: E501 diff --git a/patch_api/models/create_ethereum_estimate_request.py b/patch_api/models/create_ethereum_estimate_request.py index 0e9ee1f..6405cb8 100644 --- a/patch_api/models/create_ethereum_estimate_request.py +++ b/patch_api/models/create_ethereum_estimate_request.py @@ -37,6 +37,7 @@ class CreateEthereumEstimateRequest(object): "timestamp": "str", "gas_used": "int", "transaction_value_eth_gwei": "int", + "average_daily_balance_eth_gwei": "int", "project_id": "str", "create_order": "bool", } @@ -45,6 +46,7 @@ class CreateEthereumEstimateRequest(object): "timestamp": "timestamp", "gas_used": "gas_used", "transaction_value_eth_gwei": "transaction_value_eth_gwei", + "average_daily_balance_eth_gwei": "average_daily_balance_eth_gwei", "project_id": "project_id", "create_order": "create_order", } @@ -54,8 +56,9 @@ def __init__( timestamp=None, gas_used=None, transaction_value_eth_gwei=None, + average_daily_balance_eth_gwei=None, project_id=None, - create_order=None, + create_order=False, local_vars_configuration=None, ): # noqa: E501 """CreateEthereumEstimateRequest - a model defined in OpenAPI""" # noqa: E501 @@ -66,6 +69,7 @@ def __init__( self._timestamp = None self._gas_used = None self._transaction_value_eth_gwei = None + self._average_daily_balance_eth_gwei = None self._project_id = None self._create_order = None self.discriminator = None @@ -73,6 +77,7 @@ def __init__( self.timestamp = timestamp self.gas_used = gas_used self.transaction_value_eth_gwei = transaction_value_eth_gwei + self.average_daily_balance_eth_gwei = average_daily_balance_eth_gwei self.project_id = project_id self.create_order = create_order @@ -139,6 +144,27 @@ def transaction_value_eth_gwei(self, transaction_value_eth_gwei): self._transaction_value_eth_gwei = transaction_value_eth_gwei + @property + def average_daily_balance_eth_gwei(self): + """Gets the average_daily_balance_eth_gwei of this CreateEthereumEstimateRequest. # noqa: E501 + + + :return: The average_daily_balance_eth_gwei of this CreateEthereumEstimateRequest. # noqa: E501 + :rtype: int + """ + return self._average_daily_balance_eth_gwei + + @average_daily_balance_eth_gwei.setter + def average_daily_balance_eth_gwei(self, average_daily_balance_eth_gwei): + """Sets the average_daily_balance_eth_gwei of this CreateEthereumEstimateRequest. + + + :param average_daily_balance_eth_gwei: The average_daily_balance_eth_gwei of this CreateEthereumEstimateRequest. # noqa: E501 + :type: int + """ + + self._average_daily_balance_eth_gwei = average_daily_balance_eth_gwei + @property def project_id(self): """Gets the project_id of this CreateEthereumEstimateRequest. # noqa: E501 diff --git a/patch_api/models/create_flight_estimate_request.py b/patch_api/models/create_flight_estimate_request.py index 7208dbf..c1e051d 100644 --- a/patch_api/models/create_flight_estimate_request.py +++ b/patch_api/models/create_flight_estimate_request.py @@ -64,7 +64,7 @@ def __init__( cabin_class=None, passenger_count=None, project_id=None, - create_order=None, + create_order=False, local_vars_configuration=None, ): # noqa: E501 """CreateFlightEstimateRequest - a model defined in OpenAPI""" # noqa: E501 diff --git a/patch_api/models/create_mass_estimate_request.py b/patch_api/models/create_mass_estimate_request.py index 9a8eb44..34c1190 100644 --- a/patch_api/models/create_mass_estimate_request.py +++ b/patch_api/models/create_mass_estimate_request.py @@ -44,7 +44,7 @@ class CreateMassEstimateRequest(object): def __init__( self, mass_g=None, - create_order=None, + create_order=False, project_id=None, local_vars_configuration=None, ): # noqa: E501 diff --git a/patch_api/models/create_shipping_estimate_request.py b/patch_api/models/create_shipping_estimate_request.py index 72821ce..818e3b7 100644 --- a/patch_api/models/create_shipping_estimate_request.py +++ b/patch_api/models/create_shipping_estimate_request.py @@ -55,7 +55,7 @@ def __init__( package_mass_g=None, transportation_method=None, project_id=None, - create_order=None, + create_order=False, local_vars_configuration=None, ): # noqa: E501 """CreateShippingEstimateRequest - a model defined in OpenAPI""" # noqa: E501 diff --git a/patch_api/models/create_vehicle_estimate_request.py b/patch_api/models/create_vehicle_estimate_request.py index 9ef8162..baa2e5b 100644 --- a/patch_api/models/create_vehicle_estimate_request.py +++ b/patch_api/models/create_vehicle_estimate_request.py @@ -58,7 +58,7 @@ def __init__( model=None, year=None, project_id=None, - create_order=None, + create_order=False, local_vars_configuration=None, ): # noqa: E501 """CreateVehicleEstimateRequest - a model defined in OpenAPI""" # noqa: E501 diff --git a/setup.py b/setup.py index e7017b3..cf053d0 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "patch-api" -VERSION = "1.12.0" +VERSION = "1.13.0" # To install the library, run the following # # python setup.py install diff --git a/test/test_estimates_api.py b/test/test_estimates_api.py index c40e664..65d047b 100644 --- a/test/test_estimates_api.py +++ b/test/test_estimates_api.py @@ -157,6 +157,20 @@ def test_create_bitcoin_estimate_transaction_value(self): estimate.data.mass_g, 200 ) # not setting an exact value since this is changing daily + def test_create_bitcoin_estimate_transaction_value(self): + """Test case for create_bitcoin_estimate + + Create an estimate based on an average daily balance # noqa: E501 + """ + estimate1 = self.api.create_bitcoin_estimate( + average_daily_balance_btc_sats=100000 + ) + estimate2 = self.api.create_bitcoin_estimate( + average_daily_balance_btc_sats=1000000 + ) + self.assertEqual(estimate1.data.type, "bitcoin") + self.assertGreater(estimate2.data.mass_g, estimate1.data.mass_g) + def test_create_ethereum_estimate_transaction_value(self): """Test case for create_ethereum_estimate