route4me / route4me-php-sdk

src/Route4Me/Members/MemberConfiguration.php

Indentation +106 added lines, -106 removed lines

@@ -13,152 +13,152 @@
 
 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);
+	}
 
-    public static function fromArray(array $params)
-    {
-        $memberConfiguration = new Self();
+	public static function fromArray(array $params)
+	{
+		$memberConfiguration = new Self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($memberConfiguration, $key)) {
-                $memberConfiguration->{$key} = $value;
-            } else {
-                throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($memberConfiguration, $key)) {
+				$memberConfiguration->{$key} = $value;
+			} else {
+				throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
+			}
+		}
 
-        return $memberConfiguration;
-    }
+		return $memberConfiguration;
+	}
 
-    /*
+	/*
     * 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;
+	}
 }
\ No newline at end of file

src/Route4Me/Members/ResultsResponseV4.php

Indentation +14 added lines, -14 removed lines

@@ -9,22 +9,22 @@
  */
 class ResultsResponseV4 extends \Route4Me\Common
 {
-    /** @var MemberResponseV4[] $results */
-    public $results;
+	/** @var MemberResponseV4[] $results */
+	public $results;
 
-    /** @var int $total */
-    public $total;
+	/** @var int $total */
+	public $total;
 
-    public static function fromArray(array $params)
-    {
-        $resultsResponseV4 = new self();
+	public static function fromArray(array $params)
+	{
+		$resultsResponseV4 = new self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($resultsResponseV4, $key)) {
-                $resultsResponseV4->{$key} = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($resultsResponseV4, $key)) {
+				$resultsResponseV4->{$key} = $value;
+			}
+		}
 
-        return $resultsResponseV4;
-    }
+		return $resultsResponseV4;
+	}
 }
\ No newline at end of file

src/Route4Me/Members/MemberResponseV4.php

Indentation +132 added lines, -132 removed lines

@@ -9,137 +9,137 @@
  */
 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;
