Skip to content

WaypointOptimizationDestinationOptions

Source code in docs_src/capo_geo_routes/types/waypoint_optimization_destination_options.py
class WaypointOptimizationDestinationOptions(TypedDict, closed=True):
    access_hours: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_access_hours.WaypointOptimizationAccessHours"
    ]
    """<p>Access hours corresponding to when a waypoint can be visited.</p>"""
    appointment_time: NotRequired[
        "capo_geo_routes.types.timestamp_with_timezone_offset.TimestampWithTimezoneOffset"
    ]
    """<p>Appointment time at the destination.</p>"""
    heading: "capo_geo_routes.types.heading.Heading"
    """<p>GPS Heading at the position.</p>"""
    id: NotRequired["capo_geo_routes.types.waypoint_id.WaypointId"]
    """<p>The waypoint Id.</p>"""
    service_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Service time spent at the destination. At an appointment, the service time should be the appointment duration.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    side_of_street: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_side_of_street_options.WaypointOptimizationSideOfStreetOptions"
    ]
    """<p>Options to configure matching the provided position to a side of the street.</p>"""

access_hours instance-attribute

access_hours: NotRequired[WaypointOptimizationAccessHours]

Access hours corresponding to when a waypoint can be visited.

appointment_time instance-attribute

appointment_time: NotRequired[TimestampWithTimezoneOffset]

Appointment time at the destination.

heading instance-attribute

heading: Heading

GPS Heading at the position.

id instance-attribute

id: NotRequired[WaypointId]

The waypoint Id.

service_duration instance-attribute

service_duration: DurationSeconds

Service time spent at the destination. At an appointment, the service time should be the appointment duration.

Unit: seconds

side_of_street instance-attribute

side_of_street: NotRequired[WaypointOptimizationSideOfStreetOptions]

Options to configure matching the provided position to a side of the street.