stadiamaps 1.0.6__py3-none-any.whl → 2.0.0__py3-none-any.whl

stadiamaps/models/route_maneuver.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.5
+    The version of the OpenAPI document: 6.0.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,87 +18,104 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Any, Dict, List, Optional, Union
-from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr, conlist, validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from stadiamaps.models.maneuver_sign import ManeuverSign
 from stadiamaps.models.travel_mode import TravelMode
+from typing import Optional, Set
+from typing_extensions import Self
 
 class RouteManeuver(BaseModel):
     """
     RouteManeuver
-    """
-    type: StrictInt = Field(..., description="The type of route maneuver.  | Code | Type                                | |------|-------------------------------------| | 0    | None                                | | 1    | Start                               | | 2    | Start right                         | | 3    | Start left                          | | 4    | Destination                         | | 5    | Destination right                   | | 6    | Destination left                    | | 7    | Becomes                             | | 8    | Continue                            | | 9    | Slight right                        | | 10   | Right                               | | 11   | Sharp right                         | | 12   | U-turn right                        | | 13   | U-turn left                         | | 14   | Sharp left                          | | 15   | Left                                | | 16   | Slight left                         | | 17   | Ramp straight                       | | 18   | Ramp right                          | | 19   | Ramp left                           | | 20   | Exit right                          | | 21   | Exit left                           | | 22   | Stay straight                       | | 23   | Stay right                          | | 24   | Stay left                           | | 25   | Merge                               | | 26   | Enter roundabout                    | | 27   | Exit roundabout                     | | 28   | Enter ferry                         | | 29   | Exit ferry                          | | 30   | Transit                             | | 31   | Transit transfer                    | | 32   | Transit remain on                   | | 33   | Transit connection start            | | 34   | Transit connection transfer         | | 35   | Transit connection destination      | | 36   | Post-transit connection destination | | 37   | Merge right                         | | 38   | Merge left                          | ")
-    instruction: StrictStr = Field(..., description="The written maneuver instruction.")
-    verbal_transition_alert_instruction: Optional[StrictStr] = Field(None, description="Text suitable for use as a verbal navigation alert.")
-    verbal_pre_transition_instruction: Optional[StrictStr] = Field(None, description="Text suitable for use as a verbal navigation alert immediately prior to the maneuver transition.")
-    verbal_post_transition_instruction: Optional[StrictStr] = Field(None, description="Text suitable for use as a verbal navigation alert immediately after to the maneuver transition.")
-    street_names: Optional[conlist(StrictStr)] = Field(None, description="A list of street names that are consistent along the entire maneuver.")
-    begin_street_names: Optional[conlist(StrictStr)] = Field(None, description="A list of street names at the beginning of the maneuver, if they are different from the names at the end.")
-    time: Union[StrictFloat, StrictInt] = Field(..., description="The estimated time to complete the entire maneuver, in seconds.")
-    length: Union[StrictFloat, StrictInt] = Field(..., description="The length of the maneuver, in `units`.")
-    begin_shape_index: StrictInt = Field(..., description="The index into the list of shape points for the start of the maneuver.")
-    end_shape_index: StrictInt = Field(..., description="The index into the list of shape points for the end of the maneuver.")
-    toll: Optional[StrictBool] = Field(False, description="True any portion of the maneuver is subject to a toll.")
-    rough: Optional[StrictBool] = Field(False, description="True any portion of the maneuver is unpaved or has portions of rough pavement.")
-    gate: Optional[StrictBool] = Field(False, description="True if a gate is encountered in the course of this maneuver.")
-    ferry: Optional[StrictBool] = Field(False, description="True if a ferry is encountered in the course of this maneuver.")
+    """ # noqa: E501
+    type: StrictInt = Field(description="The type of route maneuver.  | Code | Type                                | |------|-------------------------------------| | 0    | None                                | | 1    | Start                               | | 2    | Start right                         | | 3    | Start left                          | | 4    | Destination                         | | 5    | Destination right                   | | 6    | Destination left                    | | 7    | Becomes                             | | 8    | Continue                            | | 9    | Slight right                        | | 10   | Right                               | | 11   | Sharp right                         | | 12   | U-turn right                        | | 13   | U-turn left                         | | 14   | Sharp left                          | | 15   | Left                                | | 16   | Slight left                         | | 17   | Ramp straight                       | | 18   | Ramp right                          | | 19   | Ramp left                           | | 20   | Exit right                          | | 21   | Exit left                           | | 22   | Stay straight                       | | 23   | Stay right                          | | 24   | Stay left                           | | 25   | Merge                               | | 26   | Enter roundabout                    | | 27   | Exit roundabout                     | | 28   | Enter ferry                         | | 29   | Exit ferry                          | | 30   | Transit                             | | 31   | Transit transfer                    | | 32   | Transit remain on                   | | 33   | Transit connection start            | | 34   | Transit connection transfer         | | 35   | Transit connection destination      | | 36   | Post-transit connection destination | | 37   | Merge right                         | | 38   | Merge left                          | ")
+    instruction: StrictStr = Field(description="The written maneuver instruction.")
+    verbal_transition_alert_instruction: Optional[StrictStr] = Field(default=None, description="Text suitable for use as a verbal navigation alert.")
+    verbal_pre_transition_instruction: Optional[StrictStr] = Field(default=None, description="Text suitable for use as a verbal navigation alert immediately prior to the maneuver transition.")
+    verbal_post_transition_instruction: Optional[StrictStr] = Field(default=None, description="Text suitable for use as a verbal navigation alert immediately after to the maneuver transition.")
+    street_names: Optional[List[StrictStr]] = Field(default=None, description="A list of street names that are consistent along the entire maneuver.")
+    begin_street_names: Optional[List[StrictStr]] = Field(default=None, description="A list of street names at the beginning of the maneuver, if they are different from the names at the end.")
+    time: Union[StrictFloat, StrictInt] = Field(description="The estimated time to complete the entire maneuver, in seconds.")
+    length: Union[StrictFloat, StrictInt] = Field(description="The length of the maneuver, in `units`.")
+    begin_shape_index: StrictInt = Field(description="The index into the list of shape points for the start of the maneuver.")
+    end_shape_index: StrictInt = Field(description="The index into the list of shape points for the end of the maneuver.")
+    toll: Optional[StrictBool] = Field(default=False, description="True any portion of the maneuver is subject to a toll.")
+    rough: Optional[StrictBool] = Field(default=False, description="True any portion of the maneuver is unpaved or has portions of rough pavement.")
+    gate: Optional[StrictBool] = Field(default=False, description="True if a gate is encountered in the course of this maneuver.")
+    ferry: Optional[StrictBool] = Field(default=False, description="True if a ferry is encountered in the course of this maneuver.")
     sign: Optional[ManeuverSign] = None
-    roundabout_exit_count: Optional[StrictInt] = Field(None, description="The exit number of the roundabout to take after entering.")
-    depart_instruction: Optional[StrictInt] = Field(None, description="The written departure time instruction (typically used in a transit maneuver).")
-    verbal_depart_instruction: Optional[StrictInt] = Field(None, description="Text suitable for use as a verbal departure time instruction (typically used in a transit maneuver).")
-    arrive_instruction: Optional[StrictInt] = Field(None, description="The written arrival time instruction (typically used in a transit maneuver).")
-    verbal_arrive_instruction: Optional[StrictInt] = Field(None, description="Text suitable for use as a verbal departure time instruction (typically used in a transit maneuver).")
-    transit_info: Optional[Dict[str, Any]] = Field(None, description="Public transit info (not currently supported).")
-    verbal_multi_cue: Optional[StrictBool] = Field(False, description="True if the `verbal_pre_transition_instruction` has been appended with the verbal instruction of the next maneuver.")
-    travel_mode: TravelMode = Field(...)
-    travel_type: StrictStr = Field(...)
-    bss_maneuver_type: Optional[StrictStr] = Field(None, description="Describes a bike share action when using bikeshare routing.")
+    roundabout_exit_count: Optional[StrictInt] = Field(default=None, description="The exit number of the roundabout to take after entering.")
+    depart_instruction: Optional[StrictInt] = Field(default=None, description="The written departure time instruction (typically used in a transit maneuver).")
+    verbal_depart_instruction: Optional[StrictInt] = Field(default=None, description="Text suitable for use as a verbal departure time instruction (typically used in a transit maneuver).")
+    arrive_instruction: Optional[StrictInt] = Field(default=None, description="The written arrival time instruction (typically used in a transit maneuver).")
+    verbal_arrive_instruction: Optional[StrictInt] = Field(default=None, description="Text suitable for use as a verbal departure time instruction (typically used in a transit maneuver).")
+    transit_info: Optional[Dict[str, Any]] = Field(default=None, description="Public transit info (not currently supported).")
+    verbal_multi_cue: Optional[StrictBool] = Field(default=False, description="True if the `verbal_pre_transition_instruction` has been appended with the verbal instruction of the next maneuver.")
+    travel_mode: TravelMode
+    travel_type: StrictStr = Field(description="The type of travel over the maneuver. This can be thought of as a specialization of the travel mode. For example, vehicular travel may be via car, motorcycle, etc.; and travel via bicycle may be via a road bike, mountain bike, etc.")
+    bss_maneuver_type: Optional[StrictStr] = Field(default=None, description="Describes a bike share action when using bikeshare routing.")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["type", "instruction", "verbal_transition_alert_instruction", "verbal_pre_transition_instruction", "verbal_post_transition_instruction", "street_names", "begin_street_names", "time", "length", "begin_shape_index", "end_shape_index", "toll", "rough", "gate", "ferry", "sign", "roundabout_exit_count", "depart_instruction", "verbal_depart_instruction", "arrive_instruction", "verbal_arrive_instruction", "transit_info", "verbal_multi_cue", "travel_mode", "travel_type", "bss_maneuver_type"]
+    __properties: ClassVar[List[str]] = ["type", "instruction", "verbal_transition_alert_instruction", "verbal_pre_transition_instruction", "verbal_post_transition_instruction", "street_names", "begin_street_names", "time", "length", "begin_shape_index", "end_shape_index", "toll", "rough", "gate", "ferry", "sign", "roundabout_exit_count", "depart_instruction", "verbal_depart_instruction", "arrive_instruction", "verbal_arrive_instruction", "transit_info", "verbal_multi_cue", "travel_mode", "travel_type", "bss_maneuver_type"]
 
-    @validator('travel_type')
+    @field_validator('travel_type')
     def travel_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('car', 'foot', 'road', 'tram', 'metro', 'rail', 'bus', 'ferry', 'cable_car', 'gondola', 'funicular'):
-            raise ValueError("must be one of enum values ('car', 'foot', 'road', 'tram', 'metro', 'rail', 'bus', 'ferry', 'cable_car', 'gondola', 'funicular')")
+        if value not in set(['car', 'motorcycle', 'bus', 'tractor_trailer', 'motor_scooter', 'foot', 'wheelchair', 'segway', 'road', 'cross', 'hybrid', 'mountain', 'tram', 'metro', 'rail', 'ferry', 'cable_car', 'gondola', 'funicular', 'golf_cart', 'low_speed_vehicle']):
+            raise ValueError("must be one of enum values ('car', 'motorcycle', 'bus', 'tractor_trailer', 'motor_scooter', 'foot', 'wheelchair', 'segway', 'road', 'cross', 'hybrid', 'mountain', 'tram', 'metro', 'rail', 'ferry', 'cable_car', 'gondola', 'funicular', 'golf_cart', 'low_speed_vehicle')")
         return value
 
-    @validator('bss_maneuver_type')
+    @field_validator('bss_maneuver_type')
     def bss_maneuver_type_validate_enum(cls, value):
         """Validates the enum"""
         if value is None:
             return value
 
-        if value not in ('NoneAction', 'RentBikeAtBikeShare', 'ReturnBikeAtBikeShare'):
+        if value not in set(['NoneAction', 'RentBikeAtBikeShare', 'ReturnBikeAtBikeShare']):
             raise ValueError("must be one of enum values ('NoneAction', 'RentBikeAtBikeShare', 'ReturnBikeAtBikeShare')")
         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) -> RouteManeuver:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of RouteManeuver 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 sign
         if self.sign:
             _dict['sign'] = self.sign.to_dict()
@@ -110,15 +127,15 @@ class RouteManeuver(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> RouteManeuver:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of RouteManeuver from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return RouteManeuver.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = RouteManeuver.parse_obj({
+        _obj = cls.model_validate({
             "type": obj.get("type"),
             "instruction": obj.get("instruction"),
             "verbal_transition_alert_instruction": obj.get("verbal_transition_alert_instruction"),
@@ -134,7 +151,7 @@ class RouteManeuver(BaseModel):
             "rough": obj.get("rough") if obj.get("rough") is not None else False,
             "gate": obj.get("gate") if obj.get("gate") is not None else False,
             "ferry": obj.get("ferry") if obj.get("ferry") is not None else False,
-            "sign": ManeuverSign.from_dict(obj.get("sign")) if obj.get("sign") is not None else None,
+            "sign": ManeuverSign.from_dict(obj["sign"]) if obj.get("sign") is not None else None,
             "roundabout_exit_count": obj.get("roundabout_exit_count"),
             "depart_instruction": obj.get("depart_instruction"),
             "verbal_depart_instruction": obj.get("verbal_depart_instruction"),
@@ -153,3 +170,4 @@ class RouteManeuver(BaseModel):
 
         return _obj
 
+

stadiamaps/models/route_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.5
+    The version of the OpenAPI document: 6.0.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,85 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import List, Optional, Union
-from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
 from stadiamaps.models.costing_model import CostingModel
 from stadiamaps.models.costing_options import CostingOptions
-from stadiamaps.models.directions_options import DirectionsOptions
+from stadiamaps.models.distance_unit import DistanceUnit
 from stadiamaps.models.routing_waypoint import RoutingWaypoint
+from stadiamaps.models.valhalla_languages import ValhallaLanguages
+from typing import Optional, Set
+from typing_extensions import Self
 
 class RouteRequest(BaseModel):
     """
     RouteRequest
