OptimizeWaypointsRequest ¶

class OptimizeWaypointsRequest(TypedDict, closed=True):
    avoid: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_avoidance_options.WaypointOptimizationAvoidanceOptions"
    ]
    """<p>Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.</p>"""
    clustering: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_clustering_options.WaypointOptimizationClusteringOptions"
    ]
    """<p>Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.</p>"""
    departure_time: NotRequired[
        "capo_geo_routes.types.timestamp_with_timezone_offset.TimestampWithTimezoneOffset"
    ]
    """<p>Departure time from the waypoint.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>"""
    destination: NotRequired["capo_geo_routes.types.position.Position"]
    """<p>The final position for the route in the World Geodetic System (WGS 84) format: <code>[longitude, latitude]</code>.</p>"""
    destination_options: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_destination_options.WaypointOptimizationDestinationOptions"
    ]
    """<p>Destination related options.</p>"""
    driver: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_driver_options.WaypointOptimizationDriverOptions"
    ]
    """<p>Driver related options.</p>"""
    exclude: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_exclusion_options.WaypointOptimizationExclusionOptions"
    ]
    """<p>Features to be strictly excluded while calculating the route.</p>"""
    key: NotRequired["capo_geo_routes.types.api_key.ApiKey"]
    """<p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. </p>"""
    optimize_sequencing_for: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_sequencing_objective.WaypointOptimizationSequencingObjective"
    ]
    """<p>Specifies the optimization criteria for the calculated sequence.</p> <p>Default value: <code>FastestRoute</code>.</p>"""
    origin: "capo_geo_routes.types.position.Position"
    """<p>The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    origin_options: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_origin_options.WaypointOptimizationOriginOptions"
    ]
    """<p>Origin related options.</p>"""
    traffic: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_traffic_options.WaypointOptimizationTrafficOptions"
    ]
    """<p>Traffic-related options.</p>"""
    travel_mode: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_travel_mode.WaypointOptimizationTravelMode"
    ]
    """<p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default value: <code>Car</code> </p>"""
    travel_mode_options: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_travel_mode_options.WaypointOptimizationTravelModeOptions"
    ]
    """<p>Travel mode related options for the provided travel mode.</p>"""
    waypoints: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_waypoint_list.WaypointOptimizationWaypointList"
    ]
    """<p>List of waypoints between the <code>Origin</code> and <code>Destination</code>, in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <p>The maximum number of waypoints allowed per request:</p> <ul> <li> <p>Maximum 50 waypoints per request</p> </li> <li> <p>Maximum 20 waypoints when using constraints (<code>AccessHours</code>, <code>AppointmentTime</code>, <code>ServiceDuration</code>, <code>Heading</code>, <code>SideOfStreet</code>, <code>Before</code>)</p> </li> </ul>"""