-
-    public static function fromArray(array $params)
-    {
-        $memberResponseV4 = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($memberResponseV4, $key)) {
-                $memberResponseV4->{$key} = $value;
-            }
-        }
-
-        return $memberResponseV4;
-    }
+	/** @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;
+
+	public static function fromArray(array $params)
+	{
+		$memberResponseV4 = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($memberResponseV4, $key)) {
+				$memberResponseV4->{$key} = $value;
+			}
+		}
+
+		return $memberResponseV4;
+	}
 
 }
\ No newline at end of file

src/Route4Me/Members/Member.php

Indentation +356 added lines, -356 removed lines

@@ -8,360 +8,360 @@
 
 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 fromArray(array $params)
-    {
-        $member = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($member, $key)) {
-                $member->{$key} = $value;
-            }
-        }
-
-        return $member;
-    }
-
-    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 fromArray(array $params)
+	{
+		$member = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($member, $key)) {
+				$member->{$key} = $value;
+			}
+		}
+
+		return $member;
+	}
+
+	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/Constants.php

Indentation +2 added lines, -2 removed lines

@@ -6,6 +6,6 @@
 
 class Constants
 {
-    const API_KEY = '11111111111111111111111111111111';
-    const DEMO_API_KEY = '11111111111111111111111111111111';
+	const API_KEY = '11111111111111111111111111111111';
+	const DEMO_API_KEY = '11111111111111111111111111111111';
 }
\ No newline at end of file

src/Route4Me/RouteParameters.php

Indentation +528 added lines, -528 removed lines

@@ -11,532 +11,532 @@
  */
 class RouteParameters extends Common
 {
-    /**
-     * Let the R4M API know if this SDK request is comming
-     * from a file upload within your environment (for analytics).
-     * @var Boolean
-     */
-    public $is_upload;
-
-    /**
-     * The tour type of this route. rt is short for round trip,
-     * the optimization engine changes its behavior for round trip
-     * @var Boolean
-     */
-    public $rt;
-
-    /**
-     * The name of this route. this route name will be accessible in the search API,
-     * and also will be displayed on the mobile device of a user.
-     * @var string
-     */
-    public $route_name;
-
-    /**
-     * The route start date in UTC, unix timestamp seconds.
-     * Used to show users when the route will begin, also used for reporting and analytics.
-     * @var integer
-     */
-    public $route_date;
-
-    /**
-     * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9)
-     * @var integer
-     */
-    public $route_time;
-
-    /**
-     * @deprecated 'Always false'
-     * @var string
-     */
-    public $shared_publicly;
-
-    /**
-     * By disabling optimization, the route optimization engine
-     * will not resequence the stops in your.
-     * @var disable_optimization
-     */
-    public $disable_optimization;
-
-    /**
-     * Gets or sets the optimize parameter.<br>
-     * Availabale values:
-     * - Distance,
-     * - Time,
-     * - timeWithTraffic
-     * @var string
-     */
-    public $optimize;
-
-    /**
-     * When the tour type is not round trip (rt = false),
-     * enable lock last so that the final destination is fixed.
-     * @var Boolean
-     */
-    public $lock_last;
-
-    /**
-     * Vehicle capacity.
-     * @var integer
-     */
-    public $vehicle_capacity;
-
-    /**
-     * Maximum distance for a single vehicle in the route (always in miles)
-     * @var integer
-     */
-    public $vehicle_max_distance_mi;
-
-    /**
-     * The distance measurement unit for the route.
-     * km or mi, the route4me api will convert all measurements into these units.
-     * @var string
-     */
-    public $distance_unit;
-
-    /**
-     * The mode of travel that the directions should be optimized for.<br>
-     *  Available values:
-     * - Driving
-     * - Walking
-     * @var string
-     */
-    public $travel_mode;
-
-    /**
-     * Options which let the user choose which road obstacles to avoid.<br>
-     * This has no impact on route sequencing.<br>
-     * Available values:
-     * - Highways
-     * - Tolls
-     * - minimizeHighways
-     * - minimizeTolls
-     * - highways,tolls
-     * - "".
-     * @var string
-     */
-    public $avoid;
-
-    /**
-     * The vehicle ID
-     * @var string
-     */
-    public $vehicle_id;
-
-    /**
-     * The latitude of the device making this sdk request.
-     * @var double
-     */
-    public $dev_lat;
-
-    /**
-     * The longitude of the device making this sdk request.
-     * @var double
-     */
-    public $dev_lng;
-
-    /**
-     * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br>
-     * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br>
-     * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded.
-     * @var long
-     */
-    public $route_max_duration;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by route duration.
-     * @var double
-     */
-    public $target_duration;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by route distance.
-     * @var double
-     */
-    public $target_distance;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by waiting time.
-     * @var double
-     */
-    public $target_wait_by_tail_size;
-
-    /**
-     * The email address to notify upon completion of an optimization request.
-     * @var string
-     */
-    public $route_email;
-
-    /**
-     * @deprecated All routes are stored by default at this time
-     * @var
-     */
-    public $store_route = true;
-
-    /**
-     * Metric system
-     * @see Enum\Metric
-     * @var integer
-     */
-    public $metric;
-
-    /**
-     * The algorithm type to use when optimizing the route.
-     * @see Enum\AlgorithmType
-     * @var integer
-     */
-    public $algorithm_type;
-
-    /**
-     * The route owner's member ID.<br>
-     * In order for users in your organization to have routes assigned to them,
-     * you must provide their member ID within the Route4Me system.<br>
-     * A list of member IDs can be retrieved with view_users API method.
-     * @var integer
-     */
-    public $member_id;
-
-    /**
-     * Specify the ip address of the remote user making this optimization request.
-     * @var long
-     */
-    public $ip;
-
-    /**
-     * The method to use when compute the distance between the points in a route.<br>
-     * Available values: from 1 to 12.
-     * @var integer
-     */
-    public $dm;
-
-    /**
-     * Directions method.
-     * @var integer
-     */
-    public $dirm;
-
-    /**
-     * Legacy feature which permits a user to request an example number of optimized routes.
-     * @var integer
-     */
-    public $parts;
-
-    /**
-     * 32 Character MD5 String ID of the device that was used to plan this route.
-     * @deprecated Always null
-     * @var string
-     */
-    public $device_id;
-
-    /**
-     * The type of device making this request.
-     * @see Enum\DeviceType
-     * @var string
-     */
-    public $device_type;
-
-    /**
-     * If true, the vehicle has a trailer.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance so that road directions generated do not take the vehicle
-     * where trailers are prohibited.
-     * @var Boolean
-     */
-    public $has_trailer;
-
-    /**
-     * The vehicle's trailer weight.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance so that road directions generated do not take the vehicle<br>
-     * on roads where the weight of the vehicle in tons exceeds this value.
-     * @var double
-     */
-    public $trailer_weight_t;
-
-    /**
-     * If travel_mode is Trucking, specifies the truck weight.
-     * @var double
-     */
-    public $limited_weight_t;
-
-    /**
-     * The vehicle's weight per axle (tons)
-     * @var double
-     */
-    public $weight_per_axle_t;
-
-    /**
-     * Comma-delimited list of the truck hazardous goods.
-     * @var string
-     */
-    public $truck_hazardous_goods;
-
-    /**
-     * Truck axles number.
-     * @var integer
-     */
-    public $truck_axles;
-
-    /**
-     * Truck toll road usage. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_toll_road_usage;
-
-    /**
-     * Truck avoid ferries. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_avoid_ferries;
-
-    /**
-     * Truck highway only. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_hwy_only;
-
-    /**
-     * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_lcv;
-
-    /**
-     * Avoid international borders. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_borders;
-
-    /**
-     * Truck side street adherence.<br>
-     *  enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"]
-     * @var string
-     */
-    public $truck_side_street_adherence;
-
-    /**
-     * Truck configuration.
-     * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK",
-     * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"]
-     * @var string
-     */
-    public $truck_config;
-
-    /**
-     * Truck dimension unit. enum: ["mi","km"]
-     * @var string
-     */
-    public $truck_dim_unit;
-
-    /**
-     * Truck type.
-     *  enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal",
-     * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"]
-     * @var string
-     */
-    public $truck_type;
-
-    /**
-     * If travel_mode = 'Trucking', specifies the truck weight (required)
-     * @var double
-     */
-    public $truck_weight;
-
-    /**
-     * Maximum cargo weight a vehicle can cary.
-     * @var double
-     */
-    public $vehicle_max_cargo_weight;
-
-    /**
-     * Maximum cargo volume a vehicle can cary.
-     * @var double
-     */
-    public $vehicle_max_cargo_volume;
-
-    /**
-     * Maximum allowed revenue from a subtour.
-     * @var integer
-     */
-    public $subtour_max_revenue;
-
-    /**
-     * An array of the Avoidance zones IDs.
-     * @var string[]
-     */
-    public $avoidance_zones = [];
-
-    /**
-     * The vehicle ID, to be assigned to the route.
-     * @deprecated All new routes should be assigned to a member_id
-     * @var string
-     */
-    public $driver_id;
-
-    /**
-     * Minimum number of optimized routes.
-     * @var integer
-     */
-    public $parts_min;
-
-    /**
-     * If true, the vehicle will first drive then wait between stops.
-     * @var Boolean
-     */
-    public $first_drive_then_wait_between_stops;
-
-    /**
-     * The truck height.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance of this maximum height of truck when generating
-     * road network driving directions.
-     * @var double
-     */
-    public $truck_height;
-
-    /**
-     * The truck width.<br>
-     * For routes that have trucking directions enabled, directions generated
-     * will ensure compliance of this width of the truck when generating road network
-     * driving directions.
-     * @var double
-     */
-    public $truck_width;
-
-    /**
-     * The truck length.<br>
-     * For routes that have trucking directions enabled, directions generated
-     * will ensure compliance of this length of the truck when generating
-     * road network driving directions.
-     * @var double
-     */
-    public $truck_length;
-
-    /**
-     * The optimization quality.<br>
-     * Available values:
-     * - 1 - Generate Optimized Routes As Quickly as Possible;
-     * - 2 - Generate Routes That Look Better On A Map;
-     * - 3 - Generate The Shortest And Quickest Possible Routes.
-     * @var integer
-     */
-    public $optimization_quality;
-
-    /**
-     * The maximum number of stops permitted per created subroute.
-     * @var integer
-     */
-    public $max_tour_size;
-
-    /**
-     * The minimum number of stops permitted per created subroute.
-     * @var integer
-     */
-    public $min_tour_size;
-
-    /**
-     * If equal to 1, uturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $uturn;
-
-    /**
-     * If equal to 1, leftturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $leftturn;
-
-    /**
-     * If equal to 1, rightturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $rightturn;
-
-    /**
-     * Route travel time slowdown (e.g. 25 (means 25% slowdown)).
-     * @note the parameter is read-only and it can be set
-     * with the parameter Slowdowns.TravelTime.
-     * @var integer
-     */
-    public $route_time_multiplier;
-
-    /**
-     * Route service time slowdown (e.g. 10 (means 10% slowdown)).
-     * @note the parameter is read-only and it can be set
-     * with the parameter Slowdowns.TravelTime.
-     * @var integer
-     */
-    public $route_service_time_multiplier;
-
-    /**
-     * Optimization engine (e.g. '1','2' etc)
-     * @var string
-     */
-    public $optimization_engine;
-
-    /**
-     * Override addresses
-     * @var OverrideAddresses
-     */
-    public $override_addresses;
-
-    /**
-     * Address bundling rules
-     * @var V5\Addresses\AddressBundling
-     */
-    public $bundling;
-
-    /**
-     * Advanced route constraints
-     * @var RouteAdvancedConstraints
-     */
-    public $advanced_constraints = [];
-
-    /**
-     * If true, the time windows ignored.
-     * @var Boolean
-     */
-    public $ignore_tw;
-
-    /**
-     * If true, the start time is dynamic.
-     * @var Boolean
-     */
-    public $is_dynamic_start_time;
-
-    /**
-     * @deprecated The parameter 'route_type' isn't included in route parameters.
-     * @var string
-     */
-    public $route_type;
-
-    /**
-     * Slowdown of the optimization parameters.
-     * @note This is only query parameter.
-     * @note This parameter is used in the optimization creation/generation process.
-     * @var SlowdownParams
-     */
-    public $slowdowns;
-
-    public static function fromArray(array $params)
-    {
-        $routeParams = new self();
-        foreach ($params as $key => $value) {
-            if (property_exists($routeParams, $key)) {
-                $routeParams->{$key} = $value;
-            }
-        }
-
-        return $routeParams;
-    }
-
-    public function setAddressBundle($addressBundle)
-    {
-        $this->bundling = $addressBundle;
-    }
-
-    public function getAddressBundle()
-    {
-        return $this->bundling;
-    }
+	/**
+	 * Let the R4M API know if this SDK request is comming
+	 * from a file upload within your environment (for analytics).
+	 * @var Boolean
+	 */
+	public $is_upload;
+
+	/**
+	 * The tour type of this route. rt is short for round trip,
+	 * the optimization engine changes its behavior for round trip
+	 * @var Boolean
+	 */
+	public $rt;
+
+	/**
+	 * The name of this route. this route name will be accessible in the search API,
+	 * and also will be displayed on the mobile device of a user.
+	 * @var string
+	 */
+	public $route_name;
+
+	/**
+	 * The route start date in UTC, unix timestamp seconds.
+	 * Used to show users when the route will begin, also used for reporting and analytics.
+	 * @var integer
+	 */
+	public $route_date;
+
+	/**
+	 * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9)
+	 * @var integer
+	 */
+	public $route_time;
+
+	/**
+	 * @deprecated 'Always false'
+	 * @var string
+	 */
+	public $shared_publicly;
+
+	/**
+	 * By disabling optimization, the route optimization engine
+	 * will not resequence the stops in your.
+	 * @var disable_optimization
+	 */
+	public $disable_optimization;
+
+	/**
+	 * Gets or sets the optimize parameter.<br>
+	 * Availabale values:
+	 * - Distance,
+	 * - Time,
+	 * - timeWithTraffic
+	 * @var string
+	 */
+	public $optimize;
+
+	/**
+	 * When the tour type is not round trip (rt = false),
+	 * enable lock last so that the final destination is fixed.
+	 * @var Boolean
+	 */
+	public $lock_last;
+
+	/**
+	 * Vehicle capacity.
+	 * @var integer
+	 */
+	public $vehicle_capacity;
+
+	/**
+	 * Maximum distance for a single vehicle in the route (always in miles)
+	 * @var integer
+	 */
+	public $vehicle_max_distance_mi;
+
+	/**
+	 * The distance measurement unit for the route.
+	 * km or mi, the route4me api will convert all measurements into these units.
+	 * @var string
+	 */
+	public $distance_unit;
+
+	/**
+	 * The mode of travel that the directions should be optimized for.<br>
+	 *  Available values:
+	 * - Driving
+	 * - Walking
+	 * @var string
+	 */
+	public $travel_mode;
+
+	/**
+	 * Options which let the user choose which road obstacles to avoid.<br>
+	 * This has no impact on route sequencing.<br>
+	 * Available values:
+	 * - Highways
+	 * - Tolls
+	 * - minimizeHighways
+	 * - minimizeTolls
+	 * - highways,tolls
+	 * - "".
+	 * @var string
+	 */
+	public $avoid;
+
+	/**
+	 * The vehicle ID
+	 * @var string
+	 */
+	public $vehicle_id;
+
+	/**
+	 * The latitude of the device making this sdk request.
+	 * @var double
+	 */
+	public $dev_lat;
+
+	/**
+	 * The longitude of the device making this sdk request.
+	 * @var double
+	 */
+	public $dev_lng;
+
+	/**
+	 * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br>
+	 * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br>
+	 * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded.
+	 * @var long
+	 */
+	public $route_max_duration;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by route duration.
+	 * @var double
+	 */
+	public $target_duration;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by route distance.
+	 * @var double
+	 */
+	public $target_distance;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by waiting time.
+	 * @var double
+	 */
+	public $target_wait_by_tail_size;
+
+	/**
+	 * The email address to notify upon completion of an optimization request.
+	 * @var string
+	 */
+	public $route_email;
+
+	/**
+	 * @deprecated All routes are stored by default at this time
+	 * @var
+	 */
+	public $store_route = true;
+
+	/**
+	 * Metric system
+	 * @see Enum\Metric
+	 * @var integer
+	 */
+	public $metric;
+
+	/**
+	 * The algorithm type to use when optimizing the route.
+	 * @see Enum\AlgorithmType
+	 * @var integer
+	 */
+	public $algorithm_type;
+
+	/**
+	 * The route owner's member ID.<br>
+	 * In order for users in your organization to have routes assigned to them,
+	 * you must provide their member ID within the Route4Me system.<br>
+	 * A list of member IDs can be retrieved with view_users API method.
+	 * @var integer
+	 */
+	public $member_id;
+
+	/**
+	 * Specify the ip address of the remote user making this optimization request.
+	 * @var long
+	 */
+	public $ip;
+
+	/**
+	 * The method to use when compute the distance between the points in a route.<br>
+	 * Available values: from 1 to 12.
+	 * @var integer
+	 */
+	public $dm;
+
+	/**
+	 * Directions method.
+	 * @var integer
+	 */
+	public $dirm;
+
+	/**
+	 * Legacy feature which permits a user to request an example number of optimized routes.
+	 * @var integer
+	 */
+	public $parts;
+
+	/**
+	 * 32 Character MD5 String ID of the device that was used to plan this route.
+	 * @deprecated Always null
+	 * @var string
+	 */
+	public $device_id;
+
+	/**
+	 * The type of device making this request.
+	 * @see Enum\DeviceType
+	 * @var string
+	 */
+	public $device_type;
+
+	/**
+	 * If true, the vehicle has a trailer.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance so that road directions generated do not take the vehicle
+	 * where trailers are prohibited.
+	 * @var Boolean
+	 */
+	public $has_trailer;
+
+	/**
+	 * The vehicle's trailer weight.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance so that road directions generated do not take the vehicle<br>
+	 * on roads where the weight of the vehicle in tons exceeds this value.
+	 * @var double
+	 */
+	public $trailer_weight_t;
+
+	/**
+	 * If travel_mode is Trucking, specifies the truck weight.
+	 * @var double
+	 */
+	public $limited_weight_t;
+
+	/**
+	 * The vehicle's weight per axle (tons)
+	 * @var double
+	 */
+	public $weight_per_axle_t;
+
+	/**
+	 * Comma-delimited list of the truck hazardous goods.
+	 * @var string
+	 */
+	public $truck_hazardous_goods;
+
+	/**
+	 * Truck axles number.
+	 * @var integer
+	 */
+	public $truck_axles;
+
+	/**
+	 * Truck toll road usage. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_toll_road_usage;
+
+	/**
+	 * Truck avoid ferries. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_avoid_ferries;
+
+	/**
+	 * Truck highway only. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_hwy_only;
+
+	/**
+	 * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_lcv;
+
+	/**
+	 * Avoid international borders. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_borders;
+
+	/**
+	 * Truck side street adherence.<br>
+	 *  enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"]
+	 * @var string
+	 */
+	public $truck_side_street_adherence;
+
+	/**
+	 * Truck configuration.
+	 * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK",
+	 * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"]
+	 * @var string
+	 */
+	public $truck_config;
+
+	/**
+	 * Truck dimension unit. enum: ["mi","km"]
+	 * @var string
+	 */
+	public $truck_dim_unit;
+
+	/**
+	 * Truck type.
+	 *  enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal",
+	 * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"]
+	 * @var string
+	 */
+	public $truck_type;
+
+	/**
+	 * If travel_mode = 'Trucking', specifies the truck weight (required)
+	 * @var double
+	 */
+	public $truck_weight;
+
+	/**
+	 * Maximum cargo weight a vehicle can cary.
+	 * @var double
+	 */
+	public $vehicle_max_cargo_weight;
+
+	/**
+	 * Maximum cargo volume a vehicle can cary.
+	 * @var double
+	 */
+	public $vehicle_max_cargo_volume;
+
+	/**
+	 * Maximum allowed revenue from a subtour.
+	 * @var integer
+	 */
+	public $subtour_max_revenue;
+
+	/**
+	 * An array of the Avoidance zones IDs.
+	 * @var string[]
+	 */
+	public $avoidance_zones = [];
+
+	/**
+	 * The vehicle ID, to be assigned to the route.
+	 * @deprecated All new routes should be assigned to a member_id
+	 * @var string
+	 */
+	public $driver_id;
+
+	/**
+	 * Minimum number of optimized routes.
+	 * @var integer
+	 */
+	public $parts_min;
+
+	/**
+	 * If true, the vehicle will first drive then wait between stops.
+	 * @var Boolean
+	 */
+	public $first_drive_then_wait_between_stops;
+
+	/**
+	 * The truck height.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance of this maximum height of truck when generating
+	 * road network driving directions.
+	 * @var double
+	 */
+	public $truck_height;
+
+	/**
+	 * The truck width.<br>
+	 * For routes that have trucking directions enabled, directions generated
+	 * will ensure compliance of this width of the truck when generating road network
+	 * driving directions.
+	 * @var double
+	 */
+	public $truck_width;
+
+	/**
+	 * The truck length.<br>
+	 * For routes that have trucking directions enabled, directions generated
+	 * will ensure compliance of this length of the truck when generating
+	 * road network driving directions.
+	 * @var double
+	 */
+	public $truck_length;
+
+	/**
+	 * The optimization quality.<br>
+	 * Available values:
+	 * - 1 - Generate Optimized Routes As Quickly as Possible;
+	 * - 2 - Generate Routes That Look Better On A Map;
+	 * - 3 - Generate The Shortest And Quickest Possible Routes.
+	 * @var integer
+	 */
+	public $optimization_quality;
+
+	/**
+	 * The maximum number of stops permitted per created subroute.
+	 * @var integer
+	 */
+	public $max_tour_size;
+
+	/**
+	 * The minimum number of stops permitted per created subroute.
+	 * @var integer
+	 */
+	public $min_tour_size;
+
+	/**
+	 * If equal to 1, uturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $uturn;
+
+	/**
+	 * If equal to 1, leftturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $leftturn;
+
+	/**
+	 * If equal to 1, rightturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $rightturn;
+
+	/**
+	 * Route travel time slowdown (e.g. 25 (means 25% slowdown)).
+	 * @note the parameter is read-only and it can be set
+	 * with the parameter Slowdowns.TravelTime.
+	 * @var integer
+	 */
+	public $route_time_multiplier;
+
+	/**
+	 * Route service time slowdown (e.g. 10 (means 10% slowdown)).
+	 * @note the parameter is read-only and it can be set
+	 * with the parameter Slowdowns.TravelTime.
+	 * @var integer
+	 */
+	public $route_service_time_multiplier;
+
+	/**
+	 * Optimization engine (e.g. '1','2' etc)
+	 * @var string
+	 */
+	public $optimization_engine;
+
+	/**
+	 * Override addresses
+	 * @var OverrideAddresses
+	 */
+	public $override_addresses;
+
+	/**
+	 * Address bundling rules
+	 * @var V5\Addresses\AddressBundling
+	 */
+	public $bundling;
+
+	/**
+	 * Advanced route constraints
+	 * @var RouteAdvancedConstraints
+	 */
+	public $advanced_constraints = [];
+
+	/**
+	 * If true, the time windows ignored.
+	 * @var Boolean
+	 */
+	public $ignore_tw;
+
+	/**
+	 * If true, the start time is dynamic.
+	 * @var Boolean
+	 */
+	public $is_dynamic_start_time;
+
+	/**
+	 * @deprecated The parameter 'route_type' isn't included in route parameters.
+	 * @var string
+	 */
+	public $route_type;
+
+	/**
+	 * Slowdown of the optimization parameters.
+	 * @note This is only query parameter.
+	 * @note This parameter is used in the optimization creation/generation process.
+	 * @var SlowdownParams
+	 */
+	public $slowdowns;
+
+	public static function fromArray(array $params)
+	{
+		$routeParams = new self();
+		foreach ($params as $key => $value) {
+			if (property_exists($routeParams, $key)) {
+				$routeParams->{$key} = $value;
+			}
+		}
+
+		return $routeParams;
+	}
+
+	public function setAddressBundle($addressBundle)
+	{
+		$this->bundling = $addressBundle;
+	}
+
+	public function getAddressBundle()
+	{
+		return $this->bundling;
+	}
 }

