stadiamaps 3.2.1__py3-none-any.whl → 5.0.0__py3-none-any.whl

stadiamaps/models/optimized_route_request.py

@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.3
+    The version of the OpenAPI document: 8.0.0
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,14 +18,15 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
+from stadiamaps.models.annotation_filters import AnnotationFilters
 from stadiamaps.models.coordinate import Coordinate
 from stadiamaps.models.costing_options import CostingOptions
 from stadiamaps.models.distance_unit import DistanceUnit
 from stadiamaps.models.matrix_costing_model import MatrixCostingModel
-from stadiamaps.models.valhalla_languages import ValhallaLanguages
+from stadiamaps.models.routing_languages import RoutingLanguages
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -34,14 +35,19 @@ class OptimizedRouteRequest(BaseModel):
     OptimizedRouteRequest
     """ # noqa: E501
     units: Optional[DistanceUnit] = DistanceUnit.KM
-    language: Optional[ValhallaLanguages] = ValhallaLanguages.EN_MINUS_US
+    language: Optional[RoutingLanguages] = RoutingLanguages.EN_MINUS_US
     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.")
+    format: Optional[StrictStr] = Field(default=None, description="The output response format. The default JSON format is extremely compact and ideal for web or data-constrained use cases where you want to fetch additional attributes on demand in small chunks. The OSRM format is much richer and is configurable with significantly more info for turn-by-turn navigation use cases.")
+    banner_instructions: Optional[StrictBool] = Field(default=None, description="Optionally includes helpful banners with timing information for turn-by-turn navigation. This is only available in the OSRM format.")
+    voice_instructions: Optional[StrictBool] = Field(default=None, description="Optionally includes voice instructions with timing information for turn-by-turn navigation. This is only available in the OSRM format.")
+    filters: Optional[AnnotationFilters] = None
     id: Optional[StrictStr] = Field(default=None, description="An identifier to disambiguate requests (echoed by the server).")
     locations: Annotated[List[Coordinate], Field(min_length=3)] = Field(description="The list of locations. The first and last are assumed to be the start and end points, and all intermediate points are locations that you want to visit along the way.")
     costing: MatrixCostingModel
     costing_options: Optional[CostingOptions] = None
+    elevation_interval: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, description="If greater than zero, attempts to include elevation along the route at regular intervals. The \"native\" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter. Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the routing endpoints and is not available via the elevation API. NOTE: This has no effect on the OSRM response format.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "id", "locations", "costing", "costing_options"]
+    __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "format", "banner_instructions", "voice_instructions", "filters", "id", "locations", "costing", "costing_options", "elevation_interval"]
 
     @field_validator('directions_type')
     def directions_type_validate_enum(cls, value):
@@ -53,6 +59,16 @@ class OptimizedRouteRequest(BaseModel):
             raise ValueError("must be one of enum values ('none', 'maneuvers', 'instructions')")
         return value
 
+    @field_validator('format')
+    def format_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['json', 'osrm']):
+            raise ValueError("must be one of enum values ('json', 'osrm')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -94,12 +110,15 @@ class OptimizedRouteRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of filters
+        if self.filters:
+            _dict['filters'] = self.filters.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in locations (list)
         _items = []
         if self.locations:
-            for _item in self.locations:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_locations in self.locations:
+                if _item_locations:
+                    _items.append(_item_locations.to_dict())
             _dict['locations'] = _items
         # override the default output from pydantic by calling `to_dict()` of costing_options
         if self.costing_options:
@@ -122,12 +141,17 @@ class OptimizedRouteRequest(BaseModel):
 
         _obj = cls.model_validate({
             "units": obj.get("units") if obj.get("units") is not None else DistanceUnit.KM,
-            "language": obj.get("language") if obj.get("language") is not None else ValhallaLanguages.EN_MINUS_US,
+            "language": obj.get("language") if obj.get("language") is not None else RoutingLanguages.EN_MINUS_US,
             "directions_type": obj.get("directions_type") if obj.get("directions_type") is not None else 'instructions',
+            "format": obj.get("format"),
+            "banner_instructions": obj.get("banner_instructions"),
+            "voice_instructions": obj.get("voice_instructions"),
+            "filters": AnnotationFilters.from_dict(obj["filters"]) if obj.get("filters") is not None else None,
             "id": obj.get("id"),
             "locations": [Coordinate.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["costing_options"]) if obj.get("costing_options") is not None else None
+            "costing_options": CostingOptions.from_dict(obj["costing_options"]) if obj.get("costing_options") is not None else None,
+            "elevation_interval": obj.get("elevation_interval") if obj.get("elevation_interval") is not None else 0.0
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

stadiamaps/models/osrm_admin.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    Stadia Maps Geospatial APIs
+
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+
+    The version of the OpenAPI document: 8.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
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OsrmAdmin(BaseModel):
+    """
+    OsrmAdmin
+    """ # noqa: E501
+    iso_3166_1: Optional[StrictStr] = Field(default=None, description="The ISO 3166-1 two-character code for the admin region.")
+    iso_3166_1_alpha3: Optional[StrictStr] = Field(default=None, description="The ISO 3166-1 three-character code for the admin region.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["iso_3166_1", "iso_3166_1_alpha3"]
+
+    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.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) -> Optional[Self]:
+        """Create an instance of OsrmAdmin from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OsrmAdmin from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "iso_3166_1": obj.get("iso_3166_1"),
+            "iso_3166_1_alpha3": obj.get("iso_3166_1_alpha3")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

