route4me / route4me-php-sdk

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

Indentation +21 added lines, -21 removed lines

@@ -11,28 +11,28 @@
  */
 class VehicleOrderResponse extends Common
 {
-    /** Vehicle ID
-     * @var string $vehicle_id
-     */
-    public $vehicle_id;
+	/** Vehicle ID
+	 * @var string $vehicle_id
+	 */
+	public $vehicle_id;
 
-    /** Order ID
-     * @var integer $order_id
-     */
-    public $order_id;
+	/** Order ID
+	 * @var integer $order_id
+	 */
+	public $order_id;
 
-    public static function fromArray(array $params)
-    {
-        $ordParams = new self();
+	public static function fromArray(array $params)
+	{
+		$ordParams = new self();
 
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($ordParams, $key)) {
-                $ordParams->$key = $value;
-            }
-        }
-        return $ordParams;
-    }
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($ordParams, $key)) {
+				$ordParams->$key = $value;
+			}
+		}
+		return $ordParams;
+	}
 }

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

Indentation +39 added lines, -39 removed lines

@@ -11,43 +11,43 @@
  */
 class VehicleTemporary extends Common
 {
-    /** The vehicle ID
-     * @var integer $vehicle_id
-     */
-    public $vehicle_id;
-
-    /** A license plate of the vehicle.
-     * @var string $vehicle_license_plate
-     */
-    public $vehicle_license_plate;
-
-    /** Member ID assigned to the temporary vehicle.
-     * @var string $assigned_member_id
-     */
-    public $assigned_member_id;
-
-    /** An expiration date of the temporary vehicle.
-     * @var string $expires_at
-     */
-    public $expires_at;
-
-    /** If true, an assignment forced.
-     * @var boolean $force_assignment
-     */
-    public $force_assignment;
-
-    public static function fromArray(array $params)
-    {
-        $vehicleTemp = new self();
-
-        foreach ($params as $key => $value) {
-            if (is_null(Common::getValue($params, $key))) {
-                continue;
-            }
-            if (property_exists($vehicleTemp, $key)) {
-                $vehicleTemp->$key = $value;
-            }
-        }
-        return $vehicleTemp;
-    }
+	/** The vehicle ID
+	 * @var integer $vehicle_id
+	 */
+	public $vehicle_id;
+
+	/** A license plate of the vehicle.
+	 * @var string $vehicle_license_plate
+	 */
+	public $vehicle_license_plate;
+
+	/** Member ID assigned to the temporary vehicle.
+	 * @var string $assigned_member_id
+	 */
+	public $assigned_member_id;
+
+	/** An expiration date of the temporary vehicle.
+	 * @var string $expires_at
+	 */
+	public $expires_at;
+
+	/** If true, an assignment forced.
+	 * @var boolean $force_assignment
+	 */
+	public $force_assignment;
+
+	public static function fromArray(array $params)
+	{
+		$vehicleTemp = new self();
+
+		foreach ($params as $key => $value) {
+			if (is_null(Common::getValue($params, $key))) {
+				continue;
+			}
+			if (property_exists($vehicleTemp, $key)) {
+				$vehicleTemp->$key = $value;
+			}
+		}
+		return $vehicleTemp;
+	}
 }

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

Indentation +390 added lines, -390 removed lines

@@ -18,394 +18,394 @@
  */
 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 - an array of vehicle's parameters or Vehicle object
