@@ -7,212 +7,212 @@ |
||
7 | 7 | |
8 | 8 | class Address extends Common |
9 | 9 | { |
10 | - public $route_destination_id; |
|
11 | - public $alias; |
|
12 | - public $member_id; |
|
13 | - public $address; |
|
14 | - public $addressUpdate; |
|
15 | - public $is_depot = false; |
|
16 | - public $lat; |
|
17 | - public $lng; |
|
18 | - public $route_id; |
|
19 | - public $original_route_id; |
|
20 | - public $optimization_problem_id; |
|
21 | - public $sequence_no; |
|
22 | - public $geocoded; |
|
23 | - public $preferred_geocoding; |
|
24 | - public $failed_geocoding; |
|
25 | - public $geocodings = []; |
|
26 | - public $contact_id; |
|
27 | - public $is_visited; |
|
28 | - public $customer_po; |
|
29 | - public $invoice_no; |
|
30 | - public $reference_no; |
|
31 | - public $order_no; |
|
32 | - public $weight; |
|
33 | - public $cost; |
|
34 | - public $revenue; |
|
35 | - public $cube; |
|
36 | - public $pieces; |
|
37 | - public $email; |
|
38 | - public $phone; |
|
39 | - public $tracking_number; |
|
40 | - public $destination_note_count; |
|
41 | - public $drive_time_to_next_destination; |
|
42 | - public $distance_to_next_destination; |
|
43 | - public $generated_time_window_start; |
|
44 | - public $generated_time_window_end; |
|
45 | - public $time_window_start; |
|
46 | - public $time_window_end; |
|
47 | - public $time; |
|
48 | - public $notes; |
|
49 | - public $timestamp_last_visited; |
|
50 | - public $custom_fields = []; |
|
51 | - public $manifest = []; |
|
52 | - |
|
53 | - public $first_name; |
|
54 | - public $last_name; |
|
55 | - public $is_departed; |
|
56 | - public $timestamp_last_departed; |
|
57 | - public $order_id; |
|
58 | - public $priority; |
|
59 | - public $curbside_lat; |
|
60 | - public $curbside_lng; |
|
61 | - public $time_window_start_2; |
|
62 | - public $time_window_end_2; |
|
63 | - |
|
64 | - public $timeframe_violation_state; |
|
65 | - public $timeframe_violation_time; |
|
66 | - public $timeframe_violation_rate; |
|
67 | - public $route_name; |
|
68 | - public $address_stop_type; |
|
69 | - public $visited_lat; |
|
70 | - public $visited_lng; |
|
71 | - public $departed_lat; |
|
72 | - public $departed_lng; |
|
73 | - public $group; |
|
74 | - public $abnormal_traffic_time_to_next_destination; |
|
75 | - public $uncongested_time_to_next_destination; |
|
76 | - public $traffic_time_to_next_destination; |
|
77 | - public $channel_name; |
|
78 | - public $pickup; |
|
79 | - public $dropoff; |
|
80 | - public $joint; |
|
81 | - public $geofence_detected_visited_timestamp; |
|
82 | - public $geofence_detected_departed_timestamp; |
|
83 | - public $geofence_detected_service_time; |
|
84 | - public $geofence_detected_visited_lat; |
|
85 | - public $geofence_detected_visited_lng; |
|
86 | - public $geofence_detected_departed_lat; |
|
87 | - public $geofence_detected_departed_lng; |
|
88 | - public $custom_fields_str_json; |
|
89 | - public $custom_fields_config; |
|
90 | - public $custom_fields_config_str_json; |
|
91 | - public $bundle_count; |
|
92 | - public $bundle_items; |
|
93 | - public $order_inventory; |
|
94 | - public $required_skills; |
|
95 | - public $udu_distance_to_next_destination; |
|
96 | - public $wait_time_to_next_destination; |
|
97 | - public $path_to_next = []; |
|
98 | - public $additional_status; |
|
99 | - public $tags = []; |
|
100 | - |
|
101 | - public function __construct() |
|
102 | - { |
|
103 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
104 | - } |
|
105 | - |
|
106 | - public static function getAddress($routeId, $addressId) |
|
107 | - { |
|
108 | - $address = Route4Me::makeRequst([ |
|
109 | - 'url' => Endpoint::ADDRESS_V4, |
|
110 | - 'method' => 'GET', |
|
111 | - 'query' => [ |
|
112 | - 'route_id' => $routeId, |
|
113 | - 'route_destination_id' => $addressId, |
|
114 | - ], |
|
115 | - ]); |
|
116 | - |
|
117 | - return self::fromArray($address); |
|
118 | - } |
|
119 | - |
|
120 | - public function update() |
|
121 | - { |
|
122 | - $addressUpdate = Route4Me::makeRequst([ |
|
123 | - 'url' => Endpoint::ADDRESS_V4, |
|
124 | - 'method' => 'PUT', |
|
125 | - 'body' => $this->toArray(), |
|
126 | - 'query' => [ |
|
127 | - 'route_id' => $this->route_id, |
|
128 | - 'route_destination_id' => $this->route_destination_id, |
|
129 | - ], |
|
130 | - ]); |
|
131 | - |
|
132 | - return self::fromArray($addressUpdate); |
|
133 | - } |
|
134 | - |
|
135 | - /* |
|
10 | + public $route_destination_id; |
|
11 | + public $alias; |
|
12 | + public $member_id; |
|
13 | + public $address; |
|
14 | + public $addressUpdate; |
|
15 | + public $is_depot = false; |
|
16 | + public $lat; |
|
17 | + public $lng; |
|
18 | + public $route_id; |
|
19 | + public $original_route_id; |
|
20 | + public $optimization_problem_id; |
|
21 | + public $sequence_no; |
|
22 | + public $geocoded; |
|
23 | + public $preferred_geocoding; |
|
24 | + public $failed_geocoding; |
|
25 | + public $geocodings = []; |
|
26 | + public $contact_id; |
|
27 | + public $is_visited; |
|
28 | + public $customer_po; |
|
29 | + public $invoice_no; |
|
30 | + public $reference_no; |
|
31 | + public $order_no; |
|
32 | + public $weight; |
|
33 | + public $cost; |
|
34 | + public $revenue; |
|
35 | + public $cube; |
|
36 | + public $pieces; |
|
37 | + public $email; |
|
38 | + public $phone; |
|
39 | + public $tracking_number; |
|
40 | + public $destination_note_count; |
|
41 | + public $drive_time_to_next_destination; |
|
42 | + public $distance_to_next_destination; |
|
43 | + public $generated_time_window_start; |
|
44 | + public $generated_time_window_end; |
|
45 | + public $time_window_start; |
|
46 | + public $time_window_end; |
|
47 | + public $time; |
|
48 | + public $notes; |
|
49 | + public $timestamp_last_visited; |
|
50 | + public $custom_fields = []; |
|
51 | + public $manifest = []; |
|
52 | + |
|
53 | + public $first_name; |
|
54 | + public $last_name; |
|
55 | + public $is_departed; |
|
56 | + public $timestamp_last_departed; |
|
57 | + public $order_id; |
|
58 | + public $priority; |
|
59 | + public $curbside_lat; |
|
60 | + public $curbside_lng; |
|
61 | + public $time_window_start_2; |
|
62 | + public $time_window_end_2; |
|
63 | + |
|
64 | + public $timeframe_violation_state; |
|
65 | + public $timeframe_violation_time; |
|
66 | + public $timeframe_violation_rate; |
|
67 | + public $route_name; |
|
68 | + public $address_stop_type; |
|
69 | + public $visited_lat; |
|
70 | + public $visited_lng; |
|
71 | + public $departed_lat; |
|
72 | + public $departed_lng; |
|
73 | + public $group; |
|
74 | + public $abnormal_traffic_time_to_next_destination; |
|
75 | + public $uncongested_time_to_next_destination; |
|
76 | + public $traffic_time_to_next_destination; |
|
77 | + public $channel_name; |
|
78 | + public $pickup; |
|
79 | + public $dropoff; |
|
80 | + public $joint; |
|
81 | + public $geofence_detected_visited_timestamp; |
|
82 | + public $geofence_detected_departed_timestamp; |
|
83 | + public $geofence_detected_service_time; |
|
84 | + public $geofence_detected_visited_lat; |
|
85 | + public $geofence_detected_visited_lng; |
|
86 | + public $geofence_detected_departed_lat; |
|
87 | + public $geofence_detected_departed_lng; |
|
88 | + public $custom_fields_str_json; |
|
89 | + public $custom_fields_config; |
|
90 | + public $custom_fields_config_str_json; |
|
91 | + public $bundle_count; |
|
92 | + public $bundle_items; |
|
93 | + public $order_inventory; |
|
94 | + public $required_skills; |
|
95 | + public $udu_distance_to_next_destination; |
|
96 | + public $wait_time_to_next_destination; |
|
97 | + public $path_to_next = []; |
|
98 | + public $additional_status; |
|
99 | + public $tags = []; |
|
100 | + |
|
101 | + public function __construct() |
|
102 | + { |
|
103 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
104 | + } |
|
105 | + |
|
106 | + public static function getAddress($routeId, $addressId) |
|
107 | + { |
|
108 | + $address = Route4Me::makeRequst([ |
|
109 | + 'url' => Endpoint::ADDRESS_V4, |
|
110 | + 'method' => 'GET', |
|
111 | + 'query' => [ |
|
112 | + 'route_id' => $routeId, |
|
113 | + 'route_destination_id' => $addressId, |
|
114 | + ], |
|
115 | + ]); |
|
116 | + |
|
117 | + return self::fromArray($address); |
|
118 | + } |
|
119 | + |
|
120 | + public function update() |
|
121 | + { |
|
122 | + $addressUpdate = Route4Me::makeRequst([ |
|
123 | + 'url' => Endpoint::ADDRESS_V4, |
|
124 | + 'method' => 'PUT', |
|
125 | + 'body' => $this->toArray(), |
|
126 | + 'query' => [ |
|
127 | + 'route_id' => $this->route_id, |
|
128 | + 'route_destination_id' => $this->route_destination_id, |
|
129 | + ], |
|
130 | + ]); |
|
131 | + |
|
132 | + return self::fromArray($addressUpdate); |
|
133 | + } |
|
134 | + |
|
135 | + /* |
|
136 | 136 | * Marks an address as marked as visited/as departed |
137 | 137 | * depending on which parameter is specified: 'is_visited' or 'is_departed'. |
138 | 138 | */ |
139 | - public function markAddress($params) |
|
140 | - { |
|
141 | - $allQueryFields = ['route_id', 'route_destination_id']; |
|
142 | - $allBodyFields = ['is_visited', 'is_departed']; |
|
143 | - |
|
144 | - $result = Route4Me::makeRequst([ |
|
145 | - 'url' => Endpoint::ADDRESS_V4, |
|
146 | - 'method' => 'PUT', |
|
147 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
148 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
149 | - ]); |
|
150 | - |
|
151 | - return $result; |
|
152 | - } |
|
153 | - |
|
154 | - /* |
|
139 | + public function markAddress($params) |
|
140 | + { |
|
141 | + $allQueryFields = ['route_id', 'route_destination_id']; |
|
142 | + $allBodyFields = ['is_visited', 'is_departed']; |
|
143 | + |
|
144 | + $result = Route4Me::makeRequst([ |
|
145 | + 'url' => Endpoint::ADDRESS_V4, |
|
146 | + 'method' => 'PUT', |
|
147 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
148 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
149 | + ]); |
|
150 | + |
|
151 | + return $result; |
|
152 | + } |
|
153 | + |
|
154 | + /* |
|
155 | 155 | * Marks an address as departed. |
156 | 156 | */ |
157 | - public function markAsDeparted($params) |
|
158 | - { |
|
159 | - $allQueryFields = ['route_id', 'address_id', 'is_departed', 'member_id']; |
|
157 | + public function markAsDeparted($params) |
|
158 | + { |
|
159 | + $allQueryFields = ['route_id', 'address_id', 'is_departed', 'member_id']; |
|
160 | 160 | |
161 | - $address = Route4Me::makeRequst([ |
|
162 | - 'url' => Endpoint::MARK_ADDRESS_DEPARTED, |
|
163 | - 'method' => 'PUT', |
|
164 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
165 | - ]); |
|
161 | + $address = Route4Me::makeRequst([ |
|
162 | + 'url' => Endpoint::MARK_ADDRESS_DEPARTED, |
|
163 | + 'method' => 'PUT', |
|
164 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
165 | + ]); |
|
166 | 166 | |
167 | - return $address; |
|
168 | - } |
|
167 | + return $address; |
|
168 | + } |
|
169 | 169 | |
170 | - /* |
|
170 | + /* |
|
171 | 171 | * Marks an address as visited. |
172 | 172 | */ |
173 | - public function markAsVisited($params) |
|
174 | - { |
|
175 | - $allQueryFields = ['route_id', 'address_id', 'is_visited', 'member_id']; |
|
176 | - |
|
177 | - $address = Route4Me::makeRequst([ |
|
178 | - 'url' => Endpoint::UPDATE_ADDRESS_VISITED, |
|
179 | - 'method' => 'PUT', |
|
180 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
181 | - ]); |
|
182 | - |
|
183 | - return $address; |
|
184 | - } |
|
185 | - |
|
186 | - public function deleteAddress() |
|
187 | - { |
|
188 | - $address = Route4Me::makeRequst([ |
|
189 | - 'url' => Endpoint::ADDRESS_V4, |
|
190 | - 'method' => 'DELETE', |
|
191 | - 'query' => [ |
|
192 | - 'route_id' => $this->route_id, |
|
193 | - 'route_destination_id' => $this->route_destination_id, |
|
194 | - ], |
|
195 | - ]); |
|
196 | - |
|
197 | - return (bool) $address['deleted']; |
|
198 | - } |
|
199 | - |
|
200 | - public function moveDestinationToRoute($params) |
|
201 | - { |
|
202 | - $allBodyFields = ['to_route_id', 'route_destination_id', 'after_destination_id']; |
|
203 | - |
|
204 | - $result = Route4Me::makeRequst([ |
|
205 | - 'url' => Endpoint::MOVE_ROUTE_DESTINATION, |
|
206 | - 'method' => 'POST', |
|
207 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
208 | - 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
209 | - ]); |
|
210 | - |
|
211 | - return $result; |
|
212 | - } |
|
213 | - |
|
214 | - public function getAddressId() |
|
215 | - { |
|
216 | - return $this->route_destination_id; |
|
217 | - } |
|
173 | + public function markAsVisited($params) |
|
174 | + { |
|
175 | + $allQueryFields = ['route_id', 'address_id', 'is_visited', 'member_id']; |
|
176 | + |
|
177 | + $address = Route4Me::makeRequst([ |
|
178 | + 'url' => Endpoint::UPDATE_ADDRESS_VISITED, |
|
179 | + 'method' => 'PUT', |
|
180 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
181 | + ]); |
|
182 | + |
|
183 | + return $address; |
|
184 | + } |
|
185 | + |
|
186 | + public function deleteAddress() |
|
187 | + { |
|
188 | + $address = Route4Me::makeRequst([ |
|
189 | + 'url' => Endpoint::ADDRESS_V4, |
|
190 | + 'method' => 'DELETE', |
|
191 | + 'query' => [ |
|
192 | + 'route_id' => $this->route_id, |
|
193 | + 'route_destination_id' => $this->route_destination_id, |
|
194 | + ], |
|
195 | + ]); |
|
196 | + |
|
197 | + return (bool) $address['deleted']; |
|
198 | + } |
|
199 | + |
|
200 | + public function moveDestinationToRoute($params) |
|
201 | + { |
|
202 | + $allBodyFields = ['to_route_id', 'route_destination_id', 'after_destination_id']; |
|
203 | + |
|
204 | + $result = Route4Me::makeRequst([ |
|
205 | + 'url' => Endpoint::MOVE_ROUTE_DESTINATION, |
|
206 | + 'method' => 'POST', |
|
207 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
208 | + 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
209 | + ]); |
|
210 | + |
|
211 | + return $result; |
|
212 | + } |
|
213 | + |
|
214 | + public function getAddressId() |
|
215 | + { |
|
216 | + return $this->route_destination_id; |
|
217 | + } |
|
218 | 218 | } |
@@ -6,7 +6,7 @@ |
||
6 | 6 | |
7 | 7 | class AddressBookLocationSearchResponse |
8 | 8 | { |
9 | - public $results=[]; |
|
10 | - public $total; |
|
11 | - public $fields=[]; |
|
9 | + public $results=[]; |
|
10 | + public $total; |
|
11 | + public $fields=[]; |
|
12 | 12 | } |
@@ -12,139 +12,139 @@ |
||
12 | 12 | */ |
13 | 13 | class RouteParametersQuery extends Common |
14 | 14 | { |
15 | - /** Route IDs concatenated with a comma |
|
16 | - * @var string $route_id |
|
17 | - */ |
|
18 | - public $route_id; |
|
19 | - |
|
20 | - /** Require Route directions in the results. |
|
21 | - * @var boolean $directions |
|
22 | - */ |
|
23 | - public $directions; |
|
24 | - |
|
25 | - /** Path output style. |
|
26 | - * Available values: |
|
27 | - * - Points; |
|
28 | - * - Encoded; |
|
29 | - * - None. |
|
30 | - * @var string $route_path_output |
|
31 | - */ |
|
32 | - public $route_path_output; |
|
33 | - |
|
34 | - /** Output route tracking data in response |
|
35 | - * @var boolean $device_tracking_history |
|
36 | - */ |
|
37 | - public $device_tracking_history; |
|
38 | - |
|
39 | - /** Limit of the queried records number. |
|
40 | - * @var integer $limit |
|
41 | - */ |
|
42 | - public $limit; |
|
43 | - |
|
44 | - /** Offset from the beginning of the queried records. |
|
45 | - * @var integer $offset |
|
46 | - */ |
|
47 | - public $offset; |
|
48 | - |
|
49 | - /** Start timestamp of the date range |
|
50 | - * @var integer $start_date |
|
51 | - */ |
|
52 | - public $start_date; |
|
53 | - |
|
54 | - /** End timestamp of the date range. |
|
55 | - * @var integer $end_date |
|
56 | - */ |
|
57 | - public $end_date; |
|
58 | - |
|
59 | - /** Output addresses and directions in the original optimization request sequence. |
|
60 | - * This is to allow us to compare routes before & after optimization. |
|
61 | - * @var boolean $original |
|
62 | - */ |
|
63 | - public $original; |
|
64 | - |
|
65 | - /** Require Route notes in the results. |
|
66 | - * @var boolean $notes |
|
67 | - */ |
|
68 | - public $notes; |
|
69 | - |
|
70 | - /** Require Order Inventories in the results. |
|
71 | - * @var boolean $order_inventory |
|
72 | - */ |
|
73 | - public $order_inventory; |
|
74 | - |
|
75 | - /** If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
76 | - * @var boolean $remaining |
|
77 | - */ |
|
78 | - public $remaining; |
|
79 | - |
|
80 | - /** Search the query for a Route |
|
81 | - * @var string $query |
|
82 | - */ |
|
83 | - public $query; |
|
84 | - |
|
85 | - /** Updating a route supports the reoptimize=1 parameter, |
|
86 | - * which reoptimizes only that route. |
|
87 | - * Also supports the parameters from GET. |
|
88 | - * @var boolean $reoptimize |
|
89 | - */ |
|
90 | - public $reoptimize; |
|
91 | - |
|
92 | - /** Whether disable or not a route optimization. |
|
93 | - * @var boolean $disable_optimization |
|
94 | - */ |
|
95 | - public $disable_optimization; |
|
96 | - |
|
97 | - /** The driving directions will be generated biased for this selection. This has no impact on route sequencing. |
|
98 | - * <para>Available values: </para> |
|
99 | - * <value>'Distance', 'Time', 'timeWithTraffic'.</value> |
|
100 | - * <remarks><para>Query parameter.</para></remarks> |
|
101 | - * @var string $optimize |
|
102 | - */ |
|
103 | - public $optimize; |
|
104 | - |
|
105 | - /** By sending recompute_directions=1 we request that the route directions |
|
106 | - * be recomputed (note that this does happen automatically if certain properties |
|
107 | - * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
108 | - * @var boolean $recompute_directions |
|
109 | - */ |
|
110 | - public $recompute_directions; |
|
111 | - |
|
112 | - /** Response format('json', 'csv', 'xml') |
|
113 | - * @var string $response_format |
|
114 | - */ |
|
115 | - public $response_format; |
|
116 | - |
|
117 | - /** Route destination ID |
|
118 | - * @var integer $route_destination_id |
|
119 | - */ |
|
120 | - public $route_destination_id; |
|
121 | - |
|
122 | - /** |
|
123 | - * @var boolean $redirect |
|
124 | - */ |
|
125 | - public $redirect; |
|
126 | - |
|
127 | - /** Require bundled Items in the results. |
|
128 | - * @var boolean $bundling_items |
|
129 | - */ |
|
130 | - public $bundling_items; |
|
131 | - |
|
132 | - /** Requested page. |
|
133 | - * @var integer $page |
|
134 | - */ |
|
135 | - public $page; |
|
136 | - |
|
137 | - /** Number of Routes per page. |
|
138 | - * @var integer $per_page |
|
139 | - */ |
|
140 | - public $per_page; |
|
141 | - |
|
142 | - public static function getAllProperties() |
|
143 | - { |
|
144 | - $routeQueryParams = new self(); |
|
145 | - |
|
146 | - $fields = array_keys(get_object_vars($routeQueryParams)); |
|
147 | - |
|
148 | - return $fields; |
|
149 | - } |
|
15 | + /** Route IDs concatenated with a comma |
|
16 | + * @var string $route_id |
|
17 | + */ |
|
18 | + public $route_id; |
|
19 | + |
|
20 | + /** Require Route directions in the results. |
|
21 | + * @var boolean $directions |
|
22 | + */ |
|
23 | + public $directions; |
|
24 | + |
|
25 | + /** Path output style. |
|
26 | + * Available values: |
|
27 | + * - Points; |
|
28 | + * - Encoded; |
|
29 | + * - None. |
|
30 | + * @var string $route_path_output |
|
31 | + */ |
|
32 | + public $route_path_output; |
|
33 | + |
|
34 | + /** Output route tracking data in response |
|
35 | + * @var boolean $device_tracking_history |
|
36 | + */ |
|
37 | + public $device_tracking_history; |
|
38 | + |
|
39 | + /** Limit of the queried records number. |
|
40 | + * @var integer $limit |
|
41 | + */ |
|
42 | + public $limit; |
|
43 | + |
|
44 | + /** Offset from the beginning of the queried records. |
|
45 | + * @var integer $offset |
|
46 | + */ |
|
47 | + public $offset; |
|
48 | + |
|
49 | + /** Start timestamp of the date range |
|
50 | + * @var integer $start_date |
|
51 | + */ |
|
52 | + public $start_date; |
|
53 | + |
|
54 | + /** End timestamp of the date range. |
|
55 | + * @var integer $end_date |
|
56 | + */ |
|
57 | + public $end_date; |
|
58 | + |
|
59 | + /** Output addresses and directions in the original optimization request sequence. |
|
60 | + * This is to allow us to compare routes before & after optimization. |
|
61 | + * @var boolean $original |
|
62 | + */ |
|
63 | + public $original; |
|
64 | + |
|
65 | + /** Require Route notes in the results. |
|
66 | + * @var boolean $notes |
|
67 | + */ |
|
68 | + public $notes; |
|
69 | + |
|
70 | + /** Require Order Inventories in the results. |
|
71 | + * @var boolean $order_inventory |
|
72 | + */ |
|
73 | + public $order_inventory; |
|
74 | + |
|
75 | + /** If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
76 | + * @var boolean $remaining |
|
77 | + */ |
|
78 | + public $remaining; |
|
79 | + |
|
80 | + /** Search the query for a Route |
|
81 | + * @var string $query |
|
82 | + */ |
|
83 | + public $query; |
|
84 | + |
|
85 | + /** Updating a route supports the reoptimize=1 parameter, |
|
86 | + * which reoptimizes only that route. |
|
87 | + * Also supports the parameters from GET. |
|
88 | + * @var boolean $reoptimize |
|
89 | + */ |
|
90 | + public $reoptimize; |
|
91 | + |
|
92 | + /** Whether disable or not a route optimization. |
|
93 | + * @var boolean $disable_optimization |
|
94 | + */ |
|
95 | + public $disable_optimization; |
|
96 | + |
|
97 | + /** The driving directions will be generated biased for this selection. This has no impact on route sequencing. |
|
98 | + * <para>Available values: </para> |
|
99 | + * <value>'Distance', 'Time', 'timeWithTraffic'.</value> |
|
100 | + * <remarks><para>Query parameter.</para></remarks> |
|
101 | + * @var string $optimize |
|
102 | + */ |
|
103 | + public $optimize; |
|
104 | + |
|
105 | + /** By sending recompute_directions=1 we request that the route directions |
|
106 | + * be recomputed (note that this does happen automatically if certain properties |
|
107 | + * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
108 | + * @var boolean $recompute_directions |
|
109 | + */ |
|
110 | + public $recompute_directions; |
|
111 | + |
|
112 | + /** Response format('json', 'csv', 'xml') |
|
113 | + * @var string $response_format |
|
114 | + */ |
|
115 | + public $response_format; |
|
116 | + |
|
117 | + /** Route destination ID |
|
118 | + * @var integer $route_destination_id |
|
119 | + */ |
|
120 | + public $route_destination_id; |
|
121 | + |
|
122 | + /** |
|
123 | + * @var boolean $redirect |
|
124 | + */ |
|
125 | + public $redirect; |
|
126 | + |
|
127 | + /** Require bundled Items in the results. |
|
128 | + * @var boolean $bundling_items |
|
129 | + */ |
|
130 | + public $bundling_items; |
|
131 | + |
|
132 | + /** Requested page. |
|
133 | + * @var integer $page |
|
134 | + */ |
|
135 | + public $page; |
|
136 | + |
|
137 | + /** Number of Routes per page. |
|
138 | + * @var integer $per_page |
|
139 | + */ |
|
140 | + public $per_page; |
|
141 | + |
|
142 | + public static function getAllProperties() |
|
143 | + { |
|
144 | + $routeQueryParams = new self(); |
|
145 | + |
|
146 | + $fields = array_keys(get_object_vars($routeQueryParams)); |
|
147 | + |
|
148 | + return $fields; |
|
149 | + } |
|
150 | 150 | } |
@@ -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 | } |