import { HttpParameterCodec, HttpHeaders, HttpParams, HttpClient, HttpContext, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import * as i0 from '@angular/core'; import { InjectionToken, ModuleWithProviders, EnvironmentProviders } from '@angular/core'; /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport types: * `CAR` - car * `TRUCK_1500` - truck with permissible weight 1500 kg * `TRUCK_3000` - truck with permissible weight 3000 kg * `TRUCK_5000` - truck with permissible weight 5000 kg * `TRUCK_10000` - truck with permissible weight 10000 kg * `TRUCK_20000` - truck with permissible weight 20000 kg * `TRUCK_10000_L75_H35_W24_6000` - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg * `TRUCK_18000_L95_H40_W26_11000` - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg * `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg * `TRUCK_GARBAGE_1` - truck for transporting garbage (type 1) * `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2) * `TUK_TUK` - tuk-tuk * `BICYCLE` - bicycle * `PEDESTRIAN` - pedestrian * `PUBLIC_TRANSPORT` - public transport * `TELEPORT` - teleport (instant movement between points) Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable. */ declare enum TransportTypeUniversal { CAR = "CAR", TRUCK_1500 = "TRUCK_1500", TRUCK_3000 = "TRUCK_3000", TRUCK_5000 = "TRUCK_5000", TRUCK_10000 = "TRUCK_10000", TRUCK_20000 = "TRUCK_20000", TRUCK_10000_L75_H35_W24_6000 = "TRUCK_10000_L75_H35_W24_6000", TRUCK_18000_L95_H40_W26_11000 = "TRUCK_18000_L95_H40_W26_11000", TRUCK_26000_L120_H40_W26_8000 = "TRUCK_26000_L120_H40_W26_8000", TRUCK_GARBAGE_1 = "TRUCK_GARBAGE_1", TRUCK_GARBAGE_2 = "TRUCK_GARBAGE_2", TUK_TUK = "TUK_TUK", BICYCLE = "BICYCLE", PEDESTRIAN = "PEDESTRIAN", PUBLIC_TRANSPORT = "PUBLIC_TRANSPORT", TELEPORT = "TELEPORT" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Time window. */ interface TimeWindowUniversal { [key: string]: any | any; /** * Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ from: string; /** * Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ to: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Tag life time window. */ interface FeatureLifetimeUniversal { [key: string]: any | any; /** * Tag used to determine [compatibility](#section/Description/Compatibilities). */ feature: string; /** * A list of time windows within which the specified tag exists. If compatibility is affected by several features with different windows - entities will be considered compatible within the intersection of windows. There cannot be more than 4 intersections of the specified windows for all tags for one performer. */ time_windows: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the transport with performers and locations](#section/Description/Compatibilities). */ interface TransportCompatibilitiesUniversal { [key: string]: any | any; /** * A list of tags that define a property or requirement. */ transport_features?: Array; /** * List of feature tag lifetime. */ transport_features_lifetimes?: Array; /** * A list of tags that define a property or requirement. */ performer_restrictions?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Attribute. */ interface AttributeUniversal { [key: string]: any | any; /** * Attribute\'s key. */ key: string; /** * Attribute\'s value. */ value: string; /** * Attribute processing strategy: * `LASTMILE_REF_TIME` - when sending a task to the scheduler, the value (format [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)) of the attribute is replaced with a relative time; if the value is not in the format, the calculation stops with the `FAILED` status. */ strategy?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Paid mileage is an integral part of the tariff. */ interface TransportTariffConstraintUniversal { [key: string]: any | any; /** * The length of the paid part of the way, in meters. */ stage_length?: number; /** * The cost within the paid part of the way, monetary unit per meter. */ cost_per_unit?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cost per capacity element. */ interface CapacityCostUniversal { [key: string]: any | any; /** * Cost per kilogram, in conventional monetary units. */ mass: number; /** * Cost per cubic meter, in conventional monetary units. */ volume: number; /** * Cost per unit of additional parameter (A), in conventional monetary units. */ capacity_a: number; /** * Cost per unit of additional parameter (B), in conventional monetary units. */ capacity_b: number; /** * Cost per unit of additional parameter (C), in conventional monetary units. */ capacity_c: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The tariff determines the cost of transport operation and restrictions on mileage per shift. */ interface TransportTariffUniversal { [key: string]: any | any; /** * Price for using the shift, monetary unit. */ cost_per_shift?: number; /** * List of components of the tariff. */ constraints?: Array; transportation_cost?: CapacityCostUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Working shift of transport. Specifies the availability of transport for scheduling. The end of the shift resets the cargo remaining in the body after the execution of demands of the `DROP_FROM_BOX` and `PICKUP_TO_BOX` types. */ interface TransportShiftUniversal { [key: string]: any | any; /** * Shift key, unique identifier. */ key: string; /** * The shift time window in which the transport can move between locations and be used by the performer in work on locations. */ availability_time: TimeWindowUniversal; /** * Start location key. If the key is not set, then the transport path starts on the first order. */ start_location_key?: string | null; /** * Finish location key. If the key is not set, then the transport path ends at the last order. */ finish_location_key?: string | null; tariff?: TransportTariffUniversal; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport box [compatibilities](#section/Description/Compatibilities). */ interface BoxCompatibilitiesUniversal { [key: string]: any | any; /** * Width in meters. */ width?: number; /** * Height in meters. */ height?: number; /** * Length in meters. */ length?: number; /** * A list of tags that define a property or requirement. */ box_features?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity characteristics. */ interface CapacityUniversal { [key: string]: any | any; /** * Weight in kilograms. */ mass?: number; /** * Volume in cubic meters. */ volume?: number; /** * Additional parameter (A) for measuring cargoes and boxes in alternative units. For example, to account for cargo in pieces (this parameter is equal to one for a cargo and the maximum number of cargo to hold for a box). */ capacity_a?: number; /** * Additional parameter (B) for measuring cargoes and boxes in alternative units. */ capacity_b?: number; /** * Additional parameter (C) for measuring cargoes and boxes in alternative units. */ capacity_c?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Box limits. */ interface BoxLimitsUniversal { [key: string]: any | any; max_one_cargo_capacity?: CapacityUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * A transport box capable to hold a cargo. */ interface BoxUniversal { [key: string]: any | any; /** * Unique box key. Used to identify the cargo placement in boxes. */ key: string; capacity?: CapacityUniversal | null; compatibilities?: BoxCompatibilitiesUniversal | null; limits?: BoxLimitsUniversal | null; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport load limits. */ interface TransportLimitsUniversal { [key: string]: any | any; /** * Limit of the number of transports\'s unique locations in one trip. If not specified or null, number of using boxes is not limited. The limit should not exceed the number of boxes. */ max_boxes?: number | null; max_capacity?: CapacityUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport. Used by performer for relocating and cargo transfer. */ interface TransportUniversal { [key: string]: any | any; /** * Transport key, unique identifier. */ key: string; /** * List of working shifts of transport. */ shifts: Array; transport_type?: TransportTypeUniversal; /** * A list of transport boxes that can accommodate the cargo. */ boxes?: Array; compatibilities?: TransportCompatibilitiesUniversal | null; limits?: TransportLimitsUniversal | null; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Type of goal entity. It can be an order or a performer\\transport shift. */ declare enum HardlinkElementTypeUniversal { ORDER = "ORDER", PERFORMER_SHIFT = "PERFORMER_SHIFT", TRANSPORT_SHIFT = "TRANSPORT_SHIFT" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Assignment group element. */ interface HardlinkElementUniversal { [key: string]: any | any; type: HardlinkElementTypeUniversal; /** * Key of the target entity (an order or a shift). */ entity_key: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Assignment required to associate entities in a single group. It can consist of two or more entities. Example: * driver assignment to the transport (connection between the performer\'s shifts and the transport). * order assignment to the performer (link the order to a performer\'s shift). * specifying the need to perform multiple orders during a single trip (linking orders to deliver them within one trip). */ interface HardlinkUniversal { [key: string]: any | any; /** * Hardlink key. */ key: string; /** * List of items in the assignment group. */ links: Array; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Replan strategy. */ interface ReplanStrategyUniversal { [key: string]: any | any; /** * Activate trip actions reorder. */ reorder?: boolean; /** * Ability to plan new orders into existing or new trips (if the `create_new_trips` option is enabled). */ plan_new_orders?: boolean; /** * Activate new trips creation. */ create_new_trips?: boolean; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Replanning settings. */ interface ReplanSettingsUniversal { [key: string]: any | any; replan_strategy?: ReplanStrategyUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Time window violation detail information. */ interface TimeWindowViolationDetailUniversal { [key: string]: any | any; /** * List of object\'s keys. */ demand_keys: Array; /** * The total number of demands. */ count: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics of time window violation. */ interface TimeWindowViolationsUniversal { [key: string]: any | any; /** * Count and order\'s keys, what planned before permitted time window. */ before: TimeWindowViolationDetailUniversal; /** * Count and order\'s keys, what planned after permitted time window. */ after: TimeWindowViolationDetailUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Quality metrics. */ interface QualityUniversal { [key: string]: any | any; /** * Amount of fines for violating location\'s capacity limit. */ locations_limits_penalty: number; /** * Statistics of soft time window violations. */ soft_time_window_violations: TimeWindowViolationsUniversal; /** * Statistics of hard time window violations. */ hard_time_window_violations: TimeWindowViolationsUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity limits. */ interface CapacityLimitUniversal { [key: string]: any | any; /** * Weight in kilograms. */ mass: number; /** * Volume in cubic meters. */ volume: number; /** * Additional parameter (A) for measuring cargoes and boxes in alternative units. */ capacity_a: number; /** * Additional parameter (B) for measuring cargoes and boxes in alternative units. */ capacity_b: number; /** * Additional parameter (C) for measuring cargoes and boxes in alternative units. */ capacity_c: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Limiting the location\'s ability to handle cargo. */ interface LocationCargosLimitUniversal { [key: string]: any | any; /** * Capacity value. */ capacity: CapacityLimitUniversal; /** * Penalty for violating the `capacity`. */ penalty: CapacityCostUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Limiting the location\'s ability to serve transport. */ interface LocationTransportsLimitUniversal { [key: string]: any | any; /** * The number of transport serviced on average during a specified time window. */ count: number; /** * Penalty for violating the `count`. */ penalty: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on the implementation of location capacity limits within one time window. */ interface LocationLimitStatisticsUniversal { [key: string]: any | any; /** * Location limit key, unique identifier. */ location_limit_key: string; /** * For time window - the amount of measures of cargos moved and the amount of fines for violating restrictions on the movement of cargos. */ cargos_statistics: LocationCargosLimitUniversal; /** * For time window - the number of transports serviced on average during a specified time window and the amount of fines for violating transport service restrictions. */ transports_statistics: LocationTransportsLimitUniversal; /** * The amount of fines for violating the location\'s capacity within the limit. */ location_limit_penalty: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics for a specific trip. */ interface LocationStatisticsUniversal { [key: string]: any | any; /** * Location key. */ location_key: string; /** * Amount of fines for violating location\'s capacity limit. */ location_limits_penalty: number; /** * For location - The amount of measures of cargos moved and the amount of fines for violating restrictions on the movement of cargos. * @deprecated */ total_cargos_statistics: LocationCargosLimitUniversal; /** * For location - the number of transports serviced on average during a specified time window and the amount of fines for violating transport service restrictions. * @deprecated */ total_transports_statistics: LocationTransportsLimitUniversal; /** * Location capacity limit statistics. */ limits_statistics: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics. */ interface CapacityStatisticsSumUniversal { [key: string]: any | any; /** * Total weight in kilograms. */ mass: number; /** * Total volume in cubic meters. */ volume: number; /** * Amount for additional parameter (A) for measuring loads in alternative units of measurement. */ capacity_a: number; /** * Amount for additional parameter (B) for measuring loads in alternative units of measurement. */ capacity_b: number; /** * Amount for additional parameter (C) for measuring loads in alternative units of measurement. */ capacity_c: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics (ratio). It may be more than one. */ interface CapacityStatisticsRatioUniversal { [key: string]: any | any; /** * Loading by mass, in fractions of a unit. */ mass: number; /** * Loading by volume, in fractions of a unit. */ volume: number; /** * Loading by additional parameter (A), in fractions of a unit. */ capacity_a: number; /** * Loading by additional parameter (B), in fractions of a unit. */ capacity_b: number; /** * Loading by additional parameter (C), in fractions of a unit. */ capacity_c: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Measurements of times and distances for work on location, individual trips and planning in general. */ interface MeasurementsUniversal { [key: string]: any | any; time_window: TimeWindowUniversal; /** * Time duration according to `P1DT2H12M34.2S`. */ driving_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ waiting_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ working_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ break_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ rest_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ arriving_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ departure_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ total_time: string; /** * Distance in meters. */ distance: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics on capacity characteristics (ratio). Cannot be greater than one. */ interface CapacityStatisticsLoadUniversal { [key: string]: any | any; /** * Loading by mass, in fractions of a unit. */ mass: number; /** * Loading by volume, in fractions of a unit. */ volume: number; /** * Loading by additional parameter (A), in fractions of a unit. */ capacity_a: number; /** * Loading by additional parameter (B), in fractions of a unit. */ capacity_b: number; /** * Loading by additional parameter (C), in fractions of a unit. */ capacity_c: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Summary statistics for one or a set of trips. */ interface GeneralStatisticsUniversal { [key: string]: any | any; /** * Total cost calculated based on the performer\'s and transport tariffs. */ cost: number; /** * The total reward for orders fulfillment. */ reward: number; /** * The total profit is equal to the difference between the total reward (`reward`) and cost (`cost`). */ profit: number; /** * Measurements of times and distances for aggregate and individual trips: * `time_window` - the start time of the first trip and the end time of the last, if there are no trips, the time of the left border of the planning horizon is returned, while the from \\ to fields have the same value * `driving_time` - duration of driving time * `waiting_time` - total waiting time for all locations * `working_time` - total time of work execution at all locations included in the trip * `break_time` - total break time for all locations * `rest_time` - total rest time for all locations * `arriving_time` - total time to drive / park at locations * `departure_time` - total time for departure from locations * `total_time` - total time, composed of `driving_time` + `waiting_time` + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time` * `distance` - the total length of the roundtrip/trip/set of trips, in meters */ measurements: MeasurementsUniversal; /** * The total number of planned trips. */ trips_count: number; /** * The total number of performers involved in orders fulfillment. */ performers_count: number; /** * The total number of planned and assigned orders. */ orders_count: number; /** * The total number of planned orders. */ plan_orders_count: number; /** * The total number of assigned orders. */ waitlist_orders_count: number; /** * The total number of stops (non-unique locations). */ stops_count: number; /** * The total number of unique locations within one trip. For general statistics - the sum of unique locations within each trip. */ locations_count: number; /** * Total additive measures of the transported cargo. */ cargo_capacity_sum: CapacityStatisticsSumUniversal; /** * The ratio of the total additive measures of the transported cargo to the total capacity of the boxes. In fractions of a unit. It may be more than one. */ cargo_capacity_ratio: CapacityStatisticsRatioUniversal; /** * The ratio of the maximum load of boxes to the total capacity of boxes. In fractions of a unit. Cannot be greater than one. */ max_transport_load: CapacityStatisticsLoadUniversal; /** * Average speed is the ratio of the total distance to the total time of movement, km/h. */ average_speed: number; /** * Number of [roundtrips](#section/Description/Roundtrips) within a trip. */ round_trips_count: number; /** * Average mileage per roundtrip is the ratio of the total mileage per trip to the number of roundtrips, in meters. */ average_roundtrip_distance: number; /** * Time duration according to `P1DT2H12M34.2S`. */ average_roundtrip_time: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Total transport load. */ interface TransportLoadUniversal { [key: string]: any | any; /** * Number of cargos. */ count: number; capacity: CapacityStatisticsSumUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics for a transport load. */ interface LoadStatisticsUniversal { [key: string]: any | any; /** * Total transport load for the entire trip time. */ total_load: TransportLoadUniversal; /** * Maximum transport load during the entire trip (for each dimension). */ max_load: TransportLoadUniversal; /** * Maximum transport load over the entire trip duration while in motion (for each dimension). */ max_transfer_load: TransportLoadUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics for roundtrip. */ interface RoundtripStatisticsUniversal { [key: string]: any | any; /** * Roundtrip key. */ roundtrip_key: string; /** * General statistics for roundtrip. */ general_statistics: GeneralStatisticsUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * An demand made for a specific stop. */ interface StopDemandUniversal { [key: string]: any | any; /** * Demand key. */ demand_key: string; /** * Event key. */ event_key: string; /** * Time window for completing the demand. */ demand_time_window: TimeWindowUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics for a specific stop during a trip. */ interface StopStatisticsUniversal { [key: string]: any | any; /** * Location key for stop. */ location_key: string; /** * List of orders completed at this stop. */ stop_demands: Array; /** * Stop time window - from the beginning of the parking lot to the complete departure from the location. The window duration is `waiting_time` + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`. */ stop_time_window: TimeWindowUniversal; /** * Measurements of times and distances for work on location: * `time_window` - the time window from the start of movement to the stop until the end of the departure from the stop * `driving_time` - driving time from the previous stop to the current location * `waiting_time` - the duration of waiting for the execution of work at the location * `working_time` - the time spent on the direct execution of work at the location * `break_time` - duration of the performer\'s break * `rest_time` - duration of rest for the performer * `arriving_time` - the time spent on the entrance/parking at the location * `departure_time` - the time taken to leave the location * `total_time` - total time for a stop, composed of `driving_time` + `waiting_time` + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time` * `distance` - the distance from the previous stop to the current location */ measurements: MeasurementsUniversal; /** * Loading to the transport at this stop. */ upload: TransportLoadUniversal; /** * Unloading from the transport at this stop. */ download: TransportLoadUniversal; /** * Maximum load of the transport in the process of loading/unloading at a stop. */ max_load: TransportLoadUniversal; /** * Transport loading at the time of arrival at this stop. */ arrival_load: TransportLoadUniversal; /** * Transport loading at the moment of departure from this stop. */ departure_load: TransportLoadUniversal; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Statistics for a specific trip. */ interface TripStatisticsUniversal { [key: string]: any | any; /** * Trip key, unique identifier. */ trip_key: string; /** * General statistics for trip. */ general_statistics: GeneralStatisticsUniversal; load_statistics: LoadStatisticsUniversal; /** * Statistics per stop during the trip. */ stop_statistics: Array; /** * Statistics per roundtrip during the trip. */ roundtrip_statistics: Array; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * General statistics on input data. */ interface TaskStatisticsUniversal { [key: string]: any | any; /** * Planning horizon is a time window where: * `from` - the left border of the time windows of all entities from the input data * `to` - the right border of the time windows of all entities from the input data */ planning_horizon: TimeWindowUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * General statistics on the calculation result. */ interface PlanStatisticsUniversal { [key: string]: any | any; total_statistics: GeneralStatisticsUniversal; /** * List of statistics for each scheduled trip separately. */ trips_statistics: Array; /** * Statistics on the loading of locations for which bandwidth restrictions have been set. */ locations_statistics: Array; task_statistics: TaskStatisticsUniversal; quality: QualityUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The paid period of time is an integral part of the tariff. */ interface PerformerTariffConstraintUniversal { [key: string]: any | any; /** * Length of the paid period according to `P1DT2H12M34.2S`. */ stage_length?: string; /** * Cost within the paid period, monetary unit per second of work. */ cost_per_unit?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The tariff determines the cost and time limits of the shift. */ interface PerformerTariffUniversal { [key: string]: any | any; /** * Price for using the shift, monetary unit. */ cost_per_shift?: number; /** * A list of tariff components that apply from the start of movement or execution of work on orders. */ constraints?: Array; /** * Max sum of penalties for performer or transport using this shift, monetary unit. If not specified or null, the performer can violate without restrictions. */ max_penalty_cost?: number | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The condition for the onset and characteristics of a break. */ interface BreakUniversal { [key: string]: any | any; /** * Time duration according to `P1DT2H12M34.2S`. */ relocating_duration_sum: string; /** * Time duration according to `P1DT2H12M34.2S`. */ operating_duration_sum?: string | null; /** * Time duration according to `P1DT2H12M34.2S`. */ duration: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Rules for accounting for breaks. */ interface BreakRulesUniversal { [key: string]: any | any; /** * The condition for the onset and characteristics of a first break. */ first: BreakUniversal; consecutive?: BreakUniversal | null; /** * Type of accounting for time spent moving between locations (total or continuous). */ relocating_duration_type?: BreakRulesUniversalRelocatingDurationTypeEnum; } declare enum BreakRulesUniversalRelocatingDurationTypeEnum { TOTAL = "TOTAL", CONTINUOUS = "CONTINUOUS" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The condition for the onset and characteristics of a rest. */ interface RestUniversal { [key: string]: any | any; /** * Time duration according to `P1DT2H12M34.2S`. */ relocating_duration_sum: string; /** * Time duration according to `P1DT2H12M34.2S`. */ operating_duration_sum?: string | null; /** * Time duration according to `P1DT2H12M34.2S`. */ duration: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Rules for accounting for rest. */ interface RestRulesUniversal { [key: string]: any | any; /** * The condition for the onset and characteristics of a consecutive rest. */ consecutive: RestUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Performer\'s work and rest rules. */ interface WorkAndRestRulesUniversal { [key: string]: any | any; rest_rules?: RestRulesUniversal | null; break_rules?: BreakRulesUniversal | null; /** * A list of locations keys in which the counters for breaks and rest are reset when located. */ reset_location_keys?: Array; /** * List of location keys whose stay is not taken into account in the total trip execution time counter. */ ignore_location_keys?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Performer\'s shift that determines the availability of the resource for planning within its time window. */ interface PerformerShiftUniversal { [key: string]: any | any; /** * Shift key, unique identifier. */ key: string; /** * Time shift window when the performer can perform work at locations and drive between locations. */ availability_time: TimeWindowUniversal; /** * Working time window, when the performer can perform work at locations, must be inside the time window. */ working_time: TimeWindowUniversal; /** * Start location key. If not specified, the trip starts from the first order location. */ start_location_key?: string | null; /** * Finish location key. If not specified, the trip finishes on the last order location. */ finish_location_key?: string | null; /** * Limit of the number of unique locations in one trip. If not specified or null, number of locations is not limited. */ max_locations?: number | null; /** * Limit of the number of stops in one trip. If not specified or null, number of stops is not limited. */ max_stops?: number | null; tariff?: PerformerTariffUniversal; work_and_rest_rules?: WorkAndRestRulesUniversal | null; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the performer with transport and orders](#section/Description/Compatibilities). */ interface PerformerCompatibilitiesUniversal { [key: string]: any | any; /** * A list of tags that define a property or requirement. */ performer_features?: Array; /** * List of feature tag lifetime. */ performer_features_lifetimes?: Array; /** * A list of tags that define a property or requirement. */ transport_restrictions?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional time for the execution of the application by a certain performer. */ interface DemandExtraDurationUniversal { [key: string]: any | any; /** * The key of the ticket whose events need to increase the execution time. */ demand_key: string; /** * Time duration according to `P1DT2H12M34.2S`. */ additional_duration: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Limitation on the performer\'s workload. */ interface PerformerLimitsUniversal { [key: string]: any | any; /** * Limit of the number of performer\'s shifts in one planning. */ max_work_shifts?: number; /** * A list of demands for which the performer will spend more time than indicated in the demand. Valid for the specified performer-order pair for all performer\'s shifts and all demands\'s events. */ demand_extra_durations?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Performer. Fulfills orders using transport. */ interface PerformerUniversal { [key: string]: any | any; /** * Performer\'s key, unique identifier. */ key: string; /** * List of working shifts of performer. */ shifts: Array; /** * The type of personal transport that the performer will use to get to his assigned work transport. */ own_transport_type?: TransportTypeUniversal; compatibilities?: PerformerCompatibilitiesUniversal | null; limits?: PerformerLimitsUniversal | null; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Speed change coefficient for the specified transport type. */ interface TransportSpeedMultiplierUniversal { [key: string]: any | any; transport_type: TransportTypeUniversal; /** * Average transport speed multiplier. */ speed: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity change rate for the specified transport type. */ interface CapacityMultiplierUniversal { [key: string]: any | any; /** * Mass multiplier. */ mass?: number; /** * Volume multiplier. */ volume?: number; /** * Additional parameter (A) multiplier. */ capacity_a?: number; /** * Additional parameter (B) multiplier. */ capacity_b?: number; /** * Additional parameter (C) multiplier. */ capacity_c?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Capacity change rate for the specified transport type. */ interface TransportCapacityMultiplierUniversal { [key: string]: any | any; transport_type: TransportTypeUniversal; capacity: CapacityMultiplierUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Planning assumptions. Designed to adjust the logic of planning via mass change of input data. */ interface TripAssumptionsUniversal { [key: string]: any | any; /** * Transport speed change coefficients. */ transport_speed_multipliers?: Array; /** * Transport capacity change coefficients. Change the `capacity` parameters for all boxes and `max_capacity` for the transport. */ transport_capacity_multipliers?: Array; /** * Disable the accounting for capacity. If `true` is specified, all becomes compatible with everything. */ disable_compatibility?: boolean; /** * Disable the accounting for capacity. If `true` is specified, all transports can accommodate an unlimited cargo amount. */ disable_capacity?: boolean; /** * Disable location bandwidth accounting. If `true` is specified, `location.timetable.limits` and `trips_settings.penalties.max_locations_limits_penalty` parameters are not taken into account. */ disable_location_limits?: boolean; /** * Use for calculation the same (specified) time window for orders and demands. The time window is specified from the beginning of the earliest window to the end of the latest window from all orders and demands. */ same_order_time_window?: boolean; /** * Expand the time window for performer and transport shifts. The left border of the first shift extends to the left border of the specified window, right border extends to the right border or to the beginning of the next window for this entity. Each next shift moves the right border to the next shift or to the right border of the specified window. */ expand_shift_time_window?: boolean; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Penalty for violation of compatibility. */ interface CompatibilityPenaltyUniversal { [key: string]: any | any; /** * Tag used to determine [compatibility](#section/Description/Compatibilities). */ tag: string; /** * Penalty for violation of compatibility for the specified tag. */ penalty: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Planning penalties - ability to disrupt a part of the planning business rules. */ interface TripPenaltiesUniversal { [key: string]: any | any; /** * Penalties for violation of compatibility. When taking into account transport-location compatibility violations, the penalty is applied for each stop and cannot exceed the `max_penalty_cost` of the performer assigned to the trip. Only the absence of a property is penalized; the time windows of the life of a property cannot be violated for a fine. */ compatibilities?: Array; /** * The maximum allowable amount of fines for violating location\'s capacity limit. */ max_locations_limits_penalty?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The strategy of the choosing optimal trip start time: * `EARLIEST_FINISH` * `LOWEST_COST` */ declare enum TripStartTimeStrategyUniversal { EARLIEST_FINISH = "EARLIEST_FINISH", LOWEST_COST = "LOWEST_COST" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Expectations from the calculation result. Affect the trip-building logic. */ interface TripExpectationsUniversal { [key: string]: any | any; trip_start_time_strategy?: TripStartTimeStrategyUniversal; /** * Problem kind. */ problem_kind?: string | null; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Trip creation settings. */ interface TripsSettingsUniversal { [key: string]: any | any; /** * Name of the planning configuration. The configuration determines the result goal and quality. [List of available](#section/Description/Planning-configuration) planning configurations. */ configuration?: string; expectations?: TripExpectationsUniversal; assumptions?: TripAssumptionsUniversal; penalties?: TripPenaltiesUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Geodata usage settings. */ interface GeoSettingsUniversal { [key: string]: any | any; /** * Geodata provider: * `VRT` - geo-data and traffic jams from Veeroute, work all over the world. A specific provider may be specified for a specific region, availability depending on customer settings. */ geo_provider?: string; /** * Use toll roads. */ toll_roads?: boolean; /** * Use ferry crossing. */ ferry_crossing?: boolean; /** * Accounting for traffic during the route planning. */ traffic_jams?: boolean; /** * Use for calculating straight line distances. If `false` is specified, distances are calculated by roads. When this parameter is enabled, geo-provider not used and traffic (`traffic_jams`) is automatically disabled. */ flight_distance?: boolean; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Settings for using external extensions to adjust calculations. */ interface ExtensionSettingsUniversal { [key: string]: any | any; /** * Use a third-party calculation adjuster. */ enable_extension?: boolean; /** * The address of an external service implementing the Universal Extension API. */ extension_url?: string | null; /** * The maximum time to wait for a response from the external service implementing the Universal Extension API (for each request). */ request_timeout?: string; /** * The number of attempts to request an external service implementing the Universal Extension API. */ retry_attempts?: number; /** * The time between request attempts to an external service implementing the Universal Extension API. */ retry_interval?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation settings. */ interface CalculationSettingsUniversal { [key: string]: any | any; /** * Max calculation time. The countdown starts from the time when data is uploaded to the server and calculation starts. */ max_calculation_time?: string; /** * Max calculation time. The countdown starts from the time when data is uploaded to the server. */ max_waiting_time?: string; /** * Calculation result lifetime. The countdown starts from the time when the calculation is completed. */ result_ttl?: string; /** * Timezone. */ result_timezone?: number; /** * Treat warnings as errors and do not run calculations if at least one entity contains invalid data. */ treat_warnings_as_errors?: boolean; /** * Specifies the calculation accuracy in the decimal point sequence number. It equals 3 by default, so the accuracy is 0.001. */ precision?: number; /** * Calculation tag, used to select the calculation pool. */ worker_tag?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Planning settings. */ interface PlanSettingsUniversal { [key: string]: any | any; trips_settings?: TripsSettingsUniversal; geo_settings?: GeoSettingsUniversal; calculation_settings?: CalculationSettingsUniversal; extension_settings?: ExtensionSettingsUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current [trip status](#section/Description/Trip-status-model): * `FREE` - the trip has no assigned crew, initial status, awaiting assignment by the operator * `ASSIGNED` - the trip has a crew assigned, awaiting dispatch to the crew by the operator * `SENT` - the trip has been sent to the crew, awaiting confirmation of receipt by the crew * `RECEIVED` - the trip has been received by the crew, awaiting acceptance by the crew * `CONFIRMED` - the trip has been accepted by the crew, awaiting work from the crew * `REJECTED` - the trip has been rejected by the crew, awaiting assignment by the operator * `EXECUTING` - the trip is in progress, awaiting completion by the crew * `FINISHED` - the trip has been completed, final status * `CANCELED` - the trip has been canceled, final status */ declare enum TripStatusUniversal { FREE = "FREE", ASSIGNED = "ASSIGNED", SENT = "SENT", RECEIVED = "RECEIVED", CONFIRMED = "CONFIRMED", REJECTED = "REJECTED", EXECUTING = "EXECUTING", FINISHED = "FINISHED", CANCELED = "CANCELED" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Performer\'s shift assigned to the specified time (`shift_time`). */ interface AssignedPerformerUniversal { [key: string]: any | any; /** * Performer\'s key, unique identifier. */ performer_key: string; /** * Performer\'s shift key. */ shift_key: string; shift_time: TimeWindowUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Transport\'s shift assigned to the specified time (`shift_time`). */ interface AssignedTransportUniversal { [key: string]: any | any; /** * Transport key, unique identifier. */ transport_key: string; /** * Transport\'s shift key. */ shift_key: string; shift_time: TimeWindowUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * [Flag of state](#section/Description/Trip-model) inside trip. */ declare enum TripStateFlagUniversal { AROUND_LOCATION = "AROUND_LOCATION", INSIDE_LOCATION = "INSIDE_LOCATION", INSIDE_LOCATION_WINDOW = "INSIDE_LOCATION_WINDOW", INSIDE_WORKING_WINDOW = "INSIDE_WORKING_WINDOW", INSIDE_EVENT_HARD_WINDOW = "INSIDE_EVENT_HARD_WINDOW", INSIDE_EVENT_SOFT_WINDOW = "INSIDE_EVENT_SOFT_WINDOW", ON_DEMAND = "ON_DEMAND", WAITING = "WAITING", RELOCATING = "RELOCATING", BREAK = "BREAK", REST = "REST", DEPARTURE = "DEPARTURE", ARRIVAL = "ARRIVAL", DURING_ROUNDTRIP = "DURING_ROUNDTRIP" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Types of actions with cargo: * `ADD` - moving cargo into the box * `REMOVE` - moving cargo from the box */ declare enum CargoActionTypeUniversal { ADD = "ADD", REMOVE = "REMOVE" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Action with a cargo. */ interface CargoActionUniversal { [key: string]: any | any; /** * Unique box key. Used to identify the cargo placement in boxes. */ box_key: string; /** * Cargo key, unique identifier. */ cargo_key: string; cargo_action_type: CargoActionTypeUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Trip state. */ interface TripStateUniversal { [key: string]: any | any; /** * Start time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6). */ time: string; /** * Key of the order with which an action is taken. */ order_key?: string | null; /** * Key of the demand with which an action is taken. */ demand_key?: string | null; /** * Key of the event at which an action is taken. */ event_key?: string | null; /** * Key of the location at which an action is taken. */ location_key?: string | null; /** * Key of the roundtrip at which an action is taken. */ roundtrip_key?: string | null; /** * List of flags, describing current state. Values of flags responsible for geographic location (there can be several flags at the same time): * `AROUND_LOCATION` - the performer is near the location - in the process of parking or leaving it. * `INSIDE_LOCATION` - the performer is at the location. Values of flags responsible for being in time windows (there can be several flags at the same time): * `INSIDE_WORKING_WINDOW` - the performer is inside the working time window. * `INSIDE_LOCATION_WINDOW` - the performer is inside the working time of the location. * `INSIDE_EVENT_HARD_WINDOW` - the performer is inside the hard time window. * `INSIDE_EVENT_SOFT_WINDOW` - the performer is inside the soft time window. Values of flags responsible for actions (there can be only one flag at a time): * `ON_DEMAND` - the performer has started working on the request. * `WAITING` - the performer has started waiting. * `RELOCATING` - the performer has started moving to the next stop. * `BREAK` - the performer has started a break. * `REST` - the performer has started a long rest. * `ARRIVAL` - the performer has started parking. * `DEPARTURE` - the performer has finished leaving the parking lot. The values of the flags responsible for the logical state: * `DURING_ROUNDTRIP` - the performer is making a roundtrip. */ flags: Array; /** * List of actions with cargo in transport at the beginning of the state. */ cargo_actions?: Array; /** * Cumulative distance from the start of the trip, in meters. */ distance?: number; /** * Cumulative cost from the start of the trip, calculated based on the performers\' and transport tariffs. */ cost?: number; /** * Cumulative reward from the start of the trip for orders fulfillment. */ reward?: number; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ interface TripUniversal { [key: string]: any | any; /** * Trip key, unique identifier. */ key: string; performer: AssignedPerformerUniversal; transport: AssignedTransportUniversal; /** * List of performer\'s states. */ states: Array; /** * List of order keys assigned to the performer, but not scheduled for a specific time and not taken into account in the transport load. */ waitlist?: Array; /** * Name, information field. */ name?: string; status?: TripStatusUniversal; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Actualize settings. */ interface ActualizeSettingsUniversal { [key: string]: any | any; /** * Current date and time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6). If not specified, the current time when the request was received by the server is taken. */ current_time?: string | null; /** * Acceptable delay. Affects the shift of the right boundaries of hard time windows of orders and time windows of work shifts of performers and transports. */ max_delay_duration?: string; /** * Fact processing threshold. If a fact\'s `creation_time > current_time + fact_processing_threshold`, it is considered invalid. */ fact_processing_threshold?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * A geographic point with a time reference. */ interface TrackpointUniversal { [key: string]: any | any; /** * Latitude in degrees. */ latitude: number; /** * Longitude in degrees. */ longitude: number; /** * Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ time?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Result of delivering a product or rendering a service: * `DELIVERED` - the product is delivered / the service is rendered * `CANCELED` - the product is not delivered / the service is not rendered */ declare enum ProductConclusionTypeUniversal { DELIVERED = "DELIVERED", CANCELED = "CANCELED" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Result of processing a product or service within the demand. */ interface ProductConclusionUniversal { [key: string]: any | any; /** * The key of the product or service associated with the cargo, a unique identifier. */ product_key: string; /** * Product quantity. */ unit_quantity: number; type: ProductConclusionTypeUniversal; /** * Result of processing the `Honest Sign` marking. */ honest_sign_result?: string | null; /** * Reason for delivery/cancellation of the product. Select from a customizable list. */ reason?: string | null; /** * Free-form comment on the delivery/cancellation of the product. */ comment?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreDemandDoneUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Demand key, unique identifier. */ demand_key: string; /** * Place of creation of the fact. */ trackpoint: TrackpointUniversal; /** * List of results of processing products within the cargo. */ conclusions?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * New precedence of demand in the trip. */ interface TripDemandPrecedenceUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Demand key, unique identifier. */ demand_key: string; /** * New precedence of demand in the trip. */ new_precedence_in_trip: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreTripPrecedenceChangedUniversal { [key: string]: any | any; /** * New precedence of demands in the trip. */ demands_precedence: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreDemandStartUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Demand key, unique identifier. */ demand_key: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreJobDoneUniversal { [key: string]: any | any; /** * Essence key, unique identifier. */ job_key: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreOrderDoneUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreGeotrackUpdatedUniversal { [key: string]: any | any; /** * Performer key. */ performer_key: string; /** * An array of geographic points with time reference between which a path is built. */ geotrack: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreOrderCanceledUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Reason for cancellation of order. */ comment: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information for printing a receipt. */ interface CargoInvoiceReceiptUniversal { [key: string]: any | any; /** * User e-mail address. */ email?: string | null; /** * User phone. */ phone?: string | null; /** * The document used for payment. */ payment_document?: string | null; /** * External payment id. Filled out if fiscalization occurs on the seller\'s side. */ payment_external_id?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current status of the Electronic Waybill - the last completed title of the waybill: * `T1` - ready for shipment * `T2` - accepted for transportation by the performer and is in the transport * `T3` - the client is ready to unload the goods * `T4` - unloaded from the transport and handed over to the client * `T5` - the performer has specified the cost of transportation * `T6` - the shipper has confirmed the cost of transportation, the transportation is completed * `T7` - a redirection has been issued - the delivery address or the consignee has been changed * `T8` - a replacement of the driver and (or) the transport has been issued */ declare enum CargoInvoiceWaybillStatusUniversal { T1 = "T1", T2 = "T2", T3 = "T3", T4 = "T4", T5 = "T5", T6 = "T6", T7 = "T7", T8 = "T8" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Electronic Waybill. */ interface CargoInvoiceWaybillUniversal { [key: string]: any | any; status: CargoInvoiceWaybillStatusUniversal; /** * The key for the binary file uploaded to the repository. The rule for generating the key is: `company_name/account_name/YYYY/MM/DD/UID.extension`. May be `null`. */ transportation_qr_key?: string | null; /** * The key for the binary file uploaded to the repository. The rule for generating the key is: `company_name/account_name/YYYY/MM/DD/UID.extension`. May be `null`. */ transportation_file_key?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Value-added tax (VAT). */ declare enum CargoInvoiceTaxUniversal { VAT_NA = "VAT_NA", VAT_00 = "VAT_00", VAT_05 = "VAT_05", VAT_07 = "VAT_07", VAT_10 = "VAT_10", VAT_20 = "VAT_20", VAT_22 = "VAT_22", VAT_05_105 = "VAT_05_105", VAT_07_107 = "VAT_07_107", VAT_10_110 = "VAT_10_110", VAT_20_120 = "VAT_20_120", VAT_22_122 = "VAT_22_122" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information about the `Honest Sign` marking. */ interface CargoInvoiceHonestSignUniversal { [key: string]: any | any; /** * The label of the `Honest Sign` marking. */ label?: string | null; /** * The product requires the `Honest Sign` marking. */ marking_required?: boolean; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Invoice details for the product. */ interface CargoInvoiceDetailUniversal { [key: string]: any | any; /** * The key of the product or service associated with the cargo, a unique identifier. */ key: string; /** * Product name. */ full_name: string; /** * Product unit name. */ unit_name?: string | null; /** * Product unit price. */ unit_price: number; /** * Product quantity. */ unit_quantity: number; /** * External product identifier. */ external_id?: string | null; /** * Link to product description. */ external_url?: string | null; tax: CargoInvoiceTaxUniversal; honest_sign: CargoInvoiceHonestSignUniversal; /** * Barcode or QR-code. */ scan_code?: string | null; /** * Age restrictions apply (18+). */ age_restriction?: boolean; /** * The item being paid. For example, Product or Service. */ payment_subject_type?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cargo invoice. */ interface CargoInvoiceUniversal { [key: string]: any | any; /** * Product data. */ invoice_details: Array; /** * Flag indicating whether payment is required: * `true` - payment required * `false` - payment not required */ payable: boolean; /** * Prepayment amount. */ prepayment?: number; receipt?: CargoInvoiceReceiptUniversal | null; waybill?: CargoInvoiceWaybillUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Payment details. */ interface PaymentDetailsUniversal { [key: string]: any | any; /** * Invoice of the paid goods and services. Contains line items, prepayment amount, email/phone for sending the receipt. */ invoice: CargoInvoiceUniversal; /** * Total amount of the payment. */ receipt_amount: number; /** * Receipt QR-code. */ receipt_qr?: string | null; /** * Receipt number in the payment processor. */ receipt_processing_number: string; /** * Payment type. */ payment_type: string; /** * Final payment status. The list of values depends on the payment operator. */ payment_status: string; /** * A detailed description of the payment processing status, used to clarify payment processing errors. */ payment_status_detail?: string | null; /** * Payment time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ payment_time: string; /** * Payment (transaction) approval code. */ payment_approval_code?: string | null; /** * External payment identifier. Used to identify the payment in the seller\'s systems. */ payment_external_id?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreDemandPaymentUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Demand key, unique identifier. */ demand_key: string; payment_details: PaymentDetailsUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface LoreDemandCanceledUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * Demand key, unique identifier. */ demand_key: string; /** * Place of creation of the fact. */ trackpoint: TrackpointUniversal; /** * Reason for demand cancellation. Select from a customizable list. */ reason: string; /** * Free-form commentary on the cancellation of the demand. */ comment?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional data describing the fact. */ interface FactLoreUniversal { [key: string]: any | any; geotrack_updated?: LoreGeotrackUpdatedUniversal | null; order_done?: LoreOrderDoneUniversal | null; order_canceled?: LoreOrderCanceledUniversal | null; demand_start?: LoreDemandStartUniversal | null; demand_done?: LoreDemandDoneUniversal | null; demand_canceled?: LoreDemandCanceledUniversal | null; demand_payment?: LoreDemandPaymentUniversal | null; demand_precedence?: LoreTripPrecedenceChangedUniversal | null; job_done?: LoreJobDoneUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Possible fact types: * `GEOTRACK_UPDATED` - the performer changed his location during the trip * `ORDER_DONE` - the performer has finished fulfilling the order, the cargo associated with the order is no longer in the transport box * `ORDER_CANCELED` - the order has been canceled, the cargo associated with the order is no longer in the transport box * `DEMAND_START` - performer started to fulfill the demand * `DEMAND_DONE` - performer finished to fulfill the demand * `DEMAND_CANCELED` - the performer canceled the demand * `DEMAND_PAYMENT` - the performer received payment for the demand * `TRIP_PRECEDENCE_CHANGED` - the performer changed the precedence of the demands in the trip * `TRIP_RECEIVED` - the performer has received the trip * `TRIP_CONFIRMED` - the performer has agreed to perform the trip * `TRIP_REJECTED` - the performer has refused to perform the trip * `TRIP_EXECUTING` - the performer has started performing the trip * `TRIP_DONE` - the performer has completed the trip, all orders in the trip are fulfilled * `JOB_DONE` - the performer has finished custom job */ declare enum FactTypeUniversal { GEOTRACK_UPDATED = "GEOTRACK_UPDATED", ORDER_DONE = "ORDER_DONE", ORDER_CANCELED = "ORDER_CANCELED", DEMAND_START = "DEMAND_START", DEMAND_DONE = "DEMAND_DONE", DEMAND_CANCELED = "DEMAND_CANCELED", DEMAND_PAYMENT = "DEMAND_PAYMENT", TRIP_PRECEDENCE_CHANGED = "TRIP_PRECEDENCE_CHANGED", TRIP_RECEIVED = "TRIP_RECEIVED", TRIP_CONFIRMED = "TRIP_CONFIRMED", TRIP_REJECTED = "TRIP_REJECTED", TRIP_EXECUTING = "TRIP_EXECUTING", TRIP_DONE = "TRIP_DONE", JOB_DONE = "JOB_DONE" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current fact status: * `NEW` - the fact has been created and is awaiting system processing * `APPLIED` - the fact has been processed by the system and applied to the data * `ERROR` - an error occurred while processing the fact; the sender must correct the fact and resubmit */ declare enum FactStatusUniversal { NEW = "NEW", APPLIED = "APPLIED", ERROR = "ERROR" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Typed fact processing error (set when status is `ERROR`): * `DUPLICATE` - the fact is a duplicate of a previously processed fact * `INCONSISTENT_REFERENCE` - the fact references a non-existent or inconsistent entity * `INCONSISTENT_STATUS` - the fact cannot be applied to the current status of the entity * `INCONSISTENT_TIME` - fact creation time is later than `current_time` + `fact_processing_threshold` */ declare enum FactStatusErrorUniversal { DUPLICATE = "DUPLICATE", INCONSISTENT_REFERENCE = "INCONSISTENT_REFERENCE", INCONSISTENT_STATUS = "INCONSISTENT_STATUS", INCONSISTENT_TIME = "INCONSISTENT_TIME" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Fact is an action completed during the execution of a trip. */ interface FactUniversal { [key: string]: any | any; /** * Fact key. */ key: string; type: FactTypeUniversal; /** * Fact creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ creation_date: string; /** * Date and time of receipt of the fact by the server in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ readonly reception_date?: string | null; /** * Date and time of execution the fact by the server in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ readonly execution_date?: string | null; status: FactStatusUniversal; readonly status_error?: FactStatusErrorUniversal | null; /** * Additional information about the fact status, used to clarify fact processing errors. */ status_detail?: string | null; /** * Trip key, unique identifier. */ trip_key: string; lore?: FactLoreUniversal | null; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the location with transport](#section/Description/Compatibilities). */ interface LocationCompatibilitiesUniversal { [key: string]: any | any; /** * A list of tags that define a property or requirement. */ transport_restrictions?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Geographical point. */ interface GeopointUniversal { [key: string]: any | any; /** * Latitude in degrees. */ latitude: number; /** * Longitude in degrees. */ longitude: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Limitation on the capacity of a location during a certain time period. */ interface LocationLimitUniversal { [key: string]: any | any; /** * Constraint key, unique identifier. */ key: string; /** * Time window for the restriction. */ time_window: TimeWindowUniversal; /** * A function that describes the limitation of a location\'s ability to handle cargo and penalties for violating the restrictions. Penalties are cumulative independently for each qualifying part of the function. */ min_cargos?: Array; /** * A function that describes the limitation of a location\'s ability to handle cargo and penalties for violating the restrictions. Penalties are cumulative independently for each qualifying part of the function. */ max_cargos?: Array; /** * A function that describes the limitation of a location’s ability to serve transport and penalties for violating the restrictions. Penalties are cumulative independently for each qualifying part of the function. */ min_transports?: Array; /** * A function that describes the limitation of a location’s ability to serve transport and penalties for violating the restrictions. Penalties are cumulative independently for each qualifying part of the function. */ max_transports?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Location - unique geographical location of the object with accessibility parameters. */ interface LocationTimetableElementUniversal { [key: string]: any | any; /** * Time window for location availability. */ work_window: TimeWindowUniversal; /** * List of bandwidth restrictions inside the working window of the location. Constraint time windows cannot overlap and must total `work_window`. */ limits?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Location - unique geographical location of the object with accessibility parameters. */ interface LocationUniversal { [key: string]: any | any; /** * Location key, unique identifier. */ key: string; geopoint: GeopointUniversal; /** * Time duration according to `P1DT2H12M34.2S`. */ arrival_duration?: string; /** * Time duration according to `P1DT2H12M34.2S`. */ departure_duration?: string; /** * Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions. */ timetable?: Array; compatibilities?: LocationCompatibilitiesUniversal | null; /** * Name, information field. */ name?: string; /** * Full location address. */ address?: string | null; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Contact details of the final recipient of the goods or services. */ interface PossibleEventContactUniversal { [key: string]: any | any; /** * Full name of the final recipient of the goods or services. */ recipient_name: string; /** * Phone number of the final recipient of the goods or services. */ recipient_phone: string; /** * Free-form commentary on contact information. */ comment?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Possible event. Combines the geographical location and the time window, when a demand can be completed. */ interface PossibleEventUniversal { [key: string]: any | any; /** * Event key, unique identifier. */ key: string; /** * Location key, where this event is possible. */ location_key: string; /** * Time duration according to `P1DT2H12M34.2S`. */ duration?: string; /** * Reward for completing this event. */ reward?: number; /** * A hard time window within which an event must occur. The window duration cannot be less than the `duration` of the event. Cannot be violated during planning. */ hard_time_window: TimeWindowUniversal; soft_time_window?: TimeWindowUniversal | null; /** * Attributes. Used to add service information. */ attributes?: Array; contact?: PossibleEventContactUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Demand types: * `PICKUP` - loading * `DROP` - unloading * `WORK` - work at the location * `PICKUP_TO_BOX` - loading to box * `DROP_FROM_BOX` - unloading from box */ declare enum DemandTypeUniversal { PICKUP = "PICKUP", DROP = "DROP", WORK = "WORK", PICKUP_TO_BOX = "PICKUP_TO_BOX", DROP_FROM_BOX = "DROP_FROM_BOX" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Request for a single action with a cargo (pickup / drop) or work at a location. */ interface DemandUniversal { [key: string]: any | any; /** * Demand key, unique identifier. */ key: string; demand_type: DemandTypeUniversal; /** * The list of cargo keys depends on the type of order in which the cargoes are located: * `PICKUP` - list of keys * `DROP` - one key * `WORK` - empty list * `PICKUP_TO_BOX` - one key * `DROP_FROM_BOX` - one key */ target_cargos?: Array; /** * Precedence within a trip, 0 - the precedence is not taken into account. */ precedence_in_trip?: number; /** * Precedence within an order, 0 - the precedence is not taken into account. */ precedence_in_order?: number; /** * List of possible time windows and location keys to fulfil an order. */ possible_events: Array; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the order with performers and other orders](#section/Description/Compatibilities). */ interface OrderCompatibilitiesUniversal { [key: string]: any | any; /** * A list of tags that define a property or requirement. */ order_features?: Array; /** * A list of tags that define a property or requirement. */ order_restrictions?: Array; /** * A list of tags that define a property or requirement. */ performer_restrictions?: Array; /** * A list of tags that define a property or requirement. */ performer_blacklist?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current order status: * `FREE` - the order is not assigned to any trip, initial status, awaiting assignment * `PLANNED` - the order is planned to a trip, awaiting the start of execution * `EXECUTING` - the order is in progress, awaiting completion * `FINISHED` - the order has been completed, all demands are done, final status * `CANCELED` - the order has been canceled, final status */ declare enum OrderStatusUniversal { FREE = "FREE", PLANNED = "PLANNED", EXECUTING = "EXECUTING", FINISHED = "FINISHED", CANCELED = "CANCELED" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The ability of the cargo to rotate in 90 degree increments around the axes: * `ALL` - any axes. * `YAW` - around the Z axis. * `PITCH` - around the Y axis. * `ROLL` - around the X axis. */ declare enum CargoRotationTypeUniversal { ALL = "ALL", YAW = "YAW", PITCH = "PITCH", ROLL = "ROLL" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Compatibilities of [the cargo with the transport box and other cargos](#section/Description/Compatibilities). */ interface CargoCompatibilitiesUniversal { [key: string]: any | any; /** * Width in meters, used to check the transport box capacity. */ width?: number; /** * Height in meters, used to check the transport box capacity. */ height?: number; /** * Length in meters, used to check the transport box capacity. */ length?: number; /** * List of possibilities of a object rotations (90 degree step): * `ALL` - can rotate by any axis * `YAW` - can yaw * `PITCH` - can pitch * `ROLL` - can roll Empty list means object rotations is prohibited. More about [cargo placement](#section/Description/Cargo-placement). */ rotation?: Array; /** * A list of tags that define a property or requirement. */ box_restrictions?: Array; /** * A list of tags that define a property or requirement. */ cargo_features?: Array; /** * A list of tags that define a property or requirement. */ cargo_restrictions?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Cargo. Regardless of capacity, cargo can only move inside the transport box. */ interface CargoUniversal { [key: string]: any | any; /** * Cargo key, unique identifier. */ key: string; capacity?: CapacityUniversal | null; compatibilities?: CargoCompatibilitiesUniversal | null; /** * The key of the transport box in which the cargo is already located. Applicable only for cargo that is in the order with the type `DROP_FROM_BOX`. For other order types, the key must be empty. */ target_box_key?: string | null; invoice?: CargoInvoiceUniversal | null; /** * Attributes. Used to add service information. */ attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The order for delivery/transportation, contains a list of demands. */ interface OrderUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ key: string; /** * Demands list. */ demands: Array; /** * The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type `WORK`. */ cargos?: Array; compatibilities?: OrderCompatibilitiesUniversal | null; /** * Name, information field. */ name?: string; /** * Attributes. Used to add service information. */ attributes?: Array; status?: OrderStatusUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Routing matrix waypoint. */ interface RoutingMatrixWaypointUniversal { [key: string]: any | any; geopoint: GeopointUniversal; /** * Name of the point. Can be used as an identifier to match the task and the calculation result. */ name?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Routing matrix. Contains durations and distances between points. */ interface RoutingMatrixUniversal { [key: string]: any | any; /** * Array of geographical points with distances and times calculated between them. */ waypoints: Array; /** * Routes length between two neighbors locations, in meters. The values in the array are ordered according to the elements order in the `waypoints` parameter. Each matrix row is an array of distances from the desired point to every other point. A negative value (-1) means that it is not possible to drive between the specified locations. */ distances: Array>; /** * An array of route durations between points, in seconds. The values in the array are ordered according to the order of the elements in the `waypoints` parameter. Each row of the matrix is an array of travel times from the desired point to each other point. A negative value (-1) means that it is impossible to travel between the specified points. */ durations: Array>; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Time-distance matrix for a specific transport type. */ interface RoutingTransportMatrixUniversal { [key: string]: any | any; transport_type: TransportTypeUniversal; matrix: RoutingMatrixUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * VRt.Universal JSON format. A general list of data and settings that combines all data for planning, replaning and actualization. */ interface UniversalDataUniversal { [key: string]: any | any; /** * List of locations used for orders and shifts. */ locations?: Array; /** * List of orders that need to be completed. */ orders?: Array; /** * Available performers list. The performer fulfills orders using transport. */ performers?: Array; /** * Available transports list. Transport is used by the trip performer to fulfill orders. */ transports?: Array; /** * Assignments list. */ hardlinks?: Array; /** * Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ trips?: Array; /** * List of facts. A fact is an event that has occurred that affects further trip operations. */ facts?: Array; statistics?: PlanStatisticsUniversal | null; /** * List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account. */ external_routing?: Array; plan_settings?: PlanSettingsUniversal; replan_settings?: ReplanSettingsUniversal; actualize_settings?: ActualizeSettingsUniversal; /** * The name of the dataset. A technical field that does not affect calculation. */ dataset_name?: string; } /** * Standard parameter styles defined by OpenAPI spec */ type StandardParamStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject'; /** * The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user. */ type ParamStyle = StandardParamStyle | string; /** * Standard parameter locations defined by OpenAPI spec */ type ParamLocation = 'query' | 'header' | 'path' | 'cookie'; /** * Standard types as defined in OpenAPI Specification: Data Types */ type StandardDataType = "integer" | "number" | "boolean" | "string" | "object" | "array"; /** * Standard {@link DataType}s plus your own types/classes. */ type DataType = StandardDataType | string; /** * Standard formats as defined in OpenAPI Specification: Data Types */ type StandardDataFormat = "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password"; type DataFormat = StandardDataFormat | string; /** * The parameter to encode. */ interface Param { name: string; value: unknown; in: ParamLocation; style: ParamStyle; explode: boolean; dataType: DataType; dataFormat: DataFormat | undefined; } interface ConfigurationParameters { /** * @deprecated Since 5.0. Use credentials instead */ apiKeys?: { [key: string]: string; }; username?: string; password?: string; /** * @deprecated Since 5.0. Use credentials instead */ accessToken?: string | (() => string); basePath?: string; withCredentials?: boolean; /** * Takes care of encoding query- and form-parameters. */ encoder?: HttpParameterCodec; /** * Override the default method for encoding path parameters in various * styles. *

* See {@link README.md} for more details *

*/ encodeParam?: (param: Param) => string; /** * The keys are the names in the securitySchemes section of the OpenAPI * document. They should map to the value used for authentication * minus any standard prefixes such as 'Basic' or 'Bearer'. */ credentials?: { [key: string]: string | (() => string | undefined); }; } declare class Configuration { /** * @deprecated Since 5.0. Use credentials instead */ apiKeys?: { [key: string]: string; }; username?: string; password?: string; /** * @deprecated Since 5.0. Use credentials instead */ accessToken?: string | (() => string); basePath?: string; withCredentials?: boolean; /** * Takes care of encoding query- and form-parameters. */ encoder?: HttpParameterCodec; /** * Encoding of various path parameter * styles. *

* See {@link README.md} for more details *

*/ encodeParam: (param: Param) => string; /** * The keys are the names in the securitySchemes section of the OpenAPI * document. They should map to the value used for authentication * minus any standard prefixes such as 'Basic' or 'Bearer'. */ credentials: { [key: string]: string | (() => string | undefined); }; constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder, password, username, withCredentials }?: ConfigurationParameters); /** * Select the correct content-type to use for a request. * Uses {@link Configuration#isJsonMime} to determine the correct content-type. * If no content type is found return the first found type if the contentTypes is not empty * @param contentTypes - the array of content types that are available for selection * @returns the selected content-type or undefined if no selection could be made. */ selectHeaderContentType(contentTypes: string[]): string | undefined; /** * Select the correct accept content-type to use for a request. * Uses {@link Configuration#isJsonMime} to determine the correct accept content-type. * If no content type is found return the first found type if the contentTypes is not empty * @param accepts - the array of content types that are available for selection. * @returns the selected content-type or undefined if no selection could be made. */ selectHeaderAccept(accepts: string[]): string | undefined; /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; lookupCredential(key: string): string | undefined; addCredentialToHeaders(credentialKey: string, headerName: string, headers: HttpHeaders, prefix?: string): HttpHeaders; addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams; private defaultEncodeParam; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ declare class BaseService { protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(basePath?: string | string[], configuration?: Configuration); protected canConsumeForm(consumes: string[]): boolean; protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep?: boolean): HttpParams; protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep?: boolean): HttpParams; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional attributes for target essence. */ interface AdditionalAttributesElementUniversal { [key: string]: any | any; /** * Key, unique identifier. */ target_key: string; /** * Attributes. Used to add service information. */ attributes: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Additional attributes. */ interface AdditionalAttributesUniversal { [key: string]: any | any; /** * Essences keys list. */ location_attributes?: Array; /** * Essences keys list. */ order_attributes?: Array; /** * Essences keys list. */ performer_attributes?: Array; /** * Essences keys list. */ transport_attributes?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Service name. */ declare enum ServiceUniversal { UNIVERSAL = "UNIVERSAL", ROUTING = "ROUTING", ACCOUNT = "ACCOUNT", ADMIN = "ADMIN", STUDIO = "STUDIO", MONITOR = "MONITOR", PACKER = "PACKER", AGRO = "AGRO", REGISTRY = "REGISTRY", SUPPORT = "SUPPORT" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Data for request tracing. */ interface TracedataUniversal { [key: string]: any | any; /** * Unique process identifier. One is created per process, the same for different requests for the same process. */ process_code: string; /** * Unique identifier of the request. A new one is created for each request. */ request_code: string; /** * Unique username for login. */ username: string; /** * Unique company key. */ company: string; service: ServiceUniversal; /** * Operation (request) name. */ operation: string; /** * Environment identifier. */ env: string; /** * Pod identifier. */ pod: string; /** * Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. */ time: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The result of starting an asynchronous calculation. */ interface CalculationAsyncResultUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Unique process identifier. One is created per process, the same for different requests for the same process. */ process_code: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation status: * `WAITING` - the calculation is waiting to be launched. * `IN_PROGRESS` - calculation in progress. * `FINISHED_IN_TIME` - the calculation completed correctly before the specified maximum time. * `FINISHED_OUT_OF_TIME` - the calculation ended because the specified time for calculation has expired, which can affect the quality of the result for the worse. * `CANCELED` - the calculation was canceled because a cancel command was received. * `CANCELED_BY_TIMEOUT` - the calculation was canceled automatically because the waiting time in the queue was exceeded. * `CANCELED_BY_QUOTA` - the calculation was canceled because the quota for this calculation type was exceeded. * `FAILED` - calculation completed with an error. */ declare enum CalculationStatusUniversal { WAITING = "WAITING", IN_PROGRESS = "IN_PROGRESS", FINISHED_IN_TIME = "FINISHED_IN_TIME", FINISHED_OUT_OF_TIME = "FINISHED_OUT_OF_TIME", CANCELED = "CANCELED", CANCELED_BY_TIMEOUT = "CANCELED_BY_TIMEOUT", CANCELED_BY_QUOTA = "CANCELED_BY_QUOTA", FAILED = "FAILED" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Calculation information. */ interface CalculationInfoUniversal { [key: string]: any | any; status: CalculationStatusUniversal; /** * Message with additional information about the calculation status. */ message?: string | null; /** * Planning result version. */ result_version: number; /** * Time duration according to `P1DT2H12M34.2S`. */ preparing_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ business_validation_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ math_validation_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ waiting_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ calculation_time: string; /** * Time duration according to `P1DT2H12M34.2S`. */ postprocessing_time?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Current calculation state. */ interface CalculationStateUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Calculation progress as a percentage. The progress displays the current number of completed steps. */ calculation_progress: number; calculation_info: CalculationInfoUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Service availability result. */ interface CheckResultUniversal { [key: string]: any | any; /** * The current health indicator of the service. * `0.0` means the service is not ready to perform tasks. * `1.0` means the service is fully ready to perform tasks. */ health: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error type: * `INCONSISTENT_REFERENCE` - bad reference key * `UNIQUE_IDS_VIOLATION` - all keys must be unique * `INVALID_ROUTING_MATRIX` - bad routing matrix dimension * `INVALID_GEO_PROVIDER` - bad geo provider * `INVALID_TIME_WINDOW` - bad time window * `COMPATIBILITY_CARGO_BOX` - no cargo is compatible with any box * `COMPATIBILITY_TRANSPORT_PERFORMER` - no transport is compatible with any performer * `COMPATIBILITY_TRANSPORT_LOCATION` - no transport is compatible with any location * `COMPATIBILITY_ORDER_PERFORMER` - no order is compatible with any performer * `INCONSISTENT_HARDLINK` - essence key must be only in one hardlink * `PLANNING_HORIZON_EXCEEDED` - planning horizon exceeded (difference between earliest and latest timestamp in dataset) * `MEANINGLESS_RESTRICTIONS` - the specified restrictions do not make sense * `LOCATION_LIMITS_VIOLATION` - the time windows of the constraint\'s validity must not overlap and their union must correspond to the location availability window `work_window`; if the `min_cargos`/`min_transports` constraint is specified, then the `max_cargos`/`max_transports` constraint must be specified; the `min_cargos`/`min_transports` constraints must be less than all the `max_cargos`/`max_transports` constraints; the `LOWEST_COST` time selection strategy is specified (currently not supported) * `PERFORMER_WRR_MUST_BE_SET` - at least one of the fields `rest_rules` or `break_rules` must be set for the work and rest schedule. * `PERFORMER_WRR_INVALID_REST_COUNT` - the number of rests cannot exceed 14 * `PERFORMER_WRR_INVALID_BREAK_COUNT` - no more than 14 breaks can start between rests * `PERFORMER_WRR_MEANINGLESS_REST` - the specified rest cannot be inserted * `PERFORMER_WRR_MEANINGLESS_BREAK` - the specified break cannot be inserted * `TOO_MANY_WARNINGS` - the number of warnings is greater than 15001 * `UNCLASSIFIED_ERROR` - unclassified error */ declare enum EntityErrorTypeUniversal { INCONSISTENT_REFERENCE = "INCONSISTENT_REFERENCE", UNIQUE_IDS_VIOLATION = "UNIQUE_IDS_VIOLATION", INVALID_ROUTING_MATRIX = "INVALID_ROUTING_MATRIX", INVALID_GEO_PROVIDER = "INVALID_GEO_PROVIDER", INVALID_TIME_WINDOW = "INVALID_TIME_WINDOW", COMPATIBILITY_CARGO_BOX = "COMPATIBILITY_CARGO_BOX", COMPATIBILITY_TRANSPORT_PERFORMER = "COMPATIBILITY_TRANSPORT_PERFORMER", COMPATIBILITY_TRANSPORT_LOCATION = "COMPATIBILITY_TRANSPORT_LOCATION", COMPATIBILITY_ORDER_PERFORMER = "COMPATIBILITY_ORDER_PERFORMER", INCONSISTENT_HARDLINK = "INCONSISTENT_HARDLINK", PLANNING_HORIZON_EXCEEDED = "PLANNING_HORIZON_EXCEEDED", MEANINGLESS_RESTRICTIONS = "MEANINGLESS_RESTRICTIONS", LOCATION_LIMITS_VIOLATION = "LOCATION_LIMITS_VIOLATION", PERFORMER_WRR_MUST_BE_SET = "PERFORMER_WRR_MUST_BE_SET", PERFORMER_WRR_INVALID_REST_COUNT = "PERFORMER_WRR_INVALID_REST_COUNT", PERFORMER_WRR_INVALID_BREAK_COUNT = "PERFORMER_WRR_INVALID_BREAK_COUNT", PERFORMER_WRR_MEANINGLESS_REST = "PERFORMER_WRR_MEANINGLESS_REST", PERFORMER_WRR_MEANINGLESS_BREAK = "PERFORMER_WRR_MEANINGLESS_BREAK", TOO_MANY_WARNINGS = "TOO_MANY_WARNINGS", UNCLASSIFIED_ERROR = "UNCLASSIFIED_ERROR" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Entity type. */ declare enum EntityTypeUniversal { TASK = "TASK", SETTINGS = "SETTINGS", ORDER = "ORDER", ORDER_LINK = "ORDER_LINK", PERFORMER = "PERFORMER", PERFORMER_LINK = "PERFORMER_LINK", TRANSPORT = "TRANSPORT", TRANSPORT_LINK = "TRANSPORT_LINK", HARDLINK = "HARDLINK", HARDLINK_LINK = "HARDLINK_LINK", LOCATION = "LOCATION", LOCATION_LINK = "LOCATION_LINK", BOX = "BOX", BOX_LINK = "BOX_LINK", TRIP = "TRIP", TRIP_LINK = "TRIP_LINK", CARGO = "CARGO", CARGO_LINK = "CARGO_LINK", DEMAND = "DEMAND", DEMAND_LINK = "DEMAND_LINK", EVENT = "EVENT", EVENT_LINK = "EVENT_LINK", PERFORMER_SHIFT = "PERFORMER_SHIFT", PERFORMER_SHIFT_LINK = "PERFORMER_SHIFT_LINK", TRANSPORT_SHIFT = "TRANSPORT_SHIFT", TRANSPORT_SHIFT_LINK = "TRANSPORT_SHIFT_LINK", FACT = "FACT", FACT_LINK = "FACT_LINK" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * The description of the entity and the path to it. */ interface EntityPathUniversal { [key: string]: any | any; /** * Target entity key. */ entity_key: string | null; entity_type: EntityTypeUniversal; child_entity?: EntityPathUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Description of the error in the input data. */ interface EntityErrorUniversal { [key: string]: any | any; type: EntityErrorTypeUniversal; /** * Information about error. */ info?: string | null; /** * List of entities related to error. */ entities: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Warning type: * `NO_AVAILABLE_TRANSPORT` - the order cannot be fulfilled, since there is no available (by shift limitations) transport * `NO_AVAILABLE_PERFORMER` - the order cannot be fulfilled, since there is not a single available (by shift limitations) performer * `NO_COMPATIBLE_TRANSPORT` - the order cannot be completed, since there is not a single compatible (in terms of capacity and \\ or compatibility tags) transport * `NO_COMPATIBLE_PERFORMER` - the order cannot be completed, since there is not a single compatible (by compatibility tags) performer * `NO_AVAILABLE_ORDER_FOR_TRANSPORT` - the transport is useless, since there are no compatible (by capacity and/or compatibility tags) orders * `NO_AVAILABLE_ORDER_FOR_PERFORMER` - the performer is useless, since there are no compatible (by capacity and/or compatibility tags) orders * `NO_COMPATIBLE_ORDER_FOR_TRANSPORT` - the transport is useless, since there are no available (by shift restrictions) orders * `NO_COMPATIBLE_ORDER_FOR_PERFORMER` - the performer is useless, since there are no available (by shift restrictions) orders * `PICKUP_AND_DROP_VIOLATION` - for each cargo within the order there must be exactly one loading and exactly one unloading (except for `PICKUP_TO_BOX` and `DROP_FROM_BOX` orders) * `PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_ORDER` - for each cargo within the order, loading must go before unloading (`precedence_in_order`) * `PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_TRIP` - conflicting requirements for the precedence of orders were specified (`precedence_in_trip`) * `VIOLATION_PRECEDENCE_IN_TRIP_AND_ORDER` - requirements for the precedence of orders in the trip (`precedence_in_trip`) and in the order (` precedence_in_order`) contradict each other * `TIME_WINDOW_VIOLATION` - the start time of the time window is later than the end time of the window or time window exceeds the maximum allowed * `DURATION_VIOLATION` - duration does not correspond to the allowed interval * `ORDER_WINDOWS_INTERSECTION_VIOLATION` - soft windows should not go beyond the boundaries of the hard window * `PERFORMER_SHIFTS_INTERSECTION_VIOLATION` - time ranges of the performer\'s work shifts must not overlap, the beginning of the next window cannot be equal to the end of the previous one * `TRANSPORT_SHIFTS_INTERSECTION_VIOLATION` - time ranges of transport work shifts should not overlap, the beginning of the next window cannot be equal to the end of the previous one * `LOCATION_WINDOWS_INTERSECTION_VIOLATION` - time ranges of working windows of one location should not intersect, the beginning of the next window cannot be equal to the end of the previous one * `NO_TRANSPORT_BOXES` - if there are orders with cargo, then the transport must have at least one box * `MAX_CAPACITY_VIOLATION` - `max_capacity` limit exceeds the total capacity of all boxes or set for only one box or less than the capacity of some box * `MAX_BOXES_VIOLATION` - limit `max_boxes` is greater than or equal to the total number of boxes or specified for one box or equal to zero * `TOO_MANY_CARGOS_FOR_DROP_VIOLATION` - the number of loads for an order of the` DROP` / `DROP_FROM_BOX` type must be no more than one * `EMPTY_CARGOES_LIST` - empty list of loads for orders of type `DROP` / `DROP_FROM_BOX` / `PICKUP` / `PICKUP_TO_BOX` * `CARGO_WORK_VIOLATION` - for a `WORK` order, the cargo list must be empty * `GEODATA_TIME_WINDOW_VIOLATION` - the planning horizon exceeds the maximum available value * `SHIFT_RESTRICTIONS_COULD_BE_MORE_PRECISE` - the `working_window` of the performer\'s shift does not lie entirely inside the availability window `availability_window` * `DURATION_DOES_NOT_FIT_INTO_HARD_WINDOW` - the duration of the event does not fit into the hard time window * `DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW` - the duration of the event does not fit into the soft time window * `EXTRA_DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW` - additional time for demand execution does not fit into the soft time window * `MAX_CALCULATION_TIME_VIOLATION` - the maximum allowable calculation time has been exceeded * `MAX_WAITING_TIME_VIOLATION` - the maximum allowable waiting time in queue has been exceeded * `INVALID_HARDLINK` - it is impossible to assign an order with demands with the `WORK` type to transport * `CARGO_BOX_VIOLATION` - for requests of all types except `DROP_FROM_BOX` the key of the box where the cargo is located must be empty * `CARGO_MULTIBOX_VIOLATION` - for a demand of type `DROP_FROM_BOX` the indicated cargos are in boxes of different transports * `CARGO_CAPACITY_VIOLATION` - the specified cargo on board exceeds the size of the box in which it is located * `CARGO_ORDER_VIOLATION` - the cargo specified in the order is not present in orders * `FEATURE_LIFETIME_VIOLATION` - feature time windows intersect with each other, or the `working_window` of the performer\'s or transport\'s shift does not intersect with the feature time window * `QUOTA_EXCEEDED` - service quota exceeded * `MAX_LOCATIONS_LIMITS_PENALTY_EXCEEDED` - the resulting solution does not satisfy the `max_locations_limits_penalty` requirement * `REMOVED_ITEMS_NOT_EMPTY` - during data validation, items were removed from the original dataset, the list of removed items is in the `removed_items` object * `INCOMPATIBLE_REQUIREMENTS` - incompatible requirements are specified: location load accounting and soft window optimization. * `UNCLASSIFIED_WARNING` - unclassified warning */ declare enum EntityWarningTypeUniversal { NO_AVAILABLE_TRANSPORT = "NO_AVAILABLE_TRANSPORT", NO_AVAILABLE_PERFORMER = "NO_AVAILABLE_PERFORMER", NO_COMPATIBLE_TRANSPORT = "NO_COMPATIBLE_TRANSPORT", NO_COMPATIBLE_PERFORMER = "NO_COMPATIBLE_PERFORMER", NO_AVAILABLE_ORDER_FOR_TRANSPORT = "NO_AVAILABLE_ORDER_FOR_TRANSPORT", NO_AVAILABLE_ORDER_FOR_PERFORMER = "NO_AVAILABLE_ORDER_FOR_PERFORMER", NO_COMPATIBLE_ORDER_FOR_TRANSPORT = "NO_COMPATIBLE_ORDER_FOR_TRANSPORT", NO_COMPATIBLE_ORDER_FOR_PERFORMER = "NO_COMPATIBLE_ORDER_FOR_PERFORMER", PICKUP_AND_DROP_VIOLATION = "PICKUP_AND_DROP_VIOLATION", PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_ORDER = "PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_ORDER", PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_TRIP = "PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_TRIP", VIOLATION_PRECEDENCE_IN_TRIP_AND_ORDER = "VIOLATION_PRECEDENCE_IN_TRIP_AND_ORDER", TIME_WINDOW_VIOLATION = "TIME_WINDOW_VIOLATION", DURATION_VIOLATION = "DURATION_VIOLATION", ORDER_WINDOWS_INTERSECTION_VIOLATION = "ORDER_WINDOWS_INTERSECTION_VIOLATION", PERFORMER_SHIFTS_INTERSECTION_VIOLATION = "PERFORMER_SHIFTS_INTERSECTION_VIOLATION", TRANSPORT_SHIFTS_INTERSECTION_VIOLATION = "TRANSPORT_SHIFTS_INTERSECTION_VIOLATION", LOCATION_WINDOWS_INTERSECTION_VIOLATION = "LOCATION_WINDOWS_INTERSECTION_VIOLATION", NO_TRANSPORT_BOXES = "NO_TRANSPORT_BOXES", MAX_CAPACITY_VIOLATION = "MAX_CAPACITY_VIOLATION", MAX_BOXES_VIOLATION = "MAX_BOXES_VIOLATION", TOO_MANY_CARGOS_FOR_DROP_VIOLATION = "TOO_MANY_CARGOS_FOR_DROP_VIOLATION", EMPTY_CARGOES_LIST = "EMPTY_CARGOES_LIST", CARGO_WORK_VIOLATION = "CARGO_WORK_VIOLATION", GEODATA_TIME_WINDOW_VIOLATION = "GEODATA_TIME_WINDOW_VIOLATION", SHIFT_RESTRICTIONS_COULD_BE_MORE_PRECISE = "SHIFT_RESTRICTIONS_COULD_BE_MORE_PRECISE", DURATION_DOES_NOT_FIT_INTO_HARD_WINDOW = "DURATION_DOES_NOT_FIT_INTO_HARD_WINDOW", DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW = "DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW", EXTRA_DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW = "EXTRA_DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW", MAX_CALCULATION_TIME_VIOLATION = "MAX_CALCULATION_TIME_VIOLATION", MAX_WAITING_TIME_VIOLATION = "MAX_WAITING_TIME_VIOLATION", INVALID_HARDLINK = "INVALID_HARDLINK", CARGO_BOX_VIOLATION = "CARGO_BOX_VIOLATION", CARGO_MULTIBOX_VIOLATION = "CARGO_MULTIBOX_VIOLATION", CARGO_CAPACITY_VIOLATION = "CARGO_CAPACITY_VIOLATION", CARGO_ORDER_VIOLATION = "CARGO_ORDER_VIOLATION", FEATURE_LIFETIME_VIOLATION = "FEATURE_LIFETIME_VIOLATION", QUOTA_EXCEEDED = "QUOTA_EXCEEDED", MAX_LOCATIONS_LIMITS_PENALTY_EXCEEDED = "MAX_LOCATIONS_LIMITS_PENALTY_EXCEEDED", REMOVED_ITEMS_NOT_EMPTY = "REMOVED_ITEMS_NOT_EMPTY", INCOMPATIBLE_REQUIREMENTS = "INCOMPATIBLE_REQUIREMENTS", UNCLASSIFIED_WARNING = "UNCLASSIFIED_WARNING" } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Description of the warning of the input data. */ interface EntityWarningUniversal { [key: string]: any | any; type: EntityWarningTypeUniversal; /** * Information about warning. */ info?: string | null; /** * List of entities related to warning. */ entities: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Processed fact. */ interface FactResultUniversal { [key: string]: any | any; /** * Fact key. */ fact_key: string; type: FactTypeUniversal; status: FactStatusUniversal; readonly status_error?: FactStatusErrorUniversal | null; /** * Additional information about the fact status, used to clarify fact processing errors. */ status_detail?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error details for 402 `Payment Required`. */ interface General402Universal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Error message. */ message?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error details for 403 `Forbidden`. */ interface General403Universal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Error message. */ message?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Resource details. */ interface General404DetailUniversal { [key: string]: any | any; tracedata: TracedataUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * 404 Error details. */ interface General404Universal { [key: string]: any | any; /** * Resource identifier. */ resource_key?: string | null; detail?: General404DetailUniversal | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error details for 429 `Too Many Requests`. */ interface General429Universal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Error message. */ message?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error details for 500 `Internal Server Error`. */ interface General500Universal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Error message. */ message?: string | null; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Processed order. */ interface OrderResultUniversal { [key: string]: any | any; /** * Order key, unique identifier. */ order_key: string; /** * New order status set as a result of processing. */ status: OrderStatusUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information about removed essences. */ interface RemovedItemsUniversal { [key: string]: any | any; /** * Essences keys list. */ location_keys?: Array; /** * Essences count. */ location_keys_count?: number; /** * Essences keys list. */ order_keys?: Array; /** * Essences count. */ order_keys_count?: number; /** * Essences keys list. */ performer_keys?: Array; /** * Essences count. */ performer_keys_count?: number; /** * Essences keys list. */ transport_keys?: Array; /** * Essences count. */ transport_keys_count?: number; /** * Essences keys list. */ hardlink_keys?: Array; /** * Essences count. */ hardlink_keys_count?: number; /** * Essences keys list. */ fact_keys?: Array; /** * Essences count. */ fact_keys_count?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information about unplanned essences. */ interface UnplannedItemsUniversal { [key: string]: any | any; /** * Essences keys list. */ order_keys?: Array; /** * Essences count. */ order_keys_count?: number; /** * Essences keys list. */ performer_keys?: Array; /** * Essences count. */ performer_keys_count?: number; /** * Essences keys list. */ transport_keys?: Array; /** * Essences count. */ transport_keys_count?: number; /** * Essences keys list. */ hardlink_keys?: Array; /** * Essences count. */ hardlink_keys_count?: number; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Plan result. It can be intermediate (during the calculation process) and complete (after the calculation is completed). */ interface PlanResultUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ trips: Array; statistics: PlanStatisticsUniversal | null; additional_attributes?: AdditionalAttributesUniversal | null; /** * Warning list. */ warnings?: Array; unplanned_items?: UnplannedItemsUniversal; removed_items?: RemovedItemsUniversal; /** * Calculation progress as a percentage. The progress displays the current number of completed steps. */ calculation_progress: number; calculation_info: CalculationInfoUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Task for planning */ interface PlanTaskUniversal { [key: string]: any | any; /** * List of locations used for orders and shifts. */ locations: Array; /** * List of orders that need to be completed. */ orders: Array; /** * Available performers list. The performer fulfills orders using transport. */ performers: Array; /** * Available transports list. Transport is used by the trip performer to fulfill orders. */ transports: Array; /** * Assignments list. */ hardlinks?: Array; plan_settings?: PlanSettingsUniversal; /** * List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account. */ external_routing?: Array; /** * The name of the dataset. A technical field that does not affect calculation. */ dataset_name?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Information about processed and created items. */ interface ProcessedItemsUniversal { [key: string]: any | any; /** * Processed facts with current status. */ processed_facts?: Array; /** * List of facts. A fact is an event that has occurred that affects further trip operations. */ created_facts?: Array; /** * Processed orders with current status. */ processed_orders?: Array; /** * List of locations used for orders and shifts. */ created_locations?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Refine result. */ interface RefineResultUniversal { [key: string]: any | any; tracedata: TracedataUniversal; plan_task: PlanTaskUniversal; processed_items?: ProcessedItemsUniversal; removed_items?: RemovedItemsUniversal; /** * Warning list. */ warnings?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Replan result. It can be intermediate (during the calculation process) and complete (after the calculation is completed). */ interface ReplanResultUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ trips: Array; processed_items?: ProcessedItemsUniversal; removed_items?: RemovedItemsUniversal; unplanned_items?: UnplannedItemsUniversal; statistics: PlanStatisticsUniversal | null; additional_attributes?: AdditionalAttributesUniversal | null; /** * Warning list. */ warnings?: Array; /** * Calculation progress as a percentage. The progress displays the current number of completed steps. */ calculation_progress: number; calculation_info: CalculationInfoUniversal; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Task for replanning. */ interface ReplanTaskUniversal { [key: string]: any | any; /** * List of locations used for orders and shifts. */ locations: Array; /** * List of orders that need to be completed. */ orders: Array; /** * Available performers list. The performer fulfills orders using transport. */ performers: Array; /** * Available transports list. Transport is used by the trip performer to fulfill orders. */ transports: Array; /** * Assignments list. */ hardlinks?: Array; /** * Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ trips: Array; /** * List of facts. A fact is an event that has occurred that affects further trip operations. */ facts?: Array; /** * List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account. */ external_routing?: Array; plan_settings?: PlanSettingsUniversal; actualize_settings?: ActualizeSettingsUniversal; replan_settings?: ReplanSettingsUniversal; /** * The name of the dataset. A technical field that does not affect calculation. */ dataset_name?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Data error by schema. */ interface SchemaErrorUniversal { [key: string]: any | any; /** * Target entity identifier. */ entity: string | null; /** * Error message. */ message: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Task for recalculating statistics. */ interface StatisticsTaskUniversal { [key: string]: any | any; /** * List of locations used for orders and shifts. */ locations: Array; /** * List of orders that need to be completed. */ orders: Array; /** * Available performers list. The performer fulfills orders using transport. */ performers: Array; /** * Available transports list. Transport is used by the trip performer to fulfill orders. */ transports: Array; /** * Assignments list. */ hardlinks?: Array; /** * Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model) of the performer. */ trips: Array; plan_settings?: PlanSettingsUniversal; /** * List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix `external_routing`, the `plan_settings.geo_settings` parameters are not taken into account. */ external_routing?: Array; /** * The name of the dataset. A technical field that does not affect calculation. */ dataset_name?: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Error 400 details. */ interface Universal400WithErrorsAndWarningsUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Error message. */ message?: string | null; /** * List of syntax errors - data does not match the schema. */ schema_errors?: Array; /** * List with fatal errors. */ logical_errors?: Array; /** * Warning list. */ warnings?: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Data validation result. */ interface ValidateResultUniversal { [key: string]: any | any; tracedata: TracedataUniversal; /** * Warning list. */ warnings: Array; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ /** * Service version. */ interface VersionResultUniversal { [key: string]: any | any; /** * Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services). */ major: number; /** * Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service. */ minor: number; /** * Build version. Contains backwards compatible bug fixes and docs update. */ build: string; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ interface RunConvertJsonToThriftRequestParams { universalDataUniversal: UniversalDataUniversal; } interface RunConvertJsonToXlsxRequestParams { universalDataUniversal: UniversalDataUniversal; timezone?: number; } interface RunConvertXlsxToJsonRequestParams { body: string; } interface ConvertServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * JSON >> THRIFT * Used for conversion of input data to the THRIFT format. * @param requestParameters */ runConvertJsonToThrift(requestParameters: RunConvertJsonToThriftRequestParams, extraHttpRequestParams?: any): Observable; /** * JSON >> XLSX * Used for conversion of data to the [VRt.Universal XLSX](#tag/XLSX) format. * @param requestParameters */ runConvertJsonToXlsx(requestParameters: RunConvertJsonToXlsxRequestParams, extraHttpRequestParams?: any): Observable; /** * XLSX >> JSON * Used for data conversion from the [VRt.Universal XLSX](#tag/XLSX) format to the VRt.Universal JSON format. * @param requestParameters */ runConvertXlsxToJson(requestParameters: RunConvertXlsxToJsonRequestParams, extraHttpRequestParams?: any): Observable; } declare class ConvertService extends BaseService implements ConvertServiceInterface { protected httpClient: HttpClient; constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration); /** * JSON >> THRIFT * Used for conversion of input data to the THRIFT format. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runConvertJsonToThrift(requestParameters: RunConvertJsonToThriftRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runConvertJsonToThrift(requestParameters: RunConvertJsonToThriftRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runConvertJsonToThrift(requestParameters: RunConvertJsonToThriftRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * JSON >> XLSX * Used for conversion of data to the [VRt.Universal XLSX](#tag/XLSX) format. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runConvertJsonToXlsx(requestParameters: RunConvertJsonToXlsxRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runConvertJsonToXlsx(requestParameters: RunConvertJsonToXlsxRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runConvertJsonToXlsx(requestParameters: RunConvertJsonToXlsxRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/octet-stream' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * XLSX >> JSON * Used for data conversion from the [VRt.Universal XLSX](#tag/XLSX) format to the VRt.Universal JSON format. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runConvertXlsxToJson(requestParameters: RunConvertXlsxToJsonRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runConvertXlsxToJson(requestParameters: RunConvertXlsxToJsonRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runConvertXlsxToJson(requestParameters: RunConvertXlsxToJsonRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ interface CancelPlanCalculationRequestParams { processCode: string; } interface DeletePlanResultRequestParams { processCode: string; } interface GeneratePlanStatisticsRequestParams { statisticsTaskUniversal: StatisticsTaskUniversal; } interface ReadPlanResultRequestParams { processCode: string; } interface ReadPlanStateRequestParams { processCode: string; } interface RunPlanCalculationRequestParams { planTaskUniversal: PlanTaskUniversal; } interface RunPlanCalculationAsyncRequestParams { planTaskUniversal: PlanTaskUniversal; } interface RunPlanRefineRequestParams { planTaskUniversal: PlanTaskUniversal; removeLocations?: boolean; } interface RunPlanValidationRequestParams { planTaskUniversal: PlanTaskUniversal; } interface PlanServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Cancel calculation * Cancel calculation by the calculation identifier. * @param requestParameters */ cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, extraHttpRequestParams?: any): Observable<{}>; /** * Result removal * Removal of the planning result by the calculation identifier. * @param requestParameters */ deletePlanResult(requestParameters: DeletePlanResultRequestParams, extraHttpRequestParams?: any): Observable<{}>; /** * Calculation of statistics on trips * Calculation of statistics for existing trips * @param requestParameters */ generatePlanStatistics(requestParameters: GeneratePlanStatisticsRequestParams, extraHttpRequestParams?: any): Observable; /** * Getting the result * Getting the planning result based on the calculation identifier. * @param requestParameters */ readPlanResult(requestParameters: ReadPlanResultRequestParams, extraHttpRequestParams?: any): Observable; /** * Calculation state * Read calculation state by the calculation identifier. * @param requestParameters */ readPlanState(requestParameters: ReadPlanStateRequestParams, extraHttpRequestParams?: any): Observable; /** * Planning (SYNC) * Sync method for trip planning. Use only for testing and manual plannings. For production use [async method](#operation/run_plan_calculation_async). * @param requestParameters */ runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, extraHttpRequestParams?: any): Observable; /** * Planning (ASYNC) * Starting trip planning - after loading and checking the data, the `process_code` is returned. Using the `process_code`, you can find out [calculation state](#operation/read_plan_state) and [get result](#operation/read_plan_result), and also [cancel calculation](#operation/cancel_plan_calculation) and [delete temporary data](#operation/delete_plan_result) (otherwise they will be automatically deleted according to the ttl specified in the calculation settings). * @param requestParameters */ runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, extraHttpRequestParams?: any): Observable; /** * Data refine * Cleaning up data for planning before calculation - entities that cannot participate in planning are removed from the original dataset: * Locations that no one references (depending on the `remove_locations` flag) * Orders that no performer can fulfill * Performers and transport that cannot fulfill any order * @param requestParameters */ runPlanRefine(requestParameters: RunPlanRefineRequestParams, extraHttpRequestParams?: any): Observable; /** * Data validation * Check data before using. * @param requestParameters */ runPlanValidation(requestParameters: RunPlanValidationRequestParams, extraHttpRequestParams?: any): Observable; } declare class PlanService extends BaseService implements PlanServiceInterface { protected httpClient: HttpClient; constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration); /** * Cancel calculation * Cancel calculation by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; cancelPlanCalculation(requestParameters: CancelPlanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Result removal * Removal of the planning result by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; deletePlanResult(requestParameters: DeletePlanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Calculation of statistics on trips * Calculation of statistics for existing trips * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ generatePlanStatistics(requestParameters: GeneratePlanStatisticsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; generatePlanStatistics(requestParameters: GeneratePlanStatisticsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; generatePlanStatistics(requestParameters: GeneratePlanStatisticsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Getting the result * Getting the planning result based on the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; readPlanResult(requestParameters: ReadPlanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Calculation state * Read calculation state by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; readPlanState(requestParameters: ReadPlanStateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Planning (SYNC) * Sync method for trip planning. Use only for testing and manual plannings. For production use [async method](#operation/run_plan_calculation_async). * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runPlanCalculation(requestParameters: RunPlanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Planning (ASYNC) * Starting trip planning - after loading and checking the data, the `process_code` is returned. Using the `process_code`, you can find out [calculation state](#operation/read_plan_state) and [get result](#operation/read_plan_result), and also [cancel calculation](#operation/cancel_plan_calculation) and [delete temporary data](#operation/delete_plan_result) (otherwise they will be automatically deleted according to the ttl specified in the calculation settings). * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runPlanCalculationAsync(requestParameters: RunPlanCalculationAsyncRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Data refine * Cleaning up data for planning before calculation - entities that cannot participate in planning are removed from the original dataset: * Locations that no one references (depending on the `remove_locations` flag) * Orders that no performer can fulfill * Performers and transport that cannot fulfill any order * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runPlanRefine(requestParameters: RunPlanRefineRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runPlanRefine(requestParameters: RunPlanRefineRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runPlanRefine(requestParameters: RunPlanRefineRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Data validation * Check data before using. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runPlanValidation(requestParameters: RunPlanValidationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ interface CancelReplanCalculationRequestParams { processCode: string; } interface DeleteReplanResultRequestParams { processCode: string; } interface ReadReplanResultRequestParams { processCode: string; } interface ReadReplanStateRequestParams { processCode: string; } interface RunReplanCalculationRequestParams { replanTaskUniversal: ReplanTaskUniversal; } interface RunReplanCalculationAsyncRequestParams { replanTaskUniversal: ReplanTaskUniversal; } interface RunReplanRefineRequestParams { replanTaskUniversal: ReplanTaskUniversal; removeLocations?: boolean; } interface RunReplanValidationRequestParams { replanTaskUniversal: ReplanTaskUniversal; } interface ReplanServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Cancel calculation * Cancel calculation by the calculation identifier. * @param requestParameters */ cancelReplanCalculation(requestParameters: CancelReplanCalculationRequestParams, extraHttpRequestParams?: any): Observable<{}>; /** * Result removal * Removal of the planning result by the calculation identifier. * @param requestParameters */ deleteReplanResult(requestParameters: DeleteReplanResultRequestParams, extraHttpRequestParams?: any): Observable<{}>; /** * Getting the result * Getting the replanning result based on the calculation identifier. * @param requestParameters */ readReplanResult(requestParameters: ReadReplanResultRequestParams, extraHttpRequestParams?: any): Observable; /** * Calculation state * Read calculation state by the calculation identifier. * @param requestParameters */ readReplanState(requestParameters: ReadReplanStateRequestParams, extraHttpRequestParams?: any): Observable; /** * Replanning (SYNC) * Sync method for trips replanning. Use only for testing and manual plannings. For production use [async method](#operation/run_replan_calculation_async). * @param requestParameters */ runReplanCalculation(requestParameters: RunReplanCalculationRequestParams, extraHttpRequestParams?: any): Observable; /** * Replanning (ASYNC) * Starting trip replanning - changing existing and creating new trips based on the facts and data about orders, performers and transport. After loading and checking the data, the `process_code` is returned. Using the `process_code`, you can find out [calculation state](#operation/read_replan_state) and [get result](#operation/read_replan_result), and also [cancel calculation](#operation/cancel_replan_calculation) and [delete temporary data](#operation/delete_replan_result) (otherwise they will be automatically deleted according to the ttl specified in the calculation settings). An replan task can be transformed into a plan task using [data processing](#operation/run_replan_refine). * @param requestParameters */ runReplanCalculationAsync(requestParameters: RunReplanCalculationAsyncRequestParams, extraHttpRequestParams?: any): Observable; /** * Data refine * Cleaning up data for re-planning before calculation: * If one entity is referenced by several facts, only the latest one by the time field is taken into account; if the time is the same, a random one is taken into account. * All facts that occurred later than `actualize_settings.current_time` are deleted. * If `plan_new_orders: false` is specified - all orders that are not in the specified trips are removed from the original task. * If `create_new_trips: false` is specified - all performers and transport that are not in the specified trips are removed from the original task, and unplanned shifts of performers and transport that are in the specified trips are also removed. * Afterwards, [cleaning up data for planning](#operation/run_plan_refine) is performed. As a result, a task for planning is returned. * @param requestParameters */ runReplanRefine(requestParameters: RunReplanRefineRequestParams, extraHttpRequestParams?: any): Observable; /** * Data validation * Check data before using. * @param requestParameters */ runReplanValidation(requestParameters: RunReplanValidationRequestParams, extraHttpRequestParams?: any): Observable; } declare class ReplanService extends BaseService implements ReplanServiceInterface { protected httpClient: HttpClient; constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration); /** * Cancel calculation * Cancel calculation by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ cancelReplanCalculation(requestParameters: CancelReplanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; cancelReplanCalculation(requestParameters: CancelReplanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; cancelReplanCalculation(requestParameters: CancelReplanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Result removal * Removal of the planning result by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ deleteReplanResult(requestParameters: DeleteReplanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; deleteReplanResult(requestParameters: DeleteReplanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; deleteReplanResult(requestParameters: DeleteReplanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Getting the result * Getting the replanning result based on the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ readReplanResult(requestParameters: ReadReplanResultRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; readReplanResult(requestParameters: ReadReplanResultRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; readReplanResult(requestParameters: ReadReplanResultRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Calculation state * Read calculation state by the calculation identifier. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ readReplanState(requestParameters: ReadReplanStateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; readReplanState(requestParameters: ReadReplanStateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; readReplanState(requestParameters: ReadReplanStateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Replanning (SYNC) * Sync method for trips replanning. Use only for testing and manual plannings. For production use [async method](#operation/run_replan_calculation_async). * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runReplanCalculation(requestParameters: RunReplanCalculationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runReplanCalculation(requestParameters: RunReplanCalculationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runReplanCalculation(requestParameters: RunReplanCalculationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Replanning (ASYNC) * Starting trip replanning - changing existing and creating new trips based on the facts and data about orders, performers and transport. After loading and checking the data, the `process_code` is returned. Using the `process_code`, you can find out [calculation state](#operation/read_replan_state) and [get result](#operation/read_replan_result), and also [cancel calculation](#operation/cancel_replan_calculation) and [delete temporary data](#operation/delete_replan_result) (otherwise they will be automatically deleted according to the ttl specified in the calculation settings). An replan task can be transformed into a plan task using [data processing](#operation/run_replan_refine). * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runReplanCalculationAsync(requestParameters: RunReplanCalculationAsyncRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runReplanCalculationAsync(requestParameters: RunReplanCalculationAsyncRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runReplanCalculationAsync(requestParameters: RunReplanCalculationAsyncRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Data refine * Cleaning up data for re-planning before calculation: * If one entity is referenced by several facts, only the latest one by the time field is taken into account; if the time is the same, a random one is taken into account. * All facts that occurred later than `actualize_settings.current_time` are deleted. * If `plan_new_orders: false` is specified - all orders that are not in the specified trips are removed from the original task. * If `create_new_trips: false` is specified - all performers and transport that are not in the specified trips are removed from the original task, and unplanned shifts of performers and transport that are in the specified trips are also removed. * Afterwards, [cleaning up data for planning](#operation/run_plan_refine) is performed. As a result, a task for planning is returned. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runReplanRefine(requestParameters: RunReplanRefineRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runReplanRefine(requestParameters: RunReplanRefineRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runReplanRefine(requestParameters: RunReplanRefineRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Data validation * Check data before using. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ runReplanValidation(requestParameters: RunReplanValidationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; runReplanValidation(requestParameters: RunReplanValidationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; runReplanValidation(requestParameters: RunReplanValidationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * VRt.Universal [UV] * * The version of the OpenAPI document: 7.42.3500 * Contact: support@veeroute.com * * NOTE: This class is auto generated by OpenAPI Generator. * Do not edit the class manually. */ interface FileRequestParams { filename: string; } interface SystemServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * Checking the availability * Checking the service availability. */ check(extraHttpRequestParams?: any): Observable; /** * Getting the documentation * Getting the file with this service documentation. * @param requestParameters */ file(requestParameters: FileRequestParams, extraHttpRequestParams?: any): Observable; /** * Getting the service version * Getting the service version. */ version(extraHttpRequestParams?: any): Observable; } declare class SystemService extends BaseService implements SystemServiceInterface { protected httpClient: HttpClient; constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration); /** * Checking the availability * Checking the service availability. * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ check(observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; check(observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; check(observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Getting the documentation * Getting the file with this service documentation. * @param requestParameters * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ file(requestParameters: FileRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/html' | 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; file(requestParameters: FileRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/html' | 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; file(requestParameters: FileRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/html' | 'text/plain' | 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; /** * Getting the service version * Getting the service version. * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ version(observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable; version(observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; version(observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare const APIS: (typeof ConvertService | typeof PlanService | typeof ReplanService | typeof SystemService)[]; declare const BASE_PATH: InjectionToken; declare const COLLECTION_FORMATS: { csv: string; tsv: string; ssv: string; pipes: string; }; declare class LssUniversalApiModule { static forRoot(configurationFactory: () => Configuration): ModuleWithProviders; constructor(parentModule: LssUniversalApiModule, http: HttpClient); static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare function provideApi(configOrBasePath: string | ConfigurationParameters): EnvironmentProviders; export { APIS, BASE_PATH, BreakRulesUniversalRelocatingDurationTypeEnum, COLLECTION_FORMATS, CalculationStatusUniversal, CargoActionTypeUniversal, CargoInvoiceTaxUniversal, CargoInvoiceWaybillStatusUniversal, CargoRotationTypeUniversal, Configuration, ConvertService, DemandTypeUniversal, EntityErrorTypeUniversal, EntityTypeUniversal, EntityWarningTypeUniversal, FactStatusErrorUniversal, FactStatusUniversal, FactTypeUniversal, HardlinkElementTypeUniversal, LssUniversalApiModule, OrderStatusUniversal, PlanService, ProductConclusionTypeUniversal, ReplanService, ServiceUniversal, SystemService, TransportTypeUniversal, TripStartTimeStrategyUniversal, TripStateFlagUniversal, TripStatusUniversal, provideApi }; export type { ActualizeSettingsUniversal, AdditionalAttributesElementUniversal, AdditionalAttributesUniversal, AssignedPerformerUniversal, AssignedTransportUniversal, AttributeUniversal, BoxCompatibilitiesUniversal, BoxLimitsUniversal, BoxUniversal, BreakRulesUniversal, BreakUniversal, CalculationAsyncResultUniversal, CalculationInfoUniversal, CalculationSettingsUniversal, CalculationStateUniversal, CancelPlanCalculationRequestParams, CancelReplanCalculationRequestParams, CapacityCostUniversal, CapacityLimitUniversal, CapacityMultiplierUniversal, CapacityStatisticsLoadUniversal, CapacityStatisticsRatioUniversal, CapacityStatisticsSumUniversal, CapacityUniversal, CargoActionUniversal, CargoCompatibilitiesUniversal, CargoInvoiceDetailUniversal, CargoInvoiceHonestSignUniversal, CargoInvoiceReceiptUniversal, CargoInvoiceUniversal, CargoInvoiceWaybillUniversal, CargoUniversal, CheckResultUniversal, CompatibilityPenaltyUniversal, ConfigurationParameters, ConvertServiceInterface, DataFormat, DataType, DeletePlanResultRequestParams, DeleteReplanResultRequestParams, DemandExtraDurationUniversal, DemandUniversal, EntityErrorUniversal, EntityPathUniversal, EntityWarningUniversal, ExtensionSettingsUniversal, FactLoreUniversal, FactResultUniversal, FactUniversal, FeatureLifetimeUniversal, FileRequestParams, General402Universal, General403Universal, General404DetailUniversal, General404Universal, General429Universal, General500Universal, GeneralStatisticsUniversal, GeneratePlanStatisticsRequestParams, GeoSettingsUniversal, GeopointUniversal, HardlinkElementUniversal, HardlinkUniversal, LoadStatisticsUniversal, LocationCargosLimitUniversal, LocationCompatibilitiesUniversal, LocationLimitStatisticsUniversal, LocationLimitUniversal, LocationStatisticsUniversal, LocationTimetableElementUniversal, LocationTransportsLimitUniversal, LocationUniversal, LoreDemandCanceledUniversal, LoreDemandDoneUniversal, LoreDemandPaymentUniversal, LoreDemandStartUniversal, LoreGeotrackUpdatedUniversal, LoreJobDoneUniversal, LoreOrderCanceledUniversal, LoreOrderDoneUniversal, LoreTripPrecedenceChangedUniversal, MeasurementsUniversal, OrderCompatibilitiesUniversal, OrderResultUniversal, OrderUniversal, Param, ParamLocation, ParamStyle, PaymentDetailsUniversal, PerformerCompatibilitiesUniversal, PerformerLimitsUniversal, PerformerShiftUniversal, PerformerTariffConstraintUniversal, PerformerTariffUniversal, PerformerUniversal, PlanResultUniversal, PlanServiceInterface, PlanSettingsUniversal, PlanStatisticsUniversal, PlanTaskUniversal, PossibleEventContactUniversal, PossibleEventUniversal, ProcessedItemsUniversal, ProductConclusionUniversal, QualityUniversal, ReadPlanResultRequestParams, ReadPlanStateRequestParams, ReadReplanResultRequestParams, ReadReplanStateRequestParams, RefineResultUniversal, RemovedItemsUniversal, ReplanResultUniversal, ReplanServiceInterface, ReplanSettingsUniversal, ReplanStrategyUniversal, ReplanTaskUniversal, RestRulesUniversal, RestUniversal, RoundtripStatisticsUniversal, RoutingMatrixUniversal, RoutingMatrixWaypointUniversal, RoutingTransportMatrixUniversal, RunConvertJsonToThriftRequestParams, RunConvertJsonToXlsxRequestParams, RunConvertXlsxToJsonRequestParams, RunPlanCalculationAsyncRequestParams, RunPlanCalculationRequestParams, RunPlanRefineRequestParams, RunPlanValidationRequestParams, RunReplanCalculationAsyncRequestParams, RunReplanCalculationRequestParams, RunReplanRefineRequestParams, RunReplanValidationRequestParams, SchemaErrorUniversal, StandardDataFormat, StandardDataType, StandardParamStyle, StatisticsTaskUniversal, StopDemandUniversal, StopStatisticsUniversal, SystemServiceInterface, TaskStatisticsUniversal, TimeWindowUniversal, TimeWindowViolationDetailUniversal, TimeWindowViolationsUniversal, TracedataUniversal, TrackpointUniversal, TransportCapacityMultiplierUniversal, TransportCompatibilitiesUniversal, TransportLimitsUniversal, TransportLoadUniversal, TransportShiftUniversal, TransportSpeedMultiplierUniversal, TransportTariffConstraintUniversal, TransportTariffUniversal, TransportUniversal, TripAssumptionsUniversal, TripDemandPrecedenceUniversal, TripExpectationsUniversal, TripPenaltiesUniversal, TripStateUniversal, TripStatisticsUniversal, TripUniversal, TripsSettingsUniversal, Universal400WithErrorsAndWarningsUniversal, UniversalDataUniversal, UnplannedItemsUniversal, ValidateResultUniversal, VersionResultUniversal, WorkAndRestRulesUniversal };