src/Route4Me/Exception/myErrorHandler.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 class myErrorHandler extends \Exception
 {
-    public function proc_error($errno, $errstr, $errfile, $errline)
-    {
-        echo "Error No: $errno,  line: $errline --- ".$errstr.'<br>';
-    }
+	public function proc_error($errno, $errstr, $errfile, $errline)
+	{
+		echo "Error No: $errno,  line: $errline --- ".$errstr.'<br>';
+	}
 }

src/Route4Me/Geocoding.php

Indentation +78 added lines, -78 removed lines

@@ -6,109 +6,109 @@
 
 class Geocoding extends Common
 {
-    public $strExportFormat;
-    public $format;
-    public $addresses;
-    public $pk;
-    public $offset;
-    public $limit;
-    public $housenumber;
-    public $zipcode;
+	public $strExportFormat;
+	public $format;
+	public $addresses;
+	public $pk;
+	public $offset;
+	public $limit;
+	public $housenumber;
+	public $zipcode;
 
-    public static function fromArray(array $params)
-    {
-        $geocoding = new self();
+	public static function fromArray(array $params)
+	{
+		$geocoding = new self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($geocoding, $key)) {
-                $geocoding->{$key} = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($geocoding, $key)) {
+				$geocoding->{$key} = $value;
+			}
+		}
 
-        return $geocoding;
-    }
+		return $geocoding;
+	}
 
