@@ -13,137 +13,137 @@ |
||
13 | 13 | |
14 | 14 | class MemberConfiguration extends \Route4Me\Common |
15 | 15 | { |
16 | - /* |
|
16 | + /* |
|
17 | 17 | * The member ID |
18 | 18 | */ |
19 | - public $member_id; |
|
19 | + public $member_id; |
|
20 | 20 | |
21 | - /* |
|
21 | + /* |
|
22 | 22 | * The member's config key |
23 | 23 | */ |
24 | - public $config_key; |
|
24 | + public $config_key; |
|
25 | 25 | |
26 | - /* |
|
26 | + /* |
|
27 | 27 | * The member's config value |
28 | 28 | */ |
29 | - public $config_value; |
|
29 | + public $config_value; |
|
30 | 30 | |
31 | - /* |
|
31 | + /* |
|
32 | 32 | * True, if the value is hidden. |
33 | 33 | */ |
34 | - public $is_hidden_value; |
|
34 | + public $is_hidden_value; |
|
35 | 35 | |
36 | - /* |
|
36 | + /* |
|
37 | 37 | * If true, the value is showable. |
38 | 38 | */ |
39 | - public $can_unhide_value; |
|
39 | + public $can_unhide_value; |
|
40 | 40 | |
41 | - public function __construct() |
|
42 | - { |
|
43 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
44 | - } |
|
41 | + public function __construct() |
|
42 | + { |
|
43 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
44 | + } |
|
45 | 45 | |
46 | - /* |
|
46 | + /* |
|
47 | 47 | * Create new member configuration key-value pair. |
48 | 48 | * @param array $params |
49 | 49 | * Contains key-value pair: 'config_key': 'config_value' |
50 | 50 | * @param string $errorText |
51 | 51 | * Error message text |
52 | 52 | */ |
53 | - public function CreateNewConfigurationData($params, &$errorText) |
|
54 | - { |
|
55 | - $allBodyFields = ['config_key', 'config_value']; |
|
56 | - |
|
57 | - $response = null; |
|
58 | - |
|
59 | - try { |
|
60 | - $response = Route4Me::makeRequst([ |
|
61 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
62 | - 'method' => 'POST', |
|
63 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
64 | - ]); |
|
65 | - } catch (\Exception $ex) { |
|
66 | - $errorText = $ex->getMessage(); |
|
67 | - } finally { |
|
68 | - return $response; |
|
69 | - } |
|
70 | - } |
|
71 | - |
|
72 | - /* |
|
53 | + public function CreateNewConfigurationData($params, &$errorText) |
|
54 | + { |
|
55 | + $allBodyFields = ['config_key', 'config_value']; |
|
56 | + |
|
57 | + $response = null; |
|
58 | + |
|
59 | + try { |
|
60 | + $response = Route4Me::makeRequst([ |
|
61 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
62 | + 'method' => 'POST', |
|
63 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
64 | + ]); |
|
65 | + } catch (\Exception $ex) { |
|
66 | + $errorText = $ex->getMessage(); |
|
67 | + } finally { |
|
68 | + return $response; |
|
69 | + } |
|
70 | + } |
|
71 | + |
|
72 | + /* |
|
73 | 73 | * Update the value of the specified key. |
74 | 74 | * @param array $params |
75 | 75 | * Contains key-value pair: 'config_key': 'config_value'. |
76 | 76 | * @param string $errorText |
77 | 77 | * Error message text |
78 | 78 | */ |
79 | - public function UpdateConfigurationData($params, &$errorText) |
|
80 | - { |
|
81 | - $allBodyFields = ['config_key', 'config_value']; |
|
82 | - |
|
83 | - $response = null; |
|
84 | - |
|
85 | - try { |
|
86 | - $response = Route4Me::makeRequst([ |
|
87 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
88 | - 'method' => 'PUT', |
|
89 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params) |
|
90 | - ]); |
|
91 | - } catch (\Exception $ex) { |
|
92 | - $errorText = $ex->getMessage(); |
|
93 | - } finally { |
|
94 | - return $response; |
|
95 | - } |
|
96 | - } |
|
97 | - |
|
98 | - /* |
|
79 | + public function UpdateConfigurationData($params, &$errorText) |
|
80 | + { |
|
81 | + $allBodyFields = ['config_key', 'config_value']; |
|
82 | + |
|
83 | + $response = null; |
|
84 | + |
|
85 | + try { |
|
86 | + $response = Route4Me::makeRequst([ |
|
87 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
88 | + 'method' => 'PUT', |
|
89 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params) |
|
90 | + ]); |
|
91 | + } catch (\Exception $ex) { |
|
92 | + $errorText = $ex->getMessage(); |
|
93 | + } finally { |
|
94 | + return $response; |
|
95 | + } |
|
96 | + } |
|
97 | + |
|
98 | + /* |
|
99 | 99 | * Removes specified member configuration key. |
100 | 100 | * @param array $params |
101 | 101 | * Contains key-value pair: 'config_key': 'config_value'. |
102 | 102 | * @param string $errorText |
103 | 103 | * Error message text |
104 | 104 | */ |
105 | - public function RemoveConfigurationData($params, &$errorText) |
|
106 | - { |
|
107 | - if (!isset($params['config_key'])) { |
|
108 | - $errorText = 'The parameter config_key is not specified'; |
|
109 | - return null; |
|
110 | - } |
|
111 | - |
|
112 | - $response = null; |
|
113 | - |
|
114 | - try { |
|
115 | - $response = Route4Me::makeRequst([ |
|
116 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
117 | - 'method' => 'DELETE', |
|
118 | - 'body' => [ |
|
119 | - 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
120 | - ], |
|
121 | - ]); |
|
122 | - } catch (\Exception $ex) { |
|
123 | - $errorText = $ex->getMessage(); |
|
124 | - } finally { |
|
125 | - return $response; |
|
126 | - } |
|
127 | - } |
|
128 | - |
|
129 | - /* |
|
105 | + public function RemoveConfigurationData($params, &$errorText) |
|
106 | + { |
|
107 | + if (!isset($params['config_key'])) { |
|
108 | + $errorText = 'The parameter config_key is not specified'; |
|
109 | + return null; |
|
110 | + } |
|
111 | + |
|
112 | + $response = null; |
|
113 | + |
|
114 | + try { |
|
115 | + $response = Route4Me::makeRequst([ |
|
116 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
117 | + 'method' => 'DELETE', |
|
118 | + 'body' => [ |
|
119 | + 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
120 | + ], |
|
121 | + ]); |
|
122 | + } catch (\Exception $ex) { |
|
123 | + $errorText = $ex->getMessage(); |
|
124 | + } finally { |
|
125 | + return $response; |
|
126 | + } |
|
127 | + } |
|
128 | + |
|
129 | + /* |
|
130 | 130 | * Retrieves configuration data from a member account. |
131 | 131 | * param array $params |
132 | 132 | * If specified, it contains the key 'config_key' and retrieved only corresponding configuration data, |
133 | 133 | * if not, all member configuration data retrieved. |
134 | 134 | */ |
135 | - public function GetConfigurationData($params = null) |
|
136 | - { |
|
137 | - $allQueryFields = ['config_key']; |
|
138 | - |
|
139 | - $response = Route4Me::makeRequst([ |
|
140 | - 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
141 | - 'method' => 'GET', |
|
142 | - 'query' => [ |
|
143 | - 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
144 | - ], |
|
145 | - ]); |
|
146 | - |
|
147 | - return $response; |
|
148 | - } |
|
135 | + public function GetConfigurationData($params = null) |
|
136 | + { |
|
137 | + $allQueryFields = ['config_key']; |
|
138 | + |
|
139 | + $response = Route4Me::makeRequst([ |
|
140 | + 'url' => Endpoint::CONFIGURATION_SETTINGS, |
|
141 | + 'method' => 'GET', |
|
142 | + 'query' => [ |
|
143 | + 'config_key' => isset($params['config_key']) ? $params['config_key'] : null |
|
144 | + ], |
|
145 | + ]); |
|
146 | + |
|
147 | + return $response; |
|
148 | + } |
|
149 | 149 | } |
@@ -7,38 +7,38 @@ |
||
7 | 7 | */ |
8 | 8 | class MemberCapabilities extends \Route4Me\Common |
9 | 9 | { |
10 | - /* |
|
10 | + /* |
|
11 | 11 | * Array of the avoidance zone IDs. |
12 | 12 | */ |
13 | - public $avoid = []; |
|
13 | + public $avoid = []; |
|
14 | 14 | |
15 | - /* |
|
15 | + /* |
|
16 | 16 | * Road avoid options: "Highways", "Tolls", "highways,tolls". |
17 | 17 | */ |
18 | - public $avoid_roads = []; |
|
18 | + public $avoid_roads = []; |
|
19 | 19 | |
20 | - /* |
|
20 | + /* |
|
21 | 21 | * Restriction options. |
22 | 22 | */ |
23 | - public $features = []; |
|
23 | + public $features = []; |
|
24 | 24 | |
25 | - /* |
|
25 | + /* |
|
26 | 26 | * Travel modes: "Highways", "Tolls", "highways,tolls". |
27 | 27 | */ |
28 | - public $travelModes = []; |
|
28 | + public $travelModes = []; |
|
29 | 29 | |
30 | - /* |
|
30 | + /* |
|
31 | 31 | * Navigate options |
32 | 32 | */ |
33 | - public $navigateBy = []; |
|
33 | + public $navigateBy = []; |
|
34 | 34 | |
35 | - /* |
|
35 | + /* |
|
36 | 36 | * Array of the license modules |
37 | 37 | */ |
38 | - public $LicensedModules = []; |
|
38 | + public $LicensedModules = []; |
|
39 | 39 | |
40 | - /* |
|
40 | + /* |
|
41 | 41 | * If true, the member subscription is commercial. |
42 | 42 | */ |
43 | - public $commercial; |
|
43 | + public $commercial; |
|
44 | 44 | } |
@@ -9,397 +9,397 @@ |
||
9 | 9 | */ |
10 | 10 | class MemberResponse extends \Route4Me\Common |
11 | 11 | { |
12 | - /** @var boolean $authenticated |
|
13 | - * A boolean flag indicating if the session is valid. |
|
14 | - */ |
|
15 | - public $authenticated; |
|
16 | - |
|
17 | - /** @var boolean $status |
|
18 | - * Process status |
|
19 | - */ |
|
20 | - public $status; |
|
21 | - |
|
22 | - /** @var string $geocoding_service |
|
23 | - * Geocoding service |
|
24 | - */ |
|
25 | - public $geocoding_service; |
|
26 | - |
|
27 | - /** @var string $session_id |
|
28 | - * The integer session id of the current session. |
|
29 | - */ |
|
30 | - public $session_id; |
|
31 | - |
|
32 | - /** @var string $session_guid |
|
33 | - * An MD5 hash string of the currently authenticated sesssion, |
|
34 | - * important to use this with future requests. |
|
35 | - */ |
|
36 | - public $session_guid; |
|
37 | - |
|
38 | - /** @var string $member_first_name |
|
39 | - * The first name of the user. |
|
40 | - */ |
|
41 | - public $member_first_name; |
|
42 | - |
|
43 | - /** @var string $member_last_name |
|
44 | - * The last name of the user. |
|
45 | - */ |
|
46 | - public $member_last_name; |
|
47 | - |
|
48 | - /** @var int $member_timestamp_added |
|
49 | - * The unix timestamp when the user joined the service. |
|
50 | - */ |
|
51 | - public $member_timestamp_added; |
|
52 | - |
|
53 | - /** @var string $industry |
|
54 | - * The industry the authenticated user specified. |
|
55 | - */ |
|
56 | - public $industry; |
|
57 | - |
|
58 | - /** @var int $member_id |
|
59 | - * Member ID |
|
60 | - */ |
|
61 | - public $member_id; |
|
62 | - |
|
63 | - /** @var string $member_email |
|
64 | - * Member email |
|
65 | - */ |
|
66 | - public $member_email; |
|
67 | - |
|
68 | - /** @var boolean $is_trial |
|
69 | - * If the user is currently a trial customer. |
|
70 | - */ |
|
71 | - public $is_trial; |
|
72 | - |
|
73 | - /** @var boolean $is_active |
|
74 | - * If the user is currently an active customer. |
|
75 | - */ |
|
76 | - public $is_active; |
|
77 | - |
|
78 | - /** @var string $api_key |
|
79 | - * User's API key |
|
80 | - */ |
|
81 | - public $api_key; |
|
82 | - |
|
83 | - /** @var int $tracking_ttl |
|
84 | - * Tracking TTL |
|
85 | - */ |
|
86 | - public $tracking_ttl; |
|
87 | - |
|
88 | - /** @var boolean $hide_billing_section |
|
89 | - * Hide billing section. |
|
90 | - */ |
|
91 | - public $hide_billing_section; |
|
92 | - |
|
93 | - /** @var string $last_known_member_payment_device |
|
94 | - * Last known member payment device (e.g. 'web'). |
|
95 | - */ |
|
96 | - public $last_known_member_payment_device; |
|
97 | - |
|
98 | - /** @var array $licensed_modules |
|
99 | - * Licensed module. e.g.: |
|
100 | - * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
101 | - * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
102 | - * 'MODULE__VOICE_NAVIGATION' |
|
103 | - */ |
|
104 | - public $licensed_modules; |
|
105 | - |
|
106 | - /** @var boolean $member_business_type |
|
107 | - * Member business type (e.g. 'BUSINESS_EMPLOYEE'). |
|
108 | - */ |
|
109 | - public $member_business_type; |
|
110 | - |
|
111 | - /** @var string $geofence_polygon_shape |
|
112 | - * Geofence polygon shape. Available values: |
|
113 | - * 'circle', 'poly', 'rect'. |
|
114 | - */ |
|
115 | - public $geofence_polygon_shape; |
|
116 | - |
|
117 | - /** @var int $geofence_polygon_size |
|
118 | - * Geofence polygon size |
|
119 | - */ |
|
120 | - public $geofence_polygon_size; |
|
121 | - |
|
122 | - /** @var int $geofence_time_onsite_trigger_secs |
|
123 | - * Geofence onsite trigger time (seconds). |
|
124 | - */ |
|
125 | - public $geofence_time_onsite_trigger_secs; |
|
126 | - |
|
127 | - /** @var int $geofence_minimum_trigger_speed |
|
128 | - * Geofence's minimum trigger speed. |
|
129 | - */ |
|
130 | - public $geofence_minimum_trigger_speed; |
|
131 | - |
|
132 | - /** @var bool $is_subscription_past_due |
|
133 | - * True if the subscription is past due. |
|
134 | - */ |
|
135 | - public $is_subscription_past_due; |
|
136 | - |
|
137 | - /** @var string $visited_departed_enabled |
|
138 | - * If true, triggering of the visited and departed activities is enabled. |
|
139 | - */ |
|
140 | - public $visited_departed_enabled; |
|
141 | - |
|
142 | - /** @var string $long_press_enabled |
|
143 | - * If true, long press is enabled. |
|
144 | - */ |
|
145 | - public $long_press_enabled; |
|
146 | - |
|
147 | - /** @var int $account_type_id |
|
148 | - * The account type ID. |
|
149 | - */ |
|
150 | - public $account_type_id; |
|
151 | - |
|
152 | - /** @var string $current_price |
|
153 | - * Current price (e.g. '0.000'). |
|
154 | - */ |
|
155 | - public $current_price; |
|
156 | - |
|
157 | - /** @var int $initially_requested_account_type_id |
|
158 | - * Initially Requested account type ID. |
|
159 | - */ |
|
160 | - public $initially_requested_account_type_id; |
|
161 | - |
|
162 | - /** @var string $account_type_alias |
|
163 | - * Account type alias |
|
164 | - */ |
|
165 | - public $account_type_alias; |
|
166 | - |
|
167 | - /** @var string $member_type |
|
168 | - * Member type. Available values: |
|
169 | - * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
170 | - * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER, |
|
171 | - * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE |
|
172 | - */ |
|
173 | - public $member_type; |
|
174 | - |
|
175 | - /** @var string $OWNER_MEMBER_ID |
|
176 | - * Parent user ID. |
|
177 | - */ |
|
178 | - public $OWNER_MEMBER_ID; |
|
179 | - |
|
180 | - /** @var string $ROOT_OWNER_MEMBER_ID |
|
181 | - * Root owner member ID (e.g. '402088'). |
|
182 | - */ |
|
183 | - public $ROOT_OWNER_MEMBER_ID; |
|
184 | - |
|
185 | - /** @var string $ROOT_OWNER_MEMBER_EMAIL |
|
186 | - * Root owner member email. |
|
187 | - */ |
|
188 | - public $ROOT_OWNER_MEMBER_EMAIL; |
|
189 | - |
|
190 | - /** @var string $ROOT_OWNER_MEMBER_API_KEY |
|
191 | - * Root owner member API key. |
|
192 | - */ |
|
193 | - public $ROOT_OWNER_MEMBER_API_KEY; |
|
194 | - |
|
195 | - /** @var string $geocodingMethod |
|
196 | - * Geocoding method |
|
197 | - */ |
|
198 | - public $geocodingMethod; |
|
199 | - |
|
200 | - /** @var string $service_type |
|
201 | - * Service type (e.g. 'pre5'). |
|
202 | - */ |
|
203 | - public $service_type; |
|
204 | - |
|
205 | - /** @var string $validated_by |
|
206 | - * Validated by (e.g. 'ADMIN_PANEL'). |
|
207 | - */ |
|
208 | - public $validated_by; |
|
209 | - |
|
210 | - /** @var int $max_stops_per_route |
|
211 | - * Maximum allowed number of the stops per route. |
|
212 | - */ |
|
213 | - public $max_stops_per_route; |
|
214 | - |
|
215 | - /** @var int $max_routes |
|
216 | - * Maximum allowed number of the generated routes. |
|
217 | - */ |
|
218 | - public $max_routes; |
|
219 | - |
|
220 | - /** @var int $max_route |
|
221 | - * Maximum allowed number of the generated routes. |
|
222 | - */ |
|
223 | - public $max_route; |
|
224 | - |
|
225 | - /** @var int $route_planned |
|
226 | - * Planned route numbers |
|
227 | - */ |
|
228 | - public $route_planned; |
|
229 | - |
|
230 | - /** @var int $routes_planned |
|
231 | - * Routes Planned |
|
232 | - */ |
|
233 | - public $routes_planned; |
|
234 | - |
|
235 | - /** @var int $total_routes_planned |
|
236 | - * Total planned routes. |
|
237 | - */ |
|
238 | - public $total_routes_planned; |
|
239 | - |
|
240 | - /** @var int $authentication_count |
|
241 | - * Authentication count. |
|
242 | - */ |
|
243 | - public $authentication_count; |
|
244 | - |
|
245 | - /** @var string $salesforce_unique_record_id |
|
246 | - * Salesforce unique record ID. |
|
247 | - */ |
|
248 | - public $salesforce_unique_record_id; |
|
249 | - |
|
250 | - /** @var string $salesforce_account_id |
|
251 | - * Salesforce account ID |
|
252 | - */ |
|
253 | - public $salesforce_account_id; |
|
254 | - |
|
255 | - /** @var string $salesforce_lead_id |
|
256 | - * Salesforce lead ID |
|
257 | - */ |
|
258 | - public $salesforce_lead_id; |
|
259 | - |
|
260 | - /** @var int $max_api_optimization_addresses |
|
261 | - * The maximun number of addresses the authenticated user |
|
262 | - * can optimize in this billing cycle. |
|
263 | - */ |
|
264 | - public $max_api_optimization_addresses; |
|
265 | - |
|
266 | - /** @var int $max_api_geocoding_addresses |
|
267 | - * The maximun number of geocodings the authenticated user |
|
268 | - * can optimize in this billing cycle. |
|
269 | - */ |
|
270 | - public $max_api_geocoding_addresses; |
|
271 | - |
|
272 | - /** @var int $max_api_directions_addresses |
|
273 | - * The maximum number of driving route transactions the authenticated |
|
274 | - * user can execute in this billing cycle. |
|
275 | - */ |
|
276 | - public $max_api_directions_addresses; |
|
277 | - |
|
278 | - /** @var int $max_api_validation_addresses |
|
279 | - * The maximun number of address validation transactions the authenticated |
|
280 | - * user can execute in this billing cycle. |
|
281 | - */ |
|
282 | - public $max_api_validation_addresses; |
|
283 | - |
|
284 | - /** @var int $max_stops_per_unoptimized_route |
|
285 | - * The maximum number of stops the authenticated user |
|
286 | - * can put into a route with optimization disabled. |
|
287 | - */ |
|
288 | - public $max_stops_per_unoptimized_route; |
|
289 | - |
|
290 | - /** @var int $max_api_distance_tx |
|
291 | - * The maximum number of distance transactions the authenticated |
|
292 | - * user can execute in this billing cycle. |
|
293 | - */ |
|
294 | - public $max_api_distance_tx; |
|
295 | - |
|
296 | - /** @var boolean $blDisplayUpgradeTrackingHTML |
|
297 | - * Display upgrade tracking HTML. |
|
298 | - */ |
|
299 | - public $blDisplayUpgradeTrackingHTML; |
|
300 | - |
|
301 | - /** @var int $intTrackingTrigger |
|
302 | - * Tracking trigger (int). |
|
303 | - */ |
|
304 | - public $intTrackingTrigger; |
|
305 | - |
|
306 | - /** @var int $last_payment_ts |
|
307 | - * The last unix timestamp when this user was successfully charged. |
|
308 | - */ |
|
309 | - public $last_payment_ts; |
|
310 | - |
|
311 | - /** @var int $last_failed_payment_ts |
|
312 | - * The last unix timestamp when this user was failed to pay. |
|
313 | - */ |
|
314 | - public $last_failed_payment_ts; |
|
315 | - |
|
316 | - /** @var int $account_expires_timestamp |
|
317 | - * Account expire date |
|
318 | - */ |
|
319 | - public $account_expires_timestamp; |
|
320 | - |
|
321 | - /** @var boolean $account_past_due |
|
322 | - * Account past due |
|
323 | - */ |
|
324 | - public $account_past_due; |
|
325 | - |
|
326 | - /** @var string $ui_input_method |
|
327 | - * UI input method |
|
328 | - */ |
|
329 | - public $ui_input_method; |
|
330 | - |
|
331 | - /** @var string $registration_app |
|
332 | - * Registration application |
|
333 | - */ |
|
334 | - public $registration_app; |
|
335 | - |
|
336 | - /** @var string $registration_device |
|
337 | - * Registration device |
|
338 | - */ |
|
339 | - public $registration_device; |
|
340 | - |
|
341 | - /** @var string $preferred_units |
|
342 | - * Preferred units (mi, km) |
|
343 | - */ |
|
344 | - public $preferred_units; |
|
345 | - |
|
346 | - /** @var string $preferred_language |
|
347 | - * Preferred language (en, fr) |
|
348 | - */ |
|
349 | - public $preferred_language; |
|
350 | - |
|
351 | - /** @var string $hide_routed_addresses |
|
352 | - * If true, routed addresses will be hidden. |
|
353 | - */ |
|
354 | - public $hide_routed_addresses; |
|
355 | - |
|
356 | - /** @var string $show_superuser_addresses |
|
357 | - * Show superuser addresses ('0', '1'). |
|
358 | - */ |
|
359 | - public $show_superuser_addresses; |
|
360 | - |
|
361 | - /** @var string $appdirect_url |
|
362 | - * Application direction URL |
|
363 | - */ |
|
364 | - public $appdirect_url; |
|
365 | - |
|
366 | - /** @var int $timestamp_trial_expiration |
|
367 | - * Timestamp trial expiration |
|
368 | - */ |
|
369 | - public $timestamp_trial_expiration; |
|
370 | - |
|
371 | - /** @var string $update_channel_name |
|
372 | - * Update channel name |
|
373 | - */ |
|
374 | - public $update_channel_name; |
|
375 | - |
|
376 | - /** @var int $max_subusers_cnt |
|
377 | - * Maximum subusers count |
|
378 | - */ |
|
379 | - public $max_subusers_cnt; |
|
380 | - |
|
381 | - /** @var string $hide_visited_addresses |
|
382 | - * If true, visited addresses will be hidden. |
|
383 | - */ |
|
384 | - public $hide_visited_addresses; |
|
385 | - |
|
386 | - /** @var string $HIDE_NONFUTURE_ROUTES |
|
387 | - * If true, nonfuture routes will be hidden. |
|
388 | - */ |
|
389 | - public $HIDE_NONFUTURE_ROUTES; |
|
390 | - |
|
391 | - /** @var string $display_max_routes_future_days |
|
392 | - * Display maximum routes future days ('0', '1'). |
|
393 | - */ |
|
394 | - public $display_max_routes_future_days; |
|
395 | - |
|
396 | - /** @var string $READONLY_USER |
|
397 | - * Readonly uer ('0', '1'). |
|
398 | - */ |
|
399 | - public $READONLY_USER; |
|
400 | - |
|
401 | - /** @var int $auto_logout_ts |
|
402 | - * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds. |
|
403 | - */ |
|
404 | - public $auto_logout_ts; |
|
12 | + /** @var boolean $authenticated |
|
13 | + * A boolean flag indicating if the session is valid. |
|
14 | + */ |
|
15 | + public $authenticated; |
|
16 | + |
|
17 | + /** @var boolean $status |
|
18 | + * Process status |
|
19 | + */ |
|
20 | + public $status; |
|
21 | + |
|
22 | + /** @var string $geocoding_service |
|
23 | + * Geocoding service |
|
24 | + */ |
|
25 | + public $geocoding_service; |
|
26 | + |
|
27 | + /** @var string $session_id |
|
28 | + * The integer session id of the current session. |
|
29 | + */ |
|
30 | + public $session_id; |
|
31 | + |
|
32 | + /** @var string $session_guid |
|
33 | + * An MD5 hash string of the currently authenticated sesssion, |
|
34 | + * important to use this with future requests. |
|
35 | + */ |
|
36 | + public $session_guid; |
|
37 | + |
|
38 | + /** @var string $member_first_name |
|
39 | + * The first name of the user. |
|
40 | + */ |
|
41 | + public $member_first_name; |
|
42 | + |
|
43 | + /** @var string $member_last_name |
|
44 | + * The last name of the user. |
|
45 | + */ |
|
46 | + public $member_last_name; |
|
47 | + |
|
48 | + /** @var int $member_timestamp_added |
|
49 | + * The unix timestamp when the user joined the service. |
|
50 | + */ |
|
51 | + public $member_timestamp_added; |
|
52 | + |
|
53 | + /** @var string $industry |
|
54 | + * The industry the authenticated user specified. |
|
55 | + */ |
|
56 | + public $industry; |
|
57 | + |
|
58 | + /** @var int $member_id |
|
59 | + * Member ID |
|
60 | + */ |
|
61 | + public $member_id; |
|
62 | + |
|
63 | + /** @var string $member_email |
|
64 | + * Member email |
|
65 | + */ |
|
66 | + public $member_email; |
|
67 | + |
|
68 | + /** @var boolean $is_trial |
|
69 | + * If the user is currently a trial customer. |
|
70 | + */ |
|
71 | + public $is_trial; |
|
72 | + |
|
73 | + /** @var boolean $is_active |
|
74 | + * If the user is currently an active customer. |
|
75 | + */ |
|
76 | + public $is_active; |
|
77 | + |
|
78 | + /** @var string $api_key |
|
79 | + * User's API key |
|
80 | + */ |
|
81 | + public $api_key; |
|
82 | + |
|
83 | + /** @var int $tracking_ttl |
|
84 | + * Tracking TTL |
|
85 | + */ |
|
86 | + public $tracking_ttl; |
|
87 | + |
|
88 | + /** @var boolean $hide_billing_section |
|
89 | + * Hide billing section. |
|
90 | + */ |
|
91 | + public $hide_billing_section; |
|
92 | + |
|
93 | + /** @var string $last_known_member_payment_device |
|
94 | + * Last known member payment device (e.g. 'web'). |
|
95 | + */ |
|
96 | + public $last_known_member_payment_device; |
|
97 | + |
|
98 | + /** @var array $licensed_modules |
|
99 | + * Licensed module. e.g.: |
|
100 | + * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING', |
|
101 | + * 'MODULE__VOICE_NAVIGATION:TRUE', |
|
102 | + * 'MODULE__VOICE_NAVIGATION' |
|
103 | + */ |
|
104 | + public $licensed_modules; |
|
105 | + |
|
106 | + /** @var boolean $member_business_type |
|
107 | + * Member business type (e.g. 'BUSINESS_EMPLOYEE'). |
|
108 | + */ |
|
109 | + public $member_business_type; |
|
110 | + |
|
111 | + /** @var string $geofence_polygon_shape |
|
112 | + * Geofence polygon shape. Available values: |
|
113 | + * 'circle', 'poly', 'rect'. |
|
114 | + */ |
|
115 | + public $geofence_polygon_shape; |
|
116 | + |
|
117 | + /** @var int $geofence_polygon_size |
|
118 | + * Geofence polygon size |
|
119 | + */ |
|
120 | + public $geofence_polygon_size; |
|
121 | + |
|
122 | + /** @var int $geofence_time_onsite_trigger_secs |
|
123 | + * Geofence onsite trigger time (seconds). |
|
124 | + */ |
|
125 | + public $geofence_time_onsite_trigger_secs; |
|
126 | + |
|
127 | + /** @var int $geofence_minimum_trigger_speed |
|
128 | + * Geofence's minimum trigger speed. |
|
129 | + */ |
|
130 | + public $geofence_minimum_trigger_speed; |
|
131 | + |
|
132 | + /** @var bool $is_subscription_past_due |
|
133 | + * True if the subscription is past due. |
|
134 | + */ |
|
135 | + public $is_subscription_past_due; |
|
136 | + |
|
137 | + /** @var string $visited_departed_enabled |
|
138 | + * If true, triggering of the visited and departed activities is enabled. |
|
139 | + */ |
|
140 | + public $visited_departed_enabled; |
|
141 | + |
|
142 | + /** @var string $long_press_enabled |
|
143 | + * If true, long press is enabled. |
|
144 | + */ |
|
145 | + public $long_press_enabled; |
|
146 | + |
|
147 | + /** @var int $account_type_id |
|
148 | + * The account type ID. |
|
149 | + */ |
|
150 | + public $account_type_id; |
|
151 | + |
|
152 | + /** @var string $current_price |
|
153 | + * Current price (e.g. '0.000'). |
|
154 | + */ |
|
155 | + public $current_price; |
|
156 | + |
|
157 | + /** @var int $initially_requested_account_type_id |
|
158 | + * Initially Requested account type ID. |
|
159 | + */ |
|
160 | + public $initially_requested_account_type_id; |
|
161 | + |
|
162 | + /** @var string $account_type_alias |
|
163 | + * Account type alias |
|
164 | + */ |
|
165 | + public $account_type_alias; |
|
166 | + |
|
167 | + /** @var string $member_type |
|
168 | + * Member type. Available values: |
|
169 | + * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER, |
|
170 | + * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER, |
|
171 | + * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE |
|
172 | + */ |
|
173 | + public $member_type; |
|
174 | + |
|
175 | + /** @var string $OWNER_MEMBER_ID |
|
176 | + * Parent user ID. |
|
177 | + */ |
|
178 | + public $OWNER_MEMBER_ID; |
|
179 | + |
|
180 | + /** @var string $ROOT_OWNER_MEMBER_ID |
|
181 | + * Root owner member ID (e.g. '402088'). |
|
182 | + */ |
|
183 | + public $ROOT_OWNER_MEMBER_ID; |
|
184 | + |
|
185 | + /** @var string $ROOT_OWNER_MEMBER_EMAIL |
|
186 | + * Root owner member email. |
|
187 | + */ |
|
188 | + public $ROOT_OWNER_MEMBER_EMAIL; |
|
189 | + |
|
190 | + /** @var string $ROOT_OWNER_MEMBER_API_KEY |
|
191 | + * Root owner member API key. |
|
192 | + */ |
|
193 | + public $ROOT_OWNER_MEMBER_API_KEY; |
|
194 | + |
|
195 | + /** @var string $geocodingMethod |
|
196 | + * Geocoding method |
|
197 | + */ |
|
198 | + public $geocodingMethod; |
|
199 | + |
|
200 | + /** @var string $service_type |
|
201 | + * Service type (e.g. 'pre5'). |
|
202 | + */ |
|
203 | + public $service_type; |
|
204 | + |
|
205 | + /** @var string $validated_by |
|
206 | + * Validated by (e.g. 'ADMIN_PANEL'). |
|
207 | + */ |
|
208 | + public $validated_by; |
|
209 | + |
|
210 | + /** @var int $max_stops_per_route |
|
211 | + * Maximum allowed number of the stops per route. |
|
212 | + */ |
|
213 | + public $max_stops_per_route; |
|
214 | + |
|
215 | + /** @var int $max_routes |
|
216 | + * Maximum allowed number of the generated routes. |
|
217 | + */ |
|
218 | + public $max_routes; |
|
219 | + |
|
220 | + /** @var int $max_route |
|
221 | + * Maximum allowed number of the generated routes. |
|
222 | + */ |
|
223 | + public $max_route; |
|
224 | + |
|
225 | + /** @var int $route_planned |
|
226 | + * Planned route numbers |
|
227 | + */ |
|
228 | + public $route_planned; |
|
229 | + |
|
230 | + /** @var int $routes_planned |
|
231 | + * Routes Planned |
|
232 | + */ |
|
233 | + public $routes_planned; |
|
234 | + |
|
235 | + /** @var int $total_routes_planned |
|
236 | + * Total planned routes. |
|
237 | + */ |
|
238 | + public $total_routes_planned; |
|
239 | + |
|
240 | + /** @var int $authentication_count |
|
241 | + * Authentication count. |
|
242 | + */ |
|
243 | + public $authentication_count; |
|
244 | + |
|
245 | + /** @var string $salesforce_unique_record_id |
|
246 | + * Salesforce unique record ID. |
|
247 | + */ |
|
248 | + public $salesforce_unique_record_id; |
|
249 | + |
|
250 | + /** @var string $salesforce_account_id |
|
251 | + * Salesforce account ID |
|
252 | + */ |
|
253 | + public $salesforce_account_id; |
|
254 | + |
|
255 | + /** @var string $salesforce_lead_id |
|
256 | + * Salesforce lead ID |
|
257 | + */ |
|
258 | + public $salesforce_lead_id; |
|
259 | + |
|
260 | + /** @var int $max_api_optimization_addresses |
|
261 | + * The maximun number of addresses the authenticated user |
|
262 | + * can optimize in this billing cycle. |
|
263 | + */ |
|
264 | + public $max_api_optimization_addresses; |
|
265 | + |
|
266 | + /** @var int $max_api_geocoding_addresses |
|
267 | + * The maximun number of geocodings the authenticated user |
|
268 | + * can optimize in this billing cycle. |
|
269 | + */ |
|
270 | + public $max_api_geocoding_addresses; |
|
271 | + |
|
272 | + /** @var int $max_api_directions_addresses |
|
273 | + * The maximum number of driving route transactions the authenticated |
|
274 | + * user can execute in this billing cycle. |
|
275 | + */ |
|
276 | + public $max_api_directions_addresses; |
|
277 | + |
|
278 | + /** @var int $max_api_validation_addresses |
|
279 | + * The maximun number of address validation transactions the authenticated |
|
280 | + * user can execute in this billing cycle. |
|
281 | + */ |
|
282 | + public $max_api_validation_addresses; |
|
283 | + |
|
284 | + /** @var int $max_stops_per_unoptimized_route |
|
285 | + * The maximum number of stops the authenticated user |
|
286 | + * can put into a route with optimization disabled. |
|
287 | + */ |
|
288 | + public $max_stops_per_unoptimized_route; |
|
289 | + |
|
290 | + /** @var int $max_api_distance_tx |
|
291 | + * The maximum number of distance transactions the authenticated |
|
292 | + * user can execute in this billing cycle. |
|
293 | + */ |
|
294 | + public $max_api_distance_tx; |
|
295 | + |
|
296 | + /** @var boolean $blDisplayUpgradeTrackingHTML |
|
297 | + * Display upgrade tracking HTML. |
|
298 | + */ |
|
299 | + public $blDisplayUpgradeTrackingHTML; |
|
300 | + |
|
301 | + /** @var int $intTrackingTrigger |
|
302 | + * Tracking trigger (int). |
|
303 | + */ |
|
304 | + public $intTrackingTrigger; |
|
305 | + |
|
306 | + /** @var int $last_payment_ts |
|
307 | + * The last unix timestamp when this user was successfully charged. |
|
308 | + */ |
|
309 | + public $last_payment_ts; |
|
310 | + |
|
311 | + /** @var int $last_failed_payment_ts |
|
312 | + * The last unix timestamp when this user was failed to pay. |
|
313 | + */ |
|
314 | + public $last_failed_payment_ts; |
|
315 | + |
|
316 | + /** @var int $account_expires_timestamp |
|
317 | + * Account expire date |
|
318 | + */ |
|
319 | + public $account_expires_timestamp; |
|
320 | + |
|
321 | + /** @var boolean $account_past_due |
|
322 | + * Account past due |
|
323 | + */ |
|
324 | + public $account_past_due; |
|
325 | + |
|
326 | + /** @var string $ui_input_method |
|
327 | + * UI input method |
|
328 | + */ |
|
329 | + public $ui_input_method; |
|
330 | + |
|
331 | + /** @var string $registration_app |
|
332 | + * Registration application |
|
333 | + */ |
|
334 | + public $registration_app; |
|
335 | + |
|
336 | + /** @var string $registration_device |
|
337 | + * Registration device |
|
338 | + */ |
|
339 | + public $registration_device; |
|
340 | + |
|
341 | + /** @var string $preferred_units |
|
342 | + * Preferred units (mi, km) |
|
343 | + */ |
|
344 | + public $preferred_units; |
|
345 | + |
|
346 | + /** @var string $preferred_language |
|
347 | + * Preferred language (en, fr) |
|
348 | + */ |
|
349 | + public $preferred_language; |
|
350 | + |
|
351 | + /** @var string $hide_routed_addresses |
|
352 | + * If true, routed addresses will be hidden. |
|
353 | + */ |
|
354 | + public $hide_routed_addresses; |
|
355 | + |
|
356 | + /** @var string $show_superuser_addresses |
|
357 | + * Show superuser addresses ('0', '1'). |
|
358 | + */ |
|
359 | + public $show_superuser_addresses; |
|
360 | + |
|
361 | + /** @var string $appdirect_url |
|
362 | + * Application direction URL |
|
363 | + */ |
|
364 | + public $appdirect_url; |
|
365 | + |
|
366 | + /** @var int $timestamp_trial_expiration |
|
367 | + * Timestamp trial expiration |
|
368 | + */ |
|
369 | + public $timestamp_trial_expiration; |
|
370 | + |
|
371 | + /** @var string $update_channel_name |
|
372 | + * Update channel name |
|
373 | + */ |
|
374 | + public $update_channel_name; |
|
375 | + |
|
376 | + /** @var int $max_subusers_cnt |
|
377 | + * Maximum subusers count |
|
378 | + */ |
|
379 | + public $max_subusers_cnt; |
|
380 | + |
|
381 | + /** @var string $hide_visited_addresses |
|
382 | + * If true, visited addresses will be hidden. |
|
383 | + */ |
|
384 | + public $hide_visited_addresses; |
|
385 | + |
|
386 | + /** @var string $HIDE_NONFUTURE_ROUTES |
|
387 | + * If true, nonfuture routes will be hidden. |
|
388 | + */ |
|
389 | + public $HIDE_NONFUTURE_ROUTES; |
|
390 | + |
|
391 | + /** @var string $display_max_routes_future_days |
|
392 | + * Display maximum routes future days ('0', '1'). |
|
393 | + */ |
|
394 | + public $display_max_routes_future_days; |
|
395 | + |
|
396 | + /** @var string $READONLY_USER |
|
397 | + * Readonly uer ('0', '1'). |
|
398 | + */ |
|
399 | + public $READONLY_USER; |
|
400 | + |
|
401 | + /** @var int $auto_logout_ts |
|
402 | + * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds. |
|
403 | + */ |
|
404 | + public $auto_logout_ts; |
|
405 | 405 | } |
@@ -9,9 +9,9 @@ |
||
9 | 9 | */ |
10 | 10 | class ResultsResponseV4 extends \Route4Me\Common |
11 | 11 | { |
12 | - /** @var MemberResponseV4[] $results */ |
|
13 | - public $results; |
|
12 | + /** @var MemberResponseV4[] $results */ |
|
13 | + public $results; |
|
14 | 14 | |
15 | - /** @var int $total */ |
|
16 | - public $total; |
|
15 | + /** @var int $total */ |
|
16 | + public $total; |
|
17 | 17 | } |
@@ -9,149 +9,149 @@ |
||
9 | 9 | */ |
10 | 10 | class RouteParametersQuery extends Common |
11 | 11 | { |
12 | - /** |
|
13 | - * Route unique identifier |
|
14 | - * @var string |
|
15 | - */ |
|
16 | - public $route_id; |
|
17 | - |
|
18 | - /** |
|
19 | - * Pass True to return directions and the route path. |
|
20 | - * @var boolean |
|
21 | - */ |
|
22 | - public $directions; |
|
23 | - |
|
24 | - /** |
|
25 | - * Available values: |
|
26 | - * - 'None' - no path output. |
|
27 | - * - 'Points' - points path output |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - public $route_path_output; |
|
31 | - |
|
32 | - /** |
|
33 | - * Output route tracking data in response. |
|
34 | - * @var boolean |
|
35 | - */ |
|
36 | - public $device_tracking_history; |
|
37 | - |
|
38 | - /** |
|
39 | - * The number of existing routes that should be returned per response |
|
40 | - * when looking at a list of all the routes. |
|
41 | - * @var integer |
|
42 | - */ |
|
43 | - public $limit; |
|
44 | - |
|
45 | - /** |
|
46 | - * The page number for route listing pagination.<br> |
|
47 | - * Increment the offset by the limit number to move to the next page. |
|
48 | - * @var integer |
|
49 | - */ |
|
50 | - public $offset; |
|
51 | - |
|
52 | - /** |
|
53 | - * Start date to filter |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public $start_date; |
|
57 | - |
|
58 | - /** |
|
59 | - * End date to filter |
|
60 | - * @var string |
|
61 | - */ |
|
62 | - public $end_date; |
|
63 | - |
|
64 | - /** |
|
65 | - * Output addresses and directions in the original optimization request sequence.<br> |
|
66 | - * This is to allow us to compare routes before & after optimization. |
|
67 | - * @var boolean |
|
68 | - */ |
|
69 | - public $original; |
|
70 | - |
|
71 | - /** |
|
72 | - * Output route and stop-specific notes. The notes will have timestamps, |
|
73 | - * note types, and geospatial information if available. |
|
74 | - * @var boolean |
|
75 | - */ |
|
76 | - public $notes; |
|
77 | - |
|
78 | - /** |
|
79 | - * If true, the order inventory info included in the response. |
|
80 | - * @var boolean |
|
81 | - */ |
|
82 | - public $order_inventory; |
|
83 | - |
|
84 | - /** |
|
85 | - * If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
86 | - * @var boolean |
|
87 | - */ |
|
88 | - public $remaining; |
|
89 | - |
|
90 | - /** |
|
91 | - * Search query |
|
92 | - * @var string |
|
93 | - */ |
|
94 | - public $query; |
|
95 | - |
|
96 | - /** |
|
97 | - * Updating a route supports the reoptimize=1 parameter, |
|
98 | - * which reoptimizes only that route.<br> |
|
99 | - * Also supports the parameters from GET. |
|
100 | - * @var boolean |
|
101 | - */ |
|
102 | - public $reoptimize; |
|
103 | - |
|
104 | - /** |
|
105 | - * Whether disable or not a route optimization.<br> |
|
106 | - * Available values: |
|
107 | - * - true - disable a route optimization; |
|
108 | - * - false - not disable a route optimization. |
|
109 | - * @var boolean |
|
110 | - */ |
|
111 | - public $disable_optimization; |
|
112 | - |
|
113 | - /** |
|
114 | - * The driving directions will be generated biased for this selection. |
|
115 | - * This has no impact on route sequencing.<br> |
|
116 | - * Available values: |
|
117 | - * - 'Distance'; |
|
118 | - * - 'Time'; |
|
119 | - * - 'timeWithTraffic'. |
|
120 | - * @var boolean |
|
121 | - */ |
|
122 | - public $optimize; |
|
123 | - |
|
124 | - /** |
|
125 | - * By sending recompute_directions=1 we request that the route directions |
|
126 | - * be recomputed (note that this does happen automatically if certain properties |
|
127 | - * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
128 | - * @var boolean |
|
129 | - */ |
|
130 | - public $recompute_directions; |
|
131 | - |
|
132 | - /** |
|
133 | - * Response format('json', 'csv', 'xml') |
|
134 | - * @var string |
|
135 | - */ |
|
136 | - public $response_format; |
|
137 | - |
|
138 | - /** |
|
139 | - * Identifier of a route destination. |
|
140 | - * @var integer |
|
141 | - */ |
|
142 | - public $route_destination_id; |
|
143 | - |
|
144 | - /** |
|
145 | - * If true, will be redirected |
|
146 | - * @var boolean |
|
147 | - */ |
|
148 | - public $redirect; |
|
149 | - |
|
150 | - /** |
|
151 | - * If true, the address bundling info is included into route response. |
|
152 | - * @var boolean |
|
153 | - */ |
|
154 | - public $bundling_items; |
|
155 | - |
|
156 | - public $device_type; |
|
12 | + /** |
|
13 | + * Route unique identifier |
|
14 | + * @var string |
|
15 | + */ |
|
16 | + public $route_id; |
|
17 | + |
|
18 | + /** |
|
19 | + * Pass True to return directions and the route path. |
|
20 | + * @var boolean |
|
21 | + */ |
|
22 | + public $directions; |
|
23 | + |
|
24 | + /** |
|
25 | + * Available values: |
|
26 | + * - 'None' - no path output. |
|
27 | + * - 'Points' - points path output |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + public $route_path_output; |
|
31 | + |
|
32 | + /** |
|
33 | + * Output route tracking data in response. |
|
34 | + * @var boolean |
|
35 | + */ |
|
36 | + public $device_tracking_history; |
|
37 | + |
|
38 | + /** |
|
39 | + * The number of existing routes that should be returned per response |
|
40 | + * when looking at a list of all the routes. |
|
41 | + * @var integer |
|
42 | + */ |
|
43 | + public $limit; |
|
44 | + |
|
45 | + /** |
|
46 | + * The page number for route listing pagination.<br> |
|
47 | + * Increment the offset by the limit number to move to the next page. |
|
48 | + * @var integer |
|
49 | + */ |
|
50 | + public $offset; |
|
51 | + |
|
52 | + /** |
|
53 | + * Start date to filter |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public $start_date; |
|
57 | + |
|
58 | + /** |
|
59 | + * End date to filter |
|
60 | + * @var string |
|
61 | + */ |
|
62 | + public $end_date; |
|
63 | + |
|
64 | + /** |
|
65 | + * Output addresses and directions in the original optimization request sequence.<br> |
|
66 | + * This is to allow us to compare routes before & after optimization. |
|
67 | + * @var boolean |
|
68 | + */ |
|
69 | + public $original; |
|
70 | + |
|
71 | + /** |
|
72 | + * Output route and stop-specific notes. The notes will have timestamps, |
|
73 | + * note types, and geospatial information if available. |
|
74 | + * @var boolean |
|
75 | + */ |
|
76 | + public $notes; |
|
77 | + |
|
78 | + /** |
|
79 | + * If true, the order inventory info included in the response. |
|
80 | + * @var boolean |
|
81 | + */ |
|
82 | + public $order_inventory; |
|
83 | + |
|
84 | + /** |
|
85 | + * If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
86 | + * @var boolean |
|
87 | + */ |
|
88 | + public $remaining; |
|
89 | + |
|
90 | + /** |
|
91 | + * Search query |
|
92 | + * @var string |
|
93 | + */ |
|
94 | + public $query; |
|
95 | + |
|
96 | + /** |
|
97 | + * Updating a route supports the reoptimize=1 parameter, |
|
98 | + * which reoptimizes only that route.<br> |
|
99 | + * Also supports the parameters from GET. |
|
100 | + * @var boolean |
|
101 | + */ |
|
102 | + public $reoptimize; |
|
103 | + |
|
104 | + /** |
|
105 | + * Whether disable or not a route optimization.<br> |
|
106 | + * Available values: |
|
107 | + * - true - disable a route optimization; |
|
108 | + * - false - not disable a route optimization. |
|
109 | + * @var boolean |
|
110 | + */ |
|
111 | + public $disable_optimization; |
|
112 | + |
|
113 | + /** |
|
114 | + * The driving directions will be generated biased for this selection. |
|
115 | + * This has no impact on route sequencing.<br> |
|
116 | + * Available values: |
|
117 | + * - 'Distance'; |
|
118 | + * - 'Time'; |
|
119 | + * - 'timeWithTraffic'. |
|
120 | + * @var boolean |
|
121 | + */ |
|
122 | + public $optimize; |
|
123 | + |
|
124 | + /** |
|
125 | + * By sending recompute_directions=1 we request that the route directions |
|
126 | + * be recomputed (note that this does happen automatically if certain properties |
|
127 | + * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
128 | + * @var boolean |
|
129 | + */ |
|
130 | + public $recompute_directions; |
|
131 | + |
|
132 | + /** |
|
133 | + * Response format('json', 'csv', 'xml') |
|
134 | + * @var string |
|
135 | + */ |
|
136 | + public $response_format; |
|
137 | + |
|
138 | + /** |
|
139 | + * Identifier of a route destination. |
|
140 | + * @var integer |
|
141 | + */ |
|
142 | + public $route_destination_id; |
|
143 | + |
|
144 | + /** |
|
145 | + * If true, will be redirected |
|
146 | + * @var boolean |
|
147 | + */ |
|
148 | + public $redirect; |
|
149 | + |
|
150 | + /** |
|
151 | + * If true, the address bundling info is included into route response. |
|
152 | + * @var boolean |
|
153 | + */ |
|
154 | + public $bundling_items; |
|
155 | + |
|
156 | + public $device_type; |
|
157 | 157 | } |
@@ -6,79 +6,79 @@ |
||
6 | 6 | |
7 | 7 | class ActivityParameters extends Common |
8 | 8 | { |
9 | - public $route_id; |
|
10 | - public $device_id; |
|
11 | - public $member_id; |
|
12 | - public $team; |
|
13 | - public $limit; |
|
14 | - public $offset; |
|
15 | - public $start; |
|
16 | - public $end; |
|
17 | - public $activity_type; |
|
18 | - public $activity_message; |
|
9 | + public $route_id; |
|
10 | + public $device_id; |
|
11 | + public $member_id; |
|
12 | + public $team; |
|
13 | + public $limit; |
|
14 | + public $offset; |
|
15 | + public $start; |
|
16 | + public $end; |
|
17 | + public $activity_type; |
|
18 | + public $activity_message; |
|
19 | 19 | |
20 | - public $activity_id; |
|
21 | - public $activity_timestamp; |
|
22 | - public $route_destination_id; |
|
23 | - public $note_id; |
|
24 | - public $member; |
|
25 | - public $note_type; |
|
26 | - public $note_contents; |
|
27 | - public $route_name; |
|
28 | - public $note_file; |
|
29 | - public $destination_name; |
|
30 | - public $destination_alias; |
|
20 | + public $activity_id; |
|
21 | + public $activity_timestamp; |
|
22 | + public $route_destination_id; |
|
23 | + public $note_id; |
|
24 | + public $member; |
|
25 | + public $note_type; |
|
26 | + public $note_contents; |
|
27 | + public $route_name; |
|
28 | + public $note_file; |
|
29 | + public $destination_name; |
|
30 | + public $destination_alias; |
|
31 | 31 | |
32 | - public function __construct() |
|
33 | - { |
|
34 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
35 | - } |
|
32 | + public function __construct() |
|
33 | + { |
|
34 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
35 | + } |
|
36 | 36 | |
37 | - /* |
|
37 | + /* |
|
38 | 38 | * Get all the activities limited by query parameters. |
39 | 39 | */ |
40 | - public static function getActivities($params) |
|
41 | - { |
|
42 | - $allQueryFields = ['route_id', 'team', 'limit', 'offset', 'start', 'member_id']; |
|
40 | + public static function getActivities($params) |
|
41 | + { |
|
42 | + $allQueryFields = ['route_id', 'team', 'limit', 'offset', 'start', 'member_id']; |
|
43 | 43 | |
44 | - $activity = Route4Me::makeRequst([ |
|
45 | - 'url' => Endpoint::GET_ACTIVITIES, |
|
46 | - 'method' => 'GET', |
|
47 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
48 | - ]); |
|
44 | + $activity = Route4Me::makeRequst([ |
|
45 | + 'url' => Endpoint::GET_ACTIVITIES, |
|
46 | + 'method' => 'GET', |
|
47 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
48 | + ]); |
|
49 | 49 | |
50 | - return $activity; |
|
51 | - } |
|
50 | + return $activity; |
|
51 | + } |
|
52 | 52 | |
53 | - /* |
|
53 | + /* |
|
54 | 54 | * Returns the activity feed. |
55 | 55 | */ |
56 | - public static function searchActivities($params) |
|
57 | - { |
|
58 | - $allQueryFields = ['route_id', 'limit', 'offset', 'activity_type']; |
|
56 | + public static function searchActivities($params) |
|
57 | + { |
|
58 | + $allQueryFields = ['route_id', 'limit', 'offset', 'activity_type']; |
|
59 | 59 | |
60 | - $activity = Route4Me::makeRequst([ |
|
61 | - 'url' => Endpoint::GET_ACTIVITIES, |
|
62 | - 'method' => 'GET', |
|
63 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
64 | - ]); |
|
60 | + $activity = Route4Me::makeRequst([ |
|
61 | + 'url' => Endpoint::GET_ACTIVITIES, |
|
62 | + 'method' => 'GET', |
|
63 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
64 | + ]); |
|
65 | 65 | |
66 | - return $activity; |
|
67 | - } |
|
66 | + return $activity; |
|
67 | + } |
|
68 | 68 | |
69 | - /* |
|
69 | + /* |
|
70 | 70 | * Creates a user's activity by sending a custom message to the activity stream. |
71 | 71 | */ |
72 | - public static function sendUserMessage($params) |
|
73 | - { |
|
74 | - $allBodyFields = ['activity_type', 'activity_message', 'route_id']; |
|
72 | + public static function sendUserMessage($params) |
|
73 | + { |
|
74 | + $allBodyFields = ['activity_type', 'activity_message', 'route_id']; |
|
75 | 75 | |
76 | - $result = Route4Me::makeRequst([ |
|
77 | - 'url' => Endpoint::ACTIVITY_FEED, |
|
78 | - 'method' => 'POST', |
|
79 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
80 | - ]); |
|
76 | + $result = Route4Me::makeRequst([ |
|
77 | + 'url' => Endpoint::ACTIVITY_FEED, |
|
78 | + 'method' => 'POST', |
|
79 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
80 | + ]); |
|
81 | 81 | |
82 | - return $result; |
|
83 | - } |
|
82 | + return $result; |
|
83 | + } |
|
84 | 84 | } |
@@ -7,101 +7,101 @@ |
||
7 | 7 | |
8 | 8 | class Territory extends Common |
9 | 9 | { |
10 | - /** |
|
11 | - * @var |
|
12 | - */ |
|
13 | - public $territory_id; // Territory id |
|
14 | - public $territory_name; |
|
15 | - public $territory_color; |
|
16 | - public $addresses; |
|
17 | - public $member_id; |
|
18 | - public $territory; // Territory parameters |
|
19 | - |
|
20 | - public function __construct() |
|
21 | - { |
|
22 | - Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
23 | - } |
|
24 | - |
|
25 | - public static function fromArray(array $params) |
|
26 | - { |
|
27 | - if (!isset($params['territory_name'])) { |
|
28 | - throw new BadParam('Territory name must be provided'); |
|
29 | - } |
|
30 | - |
|
31 | - if (!isset($params['territory_color'])) { |
|
32 | - throw new BadParam('Territory color must be provided'); |
|
33 | - } |
|
34 | - |
|
35 | - if (!isset($params['territory'])) { |
|
36 | - throw new BadParam('Territory must be provided'); |
|
37 | - } |
|
38 | - return parent::fromArray($params); |
|
39 | - } |
|
40 | - |
|
41 | - public static function getTerritory($params) |
|
42 | - { |
|
43 | - $allQueryFields = ['territory_id', 'addresses']; |
|
44 | - |
|
45 | - $territory = Route4Me::makeRequst([ |
|
46 | - 'url' => Endpoint::TERRITORY_V4, |
|
47 | - 'method' => 'GET', |
|
48 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
49 | - ]); |
|
50 | - |
|
51 | - return $territory; |
|
52 | - } |
|
53 | - |
|
54 | - public static function getTerritories($params) |
|
55 | - { |
|
56 | - $allQueryFields = ['offset', 'limit', 'addresses']; |
|
57 | - |
|
58 | - $response = Route4Me::makeRequst([ |
|
59 | - 'url' => Endpoint::TERRITORY_V4, |
|
60 | - 'method' => 'GET', |
|
61 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
62 | - ]); |
|
63 | - |
|
64 | - return $response; |
|
65 | - } |
|
66 | - |
|
67 | - public static function addTerritory($params) |
|
68 | - { |
|
69 | - $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory']; |
|
70 | - |
|
71 | - $response = Route4Me::makeRequst([ |
|
72 | - 'url' => Endpoint::TERRITORY_V4, |
|
73 | - 'method' => 'POST', |
|
74 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
75 | - ]); |
|
76 | - |
|
77 | - return $response; |
|
78 | - } |
|
79 | - |
|
80 | - public function deleteTerritory($territory_id) |
|
81 | - { |
|
82 | - $result = Route4Me::makeRequst([ |
|
83 | - 'url' => Endpoint::TERRITORY_V4, |
|
84 | - 'method' => 'DELETE', |
|
85 | - 'query' => [ |
|
86 | - 'territory_id' => $territory_id, |
|
87 | - ], |
|
88 | - ]); |
|
89 | - |
|
90 | - return $result; |
|
91 | - } |
|
92 | - |
|
93 | - public function updateTerritory($params) |
|
94 | - { |
|
95 | - $allQueryFields = ['territory_id']; |
|
96 | - $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory']; |
|
97 | - |
|
98 | - $response = Route4Me::makeRequst([ |
|
99 | - 'url' => Endpoint::TERRITORY_V4, |
|
100 | - 'method' => 'PUT', |
|
101 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
102 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
103 | - ]); |
|
104 | - |
|
105 | - return $response; |
|
106 | - } |
|
10 | + /** |
|
11 | + * @var |
|
12 | + */ |
|
13 | + public $territory_id; // Territory id |
|
14 | + public $territory_name; |
|
15 | + public $territory_color; |
|
16 | + public $addresses; |
|
17 | + public $member_id; |
|
18 | + public $territory; // Territory parameters |
|
19 | + |
|
20 | + public function __construct() |
|
21 | + { |
|
22 | + Route4Me::setBaseUrl(Endpoint::BASE_URL); |
|
23 | + } |
|
24 | + |
|
25 | + public static function fromArray(array $params) |
|
26 | + { |
|
27 | + if (!isset($params['territory_name'])) { |
|
28 | + throw new BadParam('Territory name must be provided'); |
|
29 | + } |
|
30 | + |
|
31 | + if (!isset($params['territory_color'])) { |
|
32 | + throw new BadParam('Territory color must be provided'); |
|
33 | + } |
|
34 | + |
|
35 | + if (!isset($params['territory'])) { |
|
36 | + throw new BadParam('Territory must be provided'); |
|
37 | + } |
|
38 | + return parent::fromArray($params); |
|
39 | + } |
|
40 | + |
|
41 | + public static function getTerritory($params) |
|
42 | + { |
|
43 | + $allQueryFields = ['territory_id', 'addresses']; |
|
44 | + |
|
45 | + $territory = Route4Me::makeRequst([ |
|
46 | + 'url' => Endpoint::TERRITORY_V4, |
|
47 | + 'method' => 'GET', |
|
48 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
49 | + ]); |
|
50 | + |
|
51 | + return $territory; |
|
52 | + } |
|
53 | + |
|
54 | + public static function getTerritories($params) |
|
55 | + { |
|
56 | + $allQueryFields = ['offset', 'limit', 'addresses']; |
|
57 | + |
|
58 | + $response = Route4Me::makeRequst([ |
|
59 | + 'url' => Endpoint::TERRITORY_V4, |
|
60 | + 'method' => 'GET', |
|
61 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
62 | + ]); |
|
63 | + |
|
64 | + return $response; |
|
65 | + } |
|
66 | + |
|
67 | + public static function addTerritory($params) |
|
68 | + { |
|
69 | + $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory']; |
|
70 | + |
|
71 | + $response = Route4Me::makeRequst([ |
|
72 | + 'url' => Endpoint::TERRITORY_V4, |
|
73 | + 'method' => 'POST', |
|
74 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
75 | + ]); |
|
76 | + |
|
77 | + return $response; |
|
78 | + } |
|
79 | + |
|
80 | + public function deleteTerritory($territory_id) |
|
81 | + { |
|
82 | + $result = Route4Me::makeRequst([ |
|
83 | + 'url' => Endpoint::TERRITORY_V4, |
|
84 | + 'method' => 'DELETE', |
|
85 | + 'query' => [ |
|
86 | + 'territory_id' => $territory_id, |
|
87 | + ], |
|
88 | + ]); |
|
89 | + |
|
90 | + return $result; |
|
91 | + } |
|
92 | + |
|
93 | + public function updateTerritory($params) |
|
94 | + { |
|
95 | + $allQueryFields = ['territory_id']; |
|
96 | + $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory']; |
|
97 | + |
|
98 | + $response = Route4Me::makeRequst([ |
|
99 | + 'url' => Endpoint::TERRITORY_V4, |
|
100 | + 'method' => 'PUT', |
|
101 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
102 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
103 | + ]); |
|
104 | + |
|
105 | + return $response; |
|
106 | + } |
|
107 | 107 | } |
@@ -11,15 +11,15 @@ |
||
11 | 11 | */ |
12 | 12 | class Direction extends Common |
13 | 13 | { |
14 | - /** |
|
15 | - * Starting location of a direction |
|
16 | - * @var DirectionLocation |
|
17 | - */ |
|
18 | - public $location = []; |
|
14 | + /** |
|
15 | + * Starting location of a direction |
|
16 | + * @var DirectionLocation |
|
17 | + */ |
|
18 | + public $location = []; |
|
19 | 19 | |
20 | - /** |
|
21 | - * The direction steps |
|
22 | - * @var DirectionStep[] |
|
23 | - */ |
|
24 | - public $steps = []; |
|
20 | + /** |
|
21 | + * The direction steps |
|
22 | + * @var DirectionStep[] |
|
23 | + */ |
|
24 | + public $steps = []; |
|
25 | 25 | } |
@@ -6,27 +6,27 @@ |
||
6 | 6 | |
7 | 7 | class CustomNoteTypeResponse extends Common |
8 | 8 | { |
9 | - /** |
|
10 | - * Note custom type ID |
|
11 | - * @var integer |
|
12 | - */ |
|
13 | - public $note_custom_type_id; |
|
9 | + /** |
|
10 | + * Note custom type ID |
|
11 | + * @var integer |
|
12 | + */ |
|
13 | + public $note_custom_type_id; |
|
14 | 14 | |
15 | - /** |
|
16 | - * Note custom type |
|
17 | - * @var CustomNoteType |
|
18 | - */ |
|
19 | - public $note_custom_type; |
|
15 | + /** |
|
16 | + * Note custom type |
|
17 | + * @var CustomNoteType |
|
18 | + */ |
|
19 | + public $note_custom_type; |
|
20 | 20 | |
21 | - /** |
|
22 | - * ID of a root owner of the account |
|
23 | - * @var integer |
|
24 | - */ |
|
25 | - public $root_owner_member_id; |
|
21 | + /** |
|
22 | + * ID of a root owner of the account |
|
23 | + * @var integer |
|
24 | + */ |
|
25 | + public $root_owner_member_id; |
|
26 | 26 | |
27 | - /** |
|
28 | - * Values of the custom note type |
|
29 | - * @var array |
|
30 | - */ |
|
31 | - public $note_custom_type_values=[]; |
|
27 | + /** |
|
28 | + * Values of the custom note type |
|
29 | + * @var array |
|
30 | + */ |
|
31 | + public $note_custom_type_values=[]; |
|
32 | 32 | } |
@@ -28,5 +28,5 @@ |
||
28 | 28 | * Values of the custom note type |
29 | 29 | * @var array |
30 | 30 | */ |
31 | - public $note_custom_type_values=[]; |
|
31 | + public $note_custom_type_values = []; |
|
32 | 32 | } |