stadiamaps 1.0.7__py3-none-any.whl → 2.1.0__py3-none-any.whl

stadiamaps/models/matched_point.py

@@ -3,14 +3,14 @@
 """
     Stadia Maps Geospatial APIs
 
-    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.  # noqa: E501
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 5.0.6
+    The version of the OpenAPI document: 6.1.0
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""
+"""  # noqa: E501
 
 
 from __future__ import annotations
@@ -18,57 +18,74 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Optional, Union
-from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr, validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
 
 class MatchedPoint(BaseModel):
     """
     MatchedPoint
-    """
-    lat: Union[StrictFloat, StrictInt] = Field(..., description="The latitude of the matched point.")
-    lon: Union[StrictFloat, StrictInt] = Field(..., description="The longitude of the matched point.")
-    type: StrictStr = Field(...)
-    edge_index: Optional[StrictInt] = Field(None, description="The index of the edge in the list of `edges`. This key will be missing if the point is unmatched.")
-    begin_route_discontinuity: Optional[StrictBool] = Field(False, description="If true, this match result is the begin location of a route discontinuity.")
-    end_route_discontinuity: Optional[StrictBool] = Field(False, description="If true, this match result is the end location of a route discontinuity.")
-    distance_along_edge: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The distance along the associated edge for this matched point, expressed as a value between 0 and 1. For example, if the matched point is halfway along the edge, then the value will be 0.5. This key will be absent if the point is unmatched.")
-    distance_from_trace_point: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The distance in meters from the trace point to the matched point. This key will be absent if the point is unmatched.")
+    """ # noqa: E501
+    lat: Union[StrictFloat, StrictInt] = Field(description="The latitude of the matched point.")
+    lon: Union[StrictFloat, StrictInt] = Field(description="The longitude of the matched point.")
+    type: StrictStr
+    edge_index: Optional[StrictInt] = Field(default=None, description="The index of the edge in the list of `edges`. This key will be missing if the point is unmatched.")
+    begin_route_discontinuity: Optional[StrictBool] = Field(default=False, description="If true, this match result is the begin location of a route discontinuity.")
+    end_route_discontinuity: Optional[StrictBool] = Field(default=False, description="If true, this match result is the end location of a route discontinuity.")
+    distance_along_edge: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The distance along the associated edge for this matched point, expressed as a value between 0 and 1. For example, if the matched point is halfway along the edge, then the value will be 0.5. This key will be absent if the point is unmatched.")
+    distance_from_trace_point: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The distance in meters from the trace point to the matched point. This key will be absent if the point is unmatched.")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["lat", "lon", "type", "edge_index", "begin_route_discontinuity", "end_route_discontinuity", "distance_along_edge", "distance_from_trace_point"]
+    __properties: ClassVar[List[str]] = ["lat", "lon", "type", "edge_index", "begin_route_discontinuity", "end_route_discontinuity", "distance_along_edge", "distance_from_trace_point"]
 
-    @validator('type')
+    @field_validator('type')
     def type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('unmatched', 'interpolated', 'matched'):
+        if value not in set(['unmatched', 'interpolated', 'matched']):
             raise ValueError("must be one of enum values ('unmatched', 'interpolated', 'matched')")
         return value
 
-    class Config:
-        """Pydantic configuration"""
-        allow_population_by_field_name = True
-        validate_assignment = True
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
 
     def to_str(self) -> str:
         """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.dict(by_alias=True))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> MatchedPoint:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of MatchedPoint from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