-    public static function forwardGeocoding($params)
-    {
-        $allBodyFields = ['strExportFormat', 'addresses'];
+	public static function forwardGeocoding($params)
+	{
+		$allBodyFields = ['strExportFormat', 'addresses'];
 
-        $fgCoding = Route4Me::makeRequst([
-            'url'           => Endpoint::GEOCODER,
-            'method'        => 'POST',
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$fgCoding = Route4Me::makeRequst([
+			'url'           => Endpoint::GEOCODER,
+			'method'        => 'POST',
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $fgCoding;
-    }
+		return $fgCoding;
+	}
 
-    public static function reverseGeocoding($params)
-    {
-        $allQueryFields = ['format', 'addresses', 'detailed'];
+	public static function reverseGeocoding($params)
+	{
+		$allQueryFields = ['format', 'addresses', 'detailed'];
 
-        $fgcoding = Route4Me::makeRequst([
-            'url'       => Endpoint::GEOCODER,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+		$fgcoding = Route4Me::makeRequst([
+			'url'       => Endpoint::GEOCODER,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $fgcoding;
-    }
+		return $fgcoding;
+	}
 
-    public static function getStreetData($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA);
+	public static function getStreetData($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA);
 
-        $allPathFields = ['pk', 'offset', 'limit'];
+		$allPathFields = ['pk', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 
-    public static function getZipCode($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE);
+	public static function getZipCode($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE);
 
-        $allPathFields = ['zipcode', 'offset', 'limit'];
+		$allPathFields = ['zipcode', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 
-    public static function getService($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE);
+	public static function getService($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE);
 
-        $allPathFields = ['zipcode', 'housenumber', 'offset', 'limit'];
+		$allPathFields = ['zipcode', 'housenumber', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 }

src/Route4Me/Schedule/ScheduleMonthly.php

Indentation +20 added lines, -20 removed lines

@@ -11,27 +11,27 @@
  */
 class ScheduleMonthly extends Common
 {
-    /**
-     * Repeat every month next 'Every' days.
-     * @var integer
-     */
-    public $every;
+	/**
+	 * Repeat every month next 'Every' days.
+	 * @var integer
+	 */
+	public $every;
 
-    /**
-     * Monthly schedule mode
-     * @var string
-     */
-    public $mode;
+	/**
+	 * Monthly schedule mode
+	 * @var string
+	 */
+	public $mode;
 
-    /**
-     * An array of month days for monthly schedule if the mode 'dates' was chosen.
-     * @var integer[]
-     */
-    public $dates = [];
+	/**
+	 * An array of month days for monthly schedule if the mode 'dates' was chosen.
+	 * @var integer[]
+	 */
+	public $dates = [];
 
-    /**
-     * Monthly schedule option if the mode 'nth' was chosen.
-     * @var ScheduleMonthlyNth
-     */
-    public $nth;
+	/**
+	 * Monthly schedule option if the mode 'nth' was chosen.
+	 * @var ScheduleMonthlyNth
+	 */
+	public $nth;
 }
\ No newline at end of file