-     * @return array          - 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),
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
-        ]);
-
-        return $response;
-    }
-
-    /** Removes a vehicle by specified vehicle ID.
-     * @param  string $vehicleID - Vehicle ID
-     * @return array             - an array of parameers of 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  $params - an array of pagginated parameters or VehicleParameters object.
-     * @return array   - 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 of parameters or VehicleTemporary object.
-     * @return array          - an array of parameters of 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),
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
-        ]);
-
-        return $response;
-    }
-
-    /** Execute a vehicle order.
-     * @param  $vehicleParams - an array of order parameters or VehicleOrderParameters object
-     * @return array          - an array of parameters of 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),
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
-        ]);
-
-        return $response;
-    }
-
-    /** Get latest vehicle locations by specified vehicle IDs.
-     * @param  $vehicleParams - Vehicle query parameters containing vehicle IDs
-     * @return array          - 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 array          - an array of parameters of 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 array          - an array of parameters of VehicleTrackResponse.
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleTrack($vehicleParams)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'].'/track',
-            'method' => 'GET',
-            'query' => null,
-        ]);
-
-        return $response;
-    }
-
-    /** Get the Vehicle Profile by license plate.
-     * @param  $vehicleParams - Vehicle query parameters containing 'vehicle_license_plate'.
-     * @return array          - an array of parameters of Vehicle
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getVehicleByLicensePlate($vehicleParams)
-    {
-        $allQueryFields = ['vehicle_license_plate'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleLicense,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
-        ]);
-
-        return $response;
-    }
-
-    /** Search for the Vehicle by sending the corresponding body payload.
-     * @param  $searchParams - query parameters or VehicleSearchParameters object.
-     * @return array         - an array of Vehicles
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function searchVehicles($searchParams)
-    {
-        $excludeFields = [];
-        $allBodyFields = Route4Me::getObjectProperties(new VehicleSearchParameters(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VehicleSearch,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $searchParams),
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
-        ]);
-
-        return $response;
-    }
-
-    /** Update the Vehicle Profile by specifying the path parameter ID and by sending.
-     * @param  $vehicleParams - an array of vehicle's parameters or Vehicle object.
-     * @return array          - an array of parameters of Vehicle
-     * @throws \Route4Me\Exception\ApiError
-     */
-    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 - an array of vehicle's parameters or Vehicle object
+	 * @return array          - 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),
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
+		]);
+
+		return $response;
+	}
+
+	/** Removes a vehicle by specified vehicle ID.
+	 * @param  string $vehicleID - Vehicle ID
+	 * @return array             - an array of parameers of 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  $params - an array of pagginated parameters or VehicleParameters object.
+	 * @return array   - 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 of parameters or VehicleTemporary object.
+	 * @return array          - an array of parameters of 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),
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
+		]);
+
+		return $response;
+	}
+
+	/** Execute a vehicle order.
+	 * @param  $vehicleParams - an array of order parameters or VehicleOrderParameters object
+	 * @return array          - an array of parameters of 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),
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
+		]);
+
+		return $response;
+	}
+
+	/** Get latest vehicle locations by specified vehicle IDs.
+	 * @param  $vehicleParams - Vehicle query parameters containing vehicle IDs
+	 * @return array          - 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 array          - an array of parameters of 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 array          - an array of parameters of VehicleTrackResponse.
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleTrack($vehicleParams)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::Vehicles.'/'.$vehicleParams['vehicle_id'].'/track',
+			'method' => 'GET',
+			'query' => null,
+		]);
+
+		return $response;
+	}
+
+	/** Get the Vehicle Profile by license plate.
+	 * @param  $vehicleParams - Vehicle query parameters containing 'vehicle_license_plate'.
+	 * @return array          - an array of parameters of Vehicle
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getVehicleByLicensePlate($vehicleParams)
+	{
+		$allQueryFields = ['vehicle_license_plate'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleLicense,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $vehicleParams),
+		]);
+
+		return $response;
+	}
+
+	/** Search for the Vehicle by sending the corresponding body payload.
+	 * @param  $searchParams - query parameters or VehicleSearchParameters object.
+	 * @return array         - an array of Vehicles
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function searchVehicles($searchParams)
+	{
+		$excludeFields = [];
+		$allBodyFields = Route4Me::getObjectProperties(new VehicleSearchParameters(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VehicleSearch,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $searchParams),
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json']
+		]);
+
+		return $response;
+	}
+
+	/** Update the Vehicle Profile by specifying the path parameter ID and by sending.
+	 * @param  $vehicleParams - an array of vehicle's parameters or Vehicle object.
+	 * @return array          - an array of parameters of Vehicle
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	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/Members/MemberAuthenticationResponse.php

Indentation +177 added lines, -177 removed lines

@@ -10,181 +10,181 @@
  */
 class MemberAuthenticationResponse extends \Route4Me\Common
 {
-    /** @var boolean $status
-     * True, if authentication process was finished successfuly.
-     */
-    public $status;
-
-    /** @var string $geocoding_service
-     * Geocoding service
-     */
-    public $geocoding_service;
-
-    /** @var int $session_id
-     * Session ID
-     */
-    public $session_id;
-
-    /** @var string $session_guid
-     * Session guid
-     */
-    public $session_guid;
-
-    /** @var int $member_id
-     * Member ID
-     */
-    public $member_id;
-
-    /** @var string $api_key
-     * API key of an user
-     */
-    public $api_key;
-
-    /** @var int $tracking_ttl
-     * Tracking TTL
-     */
-    public $tracking_ttl;
-
-    /** @var string $update_channel_name
-     * Update channel name
-     */
-    public $update_channel_name;
-
-    /** @var string $geofence_polygon_shape
-     * Geofence polygon shape. ENUM('circle', 'poly', 'rect').
-     */
-    public $geofence_polygon_shape ;
-
-    /** @var int $geofence_polygon_size
-     * Geofence polygon size
-     */
-    public $geofence_polygon_size;
-
-    /** @var int $geofence_time_onsite_trigger_secs
-     * Geofence time onsite trigger in seconds.
-     */
-    public $geofence_time_onsite_trigger_secs;
-
-    /** @var int $geofence_minimum_trigger_speed
-     * Geofence minimum trigger speed.
-     */
-    public $geofence_minimum_trigger_speed;
-
-    /** @var boolean $is_subscription_past_due
-     * If true, subscription is past due.
-     */
-    public $is_subscription_past_due;
-
-    /** @var string $visited_departed_enabled
-     * if true, triggering of the visited and departed activities is enabled.
-     */
-    public $visited_departed_enabled;
-
-    /** @var string $long_press_enabled
-     * if true, long press is enabled.
-     */
-    public $long_press_enabled;
-
-    /** @var string $account_type_id
-     * The account type ID
-     */
-    public $account_type_id;
-
-    /** @var string $account_type_alias
-     * Account type alias.
-     */
-    public $account_type_alias;
-
-    /** @var string $member_type
-     * A type of the member.
-     * Available values:
-     * 'PRIMARY_ACCOUNT',
-     * 'SUB_ACCOUNT_ADMIN',
-     * 'SUB_ACCOUNT_REGIONAL_MANAGER',
-     * 'SUB_ACCOUNT_DISPATCHER',
-     * 'SUB_ACCOUNT_PLANNER',
-     * 'SUB_ACCOUNT_DRIVER',
-     * 'SUB_ACCOUNT_ANALYST',
-     * 'SUB_ACCOUNT_VENDOR',
-     * 'SUB_ACCOUNT_CUSTOMER_SERVICE'
-     */
-    public $member_type;
-
-    /** @var string $max_stops_per_route
-     * Maximum stops per route.
-     */
-    public $max_stops_per_route;
-
-    /** @var string $max_routes
-     * Maximum number of the routes.
-     */
-    public $max_routes;
-
-    /** @var int $routes_planned
-     * Number of the planned routes by an user.
-     */
-    public $routes_planned;
-
-    /** @var string $preferred_units
-     * Preferred units. Enum('km', 'mi').
-     */
-    public $preferred_units;
-
-    /** @var string $preferred_language
-     * Preferred language. Enum('en', 'fr').
-     */
-    public $preferred_language;
-
-    /** @var string $HIDE_ROUTED_ADDRESSES
-     * If true, routed addresses will be hidden.
-     */
-    public $HIDE_ROUTED_ADDRESSES;
-
-    /** @var string $HIDE_VISITED_ADDRESSES
-     * If true, visited addresses will be hidden.
-     */
-    public $HIDE_VISITED_ADDRESSES;
-
-    /** @var string $HIDE_NONFUTURE_ROUTES
-     * If equal to true, nonfuture addresses will be hidden.
-     */
-    public $HIDE_NONFUTURE_ROUTES;
-
-    /** @var string $READONLY_USER
-     * If equal to true, user can only read data.
-     */
-    public $READONLY_USER;
-
-    /** @var int $auto_logout_ts
-     * Time in seconds. If a user is inactive during this period, he will be logout.
-     */
-    public $auto_logout_ts;
-
-    /** @var string $last_known_member_payment_device
-     * Last known member payment device (e.g. 'web')
-     */
-    public $last_known_member_payment_device;
-
-    /** @var int $account_expires_timestamp
-     * Account expire date
-     */
-    public $account_expires_timestamp;
-
-    /** @var boolean $account_past_due
-     * Account past due
-     */
-    public $account_past_due;
-
-    /** @var array  $licensed_modules
-     * Licensed module. e.g.:
-     * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
-     * 'MODULE__VOICE_NAVIGATION:TRUE',
-     * 'MODULE__VOICE_NAVIGATION'
-     */
-    public $licensed_modules;
-
-    /** @var int $last_active_timestamp
-     * Last active timestamp
-     */
-    public $last_active_timestamp;
+	/** @var boolean $status
+	 * True, if authentication process was finished successfuly.
+	 */
+	public $status;
+
+	/** @var string $geocoding_service
+	 * Geocoding service
+	 */
+	public $geocoding_service;
+
+	/** @var int $session_id
+	 * Session ID
+	 */
+	public $session_id;
+
+	/** @var string $session_guid
+	 * Session guid
+	 */
+	public $session_guid;
+
+	/** @var int $member_id
+	 * Member ID
+	 */
+	public $member_id;
+
+	/** @var string $api_key
+	 * API key of an user
+	 */
+	public $api_key;
+
+	/** @var int $tracking_ttl
+	 * Tracking TTL
+	 */
+	public $tracking_ttl;
+
+	/** @var string $update_channel_name
+	 * Update channel name
+	 */
+	public $update_channel_name;
+
+	/** @var string $geofence_polygon_shape
+	 * Geofence polygon shape. ENUM('circle', 'poly', 'rect').
+	 */
+	public $geofence_polygon_shape ;
+
+	/** @var int $geofence_polygon_size
+	 * Geofence polygon size
+	 */
+	public $geofence_polygon_size;
+
+	/** @var int $geofence_time_onsite_trigger_secs
+	 * Geofence time onsite trigger in seconds.
+	 */
+	public $geofence_time_onsite_trigger_secs;
+
+	/** @var int $geofence_minimum_trigger_speed
+	 * Geofence minimum trigger speed.
+	 */
+	public $geofence_minimum_trigger_speed;
+
+	/** @var boolean $is_subscription_past_due
+	 * If true, subscription is past due.
+	 */
+	public $is_subscription_past_due;
+
+	/** @var string $visited_departed_enabled
+	 * if true, triggering of the visited and departed activities is enabled.
+	 */
+	public $visited_departed_enabled;
+
+	/** @var string $long_press_enabled
+	 * if true, long press is enabled.
+	 */
+	public $long_press_enabled;
+
+	/** @var string $account_type_id
+	 * The account type ID
+	 */
+	public $account_type_id;
+
+	/** @var string $account_type_alias
+	 * Account type alias.
+	 */
+	public $account_type_alias;
+
+	/** @var string $member_type
+	 * A type of the member.
+	 * Available values:
+	 * 'PRIMARY_ACCOUNT',
+	 * 'SUB_ACCOUNT_ADMIN',
+	 * 'SUB_ACCOUNT_REGIONAL_MANAGER',
+	 * 'SUB_ACCOUNT_DISPATCHER',
+	 * 'SUB_ACCOUNT_PLANNER',
+	 * 'SUB_ACCOUNT_DRIVER',
+	 * 'SUB_ACCOUNT_ANALYST',
+	 * 'SUB_ACCOUNT_VENDOR',
+	 * 'SUB_ACCOUNT_CUSTOMER_SERVICE'
+	 */
+	public $member_type;
+
+	/** @var string $max_stops_per_route
+	 * Maximum stops per route.
+	 */
+	public $max_stops_per_route;
+
+	/** @var string $max_routes
+	 * Maximum number of the routes.
+	 */
+	public $max_routes;
+
+	/** @var int $routes_planned
+	 * Number of the planned routes by an user.
+	 */
+	public $routes_planned;
+
+	/** @var string $preferred_units
+	 * Preferred units. Enum('km', 'mi').
+	 */
+	public $preferred_units;
+
+	/** @var string $preferred_language
+	 * Preferred language. Enum('en', 'fr').
+	 */
+	public $preferred_language;
+
+	/** @var string $HIDE_ROUTED_ADDRESSES
+	 * If true, routed addresses will be hidden.
+	 */
+	public $HIDE_ROUTED_ADDRESSES;
+
+	/** @var string $HIDE_VISITED_ADDRESSES
+	 * If true, visited addresses will be hidden.
+	 */
+	public $HIDE_VISITED_ADDRESSES;
+
+	/** @var string $HIDE_NONFUTURE_ROUTES
+	 * If equal to true, nonfuture addresses will be hidden.
+	 */
+	public $HIDE_NONFUTURE_ROUTES;
+
+	/** @var string $READONLY_USER
+	 * If equal to true, user can only read data.
+	 */
+	public $READONLY_USER;
+
+	/** @var int $auto_logout_ts
+	 * Time in seconds. If a user is inactive during this period, he will be logout.
+	 */
+	public $auto_logout_ts;
+
+	/** @var string $last_known_member_payment_device
+	 * Last known member payment device (e.g. 'web')
+	 */
+	public $last_known_member_payment_device;
+
+	/** @var int $account_expires_timestamp
+	 * Account expire date
+	 */
+	public $account_expires_timestamp;
+
+	/** @var boolean $account_past_due
+	 * Account past due
+	 */
+	public $account_past_due;
+
+	/** @var array  $licensed_modules
+	 * Licensed module. e.g.:
+	 * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
+	 * 'MODULE__VOICE_NAVIGATION:TRUE',
+	 * 'MODULE__VOICE_NAVIGATION'
+	 */
+	public $licensed_modules;
+
+	/** @var int $last_active_timestamp
+	 * Last active timestamp
+	 */
+	public $last_active_timestamp;
 }

