Skip to content

RouteIntermodalTransitOptions

Source code in docs_src/capo_geo_routes/types/route_intermodal_transit_options.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class RouteIntermodalTransitOptions(TypedDict, closed=True):
    allowed_modes: NotRequired[
        "capo_geo_routes.types.route_transit_mode_list.RouteTransitModeList"
    ]
    """<p>Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>ExcludedModes</code>.</p>"""
    enabled_for: NotRequired[
        "capo_geo_routes.types.route_intermodal_enabled_legs_list.RouteIntermodalEnabledLegsList"
    ]
    """<p>Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:</p> <ul> <li> <p> <code>FirstLeg</code> - Enable this leg type for the first non-pedestrian leg of the route.</p> </li> <li> <p> <code>LastLeg</code> - Enable this leg type for the last non-pedestrian leg of the route.</p> </li> <li> <p> <code>EntireRoute</code> - Enable this leg type for the entire route.</p> </li> <li> <p> <code>None</code> - Disable this leg type entirely.</p> </li> </ul>"""
    excluded_modes: NotRequired[
        "capo_geo_routes.types.route_transit_mode_list.RouteTransitModeList"
    ]
    """<p>Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with <code>AllowedModes</code>.</p>"""

allowed_modes instance-attribute 

allowed_modes: NotRequired[RouteTransitModeList]

Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

enabled_for instance-attribute 

enabled_for: NotRequired[RouteIntermodalEnabledLegsList]

Specifies the portion of the route for which this leg type is enabled. By default, the leg type is enabled for all legs. Valid values:

  • FirstLeg - Enable this leg type for the first non-pedestrian leg of the route.

  • LastLeg - Enable this leg type for the last non-pedestrian leg of the route.

  • EntireRoute - Enable this leg type for the entire route.

  • None - Disable this leg type entirely.

excluded_modes instance-attribute 

excluded_modes: NotRequired[RouteTransitModeList]

Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.