-    """
-    id: Optional[StrictStr] = Field(None, description="An identifier to disambiguate requests (echoed by the server).")
-    locations: conlist(RoutingWaypoint, min_items=2) = Field(...)
-    costing: CostingModel = 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).")
+    locations: Annotated[List[RoutingWaypoint], Field(min_length=2)]
+    costing: CostingModel
     costing_options: Optional[CostingOptions] = None
-    avoid_locations: Optional[conlist(RoutingWaypoint)] = None
-    avoid_polygons: Optional[conlist(conlist(conlist(Union[StrictFloat, StrictInt])))] = Field(None, description="One or multiple exterior rings of polygons in the form of nested JSON arrays. Roads intersecting these rings will be avoided during path finding. Open rings will be closed automatically.")
-    directions_options: Optional[DirectionsOptions] = None
+    exclude_locations: Optional[List[RoutingWaypoint]] = Field(default=None, description="This has the same format as the locations list. Locations are mapped to the closed road(s), and these road(s) are excluded from the route path computation.")
+    exclude_polygons: Optional[List[List[List[Union[StrictFloat, StrictInt]]]]] = Field(default=None, description="One or multiple exterior rings of polygons in the form of nested JSON arrays. Roads intersecting these rings will be avoided during path finding. Open rings will be closed automatically. If you only need to avoid a few specific roads, it's much more efficient to use `exclude_locations`.")
+    alternates: Optional[StrictInt] = Field(default=None, description="How many alternate routes are desired. Note that fewer or no alternates may be returned. Alternates are not yet supported on routes with more than 2 locations or on time-dependent routes.")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["id", "locations", "costing", "costing_options", "avoid_locations", "avoid_polygons", "directions_options"]
+    __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "id", "locations", "costing", "costing_options", "exclude_locations", "exclude_polygons", "alternates"]
+
+    @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) -> RouteRequest:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of RouteRequest 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 locations (list)
         _items = []
         if self.locations:
@@ -75,16 +107,13 @@ class RouteRequest(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 each item in avoid_locations (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in exclude_locations (list)
         _items = []
-        if self.avoid_locations:
-            for _item in self.avoid_locations:
+        if self.exclude_locations:
+            for _item in self.exclude_locations:
                 if _item:
                     _items.append(_item.to_dict())
-            _dict['avoid_locations'] = _items
-        # 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()
+            _dict['exclude_locations'] = _items
         # 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 +122,25 @@ class RouteRequest(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> RouteRequest:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of RouteRequest from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return RouteRequest.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = RouteRequest.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"),
-            "locations": [RoutingWaypoint.from_dict(_item) for _item in obj.get("locations")] if obj.get("locations") is not None else None,
+            "locations": [RoutingWaypoint.from_dict(_item) for _item in obj["locations"]] if obj.get("locations") 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,
-            "avoid_locations": [RoutingWaypoint.from_dict(_item) for _item in obj.get("avoid_locations")] if obj.get("avoid_locations") is not None else None,
-            "avoid_polygons": obj.get("avoid_polygons"),
-            "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,
+            "exclude_locations": [RoutingWaypoint.from_dict(_item) for _item in obj["exclude_locations"]] if obj.get("exclude_locations") is not None else None,
+            "exclude_polygons": obj.get("exclude_polygons"),
+            "alternates": obj.get("alternates")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():
@@ -117,3 +149,4 @@ class RouteRequest(BaseModel):
 
         return _obj
 
+

stadiamaps/models/route_response.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.5
+    The version of the OpenAPI document: 6.0.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,48 +18,74 @@ import pprint
 import re  # noqa: F401
 import json
 
-
-from typing import Optional
-from pydantic import BaseModel, Field, StrictStr
-from stadiamaps.models.route_response_trip import RouteResponseTrip
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from stadiamaps.models.route_response_alternates_inner import RouteResponseAlternatesInner
+from stadiamaps.models.route_trip import RouteTrip
+from typing import Optional, Set
+from typing_extensions import Self
 
 class RouteResponse(BaseModel):
     """
     RouteResponse
