Add patch.estimates methods for GLEC-certified shipping estimates (#63)

* Add patch.estimates methods for GLEC-certified shipping estimates

* Fix lint

* Update changelog for python syntax

* Lowercase constant values, update air param variable names

* Remove distance_m

* Not sure why freight_mass_g wasn't included

Author: holtbp

CHANGELOG.md

@@ -5,6 +5,15 @@ 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.24.0] - 2022-07-22
+
+### Added
+
+- Adds `patch.estimates.create_air_shipping_estimate` method
+- Adds `patch.estimates.create_rail_shipping_estimate` method
+- Adds `patch.estimates.create_road_shipping_estimate` method
+- Adds `patch.estimates.create_sea_shipping_estimate` method
+
 ## [1.23.0] - 2022-06-03
 
 ### Added

patch_api/__init__.py

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

patch_api/api/estimates_api.py

@@ -46,8 +46,8 @@ class OrdersApi(object):
         "average_daily_balance_btc_sats",
         "average_daily_balance_eth_gwei",
         "timestamp",
-        "origin_aiport",
-        "destination_aiport",
+        "origin_airport",
+        "destination_airport",
         "aircraft_code",
         "cabin_class",
         "passenger_count",

patch_api/api/orders_api.py

@@ -46,8 +46,8 @@ class ProjectsApi(object):
         "average_daily_balance_btc_sats",
         "average_daily_balance_eth_gwei",
         "timestamp",
-        "origin_aiport",
-        "destination_aiport",
+        "origin_airport",
+        "destination_airport",
         "aircraft_code",
         "cabin_class",
         "passenger_count",

patch_api/api/projects_api.py

@@ -46,8 +46,8 @@ class TechnologyTypesApi(object):
         "average_daily_balance_btc_sats",
         "average_daily_balance_eth_gwei",
         "timestamp",
-        "origin_aiport",
-        "destination_aiport",
+        "origin_airport",
+        "destination_airport",
         "aircraft_code",
         "cabin_class",
         "passenger_count",

patch_api/api/technology_types_api.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.23.0"
+        self.user_agent = "patch-python/1.24.0"
 
     def __del__(self):
         if self._pool:

patch_api/api_client.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.23.0".format(
+            "SDK Package Version: 1.24.0".format(
                 env=sys.platform, pyversion=sys.version
             )
         )

patch_api/configuration.py

@@ -16,6 +16,9 @@
 
 # import models into model package
 from patch_api.models.allocation import Allocation
+from patch_api.models.create_air_shipping_estimate_request import (
+    CreateAirShippingEstimateRequest,
+)
 from patch_api.models.create_bitcoin_estimate_request import (
     CreateBitcoinEstimateRequest,
 )
@@ -26,6 +29,15 @@
 from patch_api.models.create_hotel_estimate_request import CreateHotelEstimateRequest
 from patch_api.models.create_mass_estimate_request import CreateMassEstimateRequest
 from patch_api.models.create_order_request import CreateOrderRequest
+from patch_api.models.create_rail_shipping_estimate_request import (
+    CreateRailShippingEstimateRequest,
+)
+from patch_api.models.create_road_shipping_estimate_request import (
+    CreateRoadShippingEstimateRequest,
+)
+from patch_api.models.create_sea_shipping_estimate_request import (
+    CreateSeaShippingEstimateRequest,
+)
 from patch_api.models.create_shipping_estimate_request import (
     CreateShippingEstimateRequest,
 )

patch_api/models/__init__.py