src/Route4Me/Members/MemberResponseV4.php

Indentation +119 added lines, -119 removed lines

@@ -9,123 +9,123 @@
  */
 class MemberResponseV4 extends \Route4Me\Common
 {
-    /** @var string $HIDE_NONFUTURE_ROUTES
-     * If true, the nonfuture routes will be hidden ('TRUE', 'FALSE').
-     */
-    public $HIDE_NONFUTURE_ROUTES;
-
-    /** @var string $HIDE_ROUTED_ADDRESSES
-     * If true, the routed addresses will be hidden ('TRUE', 'FALSE').
-     */
-    public $HIDE_ROUTED_ADDRESSES;
-
-    /** @var string $HIDE_VISITED_ADDRESSES
-     * If true, the visited addresses will be hidden ('TRUE', 'FALSE').
-     */
-    public $HIDE_VISITED_ADDRESSES;
-
-    /** @var string $member_id
-     * The member ID
-     */
-    public $member_id;
-
-    /** @var string $OWNER_MEMBER_ID
-     * The user's account owner ID.
-     */
-    public $OWNER_MEMBER_ID;
-
-    /** @var string $READONLY_USER
-     * If true, the user has read-only access type ('TRUE', 'FALSE').
-     */
-    public $READONLY_USER;
-
-    /** @var string $SHOW_ALL_DRIVERS
-     * If true, all drivers are visible to the user ('TRUE', 'FALSE').
-     */
-    public $SHOW_ALL_DRIVERS;
-
-    /** @var string $SHOW_ALL_VEHICLES
-     * If true, all vehicles are visible to the user ('1', '0').
-     */
-    public $SHOW_ALL_VEHICLES;
-
-    /** @var string $date_of_birth
-     * Birthdate of the user.
-     */
-    public $date_of_birth;
-
-    /** @var string $member_email
-     * User's email.
-     */
-    public $member_email;
-
-    /** @var stringn $member_first_name
-     * User's first name.
-     */
-    public $member_first_name;
-
-    /** @var string $member_last_name
-     * User's last name.
-     */
-    public $member_last_name;
-
-    /** @var string $member_phone
-     * User's phone number.
-     */
-    public $member_phone;
-
-    /** @var string $member_picture
-     * A link to the user's picture.
-     */
-    public $member_picture;
-
-    /** @var string $member_type
-     * Member type. Available values:
-     * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER,
-     * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER
-     */
-    public $member_type;
-
-    /** @var string $member_zipcode
-     * User zipcode.
-     */
-    public $member_zipcode;
-
-    /** @var string $preferred_language
-     * Preferred language (en, fr).
-     */
-    public $preferred_language;
-
-    /** @var string $preferred_units
-     * Preferred unit (mi, km).
-     */
-    public $preferred_units;
-
-    /** @var string $timezone
-     * Member's location timezone.
-     */
-    public $timezone;
-
-    /** @var string $user_reg_country_id
-     * Registration country ID of a user.
-     */
-    public $user_reg_country_id;
-
-    /** @var string $user_reg_state_id
-     * Registration state ID of a user.
-     */
-    public $user_reg_state_id;
-
-    /** @var int $level
-     * Subordination level. 0 is the highest level.
-     */
-    public $level;
-
-    /** @var array $custom_data
-     * The user's custom data.
-     */
-    public $custom_data;
-
-    /** @var string  $api_key*/
-    public $api_key;
+	/** @var string $HIDE_NONFUTURE_ROUTES
+	 * If true, the nonfuture routes will be hidden ('TRUE', 'FALSE').
+	 */
+	public $HIDE_NONFUTURE_ROUTES;
+
+	/** @var string $HIDE_ROUTED_ADDRESSES
+	 * If true, the routed addresses will be hidden ('TRUE', 'FALSE').
+	 */
+	public $HIDE_ROUTED_ADDRESSES;
+
+	/** @var string $HIDE_VISITED_ADDRESSES
+	 * If true, the visited addresses will be hidden ('TRUE', 'FALSE').
+	 */
+	public $HIDE_VISITED_ADDRESSES;
+
+	/** @var string $member_id
+	 * The member ID
+	 */
+	public $member_id;
+
+	/** @var string $OWNER_MEMBER_ID
+	 * The user's account owner ID.
+	 */
+	public $OWNER_MEMBER_ID;
+
+	/** @var string $READONLY_USER
+	 * If true, the user has read-only access type ('TRUE', 'FALSE').
+	 */
+	public $READONLY_USER;
+
+	/** @var string $SHOW_ALL_DRIVERS
+	 * If true, all drivers are visible to the user ('TRUE', 'FALSE').
+	 */
+	public $SHOW_ALL_DRIVERS;
+
+	/** @var string $SHOW_ALL_VEHICLES
+	 * If true, all vehicles are visible to the user ('1', '0').
+	 */
+	public $SHOW_ALL_VEHICLES;
+
+	/** @var string $date_of_birth
+	 * Birthdate of the user.
+	 */
+	public $date_of_birth;
+
+	/** @var string $member_email
+	 * User's email.
+	 */
+	public $member_email;
+
+	/** @var stringn $member_first_name
+	 * User's first name.
+	 */
+	public $member_first_name;
+
+	/** @var string $member_last_name
+	 * User's last name.
+	 */
+	public $member_last_name;
+
+	/** @var string $member_phone
+	 * User's phone number.
+	 */
+	public $member_phone;
+
+	/** @var string $member_picture
+	 * A link to the user's picture.
+	 */
+	public $member_picture;
+
+	/** @var string $member_type
+	 * Member type. Available values:
+	 * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER,
+	 * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER
+	 */
+	public $member_type;
+
+	/** @var string $member_zipcode
+	 * User zipcode.
+	 */
+	public $member_zipcode;
+
+	/** @var string $preferred_language
+	 * Preferred language (en, fr).
+	 */
+	public $preferred_language;
+
+	/** @var string $preferred_units
+	 * Preferred unit (mi, km).
+	 */
+	public $preferred_units;
+
+	/** @var string $timezone
+	 * Member's location timezone.
+	 */
+	public $timezone;
+
+	/** @var string $user_reg_country_id
+	 * Registration country ID of a user.
+	 */
+	public $user_reg_country_id;
+
+	/** @var string $user_reg_state_id
+	 * Registration state ID of a user.
+	 */
+	public $user_reg_state_id;
+
+	/** @var int $level
+	 * Subordination level. 0 is the highest level.
+	 */
+	public $level;
+
+	/** @var array $custom_data
+	 * The user's custom data.
+	 */
+	public $custom_data;
+
+	/** @var string  $api_key*/
+	public $api_key;
 }