-    def to_dict(self):
-        """Returns the dictionary representation of the model using alias"""
-        _dict = self.dict(by_alias=True,
-                          exclude={
-                            "additional_properties"
-                          },
-                          exclude_none=True)
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -77,15 +94,15 @@ class MatchedPoint(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> MatchedPoint:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of MatchedPoint from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return MatchedPoint.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = MatchedPoint.parse_obj({
+        _obj = cls.model_validate({
             "lat": obj.get("lat"),
             "lon": obj.get("lon"),
             "type": obj.get("type"),
@@ -102,3 +119,4 @@ class MatchedPoint(BaseModel):
 
         return _obj
 
+

stadiamaps/models/matrix_costing_model.py

@@ -3,23 +3,20 @@
 """
     Stadia Maps Geospatial APIs
 
-    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.  # noqa: E501
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 5.0.6
+    The version of the OpenAPI document: 6.1.0
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""
+"""  # noqa: E501
 
 
+from __future__ import annotations
 import json
-import pprint
-import re  # noqa: F401
-from aenum import Enum, no_arg
-
-
-
+from enum import Enum
+from typing_extensions import Self
 
 
 class MatrixCostingModel(str, Enum):
@@ -32,7 +29,6 @@ class MatrixCostingModel(str, Enum):
     """
     AUTO = 'auto'
     BUS = 'bus'
-    HOV = 'hov'
     TAXI = 'taxi'
     TRUCK = 'truck'
     BICYCLE = 'bicycle'
@@ -40,10 +36,11 @@ class MatrixCostingModel(str, Enum):
     MOTOR_SCOOTER = 'motor_scooter'
     MOTORCYCLE = 'motorcycle'
     PEDESTRIAN = 'pedestrian'
+    LOW_SPEED_VEHICLE = 'low_speed_vehicle'
 
     @classmethod
-    def from_json(cls, json_str: str) -> MatrixCostingModel:
+    def from_json(cls, json_str: str) -> Self:
         """Create an instance of MatrixCostingModel from a JSON string"""
-        return MatrixCostingModel(json.loads(json_str))
+        return cls(json.loads(json_str))
 
 

stadiamaps/models/matrix_distance.py

@@ -3,14 +3,14 @@
 """
     Stadia Maps Geospatial APIs
 
-    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.  # noqa: E501
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 5.0.6
+    The version of the OpenAPI document: 6.1.0
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""
+"""  # noqa: E501
 
 
 from __future__ import annotations
@@ -18,46 +18,63 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Union
-from pydantic import BaseModel, Field, StrictFloat, StrictInt
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
 
 class MatrixDistance(BaseModel):
     """
     MatrixDistance
-    """
-    distance: Union[StrictFloat, StrictInt] = Field(..., description="The distance (in `units`) between the location in `sources` at `from_index` and the location in `targets` at `to_index`.")
-    time: StrictInt = Field(..., description="The travel time (in seconds) between the location in `sources` at `from_index` and the location in `targets` at `to_index`.")
-    from_index: StrictInt = Field(..., description="The index of the start location in the `sources` array.")
-    to_index: StrictInt = Field(..., description="The index of the end location in the `targets` array.")
+    """ # noqa: E501
+    distance: Union[StrictFloat, StrictInt] = Field(description="The distance (in `units`) between the location in `sources` at `from_index` and the location in `targets` at `to_index`.")
+    time: StrictInt = Field(description="The travel time (in seconds) between the location in `sources` at `from_index` and the location in `targets` at `to_index`.")
+    from_index: StrictInt = Field(description="The index of the start location in the `sources` array.")
+    to_index: StrictInt = Field(description="The index of the end location in the `targets` array.")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["distance", "time", "from_index", "to_index"]
+    __properties: ClassVar[List[str]] = ["distance", "time", "from_index", "to_index"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
-    class Config:
-        """Pydantic configuration"""
-        allow_population_by_field_name = True
-        validate_assignment = True
 
     def to_str(self) -> str:
         """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.dict(by_alias=True))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> MatrixDistance:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of MatrixDistance from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
-    def to_dict(self):
-        """Returns the dictionary representation of the model using alias"""
-        _dict = self.dict(by_alias=True,
-                          exclude={
-                            "additional_properties"
-                          },
-                          exclude_none=True)
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -66,15 +83,15 @@ class MatrixDistance(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> MatrixDistance:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of MatrixDistance from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return MatrixDistance.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = MatrixDistance.parse_obj({
+        _obj = cls.model_validate({
             "distance": obj.get("distance"),
             "time": obj.get("time"),
             "from_index": obj.get("from_index"),
@@ -87,3 +104,4 @@ class MatrixDistance(BaseModel):
 
         return _obj
 
+

stadiamaps/models/matrix_request.py

@@ -3,14 +3,14 @@
 """
     Stadia Maps Geospatial APIs
 
-    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.  # noqa: E501
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 5.0.6
+    The version of the OpenAPI document: 6.1.0
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
-"""
+"""  # noqa: E501
 
 
 from __future__ import annotations
@@ -18,53 +18,84 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import List, Optional
-from pydantic import BaseModel, Field, StrictInt, StrictStr, conlist
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from stadiamaps.models.coordinate import Coordinate
 from stadiamaps.models.costing_options import CostingOptions
-from stadiamaps.models.directions_options import DirectionsOptions
+from stadiamaps.models.distance_unit import DistanceUnit
 from stadiamaps.models.matrix_costing_model import MatrixCostingModel
+from stadiamaps.models.valhalla_languages import ValhallaLanguages
+from typing import Optional, Set
+from typing_extensions import Self
 
 class MatrixRequest(BaseModel):
     """
     MatrixRequest
-    """
-    id: Optional[StrictStr] = Field(None, description="An identifier to disambiguate requests (echoed by the server).")
-    sources: conlist(Coordinate, min_items=1) = Field(..., description="The list of starting locations")
-    targets: conlist(Coordinate, min_items=1) = Field(..., description="The list of ending locations")
-    costing: MatrixCostingModel = Field(...)
+    """ # noqa: E501
+    units: Optional[DistanceUnit] = None
+    language: Optional[ValhallaLanguages] = None
+    directions_type: Optional[StrictStr] = Field(default='instructions', description="The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.")
+    id: Optional[StrictStr] = Field(default=None, description="An identifier to disambiguate requests (echoed by the server).")
+    sources: Annotated[List[Coordinate], Field(min_length=1)] = Field(description="The list of starting locations")
+    targets: Annotated[List[Coordinate], Field(min_length=1)] = Field(description="The list of ending locations")
+    costing: MatrixCostingModel
     costing_options: Optional[CostingOptions] = None
-    matrix_locations: Optional[StrictInt] = Field(None, description="Only applicable to one-to-many or many-to-one requests. This defaults to all locations. When specified explicitly, this option allows a partial result to be returned. This is basically equivalent to \"find the closest/best locations out of the full set.\" This can have a dramatic improvement for large requests.")
-    directions_options: Optional[DirectionsOptions] = None
+    matrix_locations: Optional[StrictInt] = Field(default=None, description="Only applicable to one-to-many or many-to-one requests. This defaults to all locations. When specified explicitly, this option allows a partial result to be returned. This is basically equivalent to \"find the closest/best locations out of the full set.\" This can have a dramatic improvement for large requests.")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["id", "sources", "targets", "costing", "costing_options", "matrix_locations", "directions_options"]
+    __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "id", "sources", "targets", "costing", "costing_options", "matrix_locations"]
+
+    @field_validator('directions_type')
+    def directions_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'maneuvers', 'instructions']):
+            raise ValueError("must be one of enum values ('none', 'maneuvers', 'instructions')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
-    class Config:
-        """Pydantic configuration"""
-        allow_population_by_field_name = True
-        validate_assignment = True
 
     def to_str(self) -> str:
         """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.dict(by_alias=True))
+        return pprint.pformat(self.model_dump(by_alias=True))
 
     def to_json(self) -> str:
         """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> MatrixRequest:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of MatrixRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
-    def to_dict(self):
-        """Returns the dictionary representation of the model using alias"""
-        _dict = self.dict(by_alias=True,
-                          exclude={
-                            "additional_properties"
-                          },
-                          exclude_none=True)
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
         # override the default output from pydantic by calling `to_dict()` of each item in sources (list)
         _items = []
         if self.sources:
@@ -82,9 +113,6 @@ class MatrixRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of costing_options
         if self.costing_options:
             _dict['costing_options'] = self.costing_options.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of directions_options
-        if self.directions_options:
-            _dict['directions_options'] = self.directions_options.to_dict()
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -93,22 +121,24 @@ class MatrixRequest(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> MatrixRequest:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of MatrixRequest from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return MatrixRequest.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = MatrixRequest.parse_obj({
+        _obj = cls.model_validate({
+            "units": obj.get("units"),
+            "language": obj.get("language"),
+            "directions_type": obj.get("directions_type") if obj.get("directions_type") is not None else 'instructions',
             "id": obj.get("id"),
-            "sources": [Coordinate.from_dict(_item) for _item in obj.get("sources")] if obj.get("sources") is not None else None,
-            "targets": [Coordinate.from_dict(_item) for _item in obj.get("targets")] if obj.get("targets") is not None else None,
+            "sources": [Coordinate.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "targets": [Coordinate.from_dict(_item) for _item in obj["targets"]] if obj.get("targets") is not None else None,
             "costing": obj.get("costing"),
-            "costing_options": CostingOptions.from_dict(obj.get("costing_options")) if obj.get("costing_options") is not None else None,
-            "matrix_locations": obj.get("matrix_locations"),
-            "directions_options": DirectionsOptions.from_dict(obj.get("directions_options")) if obj.get("directions_options") is not None else None
+            "costing_options": CostingOptions.from_dict(obj["costing_options"]) if obj.get("costing_options") is not None else None,
+            "matrix_locations": obj.get("matrix_locations")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():
@@ -117,3 +147,4 @@ class MatrixRequest(BaseModel):
 
         return _obj
 
+