@@ -0,0 +1,345 @@
+# coding: utf-8
+
+"""
+    Patch API V1
+
+    The core API used to integrate with Patch's service  # noqa: E501
+
+    The version of the OpenAPI document: v1
+    Contact: engineering@usepatch.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from patch_api.configuration import Configuration
+
+
+class CreateAirShippingEstimateRequest(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        "destination_airport": "str",
+        "origin_airport": "str",
+        "aircraft_code": "str",
+        "aircraft_type": "str",
+        "freight_mass_g": "int",
+        "emissions_scope": "str",
+        "project_id": "str",
+        "create_order": "bool",
+    }
+
+    attribute_map = {
+        "destination_airport": "destination_airport",
+        "origin_airport": "origin_airport",
+        "aircraft_code": "aircraft_code",
+        "aircraft_type": "aircraft_type",
+        "freight_mass_g": "freight_mass_g",
+        "emissions_scope": "emissions_scope",
+        "project_id": "project_id",
+        "create_order": "create_order",
+    }
+
+    def __init__(
+        self,
+        destination_airport=None,
+        origin_airport=None,
+        aircraft_code=None,
+        aircraft_type="unknown",
+        freight_mass_g=None,
+        emissions_scope="wtw",
+        project_id=None,
+        create_order=False,
+        local_vars_configuration=None,
+    ):  # noqa: E501
+        """CreateAirShippingEstimateRequest - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._destination_airport = None
+        self._origin_airport = None
+        self._aircraft_code = None
+        self._aircraft_type = None
+        self._freight_mass_g = None
+        self._emissions_scope = None
+        self._project_id = None
+        self._create_order = None
+        self.discriminator = None
+
+        self.destination_airport = destination_airport
+        self.origin_airport = origin_airport
+        self.aircraft_code = aircraft_code
+        self.aircraft_type = aircraft_type
+        if freight_mass_g is not None:
+            self.freight_mass_g = freight_mass_g
+        self.emissions_scope = emissions_scope
+        self.project_id = project_id
+        self.create_order = create_order
+
+    @property
+    def destination_airport(self):
+        """Gets the destination_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The destination_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._destination_airport
+
+    @destination_airport.setter
+    def destination_airport(self, destination_airport):
+        """Sets the destination_airport of this CreateAirShippingEstimateRequest.
+
+
+        :param destination_airport: The destination_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+
+        self._destination_airport = destination_airport
+
+    @property
+    def origin_airport(self):
+        """Gets the origin_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The origin_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._origin_airport
+
+    @origin_airport.setter
+    def origin_airport(self, origin_airport):
+        """Sets the origin_airport of this CreateAirShippingEstimateRequest.
+
+
+        :param origin_airport: The origin_airport of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+
+        self._origin_airport = origin_airport
+
+    @property
+    def aircraft_code(self):
+        """Gets the aircraft_code of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The aircraft_code of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._aircraft_code
+
+    @aircraft_code.setter
+    def aircraft_code(self, aircraft_code):
+        """Sets the aircraft_code of this CreateAirShippingEstimateRequest.
+
+
+        :param aircraft_code: The aircraft_code of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+
+        self._aircraft_code = aircraft_code
+
+    @property
+    def aircraft_type(self):
+        """Gets the aircraft_type of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The aircraft_type of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._aircraft_type
+
+    @aircraft_type.setter
+    def aircraft_type(self, aircraft_type):
+        """Sets the aircraft_type of this CreateAirShippingEstimateRequest.
+
+
+        :param aircraft_type: The aircraft_type of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+        allowed_values = [None, "passenger", "cargo", "unknown"]  # noqa: E501
+        if (
+            self.local_vars_configuration.client_side_validation
+            and aircraft_type not in allowed_values
+        ):  # noqa: E501
+            raise ValueError(
+                "Invalid value for `aircraft_type` ({0}), must be one of {1}".format(  # noqa: E501
+                    aircraft_type, allowed_values
+                )
+            )
+
+        self._aircraft_type = aircraft_type
+
+    @property
+    def freight_mass_g(self):
+        """Gets the freight_mass_g of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The freight_mass_g of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: int
+        """
+        return self._freight_mass_g
+
+    @freight_mass_g.setter
+    def freight_mass_g(self, freight_mass_g):
+        """Sets the freight_mass_g of this CreateAirShippingEstimateRequest.
+
+
+        :param freight_mass_g: The freight_mass_g of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: int
+        """
+        if (
+            self.local_vars_configuration.client_side_validation
+            and freight_mass_g is not None
+            and freight_mass_g > 2000000000
+        ):  # noqa: E501
+            raise ValueError(
+                "Invalid value for `freight_mass_g`, must be a value less than or equal to `2000000000`"
+            )  # noqa: E501
+        if (
+            self.local_vars_configuration.client_side_validation
+            and freight_mass_g is not None
+            and freight_mass_g < 0
+        ):  # noqa: E501
+            raise ValueError(
+                "Invalid value for `freight_mass_g`, must be a value greater than or equal to `0`"
+            )  # noqa: E501
+
+        self._freight_mass_g = freight_mass_g
+
+    @property
+    def emissions_scope(self):
+        """Gets the emissions_scope of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The emissions_scope of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._emissions_scope
+
+    @emissions_scope.setter
+    def emissions_scope(self, emissions_scope):
+        """Sets the emissions_scope of this CreateAirShippingEstimateRequest.
+
+
+        :param emissions_scope: The emissions_scope of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+        allowed_values = [None, "wtt", "ttw", "wtw"]  # noqa: E501
+        if (
+            self.local_vars_configuration.client_side_validation
+            and emissions_scope not in allowed_values
+        ):  # noqa: E501
+            raise ValueError(
+                "Invalid value for `emissions_scope` ({0}), must be one of {1}".format(  # noqa: E501
+                    emissions_scope, allowed_values
+                )
+            )
+
+        self._emissions_scope = emissions_scope
+
+    @property
+    def project_id(self):
+        """Gets the project_id of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The project_id of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._project_id
+
+    @project_id.setter
+    def project_id(self, project_id):
+        """Sets the project_id of this CreateAirShippingEstimateRequest.
+
+
+        :param project_id: The project_id of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: str
+        """
+
+        self._project_id = project_id
+
+    @property
+    def create_order(self):
+        """Gets the create_order of this CreateAirShippingEstimateRequest.  # noqa: E501
+
+
+        :return: The create_order of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :rtype: bool
+        """
+        return self._create_order
+
+    @create_order.setter
+    def create_order(self, create_order):
+        """Sets the create_order of this CreateAirShippingEstimateRequest.
+
+
+        :param create_order: The create_order of this CreateAirShippingEstimateRequest.  # noqa: E501
+        :type: bool
+        """
+
+        self._create_order = create_order
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(
+                    map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)
+                )
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(
+                    map(
+                        lambda item: (item[0], item[1].to_dict())
+                        if hasattr(item[1], "to_dict")
+                        else item,
+                        value.items(),
+                    )
+                )
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, CreateAirShippingEstimateRequest):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, CreateAirShippingEstimateRequest):
+            return True
+
+        return self.to_dict() != other.to_dict()

patch_api/models/create_air_shipping_estimate_request.py

@@ -232,7 +232,7 @@ def state(self, state):
         :param state: The state of this CreateOrderRequest.  # noqa: E501
         :type: str
         """