-    """
-    id: Optional[StrictStr] = Field(None, description="An identifier to disambiguate requests (echoed by the server).")
-    trip: RouteResponseTrip = Field(...)
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="An identifier to disambiguate requests (echoed by the server).")
+    trip: RouteTrip
+    alternates: Optional[List[RouteResponseAlternatesInner]] = None
     additional_properties: Dict[str, Any] = {}
-    __properties = ["id", "trip"]
+    __properties: ClassVar[List[str]] = ["id", "trip", "alternates"]
+
+    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) -> RouteResponse:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of RouteResponse 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 trip
         if self.trip:
             _dict['trip'] = self.trip.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in alternates (list)
+        _items = []
+        if self.alternates:
+            for _item in self.alternates:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['alternates'] = _items
         # 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():
@@ -68,17 +94,18 @@ class RouteResponse(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> RouteResponse:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of RouteResponse from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return RouteResponse.parse_obj(obj)
+            return cls.model_validate(obj)
 
-        _obj = RouteResponse.parse_obj({
+        _obj = cls.model_validate({
             "id": obj.get("id"),
-            "trip": RouteResponseTrip.from_dict(obj.get("trip")) if obj.get("trip") is not None else None
+            "trip": RouteTrip.from_dict(obj["trip"]) if obj.get("trip") is not None else None,
+            "alternates": [RouteResponseAlternatesInner.from_dict(_item) for _item in obj["alternates"]] if obj.get("alternates") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():
@@ -87,3 +114,4 @@ class RouteResponse(BaseModel):
 
         return _obj
 
+