route4me / route4me-php-sdk

src/Route4Me/V5/RecurringRoutes/Schedules.php

Indentation +495 added lines, -495 removed lines

@@ -19,499 +19,499 @@
  */
 class Schedules extends Common
 {
-    public function __construct()
-    {
-        Route4Me::setBaseUrl('');
-    }
-
-    /**
-     * Create a new Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  array    $params
-     *   string   schedule_uid - Schedule ID,
-     *   int      root_member_id,
-     *   string   name - Name of Schedule,
-     *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function createSchedule(array $params) : Schedule
-    {
-        $allBodyFields = ['schedule_uid', 'root_member_id', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Schedule by specifying the Schedule ID.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $scheduleId Schedule ID.
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function getSchedule(string $scheduleId) : Schedule
-    {
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'GET'
-        ]));
-    }
-
-    /**
-     * Get the list of all Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @return Schedule[]
-      * @throws Exception\ApiError
-    */
-    public function getAllSchedules() : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
-            'method' => 'GET'
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                $arr = [];
-                foreach ($data as $key => $value) {
-                    array_push($arr, new Schedule($value));
-                }
-                return $arr;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Get paginated list of Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @param  int   $page Requested page.
-     * @param  int   $per_page Number of Schedules per page.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getSchedules(int $page = 1, int $per_page = 15) : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES_PAGINATION,
-            'method' => 'GET',
-            'query' => [
-                'with_pagination' => true,
-                'page' => $page,
-                'per_page' => $per_page
-            ]
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            $schedules = [];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                foreach ($data as $key => $value) {
-                    array_push($schedules, new Schedule($value));
-                }
-            }
-            return [
-                'schedules' => $schedules,
-                'page_info' => new PageInfo($result['links'], $result['meta'])
-            ];
-        }
-        return null;
-    }
-
-    /**
-     * Update the existing Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $schedule_uid Schedule ID
-     * @param  array    $params
-     *   string   schedule_uid - Schedule ID,
-     *   int      root_member_id,
-     *   string   name - Name of Schedule,
-     *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function updateSchedule(string $scheduleId, array $params) : Schedule
-    {
-        $allBodyFields = ['root_member_id', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Delete the specified Schedule with the option to delete the associated route.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $schedule_uid Schedule ID
-     * @param  bool   $withRoutes Delete the Schedule that matches the specified Schedule ID.
-     *                            If the deleted Schedule has one or multiple associated Routes,
-     *                            these Routes are also deleted.
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function deleteSchedule(string $scheduleId, bool $withRoutes = false) : Schedule
-    {
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'DELETE',
-            'query' => ['with_routes' => $withRoutes]
-        ]));
-    }
-
-    /**
-     * Create a new Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  array  $params
-     *   string route_id - Route ID,
-     *   string schedule_uid - Schedule ID,
-     *   int    member_id - A unique ID of the root member,
-     *   string vehicle_id - Vehicle ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function createRouteSchedule(array $params) : RouteSchedule
-    {
-        $allBodyFields = ['route_id', 'schedule_uid', 'member_id', 'vehicle_id'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Route Schedule by specifying the Route ID.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedule(string $route_id) : RouteSchedule
-    {
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'GET'
-        ]));
-    }
-
-    /**
-     * Get the list of all Route Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @return RouteSchedule[]
-     * @throws Exception\ApiError
-     */
-    public function getAllRouteSchedules() : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
-            'method' => 'GET'
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                $arr = [];
-                foreach ($data as $key => $value) {
-                    array_push($arr, new RouteSchedule($value));
-                }
-                return $arr;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Get paginated list of Route Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @param  int $page Requested page.
-     * @param  int $per_page Number of Route Schedules per page.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedules(int $page = 1, int $per_page = 15) : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' =>    Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_PAGINATION,
-            'method' => 'GET',
-            'query' => [
-                'with_pagination' => true,
-                'page' => $page,
-                'per_page' => $per_page
-            ]
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            $route_schedules = [];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                foreach ($data as $key => $value) {
-                    array_push($route_schedules, new RouteSchedule($value));
-                }
-            }
-            return [
-                'route_schedules' => $route_schedules,
-                'page_info' => new PageInfo($result['links'], $result['meta'])
-            ];
-        }
-        return null;
-    }
-
-    /**
-     * Update the existing Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @param  array  $params
-     *   string schedule_uid - Schedule ID,
-     *   int    member_id - A unique ID of the root member,
-     *   string vehicle_id - Vehicle ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function updateRouteSchedule(string $route_id, array $params) : RouteSchedule
-    {
-        $allBodyFields = ['schedule_uid', 'member_id', 'vehicle_id'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Delete the Route Schedules.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function deleteRouteSchedules(string $route_id) : bool
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'DELETE'
-        ]);
-        return ($result == 1 ? true : false);
-    }
-
-    /**
-     * Delete the specified Route Schedule.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function deleteRouteSchedule(string $route_id) : RouteSchedule
-    {
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id  . '/items',
-            'method' => 'DELETE'
-        ]));
-    }
-
-    /**
-     * Replace the existing Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $route_id Route ID.
-     * @param  array    $params
-     *   int      member_id - A unique ID of the root member,
-     *   string   vehicle_id - Vehicle ID,
-     *   string   schedule_uid - Schedule ID,
-     *   string   name,
-     *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function replaceRouteSchedule(string $route_id, array $params)
-    {
-        $allBodyFields = ['member_id', 'vehicle_id', 'schedule_uid', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE . '/' . $route_id,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Route Schedule preview by specifying the 'route_id'.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @param  string $start Start date as 'YYYY-MM-DD'
-     * @param  string $end End date as 'YYYY-MM-DD'
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedulePreview(string $route_id, string $start, string $end) : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id . '/preview',
-            'method' => 'GET',
-            'query' => ['start' => $start, 'end' => $end]
-        ]);
-    }
-
-    /**
-     * Check if the Scheduled Route was copied by specifying the 'route_id'.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function isScheduledRouteCopy(string $route_id) : bool
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY . '/' . $route_id,
-            'method' => 'GET'
-        ]);
-    }
-
-    /**
-     * Get all routes copied from the specified Scheduled Route by sending
-     * the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $route_id Route ID.
-     * @param  string   $schedule_uid Schedule ID.
-     * @param  string   $route_date Route date as 'YYYY-MM-DD'.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getScheduledRoutesCopies(string $route_id, string $schedule_uid, string $route_date) : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_GET_COPIES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => [
-                'route_id' => $route_id,
-                'schedule_uid' => $schedule_uid,
-                'route_date' => $route_date
-            ]
-        ]);
-    }
-
-    /**
-     * Create a new Master Route by sending the corresponding data.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  array    $params
-     *   string   route_id - Route ID,
-     *   string   route_name,
-     *   int      member_id - A unique ID of the root member,
-     *   string   vehicle_id - Vehicle ID,
-     *   string   schedule_uid - Schedule ID,
-     *   string   name,
-     *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   bool     sync - Type of result, synchronous or not
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function createMasterRoute(array $params) : bool
-    {
-        $allBodyFields = ['route_id', 'route_name', 'member_id', 'schedule_uid', 'vehicle_id', 'name',
-            'schedule_blacklist', 'advance_schedule_interval_days', 'schedule', 'timezone', 'sync'];
-
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_MASTER_ROUTES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]);
-    }
-
-    private function toSchedule($result) : Schedule
-    {
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                return new Schedule($data[0]);
-            }
-        }
-        throw new ApiError('Can not convert result to Schedule object.');
-    }
-
-    private function toRouteSchedule($result) : RouteSchedule
-    {
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                return new RouteSchedule($data[0]);
-            }
-        }
-        throw new ApiError('Can not convert result to RouteSchedule object.');
-    }
+	public function __construct()
+	{
+		Route4Me::setBaseUrl('');
+	}
+
+	/**
+	 * Create a new Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array    $params
+	 *   string   schedule_uid - Schedule ID,
+	 *   int      root_member_id,
+	 *   string   name - Name of Schedule,
+	 *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function createSchedule(array $params) : Schedule
+	{
+		$allBodyFields = ['schedule_uid', 'root_member_id', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Schedule by specifying the Schedule ID.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $scheduleId Schedule ID.
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function getSchedule(string $scheduleId) : Schedule
+	{
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'GET'
+		]));
+	}
+
+	/**
+	 * Get the list of all Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @return Schedule[]
+	 * @throws Exception\ApiError
+	 */
+	public function getAllSchedules() : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
+			'method' => 'GET'
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				$arr = [];
+				foreach ($data as $key => $value) {
+					array_push($arr, new Schedule($value));
+				}
+				return $arr;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Get paginated list of Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  int   $page Requested page.
+	 * @param  int   $per_page Number of Schedules per page.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getSchedules(int $page = 1, int $per_page = 15) : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES_PAGINATION,
+			'method' => 'GET',
+			'query' => [
+				'with_pagination' => true,
+				'page' => $page,
+				'per_page' => $per_page
+			]
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			$schedules = [];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				foreach ($data as $key => $value) {
+					array_push($schedules, new Schedule($value));
+				}
+			}
+			return [
+				'schedules' => $schedules,
+				'page_info' => new PageInfo($result['links'], $result['meta'])
+			];
+		}
+		return null;
+	}
+
+	/**
+	 * Update the existing Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $schedule_uid Schedule ID
+	 * @param  array    $params
+	 *   string   schedule_uid - Schedule ID,
+	 *   int      root_member_id,
+	 *   string   name - Name of Schedule,
+	 *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function updateSchedule(string $scheduleId, array $params) : Schedule
+	{
+		$allBodyFields = ['root_member_id', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Delete the specified Schedule with the option to delete the associated route.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $schedule_uid Schedule ID
+	 * @param  bool   $withRoutes Delete the Schedule that matches the specified Schedule ID.
+	 *                            If the deleted Schedule has one or multiple associated Routes,
+	 *                            these Routes are also deleted.
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function deleteSchedule(string $scheduleId, bool $withRoutes = false) : Schedule
+	{
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'DELETE',
+			'query' => ['with_routes' => $withRoutes]
+		]));
+	}
+
+	/**
+	 * Create a new Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array  $params
+	 *   string route_id - Route ID,
+	 *   string schedule_uid - Schedule ID,
+	 *   int    member_id - A unique ID of the root member,
+	 *   string vehicle_id - Vehicle ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function createRouteSchedule(array $params) : RouteSchedule
+	{
+		$allBodyFields = ['route_id', 'schedule_uid', 'member_id', 'vehicle_id'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Route Schedule by specifying the Route ID.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedule(string $route_id) : RouteSchedule
+	{
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'GET'
+		]));
+	}
+
+	/**
+	 * Get the list of all Route Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @return RouteSchedule[]
+	 * @throws Exception\ApiError
+	 */
+	public function getAllRouteSchedules() : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
+			'method' => 'GET'
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				$arr = [];
+				foreach ($data as $key => $value) {
+					array_push($arr, new RouteSchedule($value));
+				}
+				return $arr;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Get paginated list of Route Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  int $page Requested page.
+	 * @param  int $per_page Number of Route Schedules per page.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedules(int $page = 1, int $per_page = 15) : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' =>    Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_PAGINATION,
+			'method' => 'GET',
+			'query' => [
+				'with_pagination' => true,
+				'page' => $page,
+				'per_page' => $per_page
+			]
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			$route_schedules = [];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				foreach ($data as $key => $value) {
+					array_push($route_schedules, new RouteSchedule($value));
+				}
+			}
+			return [
+				'route_schedules' => $route_schedules,
+				'page_info' => new PageInfo($result['links'], $result['meta'])
+			];
+		}
+		return null;
+	}
+
+	/**
+	 * Update the existing Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @param  array  $params
+	 *   string schedule_uid - Schedule ID,
+	 *   int    member_id - A unique ID of the root member,
+	 *   string vehicle_id - Vehicle ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function updateRouteSchedule(string $route_id, array $params) : RouteSchedule
+	{
+		$allBodyFields = ['schedule_uid', 'member_id', 'vehicle_id'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Delete the Route Schedules.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function deleteRouteSchedules(string $route_id) : bool
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'DELETE'
+		]);
+		return ($result == 1 ? true : false);
+	}
+
+	/**
+	 * Delete the specified Route Schedule.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function deleteRouteSchedule(string $route_id) : RouteSchedule
+	{
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id  . '/items',
+			'method' => 'DELETE'
+		]));
+	}
+
+	/**
+	 * Replace the existing Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $route_id Route ID.
+	 * @param  array    $params
+	 *   int      member_id - A unique ID of the root member,
+	 *   string   vehicle_id - Vehicle ID,
+	 *   string   schedule_uid - Schedule ID,
+	 *   string   name,
+	 *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function replaceRouteSchedule(string $route_id, array $params)
+	{
+		$allBodyFields = ['member_id', 'vehicle_id', 'schedule_uid', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE . '/' . $route_id,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Route Schedule preview by specifying the 'route_id'.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @param  string $start Start date as 'YYYY-MM-DD'
+	 * @param  string $end End date as 'YYYY-MM-DD'
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedulePreview(string $route_id, string $start, string $end) : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id . '/preview',
+			'method' => 'GET',
+			'query' => ['start' => $start, 'end' => $end]
+		]);
+	}
+
+	/**
+	 * Check if the Scheduled Route was copied by specifying the 'route_id'.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function isScheduledRouteCopy(string $route_id) : bool
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY . '/' . $route_id,
+			'method' => 'GET'
+		]);
+	}
+
+	/**
+	 * Get all routes copied from the specified Scheduled Route by sending
+	 * the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $route_id Route ID.
+	 * @param  string   $schedule_uid Schedule ID.
+	 * @param  string   $route_date Route date as 'YYYY-MM-DD'.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getScheduledRoutesCopies(string $route_id, string $schedule_uid, string $route_date) : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_GET_COPIES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => [
+				'route_id' => $route_id,
+				'schedule_uid' => $schedule_uid,
+				'route_date' => $route_date
+			]
+		]);
+	}
+
+	/**
+	 * Create a new Master Route by sending the corresponding data.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array    $params
+	 *   string   route_id - Route ID,
+	 *   string   route_name,
+	 *   int      member_id - A unique ID of the root member,
+	 *   string   vehicle_id - Vehicle ID,
+	 *   string   schedule_uid - Schedule ID,
+	 *   string   name,
+	 *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   bool     sync - Type of result, synchronous or not
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function createMasterRoute(array $params) : bool
+	{
+		$allBodyFields = ['route_id', 'route_name', 'member_id', 'schedule_uid', 'vehicle_id', 'name',
+			'schedule_blacklist', 'advance_schedule_interval_days', 'schedule', 'timezone', 'sync'];
+
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_MASTER_ROUTES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]);
+	}
+
+	private function toSchedule($result) : Schedule
+	{
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				return new Schedule($data[0]);
+			}
+		}
+		throw new ApiError('Can not convert result to Schedule object.');
+	}
+
+	private function toRouteSchedule($result) : RouteSchedule
+	{
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				return new RouteSchedule($data[0]);
+			}
+		}
+		throw new ApiError('Can not convert result to RouteSchedule object.');
+	}
 }

UnitTestFiles/Test/V5/VehicleTests.php

Indentation +494 added lines, -494 removed lines

@@ -26,539 +26,539 @@
 
 class VehicleTests extends TestCase
 {
-    public static $createdVehicles = [];
-    public static $createdVehicleProfiles = [];
-
-    public static function setUpBeforeClass()
-    {
-        Route4Me::setApiKey(Constants::API_KEY);
-
-        $vehicle = new Vehicle();
-
-        //region Create Test Vehicles
-
-        $class6TruckParams = Vehicle::fromArray([
-            'vehicle_alias'             => 'GMC TopKick C5500 TST 6',
-            'vehicle_vin'               => 'SAJXA01A06FN08012',
-            'vehicle_license_plate'     => 'CVH4561',
-            'vehicle_model'             => 'TopKick C5500',
-            'vehicle_model_year'        => 1995,
-            'vehicle_year_acquired'     => 2008,
-            'vehicle_reg_country_id'    => 223,
-            'vehicle_reg_state_id'      => 12,
-            'vehicle_make'              => 'GMC',
-            'vehicle_type_id'           => 'pickup_truck',
-            'vehicle_cost_new'          => 60000,
-            'purchased_new'             => true,
-            'mpg_city'                  => 8,
-            'mpg_highway'               => 14,
-            'fuel_type'                 => 'diesel',
-            'license_start_date'        => '2021-01-01',
-            'license_end_date'          => '2031-01-01',
-        ]);
-
-        $result = $vehicle->createVehicle($class6TruckParams);
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-
-        self::$createdVehicles[] = $result;
-
-
-        $class7TruckParams = Vehicle::fromArray([
-            'vehicle_alias'             => 'FORD F750 TST 7',
-            'vehicle_vin'               => '1NPAX6EX2YD550743',
-            'vehicle_license_plate'     => 'FFV9547',
-            'vehicle_model'             => 'F-750',
-            'vehicle_model_year'        => 2010,
-            'vehicle_year_acquired'     => 2018,
-            'vehicle_reg_country_id'    => 223,
-            'vehicle_make'              => 'Ford',
-            'vehicle_type_id'           => 'livestock_carrier',
-            'vehicle_cost_new'          => 60000,
-            'purchased_new'             => true,
-            'mpg_city'                  => 7,
-            'mpg_highway'               => 14,
-            'fuel_consumption_city'     => 7,
-            'fuel_consumption_highway'  => 14,
-            'fuel_type'                 => 'diesel',
-            'license_start_date'        => '2021-01-01',
-            'license_end_date'          => '2031-01-01',
-        ]);
-
-        $result = $vehicle->createVehicle($class7TruckParams);
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-
-        self::$createdVehicles[] = $result;
-
-        //endregion
-
-        #region Create Test Vehicle Profiles
-
-        $profile1 = new VehicleProfile();
-
-        $profile1->name = "Heavy Duty - 28 Double Trailer ".date('Y-m-d H:i');
-        $profile1->height_units = VehicleSizeUnits::METER;
-        $profile1->width_units = VehicleSizeUnits::METER;
-        $profile1->length_units = VehicleSizeUnits::METER;
-        $profile1->height = 4;
-        $profile1->width = 2.44;
-        $profile1->length = 12.2;
-        $profile1->is_predefined = false;
-        $profile1->is_default = false;
-        $profile1->weight_units = VehicleWeightUnits::KILOGRAM;
-        $profile1->weight = 20400;
-        $profile1->max_weight_per_axle = 15400;
-        $profile1->fuel_type = FuelTypes::UNLEADED_91;
-        $profile1->fuel_consumption_city = 6;
-        $profile1->fuel_consumption_highway = 12;
-        $profile1->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-        $profile1->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-
-        $result1 = $profile1->createVehicleProfile($profile1->toArray());
-
-        self::assertNotNull($result1);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result1)
-        );
-
-        self::$createdVehicleProfiles[] = $result1;
-
-        $profile2 = new VehicleProfile();
-
-        $profile2->name = "Heavy Duty - 40 Straight Truck ".date('Y-m-d H:i');
-        $profile2->height_units = VehicleSizeUnits::METER;
-        $profile2->width_units = VehicleSizeUnits::METER;
-        $profile2->length_units = VehicleSizeUnits::METER;
-        $profile2->height = 4;
-        $profile2->width = 2.44;
-        $profile2->length = 14.6;
-        $profile2->is_predefined = false;
-        $profile2->is_default = false;
-        $profile2->weight_units = VehicleWeightUnits::KILOGRAM;
-        $profile2->weight = 36300;
-        $profile2->max_weight_per_axle = 15400;
-        $profile2->fuel_type = FuelTypes::UNLEADED_87;
-        $profile2->fuel_consumption_city = 5;
-        $profile2->fuel_consumption_highway = 10;
-        $profile2->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-        $profile2->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-
-        $result2 = $profile2->createVehicleProfile($profile2->toArray());
-
-        self::assertNotNull($result2);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result2)
-        );
-
-        self::$createdVehicleProfiles[] = $result2;
-
-        #endregion
-    }
-
-    public function testFromArray()
-    {
-        $class6TruckParams = Vehicle::fromArray([
-            'vehicle_alias'             => 'GMC TopKick C5500 TST 6',
-            'vehicle_vin'               => 'SAJXA01A06FN08012',
-            'vehicle_license_plate'     => 'CVH4561',
-            'vehicle_model'             => 'TopKick C5500',
-            'vehicle_model_year'        => 1995,
-            'vehicle_year_acquired'     => 2008,
-            'vehicle_reg_country_id'    => 223,
-            'vehicle_reg_state_id'      => 12,
-            'vehicle_make'              => 'GMC',
-            'vehicle_type_id'           => 'pickup_truck',
-            'vehicle_cost_new'          => 60000,
-            'purchased_new'             => true,
-            'mpg_city'                  => 8,
-            'mpg_highway'               => 14,
-            'fuel_type'                 => 'diesel',
-            'license_start_date'        => '2021-01-01',
-            'license_end_date'          => '2031-01-01',
-        ]);
-
-        $this->assertEquals($class6TruckParams->vehicle_alias, 'GMC TopKick C5500 TST 6');
-        $this->assertEquals($class6TruckParams->vehicle_vin, 'SAJXA01A06FN08012');
-        $this->assertEquals($class6TruckParams->vehicle_license_plate, 'CVH4561');
-        $this->assertEquals($class6TruckParams->vehicle_model, 'TopKick C5500');
-        $this->assertEquals($class6TruckParams->vehicle_model_year, 1995);
-        $this->assertEquals($class6TruckParams->vehicle_year_acquired, 2008);
-        $this->assertEquals($class6TruckParams->vehicle_reg_country_id, 223);
-        $this->assertEquals($class6TruckParams->vehicle_reg_state_id, 12);
-        $this->assertEquals($class6TruckParams->vehicle_make, 'GMC');
-        $this->assertEquals($class6TruckParams->vehicle_type_id, 'pickup_truck');
-        $this->assertEquals($class6TruckParams->vehicle_cost_new, 60000);
-        $this->assertEquals($class6TruckParams->purchased_new, true);
-        $this->assertEquals($class6TruckParams->mpg_city, 8);
-        $this->assertEquals($class6TruckParams->mpg_highway, 14);
-        $this->assertEquals($class6TruckParams->fuel_type, 'diesel');
-        $this->assertEquals($class6TruckParams->license_start_date, '2021-01-01');
-        $this->assertEquals($class6TruckParams->license_end_date, '2031-01-01');
-    }
-
-    public function testGetVehiclesPaginatedList()
-    {
-        $vehParams = new VehicleParameters();
-
-        $vehParams->with_pagination = true;
-        $vehParams->page = 1;
-        $vehParams->perPage = 10;
-
-        $vehicle = new Vehicle();
-
-        $result = $vehicle->getVehiclesPaginatedList($vehParams->toArray());
-
-        $this->assertNotNull($result);
-        $this->assertTrue(is_array($result));
-        $this->assertTrue(sizeof($result)>0);
-        $this->assertInstanceOf(Vehicle::class, Vehicle::fromArray($result));
-    }
-
-    public function testCreateVehicle()
-    {
-        $vehicle = new Vehicle();
-
-        $class7TruckParams = Vehicle::fromArray([
-            'vehicle_alias'             => 'FORD F750 TST 7',
-            'vehicle_vin'               => '1NPAX6EX2YD550743',
-            'vehicle_license_plate'     => 'FFV9547',
-            'vehicle_model'             => 'F-750',
-            'vehicle_model_year'        => 2010,
-            'vehicle_year_acquired'     => 2018,
-            'vehicle_reg_country_id'    => 223,
-            'vehicle_reg_state_id'      => 12,
-            'vehicle_make'              => 'Ford',
-            'vehicle_type_id'           => 'livestock_carrier',
-            'vehicle_cost_new'          => 70000,
-            'purchased_new'             => false,
-            'mpg_city'                  => 6,
-            'mpg_highway'               => 12,
-            'fuel_consumption_city'     => 6,
-            'fuel_consumption_highway'  => 12,
-            'fuel_type'                 => 'diesel',
-            'license_start_date'        => '2020-03-01',
-            'license_end_date'          => '2028-12-01',
-        ]);
-
-        $result = $vehicle->createVehicle($class7TruckParams);
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-
-        self::$createdVehicles[] = $result;
-    }
-
-    public function testCreateTemporaryVehicle()
-    {
-        $this->markTestSkipped('The endpoint vehicles/assign is enabled for the accounts with the specified features.');
-
-        $vehicle = new Vehicle();
-
-        $tempVehParams = new VehicleTemporary();
-
-        $tempVehParams->assigned_member_id = 1;
-        $tempVehParams->expires_at = '2028-12-20';
-        $tempVehParams->force_assignment = true;
-        $tempVehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
-        $tempVehParams->vehicle_license_plate = self::$createdVehicles[0]['vehicle_license_plate'];
-
-        $result = $vehicle->createTemporaryVehicle($tempVehParams->toArray());
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleTemporary::class,
-            VehicleTemporary::fromArray($result)
-        );
-    }
-
-    public function testExecuteVehicleOrder()
-    {
-        $this->markTestSkipped('The endpoint vehicles/execute is enabled for the account with the specified features.');
-
-        $vehicle = new Vehicle();
-
-        $orderParams = new VehicleOrderParameters();
-        $orderParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
-        $orderParams->lat = 38.247605;
-        $orderParams->lng = -85.746697;
-
-        $result = $vehicle->executeVehicleOrder($orderParams->toArray());
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleOrderResponse::class,
-            VehicleOrderResponse::fromArray($result)
-        );
-    }
-
-    public function testGetLatestVehicleLocations()
-    {
-        $vehicle = new Vehicle();
-
-        $vehicleIDs = array_column(self::$createdVehicles, 'vehicle_id');
-
-        $vehParams = new VehicleParameters();
-        $vehParams->ids = $vehicleIDs;
-
-        $result = $vehicle->getVehicleLocations($vehParams);
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleLocationResponse::class,
-            VehicleLocationResponse::fromArray($result)
-        );
-        self::assertTrue(isset($result['data']));
-        self::assertTrue(is_array($result['data']));
-    }
-
-    public function testGetVehicleById()
-    {
-        $vehicle = new Vehicle();
-
-        $vehParams = new VehicleParameters();
-        $vehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
-
-        $result = $vehicle->getVehicleById($vehParams->toArray());
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-        self::assertEquals($vehParams->vehicle_id, $result['vehicle_id']);
-    }
-
-
-    public function testGetVehicleTrack()
-    {
-        $vehicle = new Vehicle();
+	public static $createdVehicles = [];
+	public static $createdVehicleProfiles = [];
+
+	public static function setUpBeforeClass()
+	{
+		Route4Me::setApiKey(Constants::API_KEY);
+
+		$vehicle = new Vehicle();
+
+		//region Create Test Vehicles
+
+		$class6TruckParams = Vehicle::fromArray([
+			'vehicle_alias'             => 'GMC TopKick C5500 TST 6',
+			'vehicle_vin'               => 'SAJXA01A06FN08012',
+			'vehicle_license_plate'     => 'CVH4561',
+			'vehicle_model'             => 'TopKick C5500',
+			'vehicle_model_year'        => 1995,
+			'vehicle_year_acquired'     => 2008,
+			'vehicle_reg_country_id'    => 223,
+			'vehicle_reg_state_id'      => 12,
+			'vehicle_make'              => 'GMC',
+			'vehicle_type_id'           => 'pickup_truck',
+			'vehicle_cost_new'          => 60000,
+			'purchased_new'             => true,
+			'mpg_city'                  => 8,
+			'mpg_highway'               => 14,
+			'fuel_type'                 => 'diesel',
+			'license_start_date'        => '2021-01-01',
+			'license_end_date'          => '2031-01-01',
+		]);
+
+		$result = $vehicle->createVehicle($class6TruckParams);
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+
+		self::$createdVehicles[] = $result;
+
+
+		$class7TruckParams = Vehicle::fromArray([
+			'vehicle_alias'             => 'FORD F750 TST 7',
+			'vehicle_vin'               => '1NPAX6EX2YD550743',
+			'vehicle_license_plate'     => 'FFV9547',
+			'vehicle_model'             => 'F-750',
+			'vehicle_model_year'        => 2010,
+			'vehicle_year_acquired'     => 2018,
+			'vehicle_reg_country_id'    => 223,
+			'vehicle_make'              => 'Ford',
+			'vehicle_type_id'           => 'livestock_carrier',
+			'vehicle_cost_new'          => 60000,
+			'purchased_new'             => true,
+			'mpg_city'                  => 7,
+			'mpg_highway'               => 14,
+			'fuel_consumption_city'     => 7,
+			'fuel_consumption_highway'  => 14,
+			'fuel_type'                 => 'diesel',
+			'license_start_date'        => '2021-01-01',
+			'license_end_date'          => '2031-01-01',
+		]);
+
+		$result = $vehicle->createVehicle($class7TruckParams);
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+
+		self::$createdVehicles[] = $result;
+
+		//endregion
+
+		#region Create Test Vehicle Profiles
+
+		$profile1 = new VehicleProfile();
+
+		$profile1->name = "Heavy Duty - 28 Double Trailer ".date('Y-m-d H:i');
+		$profile1->height_units = VehicleSizeUnits::METER;
+		$profile1->width_units = VehicleSizeUnits::METER;
+		$profile1->length_units = VehicleSizeUnits::METER;
+		$profile1->height = 4;
+		$profile1->width = 2.44;
+		$profile1->length = 12.2;
+		$profile1->is_predefined = false;
+		$profile1->is_default = false;
+		$profile1->weight_units = VehicleWeightUnits::KILOGRAM;
+		$profile1->weight = 20400;
+		$profile1->max_weight_per_axle = 15400;
+		$profile1->fuel_type = FuelTypes::UNLEADED_91;
+		$profile1->fuel_consumption_city = 6;
+		$profile1->fuel_consumption_highway = 12;
+		$profile1->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$profile1->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+
+		$result1 = $profile1->createVehicleProfile($profile1->toArray());
+
+		self::assertNotNull($result1);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result1)
+		);
+
+		self::$createdVehicleProfiles[] = $result1;
+
+		$profile2 = new VehicleProfile();
+
+		$profile2->name = "Heavy Duty - 40 Straight Truck ".date('Y-m-d H:i');
+		$profile2->height_units = VehicleSizeUnits::METER;
+		$profile2->width_units = VehicleSizeUnits::METER;
+		$profile2->length_units = VehicleSizeUnits::METER;
+		$profile2->height = 4;
+		$profile2->width = 2.44;
+		$profile2->length = 14.6;
+		$profile2->is_predefined = false;
+		$profile2->is_default = false;
+		$profile2->weight_units = VehicleWeightUnits::KILOGRAM;
+		$profile2->weight = 36300;
+		$profile2->max_weight_per_axle = 15400;
+		$profile2->fuel_type = FuelTypes::UNLEADED_87;
+		$profile2->fuel_consumption_city = 5;
+		$profile2->fuel_consumption_highway = 10;
+		$profile2->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$profile2->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+
+		$result2 = $profile2->createVehicleProfile($profile2->toArray());
+
+		self::assertNotNull($result2);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result2)
+		);
+
+		self::$createdVehicleProfiles[] = $result2;
+
+		#endregion
+	}
+
+	public function testFromArray()
+	{
+		$class6TruckParams = Vehicle::fromArray([
+			'vehicle_alias'             => 'GMC TopKick C5500 TST 6',
+			'vehicle_vin'               => 'SAJXA01A06FN08012',
+			'vehicle_license_plate'     => 'CVH4561',
+			'vehicle_model'             => 'TopKick C5500',
+			'vehicle_model_year'        => 1995,
+			'vehicle_year_acquired'     => 2008,
+			'vehicle_reg_country_id'    => 223,
+			'vehicle_reg_state_id'      => 12,
+			'vehicle_make'              => 'GMC',
+			'vehicle_type_id'           => 'pickup_truck',
+			'vehicle_cost_new'          => 60000,
+			'purchased_new'             => true,
+			'mpg_city'                  => 8,
+			'mpg_highway'               => 14,
+			'fuel_type'                 => 'diesel',
+			'license_start_date'        => '2021-01-01',
+			'license_end_date'          => '2031-01-01',
+		]);
+
+		$this->assertEquals($class6TruckParams->vehicle_alias, 'GMC TopKick C5500 TST 6');
+		$this->assertEquals($class6TruckParams->vehicle_vin, 'SAJXA01A06FN08012');
+		$this->assertEquals($class6TruckParams->vehicle_license_plate, 'CVH4561');
+		$this->assertEquals($class6TruckParams->vehicle_model, 'TopKick C5500');
+		$this->assertEquals($class6TruckParams->vehicle_model_year, 1995);
+		$this->assertEquals($class6TruckParams->vehicle_year_acquired, 2008);
+		$this->assertEquals($class6TruckParams->vehicle_reg_country_id, 223);
+		$this->assertEquals($class6TruckParams->vehicle_reg_state_id, 12);
+		$this->assertEquals($class6TruckParams->vehicle_make, 'GMC');
+		$this->assertEquals($class6TruckParams->vehicle_type_id, 'pickup_truck');
+		$this->assertEquals($class6TruckParams->vehicle_cost_new, 60000);
+		$this->assertEquals($class6TruckParams->purchased_new, true);
+		$this->assertEquals($class6TruckParams->mpg_city, 8);
+		$this->assertEquals($class6TruckParams->mpg_highway, 14);
+		$this->assertEquals($class6TruckParams->fuel_type, 'diesel');
+		$this->assertEquals($class6TruckParams->license_start_date, '2021-01-01');
+		$this->assertEquals($class6TruckParams->license_end_date, '2031-01-01');
+	}
+
+	public function testGetVehiclesPaginatedList()
+	{
+		$vehParams = new VehicleParameters();
+
+		$vehParams->with_pagination = true;
+		$vehParams->page = 1;
+		$vehParams->perPage = 10;
+
+		$vehicle = new Vehicle();
+
+		$result = $vehicle->getVehiclesPaginatedList($vehParams->toArray());
+
+		$this->assertNotNull($result);
+		$this->assertTrue(is_array($result));
+		$this->assertTrue(sizeof($result)>0);
+		$this->assertInstanceOf(Vehicle::class, Vehicle::fromArray($result));
+	}
+
+	public function testCreateVehicle()
+	{
+		$vehicle = new Vehicle();
+
+		$class7TruckParams = Vehicle::fromArray([
+			'vehicle_alias'             => 'FORD F750 TST 7',
+			'vehicle_vin'               => '1NPAX6EX2YD550743',
+			'vehicle_license_plate'     => 'FFV9547',
+			'vehicle_model'             => 'F-750',
+			'vehicle_model_year'        => 2010,
+			'vehicle_year_acquired'     => 2018,
+			'vehicle_reg_country_id'    => 223,
+			'vehicle_reg_state_id'      => 12,
+			'vehicle_make'              => 'Ford',
+			'vehicle_type_id'           => 'livestock_carrier',
+			'vehicle_cost_new'          => 70000,
+			'purchased_new'             => false,
+			'mpg_city'                  => 6,
+			'mpg_highway'               => 12,
+			'fuel_consumption_city'     => 6,
+			'fuel_consumption_highway'  => 12,
+			'fuel_type'                 => 'diesel',
+			'license_start_date'        => '2020-03-01',
+			'license_end_date'          => '2028-12-01',
+		]);
+
+		$result = $vehicle->createVehicle($class7TruckParams);
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+
+		self::$createdVehicles[] = $result;
+	}
+
+	public function testCreateTemporaryVehicle()
+	{
+		$this->markTestSkipped('The endpoint vehicles/assign is enabled for the accounts with the specified features.');
+
+		$vehicle = new Vehicle();
+
+		$tempVehParams = new VehicleTemporary();
+
+		$tempVehParams->assigned_member_id = 1;
+		$tempVehParams->expires_at = '2028-12-20';
+		$tempVehParams->force_assignment = true;
+		$tempVehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
+		$tempVehParams->vehicle_license_plate = self::$createdVehicles[0]['vehicle_license_plate'];
+
+		$result = $vehicle->createTemporaryVehicle($tempVehParams->toArray());
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleTemporary::class,
+			VehicleTemporary::fromArray($result)
+		);
+	}
+
+	public function testExecuteVehicleOrder()
+	{
+		$this->markTestSkipped('The endpoint vehicles/execute is enabled for the account with the specified features.');
+
+		$vehicle = new Vehicle();
+
+		$orderParams = new VehicleOrderParameters();
+		$orderParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
+		$orderParams->lat = 38.247605;
+		$orderParams->lng = -85.746697;
+
+		$result = $vehicle->executeVehicleOrder($orderParams->toArray());
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleOrderResponse::class,
+			VehicleOrderResponse::fromArray($result)
+		);
+	}
+
+	public function testGetLatestVehicleLocations()
+	{
+		$vehicle = new Vehicle();
+
+		$vehicleIDs = array_column(self::$createdVehicles, 'vehicle_id');
+
+		$vehParams = new VehicleParameters();
+		$vehParams->ids = $vehicleIDs;
+
+		$result = $vehicle->getVehicleLocations($vehParams);
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleLocationResponse::class,
+			VehicleLocationResponse::fromArray($result)
+		);
+		self::assertTrue(isset($result['data']));
+		self::assertTrue(is_array($result['data']));
+	}
+
+	public function testGetVehicleById()
+	{
+		$vehicle = new Vehicle();
+
+		$vehParams = new VehicleParameters();
+		$vehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
+
+		$result = $vehicle->getVehicleById($vehParams->toArray());
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+		self::assertEquals($vehParams->vehicle_id, $result['vehicle_id']);
+	}
+
+
+	public function testGetVehicleTrack()
+	{
+		$vehicle = new Vehicle();
 
-        $vehParams = new VehicleParameters();
-        $vehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
+		$vehParams = new VehicleParameters();
+		$vehParams->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
 
-        $result = $vehicle->getVehicleTrack($vehParams->toArray());
+		$result = $vehicle->getVehicleTrack($vehParams->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleTrackResponse::class,
-            VehicleTrackResponse::fromArray($result)
-        );
-    }
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleTrackResponse::class,
+			VehicleTrackResponse::fromArray($result)
+		);
+	}
 
-    public function testDeleteVehicle()
-    {
-        $vehicle = new Vehicle();
+	public function testDeleteVehicle()
+	{
+		$vehicle = new Vehicle();
 
-        $vehParams = new VehicleParameters();
-        $vehParams->vehicle_id = self::$createdVehicles[sizeof(self::$createdVehicles) - 1]['vehicle_id'];
+		$vehParams = new VehicleParameters();
+		$vehParams->vehicle_id = self::$createdVehicles[sizeof(self::$createdVehicles) - 1]['vehicle_id'];
 
-        $result = $vehicle->removeVehicle($vehParams->toArray());
+		$result = $vehicle->removeVehicle($vehParams->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-        self::assertEquals($vehParams->vehicle_id, $result['vehicle_id']);
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+		self::assertEquals($vehParams->vehicle_id, $result['vehicle_id']);
 
-        array_pop(self::$createdVehicles);
-    }
+		array_pop(self::$createdVehicles);
+	}
 
-    public function testGetVehicleProfiles()
-    {
-        $vehicleProfile = new VehicleProfile();
+	public function testGetVehicleProfiles()
+	{
+		$vehicleProfile = new VehicleProfile();
 
-        $vehProfileParams = new VehicleProfileParameters();
+		$vehProfileParams = new VehicleProfileParameters();
 
-        $vehProfileParams->with_pagination = true;
-        $vehProfileParams->page = 1;
-        $vehProfileParams->perPage = 10;
+		$vehProfileParams->with_pagination = true;
+		$vehProfileParams->page = 1;
+		$vehProfileParams->perPage = 10;
 
-        $result = $vehicleProfile->getVehicleProfiles($vehProfileParams->toArray());
+		$result = $vehicleProfile->getVehicleProfiles($vehProfileParams->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleProfilesResponse::class,
-            VehicleProfilesResponse::fromArray($result)
-        );
-    }
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleProfilesResponse::class,
+			VehicleProfilesResponse::fromArray($result)
+		);
+	}
 
-    public function testCreateVehicleProfile()
-    {
-        $vehicleProfile = new VehicleProfile();
+	public function testCreateVehicleProfile()
+	{
+		$vehicleProfile = new VehicleProfile();
 
-        $profile = new VehicleProfile();
+		$profile = new VehicleProfile();
 
-        $profile->name = "Heavy Duty - 48 Semitrailer ".date('Y-m-d H:i');
-        $profile->height_units = VehicleSizeUnits::METER;
-        $profile->width_units = VehicleSizeUnits::METER;
-        $profile->length_units = VehicleSizeUnits::METER;
-        $profile->height = 3.5;
-        $profile->width = 2.5;
-        $profile->length = 16;
-        $profile->is_predefined = false;
-        $profile->is_default = false;
-        $profile->weight_units = VehicleWeightUnits::KILOGRAM;
-        $profile->weight = 35000;
-        $profile->max_weight_per_axle = 17500;
-        $profile->fuel_type = FuelTypes::UNLEADED_87;
-        $profile->fuel_consumption_city = 6;
-        $profile->fuel_consumption_highway = 11;
-        $profile->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-        $profile->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$profile->name = "Heavy Duty - 48 Semitrailer ".date('Y-m-d H:i');
+		$profile->height_units = VehicleSizeUnits::METER;
+		$profile->width_units = VehicleSizeUnits::METER;
+		$profile->length_units = VehicleSizeUnits::METER;
+		$profile->height = 3.5;
+		$profile->width = 2.5;
+		$profile->length = 16;
+		$profile->is_predefined = false;
+		$profile->is_default = false;
+		$profile->weight_units = VehicleWeightUnits::KILOGRAM;
+		$profile->weight = 35000;
+		$profile->max_weight_per_axle = 17500;
+		$profile->fuel_type = FuelTypes::UNLEADED_87;
+		$profile->fuel_consumption_city = 6;
+		$profile->fuel_consumption_highway = 11;
+		$profile->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$profile->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
 
 
-        $result = $vehicleProfile->createVehicleProfile($profile->toArray());
+		$result = $vehicleProfile->createVehicleProfile($profile->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result)
-        );
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result)
+		);
 
-        self::$createdVehicleProfiles[] = $result;
-    }
+		self::$createdVehicleProfiles[] = $result;
+	}
 
-    public function testDeleteVehicleProfile()
-    {
-        $vehicleProfile = new VehicleProfile();
+	public function testDeleteVehicleProfile()
+	{
+		$vehicleProfile = new VehicleProfile();
 
-        $vehProfileId = self::$createdVehicleProfiles[sizeof(self::$createdVehicleProfiles)-1]['vehicle_profile_id'];
+		$vehProfileId = self::$createdVehicleProfiles[sizeof(self::$createdVehicleProfiles)-1]['vehicle_profile_id'];
 
-        $result = $vehicleProfile->removeVehicleProfile($vehProfileId);
+		$result = $vehicleProfile->removeVehicleProfile($vehProfileId);
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result)
-        );
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result)
+		);
 
-        array_pop(self::$createdVehicleProfiles);
-    }
+		array_pop(self::$createdVehicleProfiles);
+	}
 
-    public function testGetVehicleProfileById()
-    {
-        $vehicleProfile = new VehicleProfile();
-
-        $vehProfileId = self::$createdVehicleProfiles[sizeof(self::$createdVehicleProfiles)-1]['vehicle_profile_id'];
+	public function testGetVehicleProfileById()
+	{
+		$vehicleProfile = new VehicleProfile();
+
+		$vehProfileId = self::$createdVehicleProfiles[sizeof(self::$createdVehicleProfiles)-1]['vehicle_profile_id'];
 
-        $result = $vehicleProfile->getVehicleProfileById($vehProfileId);
+		$result = $vehicleProfile->getVehicleProfileById($vehProfileId);
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result)
-        );
-        self::assertEquals($vehProfileId, $result['vehicle_profile_id']);
-    }
-
-    public function testGetVehicleByLicensePlate()
-    {
-        $vehicle = new Vehicle();
-
-        $vehParams = new VehicleParameters();
-        $vehParams->vehicle_license_plate = self::$createdVehicles[0]['vehicle_license_plate'];
-
-        $result = $vehicle->getVehicleByLicensePlate($vehParams);
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result)
+		);
+		self::assertEquals($vehProfileId, $result['vehicle_profile_id']);
+	}
+
+	public function testGetVehicleByLicensePlate()
+	{
+		$vehicle = new Vehicle();
+
+		$vehParams = new VehicleParameters();
+		$vehParams->vehicle_license_plate = self::$createdVehicles[0]['vehicle_license_plate'];
+
+		$result = $vehicle->getVehicleByLicensePlate($vehParams);
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleResponse::class,
-            VehicleResponse::fromArray($result)
-        );
-    }
-
-    public function testSearchVehicles()
-    {
-        $this->markTestSkipped('This method is deprecated until resolving the response issue.');
-
-        $vehicle = new Vehicle();
-
-        $searchParams = new VehicleSearchParameters();
-
-        $searchParams->vehicle_ids = array_column(self::$createdVehicles, 'vehicle_id');
-        $searchParams->lat = 29.748868;
-        $searchParams->lng = -95.358473;
-
-        $result = $vehicle->searchVehicles($searchParams);
-
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            VehicleResponse::fromArray($result[0])
-        );
-    }
-
-    public function testUpdateVehicle()
-    {
-        $vehicle = new Vehicle();
-
-        $vehicle->vehicle_alias = self::$createdVehicles[0]['vehicle_alias'] .' Updated';
-        $vehicle->vehicle_vin = '11111111111111111';
-        $vehicle->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleResponse::class,
+			VehicleResponse::fromArray($result)
+		);
+	}
+
+	public function testSearchVehicles()
+	{
+		$this->markTestSkipped('This method is deprecated until resolving the response issue.');
+
+		$vehicle = new Vehicle();
+
+		$searchParams = new VehicleSearchParameters();
+
+		$searchParams->vehicle_ids = array_column(self::$createdVehicles, 'vehicle_id');
+		$searchParams->lat = 29.748868;
+		$searchParams->lng = -95.358473;
+
+		$result = $vehicle->searchVehicles($searchParams);
+
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			VehicleResponse::fromArray($result[0])
+		);
+	}
+
+	public function testUpdateVehicle()
+	{
+		$vehicle = new Vehicle();
+
+		$vehicle->vehicle_alias = self::$createdVehicles[0]['vehicle_alias'] .' Updated';
+		$vehicle->vehicle_vin = '11111111111111111';
+		$vehicle->vehicle_id = self::$createdVehicles[0]['vehicle_id'];
 
-        $result = $vehicle->updateVehicle($vehicle->toArray());
+		$result = $vehicle->updateVehicle($vehicle->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            Vehicle::class,
-            Vehicle::fromArray($result)
-        );
-    }
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			Vehicle::class,
+			Vehicle::fromArray($result)
+		);
+	}
 
-    public function testUpdateVehicleProfile()
-    {
-        $vehicleProfile = new VehicleProfile();
+	public function testUpdateVehicleProfile()
+	{
+		$vehicleProfile = new VehicleProfile();
 
-        $vehProfileId = self::$createdVehicleProfiles[0]['vehicle_profile_id'];
+		$vehProfileId = self::$createdVehicleProfiles[0]['vehicle_profile_id'];
 
-        $vehicleProfile->name = self::$createdVehicleProfiles[0]['name'].'Updated';
-        $vehicleProfile->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-        $vehicleProfile->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
-        $vehicleProfile->vehicle_profile_id = self::$createdVehicleProfiles[0]['vehicle_profile_id'];
+		$vehicleProfile->name = self::$createdVehicleProfiles[0]['name'].'Updated';
+		$vehicleProfile->fuel_consumption_city_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$vehicleProfile->fuel_consumption_highway_unit = FuelConsumptionUnits::MILES_PER_GALLON_US;
+		$vehicleProfile->vehicle_profile_id = self::$createdVehicleProfiles[0]['vehicle_profile_id'];
 
-        $result = $vehicleProfile->updateVehicleProfile($vehicleProfile->toArray());
+		$result = $vehicleProfile->updateVehicleProfile($vehicleProfile->toArray());
 
-        self::assertNotNull($result);
-        self::assertInstanceOf(
-            VehicleProfile::class,
-            VehicleProfile::fromArray($result)
-        );
-    }
+		self::assertNotNull($result);
+		self::assertInstanceOf(
+			VehicleProfile::class,
+			VehicleProfile::fromArray($result)
+		);
+	}
 
-    public static function tearDownAfterClass()
-    {
-        $vehicle = new Vehicle();
+	public static function tearDownAfterClass()
+	{
+		$vehicle = new Vehicle();
 
-        $vehParams = new VehicleParameters();
+		$vehParams = new VehicleParameters();
 
-        foreach (self::$createdVehicles as $veh1) {
-            if (isset($veh1['vehicle_id'])) {
-                $vehParams->vehicle_id = $veh1['vehicle_id'];
-                $result1 = $vehicle->removeVehicle($vehParams->toArray());
-            }
-        }
+		foreach (self::$createdVehicles as $veh1) {
+			if (isset($veh1['vehicle_id'])) {
+				$vehParams->vehicle_id = $veh1['vehicle_id'];
+				$result1 = $vehicle->removeVehicle($vehParams->toArray());
+			}
+		}
 
-        $vehProfile = new VehicleProfile();
+		$vehProfile = new VehicleProfile();
 
-        foreach (self::$createdVehicleProfiles as $prof1) {
-            if (isset($prof1['vehicle_profile_id'])) {
-                $result2 = $vehProfile->removeVehicleProfile($prof1['vehicle_profile_id']);
-            }
-        }
-    }
+		foreach (self::$createdVehicleProfiles as $prof1) {
+			if (isset($prof1['vehicle_profile_id'])) {
+				$result2 = $vehProfile->removeVehicleProfile($prof1['vehicle_profile_id']);
+			}
+		}
+	}
 }

src/Route4Me/V5/Vehicles/DataTypes/VehicleProfile.php

Indentation +254 added lines, -254 removed lines

@@ -16,258 +16,258 @@
  */
 class VehicleProfile extends Common
 {
-    /** Vehicle profile ID
-     * @var integer $vehicle_profile_id
-     */
-    public $vehicle_profile_id;
-
-    /** Root member ID
-     * @var integer $root_member_id
-     */
-    public $root_member_id;
-
-    /** Vehicle profile name
-     * @var string $name
-     */
-    public $name;
-
-    /** Vehicle height
-     * @var float $height
-     */
-    public $height;
-
-    /** Vehicle width
-     * @var float $width
-     */
-    public $width;
-
-    /** Vehicle length
-     * @var float $length
-     */
-    public $length;
-
-    /** Vehicle weight
-     * @var float $weight
-     */
-    public $weight;
-
-    /** Maximum weight per axle.
-     * @var float $max_weight_per_axle
-     */
-    public $max_weight_per_axle;
-
-    /** When the profile deleted
-     * @var string $deleted_at
-     */
-    public $deleted_at;
-
-    /** When the profile created
-     * @var string $created_at
-     */
-    public $created_at;
-
-    /** When the profile updated
-     * @var string $updated_at
-     */
-    public $updated_at;
-
-    /** A type of the fuel
-     * enum: ['unleaded 87','unleaded 89','unleaded 91',
-     * 'unleaded 93','diesel','electric','hybrid']
-     * @var string $fuel_type
-     */
-    public $fuel_type;
-
-    /** Fuel consumption city
-     * @var float $fuel_consumption_city
-     */
-    public $fuel_consumption_city;
-
-    /** Fuel consumption in the highway area
-     * @var float $fuel_consumption_highway
-     */
-    public $fuel_consumption_highway;
-
-    /** Type of a hazardous material.
-     * enum: ['general', 'explosives', 'flammable', 'inhalants', 'caustic', 'radioactive']
-     * @var string $hazmat_type
-     */
-    public $hazmat_type;
-
-    /** If true, the profile is predefined.
-     * @var boolean $is_predefined
-     */
-    public $is_predefined;
-
-    /** If true, the profile is default.
-     * @var boolean $is_default
-     */
-    public $is_default;
-
-    /** Height units (e.g. 'ft', 'm')
-     * @var string $height_units
-     */
-    public $height_units;
-
-    /** Width units (e.g. 'ft', 'm')
-     * @var string $width_units
-     */
-    public $width_units;
-
-    /** Length units (e.g. 'ft', 'm')
-     * @var string $length_units
-     */
-    public $length_units;
-
-    /** Weight units (e.g. 'lb', 'kg')
-     * @var string $weight_units
-     */
-    public $weight_units;
-
-    /** Maximum weight per axle units (e.g. 'lb', 'kg')
-     * @var string $max_weight_per_axle_units
-     */
-    public $max_weight_per_axle_units;
-
-    /** Fuel consumption units in the city area (e.g. mpg)
-     * @var string $fuel_consumption_city_unit
-     */
-    public $fuel_consumption_city_unit;
-
-    /** Fuel consumption units in the highway area (e.g. mpg)
-     * @var string $fuel_consumption_highway_unit
-     */
-    public $fuel_consumption_highway_unit;
-
-    /** Height UF value (e.g. "7'")
-     * @var string $height_uf_value
-     */
-    public $height_uf_value;
-
-    /** Width UF value (e.g. "8'")
-     * @var string $width_uf_value
-     */
-    public $width_uf_value;
-
-    /** Length UF value (e.g. "20'")
-     * @var string $length_uf_value
-     */
-    public $length_uf_value;
-
-    /** Weight UF value (e.g. "8,500lb")
-     * @var string $weight_uf_value
-     */
-    public $weight_uf_value;
-
-    /** Maximum weight per axle (UF value, e.g. "8,500lb")
-     * @var string $max_weight_per_axle_uf_value
-     */
-    public $max_weight_per_axle_uf_value;
-
-    /** Fuel consumption city (UF value, e.g. "20.01 mi/l")
-     * @var string $fuel_consumption_city_uf_value
-     */
-    public $fuel_consumption_city_uf_value;
-
-    /** Fuel consumption highway (UF value, e.g. "2,000.01 mpg")
-     * @var string $fuel_consumption_highway_uf_value
-     */
-    public $fuel_consumption_highway_uf_value;
-
-    public static function fromArray(array $params)
-    {
-        $vehicleProfile = new self();
-
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($vehicleProfile, $key)) {
-                $vehicleProfile->$key = $value;
-            }
-        }
-
-        return $vehicleProfile;
-    }
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl("");
-    }
-
-    public function removeVehicleProfile($vehicleProfileId)
-    {
-        //$vehicleProfileID = isset($params['vehicle_profile_id']) ? $params['vehicle_profile_id'] : null;
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleProfiles . '/' . $vehicleProfileId,
-            'method' => 'DELETE',
-            'HTTPHEADER' => 'Content-Type: application/json; Accept: application/json',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @param $profileParams - an array from the VehicleParameters object.
-     * @return The data including list of the vehicle profiles.
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleProfiles($profileParams)
-    {
-        $allQueryFields = ['with_pagination', 'page', 'perPage'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleProfiles,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $profileParams),
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @param $profileParams - Vehicle profile body parameters
-     * @return Created vehicle profile
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function createVehicleProfile($profileParams)
-    {
-        $excludeFields = [];
-        $allBodyFields = Route4Me::getObjectProperties(new VehicleProfile(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleProfiles,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $profileParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
-
-    public function getVehicleProfileById($vehicleProfileId)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleProfiles . '/' . $vehicleProfileId,
-            'method' => 'GET',
-        ]);
-
-        return $response;
-    }
-
-    public function updateVehicleProfile($vehicleProfile)
-    {
-        $excludeFields = ['vehicle_profile_id', 'deleted_at', 'created_at', 'updated_at'];
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleProfiles.'/'.$vehicleProfile['vehicle_profile_id'],
-            'method' => 'PATCH',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleProfile),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
+	/** Vehicle profile ID
+	 * @var integer $vehicle_profile_id
+	 */
+	public $vehicle_profile_id;
+
+	/** Root member ID
+	 * @var integer $root_member_id
+	 */
+	public $root_member_id;
+
+	/** Vehicle profile name
+	 * @var string $name
+	 */
+	public $name;
+
+	/** Vehicle height
+	 * @var float $height
+	 */
+	public $height;
+
+	/** Vehicle width
+	 * @var float $width
+	 */
+	public $width;
+
+	/** Vehicle length
+	 * @var float $length
+	 */
+	public $length;
+
+	/** Vehicle weight
+	 * @var float $weight
+	 */
+	public $weight;
+
+	/** Maximum weight per axle.
+	 * @var float $max_weight_per_axle
+	 */
+	public $max_weight_per_axle;
+
+	/** When the profile deleted
+	 * @var string $deleted_at
+	 */
+	public $deleted_at;
+
+	/** When the profile created
+	 * @var string $created_at
+	 */
+	public $created_at;
+
+	/** When the profile updated
+	 * @var string $updated_at
+	 */
+	public $updated_at;
+
+	/** A type of the fuel
+	 * enum: ['unleaded 87','unleaded 89','unleaded 91',
+	 * 'unleaded 93','diesel','electric','hybrid']
+	 * @var string $fuel_type
+	 */
+	public $fuel_type;
+
+	/** Fuel consumption city
+	 * @var float $fuel_consumption_city
+	 */
+	public $fuel_consumption_city;
+
+	/** Fuel consumption in the highway area
+	 * @var float $fuel_consumption_highway
+	 */
+	public $fuel_consumption_highway;
+
+	/** Type of a hazardous material.
+	 * enum: ['general', 'explosives', 'flammable', 'inhalants', 'caustic', 'radioactive']
+	 * @var string $hazmat_type
+	 */
+	public $hazmat_type;
+
+	/** If true, the profile is predefined.
+	 * @var boolean $is_predefined
+	 */
+	public $is_predefined;
+
+	/** If true, the profile is default.
+	 * @var boolean $is_default
+	 */
+	public $is_default;
+
+	/** Height units (e.g. 'ft', 'm')
+	 * @var string $height_units
+	 */
+	public $height_units;
+
+	/** Width units (e.g. 'ft', 'm')
+	 * @var string $width_units
+	 */
+	public $width_units;
+
+	/** Length units (e.g. 'ft', 'm')
+	 * @var string $length_units
+	 */
+	public $length_units;
+
+	/** Weight units (e.g. 'lb', 'kg')
+	 * @var string $weight_units
+	 */
+	public $weight_units;
+
+	/** Maximum weight per axle units (e.g. 'lb', 'kg')
+	 * @var string $max_weight_per_axle_units
+	 */
+	public $max_weight_per_axle_units;
+
+	/** Fuel consumption units in the city area (e.g. mpg)
+	 * @var string $fuel_consumption_city_unit
+	 */
+	public $fuel_consumption_city_unit;
+
+	/** Fuel consumption units in the highway area (e.g. mpg)
+	 * @var string $fuel_consumption_highway_unit
+	 */
+	public $fuel_consumption_highway_unit;
+
+	/** Height UF value (e.g. "7'")
+	 * @var string $height_uf_value
+	 */
+	public $height_uf_value;
+
+	/** Width UF value (e.g. "8'")
+	 * @var string $width_uf_value
+	 */
+	public $width_uf_value;
+
+	/** Length UF value (e.g. "20'")
+	 * @var string $length_uf_value
+	 */
+	public $length_uf_value;
+
+	/** Weight UF value (e.g. "8,500lb")
+	 * @var string $weight_uf_value
+	 */
+	public $weight_uf_value;
+
+	/** Maximum weight per axle (UF value, e.g. "8,500lb")
+	 * @var string $max_weight_per_axle_uf_value
+	 */
+	public $max_weight_per_axle_uf_value;
+
+	/** Fuel consumption city (UF value, e.g. "20.01 mi/l")
+	 * @var string $fuel_consumption_city_uf_value
+	 */
+	public $fuel_consumption_city_uf_value;
+
+	/** Fuel consumption highway (UF value, e.g. "2,000.01 mpg")
+	 * @var string $fuel_consumption_highway_uf_value
+	 */
+	public $fuel_consumption_highway_uf_value;
+
+	public static function fromArray(array $params)
+	{
+		$vehicleProfile = new self();
+
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($vehicleProfile, $key)) {
+				$vehicleProfile->$key = $value;
+			}
+		}
+
+		return $vehicleProfile;
+	}
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl("");
+	}
+
+	public function removeVehicleProfile($vehicleProfileId)
+	{
+		//$vehicleProfileID = isset($params['vehicle_profile_id']) ? $params['vehicle_profile_id'] : null;
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleProfiles . '/' . $vehicleProfileId,
+			'method' => 'DELETE',
+			'HTTPHEADER' => 'Content-Type: application/json; Accept: application/json',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @param $profileParams - an array from the VehicleParameters object.
+	 * @return The data including list of the vehicle profiles.
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleProfiles($profileParams)
+	{
+		$allQueryFields = ['with_pagination', 'page', 'perPage'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleProfiles,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $profileParams),
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @param $profileParams - Vehicle profile body parameters
+	 * @return Created vehicle profile
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function createVehicleProfile($profileParams)
+	{
+		$excludeFields = [];
+		$allBodyFields = Route4Me::getObjectProperties(new VehicleProfile(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleProfiles,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $profileParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
+
+	public function getVehicleProfileById($vehicleProfileId)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleProfiles . '/' . $vehicleProfileId,
+			'method' => 'GET',
+		]);
+
+		return $response;
+	}
+
+	public function updateVehicleProfile($vehicleProfile)
+	{
+		$excludeFields = ['vehicle_profile_id', 'deleted_at', 'created_at', 'updated_at'];
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleProfiles.'/'.$vehicleProfile['vehicle_profile_id'],
+			'method' => 'PATCH',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleProfile),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/V5/Vehicles/DataTypes/Vehicle.php

Indentation +375 added lines, -375 removed lines

@@ -19,379 +19,379 @@
  */
 class Vehicle extends Common
 {
-    /** The vehicle ID
-     * @var string $vehicle_id
-     */
-    public $vehicle_id;
-
-    /** Member ID assigned to the vehicle.
-     * @var integer $member_id
-     */
-    public $member_id;
-
-    /** If true, the vehicle is marked as deleted.
-     * @var boolean $is_deleted
-     */
-    public $is_deleted;
-
-    /** Vehicle alias
-     * @var string $vehicle_alias
-     */
-    public $vehicle_alias;
-
-    /** Vehicle VIN
-     * @var string $vehicle_vin
-     */
-    public $vehicle_vin;
-
-    /** Vehicle registration state ID.
-     * @var integer $vehicle_reg_state_id
-     */
-    public $vehicle_reg_state_id;
-
-    /** Vehicle registration country ID.
-     * @var integer $vehicle_reg_country_id
-     */
-    public $vehicle_reg_country_id;
-
-    /** A license plate of the vehicle.
-     * @var string $vehicle_license_plate
-     */
-    public $vehicle_license_plate;
-
-    /** Vehicle type.
-     * <para>Availbale values:</para>
-     * sedan', 'suv', 'pickup_truck', 'van', '18wheeler', 'cabin', 'hatchback',
-     * '<para>motorcyle', 'waste_disposal', 'tree_cutting', 'bigrig', 'cement_mixer', </para>
-     * 'livestock_carrier', 'dairy','tractor_trailer'.
-     * @var string $vehicle_type_id
-     */
-    public $vehicle_type_id;
-
-    /** When the vehicle was added.
-     * @var string $timestamp_added
-     */
-    public $timestamp_added;
-
-    /** Vehicle maker brend.
-     * <para>Available values:</para>
-     * "american coleman", "bmw", "chevrolet", "ford", "freightliner", "gmc",
-     * <para>"hino", "honda", "isuzu", "kenworth", "mack", "mercedes-benz", "mitsubishi", </para>
-     * "navistar", "nissan", "peterbilt", "renault", "scania", "sterling", "toyota",
-     * <para>"volvo", "western star" </para>
-     * </value>"
-     * @var string $vehicle_make
-     */
-    public $vehicle_make;
-
-    /** Vehicle model year
-     * @var integer $vehicle_model_year
-     */
-    public $vehicle_model_year;
-
-    /** Vehicle model
-     * @var string $vehicle_model
-     */
-    public $vehicle_model;
-
-    /** The year, vehicle was acquired
-     * @var integer $vehicle_year_acquired
-     */
-    public $vehicle_year_acquired;
-
-    /** A cost of the new vehicle
-     * @var float $vehicle_cost_new
-     */
-    public $vehicle_cost_new;
-
-    /** If true, the vehicle was purchased new.
-     * @var boolean $purchased_new
-     */
-    public $purchased_new;
-
-    /** Start date of the license
-     * @var string $license_start_date
-     */
-    public $license_start_date;
-
-    /** End date of the license
-     * @var string $license_end_date
-     */
-    public $license_end_date;
-
-    /** If equal to '1', the vehicle is operational.
-     * @var boolean $is_operational
-     */
-    public $is_operational;
-
-    /** A type of the fuel
-     * @var string $fuel_type
-     * enum: ['unleaded 87','unleaded 89','unleaded 91','unleaded 93','diesel','electric','hybrid']
-     */
-    public $fuel_type;
-
-    /** External telematics vehicle IDs
-     * @var integer $external_telematics_vehicle_ids
-     */
-    public $external_telematics_vehicle_id;
-
-    /** When the vehcile was marked as deleted.
-     * @var integer $timestamp_removed
-     */
-    public $timestamp_removed;
-
-    /** Vehicle profile ID
-     * @var integer $vehicle_profile_id
-     */
-    public $vehicle_profile_id;
-
-    /** Fuel consumption city
-     * @var float $fuel_consumption_city
-     */
-    public $fuel_consumption_city;
-
-    /** Fuel consumption in the highway area
-     * @var float $fuel_consumption_highway
-     */
-    public $fuel_consumption_highway;
-
-    /** Fuel consumption units in the city area (e.g. mi/l)
-     * @var string $fuel_consumption_city_unit
-     */
-    public $fuel_consumption_city_unit;
-
-    /** Fuel consumption units in the highway area (e.g. mi/l)
-     * @var string $fuel_consumption_highway_unit
-     */
-    public $fuel_consumption_highway_unit;
-
-    /** Miles per gallon in the city area
-     * @var float $mpg_city
-     */
-    public $mpg_city;
-
-    /** Miles per gallon in the highway area
-     * @var float $mpg_highway
-     */
-    public $mpg_highway;
-
-    /** Fuel consumption UF value in the city area (e.g. '20.01 mi/l')
-     * @var string $fuel_consumption_city_uf_value
-     */
-    public $fuel_consumption_city_uf_value;
-
-    /** Fuel consumption UF value in the highway area (e.g. '2,000.01 mpg')
-     * @var string $fuel_consumption_highway_uf_value
-     */
-    public $fuel_consumption_highway_uf_value;
-
-    public static function fromArray(array $params)
-    {
-        $vehicle = new self();
-
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($vehicle, $key)) {
-                $vehicle->$key = $value;
-            }
-        }
-
-        return $vehicle;
-    }
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl("");
-    }
-
-    /** Creates a vehicle
-     * @param $vehicleParams
-     * Returns a vehicle object or failure info.
-     */
-    public function createVehicle($vehicleParams)
-    {
-        $excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
-
-    /** Removes a vehicle by specified vehicle ID.
-     * @param string $vehicleID - Vehicle ID
-     * @return Vehicle object - removed vehicle object.
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function removeVehicle($vehicleParams)
-    {
-        $vehicleId = $vehicleParams['vehicle_id'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles . '/' . $vehicleId,
-            'method' => 'DELETE'
-        ]);
-
-        return $response;
-    }
-
-    /** Returns the VehiclesPaginated type object containing an array of the vehicles.
-     * @param array $params - an array from the VehicleParameters object.
-     * @return an array of the Vehicle objects.
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehiclesPaginatedList($params)
-    {
-        $allQueryFields = ['with_pagination', 'page', 'perPage'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    /** Creates temporary vehicle in the database.
-     * @param $vehicleParams - an array from the VehicleTemporary object.
-     * @return an object of the type VehicleTemporary.
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function createTemporaryVehicle($vehicleParams)
-    {
-        $excludeFields = [];
-        $allBodyFields = Route4Me::getObjectProperties(new VehicleTemporary(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleTemporary,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
-
-    /** Execute a vehicle order.
-     * @param $vehicleParams - Vehicle order parameters.
-     * @return an object of the type VehicleOrderResponse
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function executeVehicleOrder($vehicleParams)
-    {
-        $excludeFields = [];
-        $allBodyFields = Route4Me::getObjectProperties(new VehicleOrderParameters(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleExecuteOrder,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
-
-    /** Get latest vehicle locations by specified vehicle IDs.
-     * @param $vehicleParams - Vehicle query parameters containing vehicle IDs
-     * @return Data with vehicles
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleLocations($vehicleParams)
-    {
-        $allQueryFields = ['ids'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleLocation,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
-        ]);
-
-        return $response;
-    }
-
-    /** Get the Vehicle by specifying vehicle ID.
-     * @param $vehicleParams - Vehicle query parameters containing vehicle ID.
-     * @return an object of the type Vehicle
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleById($vehicleParams)
-    {
-        $allQueryFields = ['vehicle_id'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'],
-            'method' => 'GET',
-            'query' => null,
-        ]);
-
-        return $response;
-    }
-
-    /** Get the Vehicle track by specifying vehicle ID.
-     * @param $vehicleParams - Vehicle query parameters containing vehicle ID.
-     * @return Vehicle track object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleTrack($vehicleParams)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'].'/track',
-            'method' => 'GET',
-            'query' => null,
-        ]);
-
-        return $response;
-    }
-
-    public function getVehicleByLicensePlate($vehicleParams)
-    {
-        $allQueryFields = ['vehicle_license_plate'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleLicense,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
-        ]);
-
-        return $response;
-    }
-
-    public function searchVehicles($searchParams)
-    {
-        $excludeFields = [];
-        $allBodyFields = Route4Me::getObjectProperties(new VehicleSearchParameters(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleSearch,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $searchParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
-
-    public function updateVehicle($vehicleParams)
-    {
-        $excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'],
-            'method' => 'PATCH',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
-            'HTTPHEADER' => 'Content-Type: application/json'
-        ]);
-
-        return $response;
-    }
+	/** The vehicle ID
+	 * @var string $vehicle_id
+	 */
+	public $vehicle_id;
+
+	/** Member ID assigned to the vehicle.
+	 * @var integer $member_id
+	 */
+	public $member_id;
+
+	/** If true, the vehicle is marked as deleted.
+	 * @var boolean $is_deleted
+	 */
+	public $is_deleted;
+
+	/** Vehicle alias
+	 * @var string $vehicle_alias
+	 */
+	public $vehicle_alias;
+
+	/** Vehicle VIN
+	 * @var string $vehicle_vin
+	 */
+	public $vehicle_vin;
+
+	/** Vehicle registration state ID.
+	 * @var integer $vehicle_reg_state_id
+	 */
+	public $vehicle_reg_state_id;
+
+	/** Vehicle registration country ID.
+	 * @var integer $vehicle_reg_country_id
+	 */
+	public $vehicle_reg_country_id;
+
+	/** A license plate of the vehicle.
+	 * @var string $vehicle_license_plate
+	 */
+	public $vehicle_license_plate;
+
+	/** Vehicle type.
+	 * <para>Availbale values:</para>
+	 * sedan', 'suv', 'pickup_truck', 'van', '18wheeler', 'cabin', 'hatchback',
+	 * '<para>motorcyle', 'waste_disposal', 'tree_cutting', 'bigrig', 'cement_mixer', </para>
+	 * 'livestock_carrier', 'dairy','tractor_trailer'.
+	 * @var string $vehicle_type_id
+	 */
+	public $vehicle_type_id;
+
+	/** When the vehicle was added.
+	 * @var string $timestamp_added
+	 */
+	public $timestamp_added;
+
+	/** Vehicle maker brend.
+	 * <para>Available values:</para>
+	 * "american coleman", "bmw", "chevrolet", "ford", "freightliner", "gmc",
+	 * <para>"hino", "honda", "isuzu", "kenworth", "mack", "mercedes-benz", "mitsubishi", </para>
+	 * "navistar", "nissan", "peterbilt", "renault", "scania", "sterling", "toyota",
+	 * <para>"volvo", "western star" </para>
+	 * </value>"
+	 * @var string $vehicle_make
+	 */
+	public $vehicle_make;
+
+	/** Vehicle model year
+	 * @var integer $vehicle_model_year
+	 */
+	public $vehicle_model_year;
+
+	/** Vehicle model
+	 * @var string $vehicle_model
+	 */
+	public $vehicle_model;
+
+	/** The year, vehicle was acquired
+	 * @var integer $vehicle_year_acquired
+	 */
+	public $vehicle_year_acquired;
+
+	/** A cost of the new vehicle
+	 * @var float $vehicle_cost_new
+	 */
+	public $vehicle_cost_new;
+
+	/** If true, the vehicle was purchased new.
+	 * @var boolean $purchased_new
+	 */
+	public $purchased_new;
+
+	/** Start date of the license
+	 * @var string $license_start_date
+	 */
+	public $license_start_date;
+
+	/** End date of the license
+	 * @var string $license_end_date
+	 */
+	public $license_end_date;
+
+	/** If equal to '1', the vehicle is operational.
+	 * @var boolean $is_operational
+	 */
+	public $is_operational;
+
+	/** A type of the fuel
+	 * @var string $fuel_type
+	 * enum: ['unleaded 87','unleaded 89','unleaded 91','unleaded 93','diesel','electric','hybrid']
+	 */
+	public $fuel_type;
+
+	/** External telematics vehicle IDs
+	 * @var integer $external_telematics_vehicle_ids
+	 */
+	public $external_telematics_vehicle_id;
+
+	/** When the vehcile was marked as deleted.
+	 * @var integer $timestamp_removed
+	 */
+	public $timestamp_removed;
+
+	/** Vehicle profile ID
+	 * @var integer $vehicle_profile_id
+	 */
+	public $vehicle_profile_id;
+
+	/** Fuel consumption city
+	 * @var float $fuel_consumption_city
+	 */
+	public $fuel_consumption_city;
+
+	/** Fuel consumption in the highway area
+	 * @var float $fuel_consumption_highway
+	 */
+	public $fuel_consumption_highway;
+
+	/** Fuel consumption units in the city area (e.g. mi/l)
+	 * @var string $fuel_consumption_city_unit
+	 */
+	public $fuel_consumption_city_unit;
+
+	/** Fuel consumption units in the highway area (e.g. mi/l)
+	 * @var string $fuel_consumption_highway_unit
+	 */
+	public $fuel_consumption_highway_unit;
+
+	/** Miles per gallon in the city area
+	 * @var float $mpg_city
+	 */
+	public $mpg_city;
+
+	/** Miles per gallon in the highway area
+	 * @var float $mpg_highway
+	 */
+	public $mpg_highway;
+
+	/** Fuel consumption UF value in the city area (e.g. '20.01 mi/l')
+	 * @var string $fuel_consumption_city_uf_value
+	 */
+	public $fuel_consumption_city_uf_value;
+
+	/** Fuel consumption UF value in the highway area (e.g. '2,000.01 mpg')
+	 * @var string $fuel_consumption_highway_uf_value
+	 */
+	public $fuel_consumption_highway_uf_value;
+
+	public static function fromArray(array $params)
+	{
+		$vehicle = new self();
+
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($vehicle, $key)) {
+				$vehicle->$key = $value;
+			}
+		}
+
+		return $vehicle;
+	}
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl("");
+	}
+
+	/** Creates a vehicle
+	 * @param $vehicleParams
+	 * Returns a vehicle object or failure info.
+	 */
+	public function createVehicle($vehicleParams)
+	{
+		$excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
+
+	/** Removes a vehicle by specified vehicle ID.
+	 * @param string $vehicleID - Vehicle ID
+	 * @return Vehicle object - removed vehicle object.
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function removeVehicle($vehicleParams)
+	{
+		$vehicleId = $vehicleParams['vehicle_id'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles . '/' . $vehicleId,
+			'method' => 'DELETE'
+		]);
+
+		return $response;
+	}
+
+	/** Returns the VehiclesPaginated type object containing an array of the vehicles.
+	 * @param array $params - an array from the VehicleParameters object.
+	 * @return an array of the Vehicle objects.
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehiclesPaginatedList($params)
+	{
+		$allQueryFields = ['with_pagination', 'page', 'perPage'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	/** Creates temporary vehicle in the database.
+	 * @param $vehicleParams - an array from the VehicleTemporary object.
+	 * @return an object of the type VehicleTemporary.
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function createTemporaryVehicle($vehicleParams)
+	{
+		$excludeFields = [];
+		$allBodyFields = Route4Me::getObjectProperties(new VehicleTemporary(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleTemporary,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
+
+	/** Execute a vehicle order.
+	 * @param $vehicleParams - Vehicle order parameters.
+	 * @return an object of the type VehicleOrderResponse
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function executeVehicleOrder($vehicleParams)
+	{
+		$excludeFields = [];
+		$allBodyFields = Route4Me::getObjectProperties(new VehicleOrderParameters(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleExecuteOrder,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
+
+	/** Get latest vehicle locations by specified vehicle IDs.
+	 * @param $vehicleParams - Vehicle query parameters containing vehicle IDs
+	 * @return Data with vehicles
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleLocations($vehicleParams)
+	{
+		$allQueryFields = ['ids'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleLocation,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
+		]);
+
+		return $response;
+	}
+
+	/** Get the Vehicle by specifying vehicle ID.
+	 * @param $vehicleParams - Vehicle query parameters containing vehicle ID.
+	 * @return an object of the type Vehicle
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleById($vehicleParams)
+	{
+		$allQueryFields = ['vehicle_id'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'],
+			'method' => 'GET',
+			'query' => null,
+		]);
+
+		return $response;
+	}
+
+	/** Get the Vehicle track by specifying vehicle ID.
+	 * @param $vehicleParams - Vehicle query parameters containing vehicle ID.
+	 * @return Vehicle track object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleTrack($vehicleParams)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'].'/track',
+			'method' => 'GET',
+			'query' => null,
+		]);
+
+		return $response;
+	}
+
+	public function getVehicleByLicensePlate($vehicleParams)
+	{
+		$allQueryFields = ['vehicle_license_plate'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleLicense,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
+		]);
+
+		return $response;
+	}
+
+	public function searchVehicles($searchParams)
+	{
+		$excludeFields = [];
+		$allBodyFields = Route4Me::getObjectProperties(new VehicleSearchParameters(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleSearch,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $searchParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
+
+	public function updateVehicle($vehicleParams)
+	{
+		$excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'],
+			'method' => 'PATCH',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $vehicleParams),
+			'HTTPHEADER' => 'Content-Type: application/json'
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/Vehicles/VehicleV4.php

Indentation +275 added lines, -275 removed lines

@@ -16,279 +16,279 @@
  */
 class VehicleV4 extends \Route4Me\Common
 {
-    /** @var string $vehicle_id
-     * Vehicle unique 32-chars ID
-     */
-    public $vehicle_id;
-
-    /** @var int $member_id
-     * Member unique ID
-     */
-    public $member_id;
-
-    /** @var boolean $is_deleted
-     * True, if the vehicle was deleted.
-     */
-    public $is_deleted;
-
-    /** @var string $vehicle_alias
-     * Vehicle alias
-     */
-    public $vehicle_alias;
-
-    /** @var string $vehicle_vin
-     * Vehicle VIN (vehicle identification number)
-     */
-    public $vehicle_vin;
-
-    /** @var int $vehicle_reg_state_id
-     * The ID of a state the vehicle was registered.
-     */
-    public $vehicle_reg_state_id;
-
-    /** @var int $vehicle_reg_country_id
-     * The ID of a country the vehicle was registered.
-     */
-    public $vehicle_reg_country_id;
-
-    /** @var string $vehicle_license_plate
-     * A license plate of the vehicle.
-     */
-    public $vehicle_license_plate;
-
-    /** @var string $vehicle_type_id
-     * Vehicle type ID.
-     * Available values:
-     * 'sedan', 'suv', 'pickup_truck', 'van', '18wheeler', 'cabin', 'hatchback',
-     * 'motorcyle', 'waste_disposal', 'tree_cutting', 'bigrig', 'cement_mixer',
-     * 'livestock_carrier', 'dairy','tractor_trailer'
-     */
-    public $vehicle_type_id;
-
-    /** @var string $timestamp_added
-     * When the vehicle was added.
-     */
-    public $timestamp_added;
-
-    /** @var string $vehicle_make
-     * Vehicle maker brend.
-     * Available values:
-     * 'american coleman', 'bmw', 'chevrolet', 'ford', 'freightliner', 'gmc',
-     * 'hino', 'honda', 'isuzu', 'kenworth', 'mack', 'mercedes-benz', 'mitsubishi',
-     * 'navistar', 'nissan', 'peterbilt', 'renault', 'scania', 'sterling', 'toyota',
-     * 'volvo', 'western star'
-     */
-    public $vehicle_make;
-
-    /** @var int $vehicle_model_year
-     * A year of the vehicle model.
-     */
-    public $vehicle_model_year;
-
-    /** @var string $vehicle_model
-     * A model of the vehicle.
-     */
-    public $vehicle_model;
-
-    /** @var int $vehicle_year_acquired
-     * A year, the vehicle was acquired.
-     */
-    public $vehicle_year_acquired;
-
-    /** @var string $vehicle_cost_new
-     * A cost of the new vehicle.
-     */
-    public $vehicle_cost_new;
-
-    /** @var string $purchased_new
-     * If true, the vehicle was purchased new.
-     */
-    public $purchased_new;
-
-    /** @var string $license_start_date
-     * Start date of the license (e.g. '2020-12-20').
-     */
-    public $license_start_date;
-
-    /** @var string $license_end_date
-     * End date of the license (e.g. '2020-12-20').
-     */
-    public $license_end_date;
-
-    /** @var boolean $is_operational
-     * If true, the vehicle is operational.
-     */
-    public $is_operational;
-
-    /** @var string $fuel_type
-     * A type of the fuel.
-     * Available values:
-     * 'unleaded 87', 'unleaded 89', 'unleaded 91', 'unleaded 93', 'diesel', 'electric', 'hybrid'
-     */
-    public $fuel_type;
-
-    /** @var string $external_telematics_vehicle_id
-     * External telematics vehicle ID.
-     */
-    public $external_telematics_vehicle_id;
-
-    /** @var string $timestamp_removed
-     * When the vehicle was removed.
-     */
-    public $timestamp_removed;
-
-    /** @var string $vehicle_profile_id
-     * Vehicle profile ID
-     */
-    public $vehicle_profile_id;
-
-    /** @var double $fuel_consumption_city
-     * Fuel consumption in the city area.
-     */
-    public $fuel_consumption_city;
-
-    /** @var double $fuel_consumption_highway
-     * Fuel consumption in the highway area.
-     */
-    public $fuel_consumption_highway;
-
-    /** @var string $fuel_consumption_city_unit
-     * Fuel consumption unit in the city area (e.g. 'mi/l').
-     */
-    public $fuel_consumption_city_unit;
-
-    /** @var string $fuel_consumption_highway_unit
-     * Fuel consumption unit in the highway area (e.g. 'mi/l').
-     */
-    public $fuel_consumption_highway_unit;
-
-    /** @var double $mpg_city
-     * Miles per gallon in the city area.
-     */
-    public $mpg_city;
-
-    /** @var double $mpg_highway
-     * Miles per gallon in the highway area.
-     */
-    public $mpg_highway;
-
-    /** @var string $fuel_consumption_city_uf_value
-     * Fuel consumption UF (utility factor) value in the city area.
-     */
-    public $fuel_consumption_city_uf_value;
-
-    /** @var string $fuel_consumption_highway_uf_value
-     * Fuel consumption UF (utility factor) value in the highway area.
-     */
-    public $fuel_consumption_highway_uf_value;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::WH_BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $vehicle = new self();
-
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($vehicle, $key)) {
-                $vehicle->$key = $value;
-            }
-        }
-
-        return $vehicle;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehiclesPaginatedList()
-     */
-    public static function getVehicles($params)
-    {
-        $allQueryFields = ['with_pagination', 'page', 'perPage'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehicleById()
-     */
-    public function getVehicleByID($vehicleID)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
-            'method' => 'GET',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::updateVehicle()
-     */
-    public function updateVehicle($params)
-    {
-        $vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), ['vehicle_id']);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
-            'method' => 'PUT',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::createVehicle()
-     */
-    public function createVehicle($params)
-    {
-        $excludeFields = ['vehicle_id','is_deleted','created_time','timestamp_added','timestamp_removed'];
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        //Route4Me::setBaseUrl(Endpoint::BASE_URL);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::removeVehicle()
-     */
-    public function removeVehicle($params)
-    {
-        $vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
-            'method' => 'DELETE',
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
+	/** @var string $vehicle_id
+	 * Vehicle unique 32-chars ID
+	 */
+	public $vehicle_id;
+
+	/** @var int $member_id
+	 * Member unique ID
+	 */
+	public $member_id;
+
+	/** @var boolean $is_deleted
+	 * True, if the vehicle was deleted.
+	 */
+	public $is_deleted;
+
+	/** @var string $vehicle_alias
+	 * Vehicle alias
+	 */
+	public $vehicle_alias;
+
+	/** @var string $vehicle_vin
+	 * Vehicle VIN (vehicle identification number)
+	 */
+	public $vehicle_vin;
+
+	/** @var int $vehicle_reg_state_id
+	 * The ID of a state the vehicle was registered.
+	 */
+	public $vehicle_reg_state_id;
+
+	/** @var int $vehicle_reg_country_id
+	 * The ID of a country the vehicle was registered.
+	 */
+	public $vehicle_reg_country_id;
+
+	/** @var string $vehicle_license_plate
+	 * A license plate of the vehicle.
+	 */
+	public $vehicle_license_plate;
+
+	/** @var string $vehicle_type_id
+	 * Vehicle type ID.
+	 * Available values:
+	 * 'sedan', 'suv', 'pickup_truck', 'van', '18wheeler', 'cabin', 'hatchback',
+	 * 'motorcyle', 'waste_disposal', 'tree_cutting', 'bigrig', 'cement_mixer',
+	 * 'livestock_carrier', 'dairy','tractor_trailer'
+	 */
+	public $vehicle_type_id;
+
+	/** @var string $timestamp_added
+	 * When the vehicle was added.
+	 */
+	public $timestamp_added;
+
+	/** @var string $vehicle_make
+	 * Vehicle maker brend.
+	 * Available values:
+	 * 'american coleman', 'bmw', 'chevrolet', 'ford', 'freightliner', 'gmc',
+	 * 'hino', 'honda', 'isuzu', 'kenworth', 'mack', 'mercedes-benz', 'mitsubishi',
+	 * 'navistar', 'nissan', 'peterbilt', 'renault', 'scania', 'sterling', 'toyota',
+	 * 'volvo', 'western star'
+	 */
+	public $vehicle_make;
+
+	/** @var int $vehicle_model_year
+	 * A year of the vehicle model.
+	 */
+	public $vehicle_model_year;
+
+	/** @var string $vehicle_model
+	 * A model of the vehicle.
+	 */
+	public $vehicle_model;
+
+	/** @var int $vehicle_year_acquired
+	 * A year, the vehicle was acquired.
+	 */
+	public $vehicle_year_acquired;
+
+	/** @var string $vehicle_cost_new
+	 * A cost of the new vehicle.
+	 */
+	public $vehicle_cost_new;
+
+	/** @var string $purchased_new
+	 * If true, the vehicle was purchased new.
+	 */
+	public $purchased_new;
+
+	/** @var string $license_start_date
+	 * Start date of the license (e.g. '2020-12-20').
+	 */
+	public $license_start_date;
+
+	/** @var string $license_end_date
+	 * End date of the license (e.g. '2020-12-20').
+	 */
+	public $license_end_date;
+
+	/** @var boolean $is_operational
+	 * If true, the vehicle is operational.
+	 */
+	public $is_operational;
+
+	/** @var string $fuel_type
+	 * A type of the fuel.
+	 * Available values:
+	 * 'unleaded 87', 'unleaded 89', 'unleaded 91', 'unleaded 93', 'diesel', 'electric', 'hybrid'
+	 */
+	public $fuel_type;
+
+	/** @var string $external_telematics_vehicle_id
+	 * External telematics vehicle ID.
+	 */
+	public $external_telematics_vehicle_id;
+
+	/** @var string $timestamp_removed
+	 * When the vehicle was removed.
+	 */
+	public $timestamp_removed;
+
+	/** @var string $vehicle_profile_id
+	 * Vehicle profile ID
+	 */
+	public $vehicle_profile_id;
+
+	/** @var double $fuel_consumption_city
+	 * Fuel consumption in the city area.
+	 */
+	public $fuel_consumption_city;
+
+	/** @var double $fuel_consumption_highway
+	 * Fuel consumption in the highway area.
+	 */
+	public $fuel_consumption_highway;
+
+	/** @var string $fuel_consumption_city_unit
+	 * Fuel consumption unit in the city area (e.g. 'mi/l').
+	 */
+	public $fuel_consumption_city_unit;
+
+	/** @var string $fuel_consumption_highway_unit
+	 * Fuel consumption unit in the highway area (e.g. 'mi/l').
+	 */
+	public $fuel_consumption_highway_unit;
+
+	/** @var double $mpg_city
+	 * Miles per gallon in the city area.
+	 */
+	public $mpg_city;
+
+	/** @var double $mpg_highway
+	 * Miles per gallon in the highway area.
+	 */
+	public $mpg_highway;
+
+	/** @var string $fuel_consumption_city_uf_value
+	 * Fuel consumption UF (utility factor) value in the city area.
+	 */
+	public $fuel_consumption_city_uf_value;
+
+	/** @var string $fuel_consumption_highway_uf_value
+	 * Fuel consumption UF (utility factor) value in the highway area.
+	 */
+	public $fuel_consumption_highway_uf_value;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::WH_BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$vehicle = new self();
+
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($vehicle, $key)) {
+				$vehicle->$key = $value;
+			}
+		}
+
+		return $vehicle;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehiclesPaginatedList()
+	 */
+	public static function getVehicles($params)
+	{
+		$allQueryFields = ['with_pagination', 'page', 'perPage'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehicleById()
+	 */
+	public function getVehicleByID($vehicleID)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
+			'method' => 'GET',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::updateVehicle()
+	 */
+	public function updateVehicle($params)
+	{
+		$vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), ['vehicle_id']);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
+			'method' => 'PUT',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::createVehicle()
+	 */
+	public function createVehicle($params)
+	{
+		$excludeFields = ['vehicle_id','is_deleted','created_time','timestamp_added','timestamp_removed'];
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		//Route4Me::setBaseUrl(Endpoint::BASE_URL);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::removeVehicle()
+	 */
+	public function removeVehicle($params)
+	{
+		$vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4.'/'.$vehicleID,
+			'method' => 'DELETE',
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/Vehicles/Vehicle.php

Indentation +188 added lines, -188 removed lines

@@ -16,192 +16,192 @@
  */
 class Vehicle extends \Route4Me\Common
 {
-    public $vehicle_id;
-    public $member_id;
-    public $is_deleted;
-    public $vehicle_name;
-    public $vehicle_alias;
-    public $vehicle_vin;
-    //public $created_time;
-    public $vehicle_reg_state_id;
-    public $vehicle_reg_country_id;
-    public $vehicle_license_plate;
-    public $vehicle_type_id;
-    public $timestamp_added;
-    public $vehicle_make;
-    public $vehicle_model_year;
-    public $vehicle_model;
-    public $vehicle_year_acquired;
-    public $vehicle_cost_new;
-    public $purchased_new;
-    public $license_start_date;
-    public $license_end_date;
-    public $vehicle_axle_count;
-    public $mpg_city;
-    public $mpg_highway;
-    public $fuel_type;
-    public $height_inches;
-    public $weight_lb;
-    public $route4me_telematics_internal_api_key;
-    public $is_operational;
-    public $external_telematics_vehicle_id;
-    public $r4m_telematics_gateway_connection_id;
-    public $r4m_telematics_gateway_vehicle_id;
-    public $has_trailer;
-    public $heightInInches;
-    public $lengthInInches;
-    public $widthInInches;
-    public $maxWeightPerAxleGroupInPounds;
-    public $numAxles;
-    public $weightInPounds;
-    public $HazmatType;
-    public $LowEmissionZonePref;
-    public $Use53FootTrailerRouting;
-    public $UseNationalNetwork;
-    public $UseTruckRestrictions;
-    public $AvoidFerries;
-    public $DividedHighwayAvoidPreference;
-    public $FreewayAvoidPreference;
-    public $InternationalBordersOpen;
-    public $TollRoadUsage;
-    public $hwy_only;
-    public $long_combination_vehicle;
-    public $avoid_highways;
-    public $side_street_adherence;
-    public $truck_config;
-    public $height_metric;
-    public $length_metric;
-    public $width_metric;
-    public $weight_metric;
-    public $max_weight_per_axle_group_metric;
-    public $timestamp_removed;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::WH_BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $vehicle = new self();
-
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($vehicle, $key)) {
-                $vehicle->$key = $value;
-            }
-        }
-
-        return $vehicle;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehiclesPaginatedList()
-     */
-    public static function getVehicles($params)
-    {
-        $allQueryFields = ['with_pagination', 'page', 'perPage'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function getRandomVehicleId($page, $perPage)
-    {
-        $params = [
-            'page' => isset($page) ? $page : 1,
-            'perPage' => isset($perPage) ? $perPage : 10,
-            'with_pagination' => true,
-        ];
-
-        $vehicles = $this->getVehicles($params);
-
-        if (is_null($vehicles) || !isset($vehicles['data']) || sizeof($vehicles['data']) < 1) {
-            return null;
-        }
-
-        $randomIndex = rand(0, sizeof($vehicles['data']) - 1);
-
-        return $vehicles['data'][$randomIndex]['vehicle_id'];
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehicleById()
-     */
-    public function getVehicleByID($vehicleID)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
-            'method' => 'GET',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::updateVehicle()
-     */
-    public function updateVehicle($params)
-    {
-        $vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), ['vehicle_id']);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
-            'method' => 'PUT',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::createVehicle()
-     */
-    public function createVehicle($params)
-    {
-        $excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4_API,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.6
-     * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::removeVehicle()
-     */
-    public function removeVehicle($params)
-    {
-        $vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
-            'method' => 'DELETE',
-            'HTTPHEADER' => 'Content-Type: application/json',
-        ]);
-
-        return $response;
-    }
+	public $vehicle_id;
+	public $member_id;
+	public $is_deleted;
+	public $vehicle_name;
+	public $vehicle_alias;
+	public $vehicle_vin;
+	//public $created_time;
+	public $vehicle_reg_state_id;
+	public $vehicle_reg_country_id;
+	public $vehicle_license_plate;
+	public $vehicle_type_id;
+	public $timestamp_added;
+	public $vehicle_make;
+	public $vehicle_model_year;
+	public $vehicle_model;
+	public $vehicle_year_acquired;
+	public $vehicle_cost_new;
+	public $purchased_new;
+	public $license_start_date;
+	public $license_end_date;
+	public $vehicle_axle_count;
+	public $mpg_city;
+	public $mpg_highway;
+	public $fuel_type;
+	public $height_inches;
+	public $weight_lb;
+	public $route4me_telematics_internal_api_key;
+	public $is_operational;
+	public $external_telematics_vehicle_id;
+	public $r4m_telematics_gateway_connection_id;
+	public $r4m_telematics_gateway_vehicle_id;
+	public $has_trailer;
+	public $heightInInches;
+	public $lengthInInches;
+	public $widthInInches;
+	public $maxWeightPerAxleGroupInPounds;
+	public $numAxles;
+	public $weightInPounds;
+	public $HazmatType;
+	public $LowEmissionZonePref;
+	public $Use53FootTrailerRouting;
+	public $UseNationalNetwork;
+	public $UseTruckRestrictions;
+	public $AvoidFerries;
+	public $DividedHighwayAvoidPreference;
+	public $FreewayAvoidPreference;
+	public $InternationalBordersOpen;
+	public $TollRoadUsage;
+	public $hwy_only;
+	public $long_combination_vehicle;
+	public $avoid_highways;
+	public $side_street_adherence;
+	public $truck_config;
+	public $height_metric;
+	public $length_metric;
+	public $width_metric;
+	public $weight_metric;
+	public $max_weight_per_axle_group_metric;
+	public $timestamp_removed;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::WH_BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$vehicle = new self();
+
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($vehicle, $key)) {
+				$vehicle->$key = $value;
+			}
+		}
+
+		return $vehicle;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehiclesPaginatedList()
+	 */
+	public static function getVehicles($params)
+	{
+		$allQueryFields = ['with_pagination', 'page', 'perPage'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function getRandomVehicleId($page, $perPage)
+	{
+		$params = [
+			'page' => isset($page) ? $page : 1,
+			'perPage' => isset($perPage) ? $perPage : 10,
+			'with_pagination' => true,
+		];
+
+		$vehicles = $this->getVehicles($params);
+
+		if (is_null($vehicles) || !isset($vehicles['data']) || sizeof($vehicles['data']) < 1) {
+			return null;
+		}
+
+		$randomIndex = rand(0, sizeof($vehicles['data']) - 1);
+
+		return $vehicles['data'][$randomIndex]['vehicle_id'];
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::getVehicleById()
+	 */
+	public function getVehicleByID($vehicleID)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
+			'method' => 'GET',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::updateVehicle()
+	 */
+	public function updateVehicle($params)
+	{
+		$vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), ['vehicle_id']);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
+			'method' => 'PUT',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::createVehicle()
+	 */
+	public function createVehicle($params)
+	{
+		$excludeFields = ['vehicle_id', 'is_deleted', 'created_time', 'timestamp_added', 'timestamp_removed'];
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4_API,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.6
+	 * @see \Route4Me\V5\Vehicles\DataTypes\Vehicle::removeVehicle()
+	 */
+	public function removeVehicle($params)
+	{
+		$vehicleID = isset($params->vehicle_id) ? $params->vehicle_id : null;
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VEHICLE_V4 . '/' . $vehicleID,
+			'method' => 'DELETE',
+			'HTTPHEADER' => 'Content-Type: application/json',
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/OptimizationProblem.php

Indentation +328 added lines, -328 removed lines

@@ -6,185 +6,185 @@ 
 
 class OptimizationProblem extends Common
 {
-    /**
-     * Optimization problem ID
-     * @var string
-     */
-    public $optimization_problem_id;
-
-    /**
-     * Smart Optimization Problem ID
-     * @var string
-     */
-    public $smart_optimization_id;
-
-    /**
-     * An array of the user errors.
-     * @var string[]
-     */
-    public $user_errors = [];
-
-    /**
-     * An optimization problem state.<br>
-     * Available values:
-     * - OptimizationStateNew = 0,
-     * - Initial = 1,
-     * - MatrixProcessing = 2,
-     * - Optimizing = 3,
-     * - Optimized = 4,
-     * - Error = 5,
-     * - ComputingDirections = 6,
-     * - OptimizationStateInQueue = 7
-     * @var int
-     */
-    public $state;
-
-    /**
-     * An array of the optimization errors.
-     * @var string[]
-     */
-    public $optimization_errors = [];
-
-    /**
-     * Route Parameters.
-     * @var RouteParameters
-     */
-    public $parameters;
-
-    /**
-     * If true it means the solution was not returned (it is being computed in the background).
-     * @var boolean
-     */
-    public $sent_to_background;
-
-    /**
-     * When the optimization problem was created.
-     * @var long
-     */
-    public $created_timestamp;
-
-    /**
-     * An Unix Timestamp the Optimization Problem was scheduled for.
-     * @var long
-     */
-    public $scheduled_for;
-
-    /**
-     * When the optimization completed.
-     * @var long
-     */
-    public $optimization_completed_timestamp;
-
-    /**
-     * An array ot the Address type objects.
-     * @var Address[]
-     */
-    public $addresses = [];
-
-    /**
-     * An array ot the DataObjectRoute type objects.<br>
-     * The routes included in the optimization problem.
-     * @var Route[]
-     */
-    public $routes = [];
-
-    /** @var string[] $links
-     * The links to the GET operations for the optimization problem.
-     */
-    public $links = [];
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-        $this->parameters = new RouteParameters();
-    }
-
-    public static function fromArray(array $params)
-    {
-        $problem = new self();
-        $problem->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
-        $problem->user_errors = Common::getValue($params, 'user_errors', []);
-        $problem->state = Common::getValue($params, 'state', []);
-        $problem->sent_to_background = Common::getValue($params, 'sent_to_background', []);
-        $problem->links = Common::getValue($params, 'links', []);
-
-        if (isset($params['parameters'])) {
-            $problem->parameters = RouteParameters::fromArray($params['parameters']);
-        }
-
-        if (isset($params['addresses'])) {
-            $addresses = [];
-
-            foreach ($params['addresses'] as $address) {
-                $addresses[] = Address::fromArray($address);
-            }
-
-            $problem->addresses = $addresses;
-        }
-
-        if (isset($params['routes'])) {
-            $routes = [];
-
-            foreach ($params['routes'] as $route) {
-                $routes[] = Route::fromArray($route);
-            }
-
-            $problem->routes = $routes;
-        }
-
-        return $problem;
-    }
-
-    public static function optimize(OptimizationProblemParams $params)
-    {
-        $allQueryFields = ['redirect', 'directions', 'format', 'route_path_output', 'optimized_callback_url'];
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => [
-                'addresses'     => $params->getAddressesArray(),
-                'depots'        => $params->getDepotsArray(),
-                'parameters'    => $params->getParametersArray(),
-            ],
-        ]);
-
-        return self::fromArray($optimize);
-    }
-
-    public static function get($params)
-    {
-        $allQueryFields = ['state', 'limit', 'format', 'offset',
-        'optimization_problem_id', 'wait_for_final_state','start_date','end_date', ];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        if (isset($result['optimizations'])) {
-            $problems = [];
-
-            foreach ($result['optimizations'] as $problem) {
-                $problems[] = self::fromArray($problem);
-            }
-
-            return $problems;
-        } else {
-            return self::fromArray($result);
-        }
-    }
-
-    public function reoptimize($params)
-    {
-        $param['reoptimize'] = 1;
-
-        return self::update($params);
-    }
-
-    /*
+	/**
+	 * Optimization problem ID
+	 * @var string
+	 */
+	public $optimization_problem_id;
+
+	/**
+	 * Smart Optimization Problem ID
+	 * @var string
+	 */
+	public $smart_optimization_id;
+
+	/**
+	 * An array of the user errors.
+	 * @var string[]
+	 */
+	public $user_errors = [];
+
+	/**
+	 * An optimization problem state.<br>
+	 * Available values:
+	 * - OptimizationStateNew = 0,
+	 * - Initial = 1,
+	 * - MatrixProcessing = 2,
+	 * - Optimizing = 3,
+	 * - Optimized = 4,
+	 * - Error = 5,
+	 * - ComputingDirections = 6,
+	 * - OptimizationStateInQueue = 7
+	 * @var int
+	 */
+	public $state;
+
+	/**
+	 * An array of the optimization errors.
+	 * @var string[]
+	 */
+	public $optimization_errors = [];
+
+	/**
+	 * Route Parameters.
+	 * @var RouteParameters
+	 */
+	public $parameters;
+
+	/**
+	 * If true it means the solution was not returned (it is being computed in the background).
+	 * @var boolean
+	 */
+	public $sent_to_background;
+
+	/**
+	 * When the optimization problem was created.
+	 * @var long
+	 */
+	public $created_timestamp;
+
+	/**
+	 * An Unix Timestamp the Optimization Problem was scheduled for.
+	 * @var long
+	 */
+	public $scheduled_for;
+
+	/**
+	 * When the optimization completed.
+	 * @var long
+	 */
+	public $optimization_completed_timestamp;
+
+	/**
+	 * An array ot the Address type objects.
+	 * @var Address[]
+	 */
+	public $addresses = [];
+
+	/**
+	 * An array ot the DataObjectRoute type objects.<br>
+	 * The routes included in the optimization problem.
+	 * @var Route[]
+	 */
+	public $routes = [];
+
+	/** @var string[] $links
+	 * The links to the GET operations for the optimization problem.
+	 */
+	public $links = [];
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+		$this->parameters = new RouteParameters();
+	}
+
+	public static function fromArray(array $params)
+	{
+		$problem = new self();
+		$problem->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
+		$problem->user_errors = Common::getValue($params, 'user_errors', []);
+		$problem->state = Common::getValue($params, 'state', []);
+		$problem->sent_to_background = Common::getValue($params, 'sent_to_background', []);
+		$problem->links = Common::getValue($params, 'links', []);
+
+		if (isset($params['parameters'])) {
+			$problem->parameters = RouteParameters::fromArray($params['parameters']);
+		}
+
+		if (isset($params['addresses'])) {
+			$addresses = [];
+
+			foreach ($params['addresses'] as $address) {
+				$addresses[] = Address::fromArray($address);
+			}
+
+			$problem->addresses = $addresses;
+		}
+
+		if (isset($params['routes'])) {
+			$routes = [];
+
+			foreach ($params['routes'] as $route) {
+				$routes[] = Route::fromArray($route);
+			}
+
+			$problem->routes = $routes;
+		}
+
+		return $problem;
+	}
+
+	public static function optimize(OptimizationProblemParams $params)
+	{
+		$allQueryFields = ['redirect', 'directions', 'format', 'route_path_output', 'optimized_callback_url'];
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => [
+				'addresses'     => $params->getAddressesArray(),
+				'depots'        => $params->getDepotsArray(),
+				'parameters'    => $params->getParametersArray(),
+			],
+		]);
+
+		return self::fromArray($optimize);
+	}
+
+	public static function get($params)
+	{
+		$allQueryFields = ['state', 'limit', 'format', 'offset',
+		'optimization_problem_id', 'wait_for_final_state','start_date','end_date', ];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		if (isset($result['optimizations'])) {
+			$problems = [];
+
+			foreach ($result['optimizations'] as $problem) {
+				$problems[] = self::fromArray($problem);
+			}
+
+			return $problems;
+		} else {
+			return self::fromArray($result);
+		}
+	}
+
+	public function reoptimize($params)
+	{
+		$param['reoptimize'] = 1;
+
+		return self::update($params);
+	}
+
+	/*
      * Updates an existing optimization problem.<br>
      * @param array $params with items:
      * - optimization_problem_id   : query parameter. ID of an updated optimization;
@@ -193,157 +193,157 @@ 
      * - parameters                : body parameter. Modified route parameters;
      * @return Optimization problem
      */
-    public static function update($params)
-    {
-        $allQueryFields = ['optimization_problem_id', 'reoptimize'];
-        $allBodyFields = ['addresses', 'parameters'];
-        $query = null;
-        $body = null;
-
-        if (is_array($params)) {
-            if (isset($params['optimization_problem_id']) || isset($params['parameters'])) {
-                $query = Route4Me::generateRequestParameters($allQueryFields, $params);
-            }
-
-            if ((isset($params['addresses']) && sizeof($params['addresses']) > 0)
-                || (isset($params['parameters']) && sizeof($params['parameters']) > 0)
-            ) {
-                $body = Route4Me::generateRequestParameters($allBodyFields, $params);
-            }
-        } else {
-            if (isset($params->optimization_problem_id) || isset($params->parameters)) {
-                $query = Route4Me::generateRequestParameters($allQueryFields, $params);
-            }
-
-            if ((isset($params->addresses) && sizeof($params->addresses) > 0)
-                || (isset($params->parameters) && sizeof($params->parameters) > 0)
-            ) {
-                $body = Route4Me::generateRequestParameters($allBodyFields, $params);
-            }
-        }
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'PUT',
-            'query'     => $query,
-            'body'      => $body,
-        ]);
-
-        return $optimize;
-    }
-
-    public function getOptimizationId()
-    {
-        return $this->optimization_problem_id;
-    }
-
-    public function getRoutes()
-    {
-        return $this->routes;
-    }
-
-    public function getRandomOptimizationId($offset, $limit)
-    {
-        $optimizations = self::get(['offset' => $offset, 'limit' => $limit]);
-
-        $rOptimization = $optimizations[rand(0, sizeof($optimizations) - 1)];
-
-        if (!isset($rOptimization->optimization_problem_id)) {
-            if (sizeof($optimizations) > 9) {
-                $this->getRandomOptimizationId($offset, $limit);
-            } else {
-                return null;
-            }
-        }
-
-        return $rOptimization->optimization_problem_id;
-    }
-
-    public function getAddresses($opt_id)
-    {
-        if (null == $opt_id) {
-            return null;
-        }
-
-        $params = ['optimization_problem_id' => $opt_id];
-
-        $optimization = (array) $this->get($params);
-
-        $addresses = $optimization['addresses'];
-
-        return $addresses;
-    }
-
-    public function getRandomAddressFromOptimization($opt_id)
-    {
-        $addresses = (array) $this->getAddresses($opt_id);
-
-        if (null == $addresses) {
-            echo 'There are no addresses in this optimization!.. Try again.';
-
-            return null;
-        }
-
-        $num = rand(0, sizeof($addresses) - 1);
-
-        $rAddress = $addresses[$num];
-
-        return $rAddress;
-    }
-
-    public function removeAddress($params)
-    {
-        $allQueryFields = ['optimization_problem_id', 'route_destination_id'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_V4,
-            'method'    => 'DELETE',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function removeOptimization($params)
-    {
-        $allQueryFields = ['redirect'];
-        $allBodyFields = ['optimization_problem_ids'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'DELETE',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function getHybridOptimization($params)
-    {
-        $allQueryFields = ['target_date_string', 'timezone_offset_minutes'];
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::HYBRID_DATE_OPTIMIZATION,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+	public static function update($params)
+	{
+		$allQueryFields = ['optimization_problem_id', 'reoptimize'];
+		$allBodyFields = ['addresses', 'parameters'];
+		$query = null;
+		$body = null;
+
+		if (is_array($params)) {
+			if (isset($params['optimization_problem_id']) || isset($params['parameters'])) {
+				$query = Route4Me::generateRequestParameters($allQueryFields, $params);
+			}
+
+			if ((isset($params['addresses']) && sizeof($params['addresses']) > 0)
+				|| (isset($params['parameters']) && sizeof($params['parameters']) > 0)
+			) {
+				$body = Route4Me::generateRequestParameters($allBodyFields, $params);
+			}
+		} else {
+			if (isset($params->optimization_problem_id) || isset($params->parameters)) {
+				$query = Route4Me::generateRequestParameters($allQueryFields, $params);
+			}
+
+			if ((isset($params->addresses) && sizeof($params->addresses) > 0)
+				|| (isset($params->parameters) && sizeof($params->parameters) > 0)
+			) {
+				$body = Route4Me::generateRequestParameters($allBodyFields, $params);
+			}
+		}
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'PUT',
+			'query'     => $query,
+			'body'      => $body,
+		]);
+
+		return $optimize;
+	}
+
+	public function getOptimizationId()
+	{
+		return $this->optimization_problem_id;
+	}
+
+	public function getRoutes()
+	{
+		return $this->routes;
+	}
+
+	public function getRandomOptimizationId($offset, $limit)
+	{
+		$optimizations = self::get(['offset' => $offset, 'limit' => $limit]);
+
+		$rOptimization = $optimizations[rand(0, sizeof($optimizations) - 1)];
+
+		if (!isset($rOptimization->optimization_problem_id)) {
+			if (sizeof($optimizations) > 9) {
+				$this->getRandomOptimizationId($offset, $limit);
+			} else {
+				return null;
+			}
+		}
+
+		return $rOptimization->optimization_problem_id;
+	}
+
+	public function getAddresses($opt_id)
+	{
+		if (null == $opt_id) {
+			return null;
+		}
+
+		$params = ['optimization_problem_id' => $opt_id];
+
+		$optimization = (array) $this->get($params);
+
+		$addresses = $optimization['addresses'];
+
+		return $addresses;
+	}
+
+	public function getRandomAddressFromOptimization($opt_id)
+	{
+		$addresses = (array) $this->getAddresses($opt_id);
+
+		if (null == $addresses) {
+			echo 'There are no addresses in this optimization!.. Try again.';
+
+			return null;
+		}
+
+		$num = rand(0, sizeof($addresses) - 1);
+
+		$rAddress = $addresses[$num];
+
+		return $rAddress;
+	}
+
+	public function removeAddress($params)
+	{
+		$allQueryFields = ['optimization_problem_id', 'route_destination_id'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_V4,
+			'method'    => 'DELETE',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function removeOptimization($params)
+	{
+		$allQueryFields = ['redirect'];
+		$allBodyFields = ['optimization_problem_ids'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'DELETE',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function getHybridOptimization($params)
+	{
+		$allQueryFields = ['target_date_string', 'timezone_offset_minutes'];
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::HYBRID_DATE_OPTIMIZATION,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $optimize;
-    }
+		return $optimize;
+	}
 
-    public function addDepotsToHybrid($params)
-    {
-        $allQueryFields = ['optimization_problem_id'];
-        $allBodyFields = ['optimization_problem_id', 'delete_old_depots', 'new_depots'];
+	public function addDepotsToHybrid($params)
+	{
+		$allQueryFields = ['optimization_problem_id'];
+		$allBodyFields = ['optimization_problem_id', 'delete_old_depots', 'new_depots'];
 
-        $depots = Route4Me::makeRequst([
-            'url'       => Endpoint::CHANGE_HYBRID_OPTIMIZATION_DEPOT,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
+		$depots = Route4Me::makeRequst([
+			'url'       => Endpoint::CHANGE_HYBRID_OPTIMIZATION_DEPOT,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
 
-        return $depots;
-    }
+		return $depots;
+	}
 }

UnitTestFiles/Test/V5/TeamManagementUnitTests.php

Indentation +177 added lines, -177 removed lines

@@ -12,184 +12,184 @@
 
 final class TeamManagementUnitTests extends \PHPUnit\Framework\TestCase
 {
-    public static ?int $member_id = null;
-    public static ?int $owner_member_id = null;
-
-    public static function setUpBeforeClass() : void
-    {
-        Route4Me::setApiKey(Constants::API_KEY);
-    }
-
-    public function testOwnerMemberMustExists() : void
-    {
-        $member = new Member();
-        $res_members = $member->getUsers();
+	public static ?int $member_id = null;
+	public static ?int $owner_member_id = null;
+
+	public static function setUpBeforeClass() : void
+	{
+		Route4Me::setApiKey(Constants::API_KEY);
+	}
+
+	public function testOwnerMemberMustExists() : void
+	{
+		$member = new Member();
+		$res_members = $member->getUsers();
     
-        if (is_array($res_members) && isset($res_members['results'])) {
-            foreach ($res_members['results'] as $key => $value) {
-                if ($value['OWNER_MEMBER_ID'] == 0) {
-                    self::$owner_member_id = $value['member_id'];
-                    break;
-                }
-            }
-        }
-        $this->assertNotNull(self::$owner_member_id);
-    }
-
-    public function testOptionCanBeCreateEmpty() : void
-    {
-        $this->assertInstanceOf(Option::class, new Option());
-    }
-
-    public function testOptionCanBeCreateFromArray() : void
-    {
-        $this->assertInstanceOf(Option::class, new Option([
-            'value' => '1',
-            'title' => '2'
-        ]));
-    }
-
-    public function testPermissionCanBeCreateEmpty() : void
-    {
-        $this->assertInstanceOf(Permission::class, new Permission());
-    }
-
-    public function testPermissionCanBeCreateFromArray() : void
-    {
-        $this->assertInstanceOf(Permission::class, new Permission([
-            'id' => '1',
-            'options' => [
-                [
-                    'value' => '2',
-                    'title' => '3'
-                ], [
-                    'value' => '4',
-                    'title' => '5'
-                ]
-            ]
-        ]));
-    }
-
-    public function testResponseTeamCanBeCreateEmpty() : void
-    {
-        $this->assertInstanceOf(ResponseTeam::class, new ResponseTeam());
-    }
-
-    public function testResponseTeamCanBeCreateFromArray() : void
-    {
-        $this->assertInstanceOf(ResponseTeam::class, new ResponseTeam([
-            'member_id' => '1',
-            'member_first_name' => '2'
-        ]));
-    }
-
-    public function testTeamManagementCanBeCreateEmpty() : void
-    {
-        $this->assertInstanceOf(TeamManagement::class, new TeamManagement());
-    }
-
-    public function testCreateMustReturnResponseTeam() : void
-    {
-        $team_mng = new TeamManagement();
-        $res_team = $team_mng->create([
-            'new_password' => '12345&Qwerty',
-            'member_first_name' => 'Tusha I',
-            'member_last_name' => 'Pupkindzes',
-            'member_email' => 'The_I@best.com',
-            'member_type' => 'SUB_ACCOUNT_DRIVER',
-            'OWNER_MEMBER_ID' => self::$owner_member_id
-        ]);
-
-        $this->assertInstanceOf(ResponseTeam::class, $res_team);
-        $this->assertNotNull($res_team->member_id);
-        $this->assertEquals($res_team->member_first_name, 'Tusha I');
+		if (is_array($res_members) && isset($res_members['results'])) {
+			foreach ($res_members['results'] as $key => $value) {
+				if ($value['OWNER_MEMBER_ID'] == 0) {
+					self::$owner_member_id = $value['member_id'];
+					break;
+				}
+			}
+		}
+		$this->assertNotNull(self::$owner_member_id);
+	}
+
+	public function testOptionCanBeCreateEmpty() : void
+	{
+		$this->assertInstanceOf(Option::class, new Option());
+	}
+
+	public function testOptionCanBeCreateFromArray() : void
+	{
+		$this->assertInstanceOf(Option::class, new Option([
+			'value' => '1',
+			'title' => '2'
+		]));
+	}
+
+	public function testPermissionCanBeCreateEmpty() : void
+	{
+		$this->assertInstanceOf(Permission::class, new Permission());
+	}
+
+	public function testPermissionCanBeCreateFromArray() : void
+	{
+		$this->assertInstanceOf(Permission::class, new Permission([
+			'id' => '1',
+			'options' => [
+				[
+					'value' => '2',
+					'title' => '3'
+				], [
+					'value' => '4',
+					'title' => '5'
+				]
+			]
+		]));
+	}
+
+	public function testResponseTeamCanBeCreateEmpty() : void
+	{
+		$this->assertInstanceOf(ResponseTeam::class, new ResponseTeam());
+	}
+
+	public function testResponseTeamCanBeCreateFromArray() : void
+	{
+		$this->assertInstanceOf(ResponseTeam::class, new ResponseTeam([
+			'member_id' => '1',
+			'member_first_name' => '2'
+		]));
+	}
+
+	public function testTeamManagementCanBeCreateEmpty() : void
+	{
+		$this->assertInstanceOf(TeamManagement::class, new TeamManagement());
+	}
+
+	public function testCreateMustReturnResponseTeam() : void
+	{
+		$team_mng = new TeamManagement();
+		$res_team = $team_mng->create([
+			'new_password' => '12345&Qwerty',
+			'member_first_name' => 'Tusha I',
+			'member_last_name' => 'Pupkindzes',
+			'member_email' => 'The_I@best.com',
+			'member_type' => 'SUB_ACCOUNT_DRIVER',
+			'OWNER_MEMBER_ID' => self::$owner_member_id
+		]);
+
+		$this->assertInstanceOf(ResponseTeam::class, $res_team);
+		$this->assertNotNull($res_team->member_id);
+		$this->assertEquals($res_team->member_first_name, 'Tusha I');
         
-        self::$member_id = $res_team->member_id;
-    }
-
-    public function testGetUserMustReturnResponseTeam() : void
-    {
-        $team_mng = new TeamManagement();
-        $res_team = $team_mng->getUser(self::$member_id);
-
-        $this->assertInstanceOf(ResponseTeam::class, $res_team);
-        $this->assertNotNull($res_team->member_id);
-        $this->assertEquals($res_team->member_first_name, 'Tusha I');
-    }
-
-    public function testGetUsersMustReturnArrayOfResponseTeam() : void
-    {
-        $team_mng = new TeamManagement();
-        $result = $team_mng->getUsers();
-
-        $this->assertIsArray($result);
-        if (count($result) > 0) {
-            $this->assertInstanceOf(ResponseTeam::class, $result[0]);
-        }
-    }
-
-    public function testUpdateMustReturnUpdatedResponseTeam() : void
-    {
-        $team_mng = new TeamManagement();
-        $res_team = $team_mng->update(self::$member_id, [
-            'HIDE_ROUTED_ADDRESSES' => true,
-            'member_type' => 'SUB_ACCOUNT_DISPATCHER'
-        ]);
-
-        $this->assertInstanceOf(ResponseTeam::class, $res_team);
-        $this->assertEquals($res_team->HIDE_ROUTED_ADDRESSES, 1);
-        $this->assertEquals($res_team->member_type, 'SUB_ACCOUNT_DISPATCHER');
-    }
-
-    public function testDeleteMustReturnDeletedResponseTeam() : void
-    {
-        $team_mng = new TeamManagement();
-        $res_team = $team_mng->delete(self::$member_id);
-
-        $this->assertInstanceOf(ResponseTeam::class, $res_team);
-        $this->assertNotNull($res_team->member_id);
-        $this->assertEquals($res_team->member_first_name, 'Tusha I');
-    }
-
-    public function testBulkInsertMustAddNewMembers() : void
-    {
-        $team_mng = new TeamManagement();
-        $result = $team_mng->bulkInsert([
-            [
-                'new_password' => '12345&Qwerty',
-                'member_first_name' => 'Tusha I',
-                'member_last_name' => 'Pupkindzes',
-                'member_email' => 'the_I@best.com',
-                'member_type' => 'SUB_ACCOUNT_DRIVER',
-                'OWNER_MEMBER_ID' => self::$owner_member_id
-            ], [
-                'new_password' => '12345&Qwerty',
-                'member_first_name' => 'Tusha II',
-                'member_last_name' => 'Pupkindzes',
-                'member_email' => 'the_II@best.com',
-                'member_type' => 'SUB_ACCOUNT_DRIVER',
-                'OWNER_MEMBER_ID' => self::$owner_member_id
-                ]
-        ], [
-            'conflicts' => 'overwrite'
-        ]);
-
-        $this->assertIsArray($result);
-    }
+		self::$member_id = $res_team->member_id;
+	}
+
+	public function testGetUserMustReturnResponseTeam() : void
+	{
+		$team_mng = new TeamManagement();
+		$res_team = $team_mng->getUser(self::$member_id);
+
+		$this->assertInstanceOf(ResponseTeam::class, $res_team);
+		$this->assertNotNull($res_team->member_id);
+		$this->assertEquals($res_team->member_first_name, 'Tusha I');
+	}
+
+	public function testGetUsersMustReturnArrayOfResponseTeam() : void
+	{
+		$team_mng = new TeamManagement();
+		$result = $team_mng->getUsers();
+
+		$this->assertIsArray($result);
+		if (count($result) > 0) {
+			$this->assertInstanceOf(ResponseTeam::class, $result[0]);
+		}
+	}
+
+	public function testUpdateMustReturnUpdatedResponseTeam() : void
+	{
+		$team_mng = new TeamManagement();
+		$res_team = $team_mng->update(self::$member_id, [
+			'HIDE_ROUTED_ADDRESSES' => true,
+			'member_type' => 'SUB_ACCOUNT_DISPATCHER'
+		]);
+
+		$this->assertInstanceOf(ResponseTeam::class, $res_team);
+		$this->assertEquals($res_team->HIDE_ROUTED_ADDRESSES, 1);
+		$this->assertEquals($res_team->member_type, 'SUB_ACCOUNT_DISPATCHER');
+	}
+
+	public function testDeleteMustReturnDeletedResponseTeam() : void
+	{
+		$team_mng = new TeamManagement();
+		$res_team = $team_mng->delete(self::$member_id);
+
+		$this->assertInstanceOf(ResponseTeam::class, $res_team);
+		$this->assertNotNull($res_team->member_id);
+		$this->assertEquals($res_team->member_first_name, 'Tusha I');
+	}
+
+	public function testBulkInsertMustAddNewMembers() : void
+	{
+		$team_mng = new TeamManagement();
+		$result = $team_mng->bulkInsert([
+			[
+				'new_password' => '12345&Qwerty',
+				'member_first_name' => 'Tusha I',
+				'member_last_name' => 'Pupkindzes',
+				'member_email' => 'the_I@best.com',
+				'member_type' => 'SUB_ACCOUNT_DRIVER',
+				'OWNER_MEMBER_ID' => self::$owner_member_id
+			], [
+				'new_password' => '12345&Qwerty',
+				'member_first_name' => 'Tusha II',
+				'member_last_name' => 'Pupkindzes',
+				'member_email' => 'the_II@best.com',
+				'member_type' => 'SUB_ACCOUNT_DRIVER',
+				'OWNER_MEMBER_ID' => self::$owner_member_id
+				]
+		], [
+			'conflicts' => 'overwrite'
+		]);
+
+		$this->assertIsArray($result);
+	}
     
-    public static function tearDownAfterClass() : void
-    {
-        sleep(5);
-
-        $team_mng = new TeamManagement();
-        $result = $team_mng->getUsers();
-
-        if (is_array($result)) {
-            foreach ($result as $key => $member) {
-                if ($member->member_last_name == 'Pupkindzes') {
-                    $team_mng->delete($member->member_id);
-                }
-            }
-        }
-    }
+	public static function tearDownAfterClass() : void
+	{
+		sleep(5);
+
+		$team_mng = new TeamManagement();
+		$result = $team_mng->getUsers();
+
+		if (is_array($result)) {
+			foreach ($result as $key => $member) {
+				if ($member->member_last_name == 'Pupkindzes') {
+					$team_mng->delete($member->member_id);
+				}
+			}
+		}
+	}
 }

src/Route4Me/V5/TeamManagement/Option.php

Indentation +8 added lines, -8 removed lines

@@ -13,13 +13,13 @@
  */
 class Option extends Common
 {
-    public ?string $value = null;
-    public ?string $title = null;
+	public ?string $value = null;
+	public ?string $title = null;
 
-    public function __construct(?array $params = null)
-    {
-        if ($params !== null) {
-            $this->fillFromArray($params);
-        }
-    }
+	public function __construct(?array $params = null)
+	{
+		if ($params !== null) {
+			$this->fillFromArray($params);
+		}
+	}
 }