-        allowed_values = [None, "draft", "placed"]  # noqa: E501
+        allowed_values = [None, "draft", "reserved", "placed"]  # noqa: E501
         if (
             self.local_vars_configuration.client_side_validation
             and state not in allowed_values

patch_api/models/create_order_request.py

@@ -298,6 +298,7 @@ def state(self, state):
             )  # noqa: E501
         allowed_values = [
             "draft",
+            "reserved",
             "placed",
             "processing",
             "complete",

patch_api/models/create_rail_shipping_estimate_request.py

@@ -301,7 +301,7 @@ def type(self, type):
     def mechanism(self):
         """Gets the mechanism of this Project.  # noqa: E501
 
-        The mechanism of the project. Either removal or avoidance.  # noqa: E501
+        The mechanism of the project. One of: removal, avoidance, avoidance_and_removal.  # noqa: E501
 
         :return: The mechanism of this Project.  # noqa: E501
         :rtype: str
@@ -312,7 +312,7 @@ def mechanism(self):
     def mechanism(self, mechanism):
         """Sets the mechanism of this Project.
 
-        The mechanism of the project. Either removal or avoidance.  # noqa: E501
+        The mechanism of the project. One of: removal, avoidance, avoidance_and_removal.  # noqa: E501
 
         :param mechanism: The mechanism of this Project.  # noqa: E501
         :type: str

patch_api/models/create_road_shipping_estimate_request.py

@@ -3,4 +3,4 @@ six >= 1.10
 python_dateutil >= 2.5.3
 setuptools >= 21.0.0
 urllib3 >= 1.15.1
-pre-commit >= 2.19.0
+pre-commit >= 2.10.0

patch_api/models/create_sea_shipping_estimate_request.py

@@ -12,7 +12,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "patch-api"
-VERSION = "1.23.0"
+VERSION = "1.24.0"
 # To install the library, run the following
 #
 # python setup.py install

patch_api/models/order.py

@@ -195,6 +195,184 @@ def test_create_hotel_estimate(self):
             estimate.data.mass_g, 15_000
         )  # not setting an exact value since this is changing daily
 