stadiamaps/models/osrm_annotation.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    Stadia Maps Geospatial APIs
+
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+
+    The version of the OpenAPI document: 8.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
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from stadiamaps.models.osrm_speed_limit import OsrmSpeedLimit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OsrmAnnotation(BaseModel):
+    """
+    OsrmAnnotation
+    """ # noqa: E501
+    distance: Optional[List[Union[StrictFloat, StrictInt]]] = Field(default=None, description="The distance, in meters, between each pair of coordinates.")
+    duration: Optional[List[Union[StrictFloat, StrictInt]]] = Field(default=None, description="The duration between each pair of coordinates, in seconds.")
+    weight: Optional[List[StrictInt]] = None
+    speed: Optional[List[Union[StrictFloat, StrictInt]]] = Field(default=None, description="The estimated speed of travel between each pair of coordinates in meters/sec.")
+    maxspeed: Optional[List[OsrmSpeedLimit]] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["distance", "duration", "weight", "speed", "maxspeed"]
+
+    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.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) -> Optional[Self]:
+        """Create an instance of OsrmAnnotation from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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 maxspeed (list)
+        _items = []
+        if self.maxspeed:
+            for _item_maxspeed in self.maxspeed:
+                if _item_maxspeed:
+                    _items.append(_item_maxspeed.to_dict())
+            _dict['maxspeed'] = _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():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OsrmAnnotation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "distance": obj.get("distance"),
+            "duration": obj.get("duration"),
+            "weight": obj.get("weight"),
+            "speed": obj.get("speed"),
+            "maxspeed": [OsrmSpeedLimit.from_dict(_item) for _item in obj["maxspeed"]] if obj.get("maxspeed") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

stadiamaps/models/osrm_banner_component.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    Stadia Maps Geospatial APIs
+
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+
+    The version of the OpenAPI document: 8.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
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OsrmBannerComponent(BaseModel):
+    """
+    OsrmBannerComponent
+    """ # noqa: E501
+    text: Optional[StrictStr] = None
+    type: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["text", "type"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['text', 'icon', 'delimiter', 'exit-number', 'exit', 'lane']):
+            raise ValueError("must be one of enum values ('text', 'icon', 'delimiter', 'exit-number', 'exit', 'lane')")
+        return value
+
+    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.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) -> Optional[Self]:
+        """Create an instance of OsrmBannerComponent from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OsrmBannerComponent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "type": obj.get("type")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

stadiamaps/models/osrm_banner_content.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+"""
+    Stadia Maps Geospatial APIs
+
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+
+    The version of the OpenAPI document: 8.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
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from stadiamaps.models.osrm_banner_component import OsrmBannerComponent
+from stadiamaps.models.osrm_guidance_modifier import OsrmGuidanceModifier
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OsrmBannerContent(BaseModel):
+    """
+    OsrmBannerContent
+    """ # noqa: E501
+    text: StrictStr
+    type: Optional[StrictStr] = None
+    modifier: Optional[OsrmGuidanceModifier] = None
+    components: Optional[List[OsrmBannerComponent]] = Field(default=None, description="A list of objects with additional context that allow for visual layout improvements beyond what's possible with plain text.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["text", "type", "modifier", "components"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['turn', 'new name', 'depart', 'arrive', 'merge', 'on ramp', 'off ramp', 'fork', 'end of road', 'continue', 'roundabout', 'rotary', 'roundabout turn', 'notification', 'exit roundabout', 'exit rotary']):
+            raise ValueError("must be one of enum values ('turn', 'new name', 'depart', 'arrive', 'merge', 'on ramp', 'off ramp', 'fork', 'end of road', 'continue', 'roundabout', 'rotary', 'roundabout turn', 'notification', 'exit roundabout', 'exit rotary')")
+        return value
+
+    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.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) -> Optional[Self]:
+        """Create an instance of OsrmBannerContent from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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 components (list)
+        _items = []
+        if self.components:
+            for _item_components in self.components:
+                if _item_components:
+                    _items.append(_item_components.to_dict())
+            _dict['components'] = _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():
+                _dict[_key] = _value
+
+        # set to None if modifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.modifier is None and "modifier" in self.model_fields_set:
+            _dict['modifier'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OsrmBannerContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "type": obj.get("type"),
+            "modifier": obj.get("modifier"),
+            "components": [OsrmBannerComponent.from_dict(_item) for _item in obj["components"]] if obj.get("components") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

stadiamaps/models/osrm_banner_instruction.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Stadia Maps Geospatial APIs
+
+    The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+
+    The version of the OpenAPI document: 8.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
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from stadiamaps.models.osrm_banner_content import OsrmBannerContent
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OsrmBannerInstruction(BaseModel):
+    """
+    OsrmBannerInstruction
+    """ # noqa: E501
+    distance_along_geometry: Union[StrictFloat, StrictInt] = Field(description="How far (in meters) from the upcoming maneuver the instruction should start being displayed.", alias="distanceAlongGeometry")
+    primary: OsrmBannerContent
+    secondary: Optional[OsrmBannerContent] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["distanceAlongGeometry", "primary", "secondary"]
+
+    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.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) -> Optional[Self]:
+        """Create an instance of OsrmBannerInstruction from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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 primary
+        if self.primary:
+            _dict['primary'] = self.primary.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of secondary
+        if self.secondary:
+            _dict['secondary'] = self.secondary.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():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OsrmBannerInstruction from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "distanceAlongGeometry": obj.get("distanceAlongGeometry"),
+            "primary": OsrmBannerContent.from_dict(obj["primary"]) if obj.get("primary") is not None else None,
+            "secondary": OsrmBannerContent.from_dict(obj["secondary"]) if obj.get("secondary") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+