src/Route4Me/Members/Member.php

Indentation +343 added lines, -343 removed lines

@@ -8,347 +8,347 @@
 
 class Member extends \Route4Me\Common
 {
-    public $device_id;
-    public $device_type;
-    public $format;
-
-    public $strEmail;
-    public $strPassword;
-    public $strPassword_1;
-    public $strPassword_2;
-    public $strFirstName;
-    public $strLastName;
-    public $strIndustry;
-    public $chkTerms;
-    public $plan;
-
-    public $session_guid;
-    public $member_id;
-
-    public $email_address;
-    public $first_name;
-    public $last_name;
-    public $phone_number;
-    public $company_name;
-    public $webinar_date;
-
-    public $subscription_name;
-    public $token;
-    public $payload;
-
-    public $HIDE_ROUTED_ADDRESSES;
-    public $member_phone;
-    public $member_zipcode;
-    public $route_count;
-    public $member_email;
-    public $HIDE_VISITED_ADDRESSES;
-    public $READONLY_USER;
-    public $member_type;
-    public $date_of_birth;
-    public $member_first_name;
-    public $member_password;
-    public $HIDE_NONFUTURE_ROUTES;
-    public $member_last_name;
-    public $SHOW_ALL_VEHICLES;
-    public $SHOW_ALL_DRIVERS;
-
-    public $config_key;
-    public $config_value;
-
-    public $preferred_units;
-    public $preferred_language;
-    public $timezone;
-    public $OWNER_MEMBER_ID;
-    public $user_reg_state_id;
-    public $user_reg_country_id;
-    public $member_picture;
-    public $api_key;
-    public $custom_data;
-    public $level;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function getUsers()
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::USER_V4,
-            'method' => 'GET',
-        ]);
-
-        return $response;
-    }
-
-    public static function getUser($params)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::USER_V4,
-            'method' => 'GET',
-            'query' => [
-                'member_id' => isset($params['member_id']) ? $params['member_id'] : null,
-            ],
-        ]);
-
-        return $response;
-    }
-
-    public static function getUserLocations($param)
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VIEW_USER_LOCATIONS,
-            'method' => 'GET',
-            'query' => [
-                'query' => $param,
-            ],
-        ]);
-
-        return $response;
-    }
-
-    public static function addDeviceRecord($params)
-    {
-        $allQueryFields = ['device_id', 'device_type'];
-        $allBodyFields = ['device_id', 'device_type', 'format'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VERIFY_DEVICE_LICENSE,
-            'method' => 'POST',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function createMember($params)
-    {
-        $excludeFields = ['session_guid', 'member_id', 'token', 'payload', 'webinar_date',
-        'company_name', 'config_key', 'config_value', 'api_key', ];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::USER_V4,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getRandomMemberByType($memberType)
-    {
-        $members = self::getUsers();
-
-        if (is_null($members) || !isset($members['results'])) {
-            return null;
-        }
-
-        $memberIDs = [];
-
-        foreach ($members['results'] as $memb) {
-            if (isset($memb['member_id']) && isset($memb['member_type'])) {
-                if ($memberType == $memb['member_type']) {
-                    $memberIDs[] = $memb['member_id'];
-                }
-            }
-        }
-
-        if (sizeof($memberIDs) < 1) {
-            return null;
-        }
-
-        $randomIndex = rand(0, sizeof($memberIDs) - 1);
-
-        return $memberIDs[$randomIndex];
-    }
-
-    public static function updateMember($body)
-    {
-        $excludeFields = ['session_guid', 'token', 'payload', 'webinar_date',
-        'company_name', 'config_key', 'config_value', 'api_key', ];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::USER_V4,
-            'method' => 'PUT',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $body),
-        ]);
-
-        return $response;
-    }
-
-    public static function deleteMember($body, &$errorText)
-    {
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::USER_V4,
-                'method' => 'DELETE',
-                'body' => [
-                    'member_id' => isset($body->member_id) ? $body->member_id : null,
-                ],
-            ]);
-        } catch (\Exception $ex) {
-            $errorText = $ex->getMessage();
-            $response = null;
-        } finally {
-            return $response;
-        }
-    }
-
-    public static function newAccountRegistration($params, &$errorText)
-    {
-        $allQueryFields = ['plan'];
-        $allBodyFields = ['strEmail', 'strPassword_1', 'strPassword_2', 'strFirstName',
-        'strLastName', 'format', 'strIndustry', 'chkTerms', 'device_type', 'strSubAccountType',
-        'blDisableMarketing', 'blDisableAccountActivationEmail', ];
-
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::REGISTER_ACTION,
-                'method' => 'POST',
-                'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-                'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-                'HTTPHEADER' => 'Content-Type: multipart/form-data',
-            ]);
-        } catch (\Exception $ex) {
-            $response = null;
-            $errorText = "Cannot registrate new account <br> ".$ex->getMessage();
-        } finally {
-            return $response;
-        }
-    }
-
-    public static function validateSession($params)
-    {
-        $allQueryFields = ['session_guid', 'member_id', 'format'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::VALIDATE_SESSION,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function memberAuthentication($params)
-    {
-        $allBodyFields = ['strEmail', 'strPassword', 'format'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::AUTHENTICATE,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $response;
-    }
-
-    public static function webinarRegistration($params)
-    {
-        $allBodyFields = ['email_address', 'first_name', 'last_name', 'phone_number',
-        'company_name', 'member_id', 'webinar_date', ];
-
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::WEBINAR_REGISTER,
-                'method' => 'POST',
-                'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            ]);
-        } catch (\Exception $ex) {
-            $response = null;
-        } finally {
-            return $response;
-        }
-    }
-
-    public static function purchaseUserLicense($params)
-    {
-        $allQueryFields = ['device_id'];
-        $allBodyFields = ['member_id', 'session_guid', 'device_id', 'device_type',
-        'subscription_name', 'token', 'payload', 'format', ];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::USER_LICENSE,
-            'method' => 'POST',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function newMemberConfigKey($params)
-    {
-        $allBodyFields = ['config_key', 'config_value'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::CONFIGURATION_SETTINGS,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function removeMemberConfigKey($params)
-    {
-        $allBodyFields = ['config_key'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::CONFIGURATION_SETTINGS,
-            'method' => 'DELETE',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getMemberConfigData($params)
-    {
-        $allQueryFields = ['config_key'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::CONFIGURATION_SETTINGS,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function updateMemberConfigKey($params)
-    {
-        $allBodyFields = ['config_key', 'config_value'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::CONFIGURATION_SETTINGS,
-            'method' => 'PUT',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getMemberCapabilities()
-    {
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::MEMBER_CAPABILITIES,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters([], null),
-        ]);
-
-        return $response;
-    }
+	public $device_id;
+	public $device_type;
+	public $format;
+
+	public $strEmail;
+	public $strPassword;
+	public $strPassword_1;
+	public $strPassword_2;
+	public $strFirstName;
+	public $strLastName;
+	public $strIndustry;
+	public $chkTerms;
+	public $plan;
+
+	public $session_guid;
+	public $member_id;
+
+	public $email_address;
+	public $first_name;
+	public $last_name;
+	public $phone_number;
+	public $company_name;
+	public $webinar_date;
+
+	public $subscription_name;
+	public $token;
+	public $payload;
+
+	public $HIDE_ROUTED_ADDRESSES;
+	public $member_phone;
+	public $member_zipcode;
+	public $route_count;
+	public $member_email;
+	public $HIDE_VISITED_ADDRESSES;
+	public $READONLY_USER;
+	public $member_type;
+	public $date_of_birth;
+	public $member_first_name;
+	public $member_password;
+	public $HIDE_NONFUTURE_ROUTES;
+	public $member_last_name;
+	public $SHOW_ALL_VEHICLES;
+	public $SHOW_ALL_DRIVERS;
+
+	public $config_key;
+	public $config_value;
+
+	public $preferred_units;
+	public $preferred_language;
+	public $timezone;
+	public $OWNER_MEMBER_ID;
+	public $user_reg_state_id;
+	public $user_reg_country_id;
+	public $member_picture;
+	public $api_key;
+	public $custom_data;
+	public $level;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function getUsers()
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::USER_V4,
+			'method' => 'GET',
+		]);
+
+		return $response;
+	}
+
+	public static function getUser($params)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::USER_V4,
+			'method' => 'GET',
+			'query' => [
+				'member_id' => isset($params['member_id']) ? $params['member_id'] : null,
+			],
+		]);
+
+		return $response;
+	}
+
+	public static function getUserLocations($param)
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VIEW_USER_LOCATIONS,
+			'method' => 'GET',
+			'query' => [
+				'query' => $param,
+			],
+		]);
+
+		return $response;
+	}
+
+	public static function addDeviceRecord($params)
+	{
+		$allQueryFields = ['device_id', 'device_type'];
+		$allBodyFields = ['device_id', 'device_type', 'format'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VERIFY_DEVICE_LICENSE,
+			'method' => 'POST',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function createMember($params)
+	{
+		$excludeFields = ['session_guid', 'member_id', 'token', 'payload', 'webinar_date',
+		'company_name', 'config_key', 'config_value', 'api_key', ];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::USER_V4,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getRandomMemberByType($memberType)
+	{
+		$members = self::getUsers();
+
+		if (is_null($members) || !isset($members['results'])) {
+			return null;
+		}
+
+		$memberIDs = [];
+
+		foreach ($members['results'] as $memb) {
+			if (isset($memb['member_id']) && isset($memb['member_type'])) {
+				if ($memberType == $memb['member_type']) {
+					$memberIDs[] = $memb['member_id'];
+				}
+			}
+		}
+
+		if (sizeof($memberIDs) < 1) {
+			return null;
+		}
+
+		$randomIndex = rand(0, sizeof($memberIDs) - 1);
+
+		return $memberIDs[$randomIndex];
+	}
+
+	public static function updateMember($body)
+	{
+		$excludeFields = ['session_guid', 'token', 'payload', 'webinar_date',
+		'company_name', 'config_key', 'config_value', 'api_key', ];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::USER_V4,
+			'method' => 'PUT',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $body),
+		]);
+
+		return $response;
+	}
+
+	public static function deleteMember($body, &$errorText)
+	{
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::USER_V4,
+				'method' => 'DELETE',
+				'body' => [
+					'member_id' => isset($body->member_id) ? $body->member_id : null,
+				],
+			]);
+		} catch (\Exception $ex) {
+			$errorText = $ex->getMessage();
+			$response = null;
+		} finally {
+			return $response;
+		}
+	}
+
+	public static function newAccountRegistration($params, &$errorText)
+	{
+		$allQueryFields = ['plan'];
+		$allBodyFields = ['strEmail', 'strPassword_1', 'strPassword_2', 'strFirstName',
+		'strLastName', 'format', 'strIndustry', 'chkTerms', 'device_type', 'strSubAccountType',
+		'blDisableMarketing', 'blDisableAccountActivationEmail', ];
+
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::REGISTER_ACTION,
+				'method' => 'POST',
+				'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+				'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+				'HTTPHEADER' => 'Content-Type: multipart/form-data',
+			]);
+		} catch (\Exception $ex) {
+			$response = null;
+			$errorText = "Cannot registrate new account <br> ".$ex->getMessage();
+		} finally {
+			return $response;
+		}
+	}
+
+	public static function validateSession($params)
+	{
+		$allQueryFields = ['session_guid', 'member_id', 'format'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::VALIDATE_SESSION,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function memberAuthentication($params)
+	{
+		$allBodyFields = ['strEmail', 'strPassword', 'format'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::AUTHENTICATE,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: multipart/form-data',
+		]);
+
+		return $response;
+	}
+
+	public static function webinarRegistration($params)
+	{
+		$allBodyFields = ['email_address', 'first_name', 'last_name', 'phone_number',
+		'company_name', 'member_id', 'webinar_date', ];
+
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::WEBINAR_REGISTER,
+				'method' => 'POST',
+				'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			]);
+		} catch (\Exception $ex) {
+			$response = null;
+		} finally {
+			return $response;
+		}
+	}
+
+	public static function purchaseUserLicense($params)
+	{
+		$allQueryFields = ['device_id'];
+		$allBodyFields = ['member_id', 'session_guid', 'device_id', 'device_type',
+		'subscription_name', 'token', 'payload', 'format', ];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::USER_LICENSE,
+			'method' => 'POST',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function newMemberConfigKey($params)
+	{
+		$allBodyFields = ['config_key', 'config_value'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::CONFIGURATION_SETTINGS,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function removeMemberConfigKey($params)
+	{
+		$allBodyFields = ['config_key'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::CONFIGURATION_SETTINGS,
+			'method' => 'DELETE',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getMemberConfigData($params)
+	{
+		$allQueryFields = ['config_key'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::CONFIGURATION_SETTINGS,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function updateMemberConfigKey($params)
+	{
+		$allBodyFields = ['config_key', 'config_value'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::CONFIGURATION_SETTINGS,
+			'method' => 'PUT',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getMemberCapabilities()
+	{
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::MEMBER_CAPABILITIES,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters([], null),
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/Members/MemberConfiguration.php

Indentation +94 added lines, -94 removed lines

@@ -13,137 +13,137 @@
 
 class MemberConfiguration extends \Route4Me\Common
 {
-    /*
+	/*
      * The member ID
      */
-    public $member_id;
+	public $member_id;
 
-    /*
+	/*
      * The member's config key
      */
-    public $config_key;
+	public $config_key;
 
-    /*
+	/*
      * The member's config value
      */
-    public $config_value;
+	public $config_value;
 
-    /*
+	/*
      * True, if the value is hidden.
      */
-    public $is_hidden_value;
+	public $is_hidden_value;
 
-    /*
+	/*
      * If true, the value is showable.
      */
-    public $can_unhide_value;
+	public $can_unhide_value;
 
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
 
-    /*
+	/*
     * Create new member configuration key-value pair.
     * @param array $params
      *       Contains key-value pair:  'config_key': 'config_value'
      * @param string $errorText
      *        Error message text
     */
-    public function CreateNewConfigurationData($params, &$errorText)
-    {
-        $allBodyFields = ['config_key', 'config_value'];
-
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::CONFIGURATION_SETTINGS,
-                'method' => 'POST',
-                'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            ]);
-        } catch (\Exception $ex) {
-            $errorText = $ex->getMessage();
-        } finally {
-            return $response;
-        }
-    }
-
-    /*
+	public function CreateNewConfigurationData($params, &$errorText)
+	{
+		$allBodyFields = ['config_key', 'config_value'];
+
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::CONFIGURATION_SETTINGS,
+				'method' => 'POST',
+				'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			]);
+		} catch (\Exception $ex) {
+			$errorText = $ex->getMessage();
+		} finally {
+			return $response;
+		}
+	}
+
+	/*
      * Update the value of the specified key.
      * @param array $params
      *       Contains key-value pair:  'config_key': 'config_value'.
      * @param string $errorText
      *        Error message text
      */
-    public function UpdateConfigurationData($params, &$errorText)
-    {
-        $allBodyFields = ['config_key', 'config_value'];
-
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::CONFIGURATION_SETTINGS,
-                'method' => 'PUT',
-                'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-            ]);
-        } catch (\Exception $ex) {
-            $errorText = $ex->getMessage();
-        } finally {
-            return $response;
-        }
-    }
-
-    /*
+	public function UpdateConfigurationData($params, &$errorText)
+	{
+		$allBodyFields = ['config_key', 'config_value'];
+
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::CONFIGURATION_SETTINGS,
+				'method' => 'PUT',
+				'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+			]);
+		} catch (\Exception $ex) {
+			$errorText = $ex->getMessage();
+		} finally {
+			return $response;
+		}
+	}
+
+	/*
      * Removes specified member configuration key.
      * @param array $params
      *       Contains key-value pair:  'config_key': 'config_value'.
      * @param string $errorText
      *        Error message text
      */
-    public function RemoveConfigurationData($params, &$errorText)
-    {
-        if (!isset($params['config_key'])) {
-            $errorText = 'The parameter config_key is not specified';
-            return null;
-        }
-
-        $response = null;
-
-        try {
-            $response = Route4Me::makeRequst([
-                'url' => Endpoint::CONFIGURATION_SETTINGS,
-                'method' => 'DELETE',
-                'body' => [
-                    'config_key' => isset($params['config_key']) ? $params['config_key'] : null
-                ],
-            ]);
-        } catch (\Exception $ex) {
-            $errorText = $ex->getMessage();
-        } finally {
-            return $response;
-        }
-    }
-
-    /*
+	public function RemoveConfigurationData($params, &$errorText)
+	{
+		if (!isset($params['config_key'])) {
+			$errorText = 'The parameter config_key is not specified';
+			return null;
+		}
+
+		$response = null;
+
+		try {
+			$response = Route4Me::makeRequst([
+				'url' => Endpoint::CONFIGURATION_SETTINGS,
+				'method' => 'DELETE',
+				'body' => [
+					'config_key' => isset($params['config_key']) ? $params['config_key'] : null
+				],
+			]);
+		} catch (\Exception $ex) {
+			$errorText = $ex->getMessage();
+		} finally {
+			return $response;
+		}
+	}
+
+	/*
      * Retrieves configuration data from a member account.
      * param array $params
      *       If specified, it contains the key 'config_key' and retrieved only corresponding configuration data,
      *       if not, all member configuration data retrieved.
      */
-    public function GetConfigurationData($params = null)
-    {
-        $allQueryFields = ['config_key'];
-
-        $response = Route4Me::makeRequst([
-            'url' => Endpoint::CONFIGURATION_SETTINGS,
-            'method' => 'GET',
-            'query' => [
-                'config_key' => isset($params['config_key']) ? $params['config_key'] : null
-            ],
-        ]);
-
-        return $response;
-    }
+	public function GetConfigurationData($params = null)
+	{
+		$allQueryFields = ['config_key'];
+
+		$response = Route4Me::makeRequst([
+			'url' => Endpoint::CONFIGURATION_SETTINGS,
+			'method' => 'GET',
+			'query' => [
+				'config_key' => isset($params['config_key']) ? $params['config_key'] : null
+			],
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/Members/MemberCapabilities.php

Indentation +14 added lines, -14 removed lines

@@ -7,38 +7,38 @@
  */
 class MemberCapabilities extends \Route4Me\Common
 {
-    /*
+	/*
      * Array of the avoidance zone IDs.
      */
-    public $avoid = [];
+	public $avoid = [];
 
-    /*
+	/*
      * Road avoid options: "Highways", "Tolls", "highways,tolls".
      */
-    public $avoid_roads = [];
+	public $avoid_roads = [];
 
-    /*
+	/*
      * Restriction options.
      */
-    public $features = [];
+	public $features = [];
 
-    /*
+	/*
      * Travel modes: "Highways", "Tolls", "highways,tolls".
      */
-    public $travelModes = [];
+	public $travelModes = [];
 
-    /*
+	/*
      * Navigate options
      */
-    public $navigateBy = [];
+	public $navigateBy = [];
 
-    /*
+	/*
      * Array of the license modules
      */
-    public $LicensedModules = [];
+	public $LicensedModules = [];
 
-    /*
+	/*
      * If true, the member subscription is commercial.
      */
-    public $commercial;
+	public $commercial;
 }

src/Route4Me/Members/MemberResponse.php

Indentation +393 added lines, -393 removed lines

@@ -9,397 +9,397 @@
  */
 class MemberResponse extends \Route4Me\Common
 {
-    /** @var boolean $authenticated
-     * A boolean flag indicating if the session is valid.
-     */
-    public $authenticated;
-
-    /** @var boolean $status
-     * Process status
-     */
-    public $status;
-
-    /** @var string $geocoding_service
-     * Geocoding service
-     */
-    public $geocoding_service;
-
-    /** @var string $session_id
-     * The integer session id of the current session.
-     */
-    public $session_id;
-
-    /** @var string $session_guid
-     * An MD5 hash string of the currently authenticated sesssion,
-     * important to use this with future requests.
-     */
-    public $session_guid;
-
-    /** @var string $member_first_name
-     * The first name of the user.
-     */
-    public $member_first_name;
-
-    /** @var string $member_last_name
-     * The last name of the user.
-     */
-    public $member_last_name;
-
-    /** @var int $member_timestamp_added
-     * The unix timestamp when the user joined the service.
-     */
-    public $member_timestamp_added;
-
-    /** @var string $industry
-     * The industry the authenticated user specified.
-     */
-    public $industry;
-
-    /** @var int $member_id
-     * Member ID
-     */
-    public $member_id;
-
-    /** @var string $member_email
-     * Member email
-     */
-    public $member_email;
-
-    /** @var boolean $is_trial
-     * If the user is currently a trial customer.
-     */
-    public $is_trial;
-
-    /** @var boolean $is_active
-     * If the user is currently an active customer.
-     */
-    public $is_active;
-
-    /** @var string $api_key
-     * User's API key
-     */
-    public $api_key;
-
-    /** @var int $tracking_ttl
-     * Tracking TTL
-     */
-    public $tracking_ttl;
-
-    /** @var boolean $hide_billing_section
-     * Hide billing section.
-     */
-    public $hide_billing_section;
-
-    /** @var string $last_known_member_payment_device
-     * Last known member payment device (e.g. 'web').
-     */
-    public $last_known_member_payment_device;
-
-    /** @var array $licensed_modules
-     * Licensed module. e.g.:
-     * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
-     * 'MODULE__VOICE_NAVIGATION:TRUE',
-     * 'MODULE__VOICE_NAVIGATION'
-     */
-    public $licensed_modules;
-
-    /** @var boolean $member_business_type
-     * Member business type (e.g. 'BUSINESS_EMPLOYEE').
-     */
-    public $member_business_type;
-
-    /** @var string $geofence_polygon_shape
-     * Geofence polygon shape. Available values:
-     * 'circle', 'poly', 'rect'.
-     */
-    public $geofence_polygon_shape;
-
-    /** @var int $geofence_polygon_size
-     * Geofence polygon size
-     */
-    public $geofence_polygon_size;
-
-    /** @var int $geofence_time_onsite_trigger_secs
-     * Geofence onsite trigger time (seconds).
-     */
-    public $geofence_time_onsite_trigger_secs;
-
-    /** @var int $geofence_minimum_trigger_speed
-     * Geofence's minimum trigger speed.
-     */
-    public $geofence_minimum_trigger_speed;
-
-    /** @var bool $is_subscription_past_due
-     * True if the subscription is past due.
-     */
-    public $is_subscription_past_due;
-
-    /** @var string $visited_departed_enabled
-     * If true, triggering of the visited and departed activities is enabled.
-     */
-    public $visited_departed_enabled;
-
-    /** @var string $long_press_enabled
-     * If true, long press is enabled.
-     */
-    public $long_press_enabled;
-
-    /** @var int $account_type_id
-     * The account type ID.
-     */
-    public $account_type_id;
-
-    /** @var string $current_price
-     * Current price (e.g. '0.000').
-     */
-    public $current_price;
-
-    /** @var int $initially_requested_account_type_id
-     * Initially Requested account type ID.
-     */
-    public $initially_requested_account_type_id;
-
-    /** @var string $account_type_alias
-     * Account type alias
-     */
-    public $account_type_alias;
-
-    /** @var string $member_type
-     * Member type. Available values:
-     * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER,
-     * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER,
-     * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE
-     */
-    public $member_type;
-
-    /** @var string $OWNER_MEMBER_ID
-     * Parent user ID.
-     */
-    public $OWNER_MEMBER_ID;
-
-    /** @var string $ROOT_OWNER_MEMBER_ID
-     * Root owner member ID (e.g. '402088').
-     */
-    public $ROOT_OWNER_MEMBER_ID;
-
-    /** @var string $ROOT_OWNER_MEMBER_EMAIL
-     * Root owner member email.
-     */
-    public $ROOT_OWNER_MEMBER_EMAIL;
-
-    /** @var string $ROOT_OWNER_MEMBER_API_KEY
-     * Root owner member API key.
-     */
-    public $ROOT_OWNER_MEMBER_API_KEY;
-
-    /** @var string $geocodingMethod
-     * Geocoding method
-     */
-    public $geocodingMethod;
-
-    /** @var string $service_type
-     * Service type (e.g. 'pre5').
-     */
-    public $service_type;
-
-    /** @var string $validated_by
-     * Validated by (e.g. 'ADMIN_PANEL').
-     */
-    public $validated_by;
-
-    /** @var int $max_stops_per_route
-     * Maximum allowed number of the stops per route.
-     */
-    public $max_stops_per_route;
-
-    /** @var int $max_routes
-     * Maximum allowed number of the generated routes.
-     */
-    public $max_routes;
-
-    /** @var int $max_route
-     * Maximum allowed number of the generated routes.
-     */
-    public $max_route;
-
-    /** @var int $route_planned
-     * Planned route numbers
-     */
-    public $route_planned;
-
-    /** @var int $routes_planned
-     * Routes Planned
-     */
-    public $routes_planned;
-
-    /** @var int $total_routes_planned
-     * Total planned routes.
-     */
-    public $total_routes_planned;
-
-    /** @var int $authentication_count
-     * Authentication count.
-     */
-    public $authentication_count;
-
-    /** @var string $salesforce_unique_record_id
-     * Salesforce unique record ID.
-     */
-    public $salesforce_unique_record_id;
-
-    /** @var string $salesforce_account_id
-     * Salesforce account ID
-     */
-    public $salesforce_account_id;
-
-    /** @var string $salesforce_lead_id
-     * Salesforce lead ID
-     */
-    public $salesforce_lead_id;
-
-    /** @var int $max_api_optimization_addresses
-     * The maximun number of addresses the authenticated user
-     * can optimize in this billing cycle.
-     */
-    public $max_api_optimization_addresses;
-
-    /** @var int $max_api_geocoding_addresses
-     * The maximun number of geocodings the authenticated user
-     * can optimize in this billing cycle.
-     */
-    public $max_api_geocoding_addresses;
-
-    /** @var int $max_api_directions_addresses
-     * The maximum number of driving route transactions the authenticated
-     * user can execute in this billing cycle.
-     */
-    public $max_api_directions_addresses;
-
-    /** @var int $max_api_validation_addresses
-     * The maximun number of address validation transactions the authenticated
-     * user can execute in this billing cycle.
-     */
-    public $max_api_validation_addresses;
-
-    /** @var int $max_stops_per_unoptimized_route
-     * The maximum number of stops the authenticated user
-     * can put into a route with optimization disabled.
-     */
-    public $max_stops_per_unoptimized_route;
-
-    /** @var int $max_api_distance_tx
-     * The maximum number of distance transactions the authenticated
-     * user can execute in this billing cycle.
-     */
-    public $max_api_distance_tx;
-
-    /** @var boolean $blDisplayUpgradeTrackingHTML
-     * Display upgrade tracking HTML.
-     */
-    public $blDisplayUpgradeTrackingHTML;
-
-    /** @var int $intTrackingTrigger
-     * Tracking trigger (int).
-     */
-    public $intTrackingTrigger;
-
-    /** @var int $last_payment_ts
-     * The last unix timestamp when this user was successfully charged.
-     */
-    public $last_payment_ts;
-
-    /** @var int $last_failed_payment_ts
-     * The last unix timestamp when this user was failed to pay.
-     */
-    public $last_failed_payment_ts;
-
-    /** @var int $account_expires_timestamp
-     * Account expire date
-     */
-    public $account_expires_timestamp;
-
-    /** @var boolean $account_past_due
-     * Account past due
-     */
-    public $account_past_due;
-
-    /** @var string $ui_input_method
-     * UI input method
-     */
-    public $ui_input_method;
-
-    /** @var string $registration_app
-     * Registration application
-     */
-    public $registration_app;
-
-    /** @var string $registration_device
-     * Registration device
-     */
-    public $registration_device;
-
-    /** @var string $preferred_units
-     * Preferred units (mi, km)
-     */
-    public $preferred_units;
-
-    /** @var string $preferred_language
-     * Preferred language (en, fr)
-     */
-    public $preferred_language;
-
-    /** @var string $hide_routed_addresses
-     * If true, routed addresses will be hidden.
-     */
-    public $hide_routed_addresses;
-
-    /** @var string $show_superuser_addresses
-     * Show superuser addresses ('0', '1').
-     */
-    public $show_superuser_addresses;
-
-    /** @var string $appdirect_url
-     * Application direction URL
-     */
-    public $appdirect_url;
-
-    /** @var int $timestamp_trial_expiration
-     * Timestamp trial expiration
-     */
-    public $timestamp_trial_expiration;
-
-    /** @var string $update_channel_name
-     * Update channel name
-     */
-    public $update_channel_name;
-
-    /** @var int $max_subusers_cnt
-     * Maximum subusers count
-     */
-    public $max_subusers_cnt;
-
-    /** @var string $hide_visited_addresses
-     * If true, visited addresses will be hidden.
-     */
-    public $hide_visited_addresses;
-
-    /** @var string $HIDE_NONFUTURE_ROUTES
-     * If true, nonfuture routes will be hidden.
-     */
-    public $HIDE_NONFUTURE_ROUTES;
-
-    /** @var string $display_max_routes_future_days
-     * Display maximum routes future days ('0', '1').
-     */
-    public $display_max_routes_future_days;
-
-    /** @var string $READONLY_USER
-     * Readonly uer ('0', '1').
-     */
-    public $READONLY_USER;
-
-    /** @var int $auto_logout_ts
-     * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds.
-     */
-    public $auto_logout_ts;
+	/** @var boolean $authenticated
+	 * A boolean flag indicating if the session is valid.
+	 */
+	public $authenticated;
+
+	/** @var boolean $status
+	 * Process status
+	 */
+	public $status;
+
+	/** @var string $geocoding_service
+	 * Geocoding service
+	 */
+	public $geocoding_service;
+
+	/** @var string $session_id
+	 * The integer session id of the current session.
+	 */
+	public $session_id;
+
+	/** @var string $session_guid
+	 * An MD5 hash string of the currently authenticated sesssion,
+	 * important to use this with future requests.
+	 */
+	public $session_guid;
+
+	/** @var string $member_first_name
+	 * The first name of the user.
+	 */
+	public $member_first_name;
+
+	/** @var string $member_last_name
+	 * The last name of the user.
+	 */
+	public $member_last_name;
+
+	/** @var int $member_timestamp_added
+	 * The unix timestamp when the user joined the service.
+	 */
+	public $member_timestamp_added;
+
+	/** @var string $industry
+	 * The industry the authenticated user specified.
+	 */
+	public $industry;
+
+	/** @var int $member_id
+	 * Member ID
+	 */
+	public $member_id;
+
+	/** @var string $member_email
+	 * Member email
+	 */
+	public $member_email;
+
+	/** @var boolean $is_trial
+	 * If the user is currently a trial customer.
+	 */
+	public $is_trial;
+
+	/** @var boolean $is_active
+	 * If the user is currently an active customer.
+	 */
+	public $is_active;
+
+	/** @var string $api_key
+	 * User's API key
+	 */
+	public $api_key;
+
+	/** @var int $tracking_ttl
+	 * Tracking TTL
+	 */
+	public $tracking_ttl;
+
+	/** @var boolean $hide_billing_section
+	 * Hide billing section.
+	 */
+	public $hide_billing_section;
+
+	/** @var string $last_known_member_payment_device
+	 * Last known member payment device (e.g. 'web').
+	 */
+	public $last_known_member_payment_device;
+
+	/** @var array $licensed_modules
+	 * Licensed module. e.g.:
+	 * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
+	 * 'MODULE__VOICE_NAVIGATION:TRUE',
+	 * 'MODULE__VOICE_NAVIGATION'
+	 */
+	public $licensed_modules;
+
+	/** @var boolean $member_business_type
+	 * Member business type (e.g. 'BUSINESS_EMPLOYEE').
+	 */
+	public $member_business_type;
+
+	/** @var string $geofence_polygon_shape
+	 * Geofence polygon shape. Available values:
+	 * 'circle', 'poly', 'rect'.
+	 */
+	public $geofence_polygon_shape;
+
+	/** @var int $geofence_polygon_size
+	 * Geofence polygon size
+	 */
+	public $geofence_polygon_size;
+
+	/** @var int $geofence_time_onsite_trigger_secs
+	 * Geofence onsite trigger time (seconds).
+	 */
+	public $geofence_time_onsite_trigger_secs;
+
+	/** @var int $geofence_minimum_trigger_speed
+	 * Geofence's minimum trigger speed.
+	 */
+	public $geofence_minimum_trigger_speed;
+
+	/** @var bool $is_subscription_past_due
+	 * True if the subscription is past due.
+	 */
+	public $is_subscription_past_due;
+
+	/** @var string $visited_departed_enabled
+	 * If true, triggering of the visited and departed activities is enabled.
+	 */
+	public $visited_departed_enabled;
+
+	/** @var string $long_press_enabled
+	 * If true, long press is enabled.
+	 */
+	public $long_press_enabled;
+
+	/** @var int $account_type_id
+	 * The account type ID.
+	 */
+	public $account_type_id;
+
+	/** @var string $current_price
+	 * Current price (e.g. '0.000').
+	 */
+	public $current_price;
+
+	/** @var int $initially_requested_account_type_id
+	 * Initially Requested account type ID.
+	 */
+	public $initially_requested_account_type_id;
+
+	/** @var string $account_type_alias
+	 * Account type alias
+	 */
+	public $account_type_alias;
+
+	/** @var string $member_type
+	 * Member type. Available values:
+	 * PRIMARY_ACCOUNT, SUB_ACCOUNT_ADMIN, SUB_ACCOUNT_REGIONAL_MANAGER,
+	 * SUB_ACCOUNT_DISPATCHER, SUB_ACCOUNT_PLANNER, SUB_ACCOUNT_DRIVER,
+	 * SUB_ACCOUNT_ANALYSTSUB_ACCOUNT_VENDORSUB_ACCOUNT_CUSTOMER_SERVICE
+	 */
+	public $member_type;
+
+	/** @var string $OWNER_MEMBER_ID
+	 * Parent user ID.
+	 */
+	public $OWNER_MEMBER_ID;
+
+	/** @var string $ROOT_OWNER_MEMBER_ID
+	 * Root owner member ID (e.g. '402088').
+	 */
+	public $ROOT_OWNER_MEMBER_ID;
+
+	/** @var string $ROOT_OWNER_MEMBER_EMAIL
+	 * Root owner member email.
+	 */
+	public $ROOT_OWNER_MEMBER_EMAIL;
+
+	/** @var string $ROOT_OWNER_MEMBER_API_KEY
+	 * Root owner member API key.
+	 */
+	public $ROOT_OWNER_MEMBER_API_KEY;
+
+	/** @var string $geocodingMethod
+	 * Geocoding method
+	 */
+	public $geocodingMethod;
+
+	/** @var string $service_type
+	 * Service type (e.g. 'pre5').
+	 */
+	public $service_type;
+
+	/** @var string $validated_by
+	 * Validated by (e.g. 'ADMIN_PANEL').
+	 */
+	public $validated_by;
+
+	/** @var int $max_stops_per_route
+	 * Maximum allowed number of the stops per route.
+	 */
+	public $max_stops_per_route;
+
+	/** @var int $max_routes
+	 * Maximum allowed number of the generated routes.
+	 */
+	public $max_routes;
+
+	/** @var int $max_route
+	 * Maximum allowed number of the generated routes.
+	 */
+	public $max_route;
+
+	/** @var int $route_planned
+	 * Planned route numbers
+	 */
+	public $route_planned;
+
+	/** @var int $routes_planned
+	 * Routes Planned
+	 */
+	public $routes_planned;
+
+	/** @var int $total_routes_planned
+	 * Total planned routes.
+	 */
+	public $total_routes_planned;
+
+	/** @var int $authentication_count
+	 * Authentication count.
+	 */
+	public $authentication_count;
+
+	/** @var string $salesforce_unique_record_id
+	 * Salesforce unique record ID.
+	 */
+	public $salesforce_unique_record_id;
+
+	/** @var string $salesforce_account_id
+	 * Salesforce account ID
+	 */
+	public $salesforce_account_id;
+
+	/** @var string $salesforce_lead_id
+	 * Salesforce lead ID
+	 */
+	public $salesforce_lead_id;
+
+	/** @var int $max_api_optimization_addresses
+	 * The maximun number of addresses the authenticated user
+	 * can optimize in this billing cycle.
+	 */
+	public $max_api_optimization_addresses;
+
+	/** @var int $max_api_geocoding_addresses
+	 * The maximun number of geocodings the authenticated user
+	 * can optimize in this billing cycle.
+	 */
+	public $max_api_geocoding_addresses;
+
+	/** @var int $max_api_directions_addresses
+	 * The maximum number of driving route transactions the authenticated
+	 * user can execute in this billing cycle.
+	 */
+	public $max_api_directions_addresses;
+
+	/** @var int $max_api_validation_addresses
+	 * The maximun number of address validation transactions the authenticated
+	 * user can execute in this billing cycle.
+	 */
+	public $max_api_validation_addresses;
+
+	/** @var int $max_stops_per_unoptimized_route
+	 * The maximum number of stops the authenticated user
+	 * can put into a route with optimization disabled.
+	 */
+	public $max_stops_per_unoptimized_route;
+
+	/** @var int $max_api_distance_tx
+	 * The maximum number of distance transactions the authenticated
+	 * user can execute in this billing cycle.
+	 */
+	public $max_api_distance_tx;
+
+	/** @var boolean $blDisplayUpgradeTrackingHTML
+	 * Display upgrade tracking HTML.
+	 */
+	public $blDisplayUpgradeTrackingHTML;
+
+	/** @var int $intTrackingTrigger
+	 * Tracking trigger (int).
+	 */
+	public $intTrackingTrigger;
+
+	/** @var int $last_payment_ts
+	 * The last unix timestamp when this user was successfully charged.
+	 */
+	public $last_payment_ts;
+
+	/** @var int $last_failed_payment_ts
+	 * The last unix timestamp when this user was failed to pay.
+	 */
+	public $last_failed_payment_ts;
+
+	/** @var int $account_expires_timestamp
+	 * Account expire date
+	 */
+	public $account_expires_timestamp;
+
+	/** @var boolean $account_past_due
+	 * Account past due
+	 */
+	public $account_past_due;
+
+	/** @var string $ui_input_method
+	 * UI input method
+	 */
+	public $ui_input_method;
+
+	/** @var string $registration_app
+	 * Registration application
+	 */
+	public $registration_app;
+
+	/** @var string $registration_device
+	 * Registration device
+	 */
+	public $registration_device;
+
+	/** @var string $preferred_units
+	 * Preferred units (mi, km)
+	 */
+	public $preferred_units;
+
+	/** @var string $preferred_language
+	 * Preferred language (en, fr)
+	 */
+	public $preferred_language;
+
+	/** @var string $hide_routed_addresses
+	 * If true, routed addresses will be hidden.
+	 */
+	public $hide_routed_addresses;
+
+	/** @var string $show_superuser_addresses
+	 * Show superuser addresses ('0', '1').
+	 */
+	public $show_superuser_addresses;
+
+	/** @var string $appdirect_url
+	 * Application direction URL
+	 */
+	public $appdirect_url;
+
+	/** @var int $timestamp_trial_expiration
+	 * Timestamp trial expiration
+	 */
+	public $timestamp_trial_expiration;
+
+	/** @var string $update_channel_name
+	 * Update channel name
+	 */
+	public $update_channel_name;
+
+	/** @var int $max_subusers_cnt
+	 * Maximum subusers count
+	 */
+	public $max_subusers_cnt;
+
+	/** @var string $hide_visited_addresses
+	 * If true, visited addresses will be hidden.
+	 */
+	public $hide_visited_addresses;
+
+	/** @var string $HIDE_NONFUTURE_ROUTES
+	 * If true, nonfuture routes will be hidden.
+	 */
+	public $HIDE_NONFUTURE_ROUTES;
+
+	/** @var string $display_max_routes_future_days
+	 * Display maximum routes future days ('0', '1').
+	 */
+	public $display_max_routes_future_days;
+
+	/** @var string $READONLY_USER
+	 * Readonly uer ('0', '1').
+	 */
+	public $READONLY_USER;
+
+	/** @var int $auto_logout_ts
+	 * Time in seconds. A user will be logged out after been inactive during specified by this parameter seconds.
+	 */
+	public $auto_logout_ts;
 }