+    def test_create_air_shipping_estimate_airport_iatas(self):
+        """Test case for create_air_shipping_estimate
+
+        Create an estimate based on airport iata values  # noqa: E501
+        """
+        estimate = self.api.create_air_shipping_estimate(
+            destination_airport="JFK", freight_mass_g=19_158, origin_airport="ATL"
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_air")
+        self.assertGreater(
+            estimate.data.mass_g, 10_000
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_air_shipping_estimate_create_order(self):
+        """Test case for create_air_shipping_estimate
+
+        Create an estimate and an order  # noqa: E501
+        """
+        estimate = self.api.create_air_shipping_estimate(
+            create_order=True,
+            destination_airport="JFK",
+            freight_mass_g=18_092,
+            origin_airport="ATL",
+        )
+        self.assertGreater(estimate.data.order.amount, 2_000)
+        self.assertEqual(estimate.data.type, "shipping_air")
+        self.assertGreater(
+            estimate.data.mass_g, 10_000
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_rail_shipping_estimate_addresses(self):
+        """Test case for create_rail_shipping_estimate
+
+        Create an estimate based on locode values  # noqa: E501
+        """
+        estimate = self.api.create_rail_shipping_estimate(
+            destination_country_code="US",
+            destination_postal_code="90210",
+            freight_mass_g=18092,
+            origin_country_code="US",
+            origin_postal_code="97209",
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_rail")
+        self.assertGreater(
+            estimate.data.mass_g, 300
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_rail_shipping_estimate_locodes(self):
+        """Test case for create_rail_shipping_estimate
+
+        Create an estimate based on locode values  # noqa: E501
+        """
+        estimate = self.api.create_rail_shipping_estimate(
+            destination_locode="USSD2", freight_mass_g=18092, origin_locode="USSEA"
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_rail")
+        self.assertGreater(
+            estimate.data.mass_g, 800
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_rail_shipping_estimate_create_order(self):
+        """Test case for create_rail_shipping_estimate
+
+        Create an estimate and an order  # noqa: E501
+        """
+        estimate = self.api.create_rail_shipping_estimate(
+            create_order=True,
+            destination_locode="USSD2",
+            freight_mass_g=19_217,
+            origin_locode="USSEA",
+        )
+        self.assertGreater(estimate.data.order.amount, 900)
+        self.assertEqual(estimate.data.type, "shipping_rail")
+        self.assertGreater(
+            estimate.data.mass_g, 800
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_road_shipping_estimate_addresses(self):
+        """Test case for create_road_shipping_estimate
+
+        Create an estimate based on locode values  # noqa: E501
+        """
+        estimate = self.api.create_road_shipping_estimate(
+            destination_country_code="US",
+            destination_postal_code="90210",
+            freight_mass_g=19_166,
+            origin_country_code="US",
+            origin_postal_code="97209",
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_road")
+        self.assertGreater(
+            estimate.data.mass_g, 600
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_road_shipping_estimate_locodes(self):
+        """Test case for create_road_shipping_estimate
+
+        Create an estimate based on locode values  # noqa: E501
+        """
+        estimate = self.api.create_road_shipping_estimate(
+            destination_locode="USSD2", freight_mass_g=16_907, origin_locode="USSEA"
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_road")
+        self.assertGreater(
+            estimate.data.mass_g, 1_000
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_road_shipping_estimate_create_order(self):
+        """Test case for create_road_shipping_estimate
+
+        Create an estimate and an order  # noqa: E501
+        """
+        estimate = self.api.create_road_shipping_estimate(
+            create_order=True,
+            destination_locode="USSD2",
+            freight_mass_g=21_933,
+            origin_locode="USSEA",
+        )
+        self.assertGreater(estimate.data.order.amount, 1_000)
+        self.assertEqual(estimate.data.type, "shipping_road")
+        self.assertGreater(
+            estimate.data.mass_g, 800
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_sea_shipping_estimate_addresses(self):
+        """Test case for create_sea_shipping_estimate
+
+        Create an estimate based on address values  # noqa: E501
+        """
+        estimate = self.api.create_sea_shipping_estimate(
+            destination_country_code="US",
+            destination_postal_code="90210",
+            freight_mass_g=26_906,
+            origin_country_code="US",
+            origin_postal_code="97209",
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_sea")
+        self.assertGreater(
+            estimate.data.mass_g, 600
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_sea_shipping_estimate_locodes(self):
+        """Test case for create_sea_shipping_estimate
+
+        Create an estimate based on locode values  # noqa: E501
+        """
+        estimate = self.api.create_sea_shipping_estimate(
+            destination_locode="USSD2", freight_mass_g=17_311, origin_locode="USSEA"
+        )
+        self.assertEqual(estimate.data.order, None)
+        self.assertEqual(estimate.data.type, "shipping_sea")
+        self.assertGreater(
+            estimate.data.mass_g, 1_000
+        )  # not setting an exact value since the mock values returned are randomized
+
+    def test_create_sea_shipping_estimate_create_order(self):
+        """Test case for create_sea_shipping_estimate
+
+        Create an estimate and an order  # noqa: E501
+        """
+        estimate = self.api.create_sea_shipping_estimate(
+            create_order=True,
+            destination_locode="USSD2",
+            freight_mass_g=22_210,
+            origin_locode="USSEA",
+        )
+        self.assertGreater(estimate.data.order.amount, 1_000)
+        self.assertEqual(estimate.data.type, "shipping_sea")
+        self.assertGreater(
+            estimate.data.mass_g, 800
+        )  # not setting an exact value since the mock values returned are randomized
+
 
 if __name__ == "__main__":
     unittest.main()