@@ -10,18 +10,18 @@ |
||
| 10 | 10 | */ |
| 11 | 11 | class RouteDuplicateResponse extends \Route4Me\Common |
| 12 | 12 | { |
| 13 | - /** If true, the route duplicated successfully. |
|
| 14 | - * @var boolean $status |
|
| 15 | - */ |
|
| 16 | - public $status; |
|
| 13 | + /** If true, the route duplicated successfully. |
|
| 14 | + * @var boolean $status |
|
| 15 | + */ |
|
| 16 | + public $status; |
|
| 17 | 17 | |
| 18 | - /** If true, the route duplication process was asynchronous. |
|
| 19 | - * @var boolean $async |
|
| 20 | - */ |
|
| 21 | - public $async; |
|
| 18 | + /** If true, the route duplication process was asynchronous. |
|
| 19 | + * @var boolean $async |
|
| 20 | + */ |
|
| 21 | + public $async; |
|
| 22 | 22 | |
| 23 | - /** An array of the duplicated route IDs. |
|
| 24 | - * @var string[] $route_ids |
|
| 25 | - */ |
|
| 26 | - public $route_ids = []; |
|
| 23 | + /** An array of the duplicated route IDs. |
|
| 24 | + * @var string[] $route_ids |
|
| 25 | + */ |
|
| 26 | + public $route_ids = []; |
|
| 27 | 27 | } |
@@ -9,13 +9,13 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | class RouteDataTableConfigResponse extends \Route4Me\Common |
| 11 | 11 | { |
| 12 | - /** API Capabilities |
|
| 13 | - * @var ApiCapabilities $api_capabilities |
|
| 14 | - */ |
|
| 15 | - public $api_capabilities = []; |
|
| 12 | + /** API Capabilities |
|
| 13 | + * @var ApiCapabilities $api_capabilities |
|
| 14 | + */ |
|
| 15 | + public $api_capabilities = []; |
|
| 16 | 16 | |
| 17 | - /** API Preferences |
|
| 18 | - * @var ApiPreferences $api_preferences |
|
| 19 | - */ |
|
| 20 | - public $api_preferences = []; |
|
| 17 | + /** API Preferences |
|
| 18 | + * @var ApiPreferences $api_preferences |
|
| 19 | + */ |
|
| 20 | + public $api_preferences = []; |
|
| 21 | 21 | } |
@@ -4,18 +4,18 @@ |
||
| 4 | 4 | |
| 5 | 5 | class ApiPreferences extends \Route4Me\Common |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @var boolean $force_server_side_search |
|
| 9 | - */ |
|
| 10 | - public $force_server_side_search; |
|
| 7 | + /** |
|
| 8 | + * @var boolean $force_server_side_search |
|
| 9 | + */ |
|
| 10 | + public $force_server_side_search; |
|
| 11 | 11 | |
| 12 | - /** |
|
| 13 | - * @var boolean $partial_load |
|
| 14 | - */ |
|
| 15 | - public $partial_load; |
|
| 12 | + /** |
|
| 13 | + * @var boolean $partial_load |
|
| 14 | + */ |
|
| 15 | + public $partial_load; |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var boolean $simple_pagination |
|
| 19 | - */ |
|
| 20 | - public $simple_pagination; |
|
| 17 | + /** |
|
| 18 | + * @var boolean $simple_pagination |
|
| 19 | + */ |
|
| 20 | + public $simple_pagination; |
|
| 21 | 21 | } |
@@ -4,28 +4,28 @@ |
||
| 4 | 4 | |
| 5 | 5 | class ApiCapabilities extends \Route4Me\Common |
| 6 | 6 | { |
| 7 | - /** Sortable Fields |
|
| 8 | - * @var string[] $sortable_fields |
|
| 9 | - */ |
|
| 10 | - public $sortable_fields = []; |
|
| 7 | + /** Sortable Fields |
|
| 8 | + * @var string[] $sortable_fields |
|
| 9 | + */ |
|
| 10 | + public $sortable_fields = []; |
|
| 11 | 11 | |
| 12 | - /** Combinations of the sortable fields |
|
| 13 | - * @var Array $sortable_fields_combinations |
|
| 14 | - */ |
|
| 15 | - public $sortable_fields_combinations = []; |
|
| 12 | + /** Combinations of the sortable fields |
|
| 13 | + * @var Array $sortable_fields_combinations |
|
| 14 | + */ |
|
| 15 | + public $sortable_fields_combinations = []; |
|
| 16 | 16 | |
| 17 | - /** If true, multi-sorting enabled. |
|
| 18 | - * @var boolean $multi_sorting_enabled |
|
| 19 | - */ |
|
| 20 | - public $multi_sorting_enabled; |
|
| 17 | + /** If true, multi-sorting enabled. |
|
| 18 | + * @var boolean $multi_sorting_enabled |
|
| 19 | + */ |
|
| 20 | + public $multi_sorting_enabled; |
|
| 21 | 21 | |
| 22 | - /** An array of the filterable fields. |
|
| 23 | - * @var string[] $filterable_fields |
|
| 24 | - */ |
|
| 25 | - public $filterable_fields = []; |
|
| 22 | + /** An array of the filterable fields. |
|
| 23 | + * @var string[] $filterable_fields |
|
| 24 | + */ |
|
| 25 | + public $filterable_fields = []; |
|
| 26 | 26 | |
| 27 | - /** If true, search enabled. |
|
| 28 | - * @var boolean $search |
|
| 29 | - */ |
|
| 30 | - public $search; |
|
| 27 | + /** If true, search enabled. |
|
| 28 | + * @var boolean $search |
|
| 29 | + */ |
|
| 30 | + public $search; |
|
| 31 | 31 | } |
@@ -10,23 +10,23 @@ |
||
| 10 | 10 | */ |
| 11 | 11 | class RoutesDeleteResponse extends \Route4Me\Common |
| 12 | 12 | { |
| 13 | - /** If true, the route duplicated successfully. |
|
| 14 | - * @var boolean $deleted |
|
| 15 | - */ |
|
| 16 | - public $deleted; |
|
| 13 | + /** If true, the route duplicated successfully. |
|
| 14 | + * @var boolean $deleted |
|
| 15 | + */ |
|
| 16 | + public $deleted; |
|
| 17 | 17 | |
| 18 | - /** If true, the route duplication process was asynchronous. |
|
| 19 | - * @var bool $async |
|
| 20 | - */ |
|
| 21 | - public $async; |
|
| 18 | + /** If true, the route duplication process was asynchronous. |
|
| 19 | + * @var bool $async |
|
| 20 | + */ |
|
| 21 | + public $async; |
|
| 22 | 22 | |
| 23 | - /** Route ID |
|
| 24 | - * @var string $route_id |
|
| 25 | - */ |
|
| 26 | - public $route_id; |
|
| 23 | + /** Route ID |
|
| 24 | + * @var string $route_id |
|
| 25 | + */ |
|
| 26 | + public $route_id; |
|
| 27 | 27 | |
| 28 | - /** An array of the duplicated route IDs. |
|
| 29 | - * @var string[] $route_ids |
|
| 30 | - */ |
|
| 31 | - public $route_ids; |
|
| 28 | + /** An array of the duplicated route IDs. |
|
| 29 | + * @var string[] $route_ids |
|
| 30 | + */ |
|
| 31 | + public $route_ids; |
|
| 32 | 32 | } |
@@ -9,54 +9,54 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | class RouteAdvancedConstraints extends \Route4Me\Common |
| 11 | 11 | { |
| 12 | - /** Maximum cargo volume per route |
|
| 13 | - * @var double $max_cargo_volume |
|
| 14 | - */ |
|
| 15 | - public $max_cargo_volume; |
|
| 16 | - |
|
| 17 | - /** Vehicle capacity. |
|
| 18 | - * <para>How much total cargo can be transported per route (units, e.g. cubic meters)</para> |
|
| 19 | - * @var integer $max_capacity |
|
| 20 | - */ |
|
| 21 | - public $max_capacity; |
|
| 22 | - |
|
| 23 | - /** Legacy feature which permits a user to request an example number of optimized routes. |
|
| 24 | - * @var integer $members_count |
|
| 25 | - */ |
|
| 26 | - public $members_count; |
|
| 27 | - |
|
| 28 | - /** An array of the available time windows (e.g. [ [25200, 75000 ] ) |
|
| 29 | - * @var Array $available_time_windows |
|
| 30 | - */ |
|
| 31 | - public $available_time_windows; |
|
| 32 | - |
|
| 33 | - /** The driver tags specified in a team member's custom data. |
|
| 34 | - * (e.g. "driver skills": |
|
| 35 | - * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"] |
|
| 36 | - * @var string[] $tags |
|
| 37 | - */ |
|
| 38 | - public $tags; |
|
| 39 | - |
|
| 40 | - /** An array of the skilled driver IDs. |
|
| 41 | - * @var integer[] $route4me_members_id |
|
| 42 | - */ |
|
| 43 | - public $route4me_members_id; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * A depot address. |
|
| 47 | - * @var Address |
|
| 48 | - */ |
|
| 49 | - public $depot_address; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * An array of locations. |
|
| 53 | - * @var object[] |
|
| 54 | - */ |
|
| 55 | - public $location_sequence_pattern; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Group name of the advanced constraints. |
|
| 59 | - * @var string |
|
| 60 | - */ |
|
| 61 | - public $group; |
|
| 12 | + /** Maximum cargo volume per route |
|
| 13 | + * @var double $max_cargo_volume |
|
| 14 | + */ |
|
| 15 | + public $max_cargo_volume; |
|
| 16 | + |
|
| 17 | + /** Vehicle capacity. |
|
| 18 | + * <para>How much total cargo can be transported per route (units, e.g. cubic meters)</para> |
|
| 19 | + * @var integer $max_capacity |
|
| 20 | + */ |
|
| 21 | + public $max_capacity; |
|
| 22 | + |
|
| 23 | + /** Legacy feature which permits a user to request an example number of optimized routes. |
|
| 24 | + * @var integer $members_count |
|
| 25 | + */ |
|
| 26 | + public $members_count; |
|
| 27 | + |
|
| 28 | + /** An array of the available time windows (e.g. [ [25200, 75000 ] ) |
|
| 29 | + * @var Array $available_time_windows |
|
| 30 | + */ |
|
| 31 | + public $available_time_windows; |
|
| 32 | + |
|
| 33 | + /** The driver tags specified in a team member's custom data. |
|
| 34 | + * (e.g. "driver skills": |
|
| 35 | + * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"] |
|
| 36 | + * @var string[] $tags |
|
| 37 | + */ |
|
| 38 | + public $tags; |
|
| 39 | + |
|
| 40 | + /** An array of the skilled driver IDs. |
|
| 41 | + * @var integer[] $route4me_members_id |
|
| 42 | + */ |
|
| 43 | + public $route4me_members_id; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * A depot address. |
|
| 47 | + * @var Address |
|
| 48 | + */ |
|
| 49 | + public $depot_address; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * An array of locations. |
|
| 53 | + * @var object[] |
|
| 54 | + */ |
|
| 55 | + public $location_sequence_pattern; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Group name of the advanced constraints. |
|
| 59 | + * @var string |
|
| 60 | + */ |
|
| 61 | + public $group; |
|
| 62 | 62 | } |
@@ -7,89 +7,89 @@ |
||
| 7 | 7 | |
| 8 | 8 | class RouteParameters extends Common |
| 9 | 9 | { |
| 10 | - public $is_upload; |
|
| 11 | - public $rt; |
|
| 12 | - public $route_name; |
|
| 13 | - public $route_date; |
|
| 14 | - public $shared_publicly; |
|
| 15 | - public $disable_optimization; |
|
| 16 | - public $optimize; |
|
| 17 | - public $lock_last; |
|
| 18 | - public $vehicle_capacity; |
|
| 19 | - public $vehicle_max_cargo_weight; |
|
| 20 | - public $vehicle_max_cargo_volume; |
|
| 21 | - public $vehicle_max_distance_mi; |
|
| 22 | - public $subtour_max_revenue; |
|
| 23 | - public $distance_unit; |
|
| 24 | - public $travel_mode; |
|
| 25 | - public $avoid; |
|
| 26 | - public $avoidance_zones = []; |
|
| 27 | - public $vehicle_id; |
|
| 28 | - public $driver_id; |
|
| 29 | - public $dev_lat; |
|
| 30 | - public $dev_lng; |
|
| 31 | - public $route_max_duration; |
|
| 32 | - public $route_email; |
|
| 33 | - public $store_route; |
|
| 34 | - public $metric; |
|
| 35 | - public $algorithm_type; |
|
| 36 | - public $member_id; |
|
| 37 | - public $ip; |
|
| 38 | - public $dm; |
|
| 39 | - public $dirm; |
|
| 40 | - public $parts; |
|
| 41 | - public $parts_min; |
|
| 42 | - public $device_id; |
|
| 43 | - public $device_type; |
|
| 44 | - public $first_drive_then_wait_between_stops; |
|
| 45 | - public $has_trailer; |
|
| 46 | - public $trailer_weight_t; |
|
| 47 | - public $limited_weight_t; |
|
| 48 | - public $weight_per_axle_t; |
|
| 49 | - public $truck_height; |
|
| 50 | - public $truck_width; |
|
| 51 | - public $truck_length; |
|
| 52 | - public $truck_hazardous_goods; |
|
| 53 | - public $truck_axles; |
|
| 54 | - public $truck_toll_road_usage; |
|
| 55 | - public $truck_avoid_ferries; |
|
| 56 | - public $truck_hwy_only; |
|
| 57 | - public $truck_lcv; |
|
| 58 | - public $truck_borders; |
|
| 59 | - public $truck_side_street_adherence; |
|
| 60 | - public $truck_config; |
|
| 61 | - public $truck_dim_unit; |
|
| 62 | - public $truck_type; |
|
| 63 | - public $truck_weight; |
|
| 64 | - public $optimization_quality; |
|
| 65 | - public $override_addresses = []; |
|
| 66 | - public $max_tour_size; |
|
| 67 | - public $min_tour_size; |
|
| 68 | - public $uturn; |
|
| 69 | - public $leftturn; |
|
| 70 | - public $rightturn; |
|
| 71 | - public $route_time_multiplier; |
|
| 72 | - public $route_service_time_multiplier; |
|
| 73 | - public $optimization_engine; |
|
| 74 | - public $is_dynamic_start_time; |
|
| 75 | - public $bundling; |
|
| 10 | + public $is_upload; |
|
| 11 | + public $rt; |
|
| 12 | + public $route_name; |
|
| 13 | + public $route_date; |
|
| 14 | + public $shared_publicly; |
|
| 15 | + public $disable_optimization; |
|
| 16 | + public $optimize; |
|
| 17 | + public $lock_last; |
|
| 18 | + public $vehicle_capacity; |
|
| 19 | + public $vehicle_max_cargo_weight; |
|
| 20 | + public $vehicle_max_cargo_volume; |
|
| 21 | + public $vehicle_max_distance_mi; |
|
| 22 | + public $subtour_max_revenue; |
|
| 23 | + public $distance_unit; |
|
| 24 | + public $travel_mode; |
|
| 25 | + public $avoid; |
|
| 26 | + public $avoidance_zones = []; |
|
| 27 | + public $vehicle_id; |
|
| 28 | + public $driver_id; |
|
| 29 | + public $dev_lat; |
|
| 30 | + public $dev_lng; |
|
| 31 | + public $route_max_duration; |
|
| 32 | + public $route_email; |
|
| 33 | + public $store_route; |
|
| 34 | + public $metric; |
|
| 35 | + public $algorithm_type; |
|
| 36 | + public $member_id; |
|
| 37 | + public $ip; |
|
| 38 | + public $dm; |
|
| 39 | + public $dirm; |
|
| 40 | + public $parts; |
|
| 41 | + public $parts_min; |
|
| 42 | + public $device_id; |
|
| 43 | + public $device_type; |
|
| 44 | + public $first_drive_then_wait_between_stops; |
|
| 45 | + public $has_trailer; |
|
| 46 | + public $trailer_weight_t; |
|
| 47 | + public $limited_weight_t; |
|
| 48 | + public $weight_per_axle_t; |
|
| 49 | + public $truck_height; |
|
| 50 | + public $truck_width; |
|
| 51 | + public $truck_length; |
|
| 52 | + public $truck_hazardous_goods; |
|
| 53 | + public $truck_axles; |
|
| 54 | + public $truck_toll_road_usage; |
|
| 55 | + public $truck_avoid_ferries; |
|
| 56 | + public $truck_hwy_only; |
|
| 57 | + public $truck_lcv; |
|
| 58 | + public $truck_borders; |
|
| 59 | + public $truck_side_street_adherence; |
|
| 60 | + public $truck_config; |
|
| 61 | + public $truck_dim_unit; |
|
| 62 | + public $truck_type; |
|
| 63 | + public $truck_weight; |
|
| 64 | + public $optimization_quality; |
|
| 65 | + public $override_addresses = []; |
|
| 66 | + public $max_tour_size; |
|
| 67 | + public $min_tour_size; |
|
| 68 | + public $uturn; |
|
| 69 | + public $leftturn; |
|
| 70 | + public $rightturn; |
|
| 71 | + public $route_time_multiplier; |
|
| 72 | + public $route_service_time_multiplier; |
|
| 73 | + public $optimization_engine; |
|
| 74 | + public $is_dynamic_start_time; |
|
| 75 | + public $bundling; |
|
| 76 | 76 | |
| 77 | - public function setAddressBundle($addressBundle) |
|
| 78 | - { |
|
| 79 | - $this->bundling = $addressBundle; |
|
| 80 | - } |
|
| 77 | + public function setAddressBundle($addressBundle) |
|
| 78 | + { |
|
| 79 | + $this->bundling = $addressBundle; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - public function getAddressBundle() |
|
| 83 | - { |
|
| 84 | - return $this->bundling; |
|
| 85 | - } |
|
| 82 | + public function getAddressBundle() |
|
| 83 | + { |
|
| 84 | + return $this->bundling; |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | - public static function getAllProperties() |
|
| 88 | - { |
|
| 89 | - $routeParams = new self(); |
|
| 87 | + public static function getAllProperties() |
|
| 88 | + { |
|
| 89 | + $routeParams = new self(); |
|
| 90 | 90 | |
| 91 | - $fields = array_keys(get_object_vars($routeParams)); |
|
| 91 | + $fields = array_keys(get_object_vars($routeParams)); |
|
| 92 | 92 | |
| 93 | - return $fields; |
|
| 94 | - } |
|
| 93 | + return $fields; |
|
| 94 | + } |
|
| 95 | 95 | } |
@@ -9,29 +9,29 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | class DriverReview extends \Route4Me\Common |
| 11 | 11 | { |
| 12 | - /** Driver Rating ID |
|
| 13 | - * @var string $rating_id |
|
| 14 | - */ |
|
| 15 | - public $rating_id; |
|
| 12 | + /** Driver Rating ID |
|
| 13 | + * @var string $rating_id |
|
| 14 | + */ |
|
| 15 | + public $rating_id; |
|
| 16 | 16 | |
| 17 | - /** The tracking number of the route destination |
|
| 18 | - * @var string $tracking_number |
|
| 19 | - */ |
|
| 20 | - public $tracking_number; |
|
| 17 | + /** The tracking number of the route destination |
|
| 18 | + * @var string $tracking_number |
|
| 19 | + */ |
|
| 20 | + public $tracking_number; |
|
| 21 | 21 | |
| 22 | - /** review the driver got |
|
| 23 | - * @var string $review |
|
| 24 | - */ |
|
| 25 | - public $review; |
|
| 22 | + /** review the driver got |
|
| 23 | + * @var string $review |
|
| 24 | + */ |
|
| 25 | + public $review; |
|
| 26 | 26 | |
| 27 | - /** The rating assigned to the driver. |
|
| 28 | - * Available values: 1,2,3,4 |
|
| 29 | - * @var integer $rating |
|
| 30 | - */ |
|
| 31 | - public $rating; |
|
| 27 | + /** The rating assigned to the driver. |
|
| 28 | + * Available values: 1,2,3,4 |
|
| 29 | + * @var integer $rating |
|
| 30 | + */ |
|
| 31 | + public $rating; |
|
| 32 | 32 | |
| 33 | - /** When the review was created. |
|
| 34 | - * @var string $added_at |
|
| 35 | - */ |
|
| 36 | - public $added_at; |
|
| 33 | + /** When the review was created. |
|
| 34 | + * @var string $added_at |
|
| 35 | + */ |
|
| 36 | + public $added_at; |
|
| 37 | 37 | } |
@@ -10,33 +10,33 @@ |
||
| 10 | 10 | */ |
| 11 | 11 | class SimplePaginationData extends \Route4Me\Common |
| 12 | 12 | { |
| 13 | - /** Driver reviews number per page. |
|
| 14 | - * @var integer $per_page |
|
| 15 | - */ |
|
| 16 | - public $per_page; |
|
| 17 | - |
|
| 18 | - /** Current page number in the driver reviews collection. |
|
| 19 | - * @var integer $current_page |
|
| 20 | - */ |
|
| 21 | - public $current_page; |
|
| 22 | - |
|
| 23 | - /** Path to the driver review addon. |
|
| 24 | - * @var string $path |
|
| 25 | - */ |
|
| 26 | - public $path; |
|
| 27 | - |
|
| 28 | - /** Path to the first page of the driver reviews collection. |
|
| 29 | - * @var string $first |
|
| 30 | - */ |
|
| 31 | - public $first; |
|
| 32 | - |
|
| 33 | - /** Path to the previous page of the driver reviews collection. |
|
| 34 | - * @var string $prev |
|
| 35 | - */ |
|
| 36 | - public $prev; |
|
| 37 | - |
|
| 38 | - /** Path to the next page of the driver reviews collection. |
|
| 39 | - * @var string $next |
|
| 40 | - */ |
|
| 41 | - public $next; |
|
| 13 | + /** Driver reviews number per page. |
|
| 14 | + * @var integer $per_page |
|
| 15 | + */ |
|
| 16 | + public $per_page; |
|
| 17 | + |
|
| 18 | + /** Current page number in the driver reviews collection. |
|
| 19 | + * @var integer $current_page |
|
| 20 | + */ |
|
| 21 | + public $current_page; |
|
| 22 | + |
|
| 23 | + /** Path to the driver review addon. |
|
| 24 | + * @var string $path |
|
| 25 | + */ |
|
| 26 | + public $path; |
|
| 27 | + |
|
| 28 | + /** Path to the first page of the driver reviews collection. |
|
| 29 | + * @var string $first |
|
| 30 | + */ |
|
| 31 | + public $first; |
|
| 32 | + |
|
| 33 | + /** Path to the previous page of the driver reviews collection. |
|
| 34 | + * @var string $prev |
|
| 35 | + */ |
|
| 36 | + public $prev; |
|
| 37 | + |
|
| 38 | + /** Path to the next page of the driver reviews collection. |
|
| 39 | + * @var string $next |
|
| 40 | + */ |
|
| 41 | + public $next; |
|
| 42 | 42 | } |