route4me / route4me-php-sdk

src/Route4Me/V5/AccountProfile.php

Indentation +25 added lines, -25 removed lines

@@ -9,33 +9,33 @@
  */
 class AccountProfile extends Common
 {
-    /**
-     * Account profile email
-     * @var type string
-     */
-    public $email;
+	/**
+	 * Account profile email
+	 * @var type string
+	 */
+	public $email;
     
-    /**
-     * Account member ID
-     * @var type integer
-     */
-    public $member_id;
+	/**
+	 * Account member ID
+	 * @var type integer
+	 */
+	public $member_id;
     
-    /**
-     * Account API key
-     * @var type string
-     */
-    public $api_key;
+	/**
+	 * Account API key
+	 * @var type string
+	 */
+	public $api_key;
     
-    /**
-     * Account root member ID
-     * @var type integer
-     */
-    public $root_member_id;
+	/**
+	 * Account root member ID
+	 * @var type integer
+	 */
+	public $root_member_id;
     
-    /**
-     * Preferred units of the account.
-     * @var type string
-     */
-    public $preferred_units;
+	/**
+	 * Preferred units of the account.
+	 * @var type string
+	 */
+	public $preferred_units;
 }

src/Route4Me/V5/Country.php

Indentation +15 added lines, -15 removed lines

@@ -9,21 +9,21 @@
  */
 class Country extends Common
 {
-    /**
-     * Country ID
-     * @var type string
-     */
-    public $id;
+	/**
+	 * Country ID
+	 * @var type string
+	 */
+	public $id;
     
-    /**
-     * Country code
-     * @var type string
-     */
-    public $country_code;
+	/**
+	 * Country code
+	 * @var type string
+	 */
+	public $country_code;
     
-    /**
-     * Country name
-     * @var type string
-     */
-    public $country_name;
+	/**
+	 * Country name
+	 * @var type string
+	 */
+	public $country_name;
 }

src/Route4Me/V5/AddressBook/AddressBook.php

Indentation +922 added lines, -922 removed lines

@@ -20,926 +20,926 @@
  */
 class AddressBook extends Common
 {
-    public function __construct()
-    {
-        Route4Me::setBaseUrl('');
-    }
-
-    /**
-     * Get all Addresses filtered by specifying the corresponding query parameters.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   string [fields]                   - Comma-delimited list of the address
-     *                                       fields to be included into the search results
-     *                                       e.g., 'address_id, address_alias, address_1'.
-     *   string [display = 'all']          - Specify which Addresses to show in the
-     *                                       corresponding query results.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *   string [query]                    - Search in the Addresses by the
-     *                                       corresponding query phrase.
-     *   int    [limit]                    - Limit of the queried records number.
-     *   int    [offset]                   - Offset from the beginning of the queried records.
-     * @return ResponseAll
-     * @throws Exception\ApiError
-     */
-    public function getAddresses(?array $options = null) : ResponseAll
-    {
-        $allQueryFields = ['fields', 'display', 'query', 'limit', 'offset'];
-
-        return $this->toResponseAll(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_ALL,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
-        ]));
-    }
-
-    /**
-     * Get all Addresses filtered and sorted by sending the corresponding body payload, with
-     * the option to search by the specified areas.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   array  [fields = []]              - An array of the fields to be included
-     *                                       in the search result.
-     *                                       e.g., ['address_id', 'address_alias', 'address_1'].
-     *   array  [filter]                   - FIlter parameters
-     *     string [query]                  - Query string.
-     *     array  [selected_areas]         - Selected areas
-     *       string [type]                 - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *       array  [value]                - Area parameters.
-     *         e.g.,
-     *         'type' => 'circle',
-     *         'value' => [
-     *             'center' => ['lat' => 40, 'lng' => 80],
-     *             'distance' => 1000
-     *         ]
-     *
-     *         'type' => 'polygon',
-     *         'value' => [
-     *             'points' => [[74, 40], [88, 30], [90, 25]]
-     *         ]
-     *
-     *         'type' => 'rect',
-     *         'value' => [
-     *             'top_left' => [50, 90],
-     *             'bottom_right' => [48, 70]
-     *         ]
-     *
-     *     array  [bounding_box]           - Coordinates of bounding box
-     *       float [top]                   - Top
-     *       float [left]                  - Left
-     *       float [bottom                 - Bottom
-     *       float [right]                 - Right
-     *
-     *     array  [center]                 - GPS coordinates of central point.
-     *       float [lat]                   - Latitude.
-     *       float [lng]                   - Longitude.
-     *     float  [distance]               - Distance from the area center.
-     *     string [display]                - Display option of the contacts.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *     float  [assigned_member_id]     - A member the contact assigned to.
-     *     float  [is_assigned]            - If true, the contact assigned to a member.
-     *   array  [order_by]                 - Array of order fields
-     *                                       You can sort the results using the specified fields:
-     *                                       address_1, address_alias, first_name, last_name,
-     *                                       address_phone_number, address_email, address_group,
-     *                                       in_route_count, visited_count, last_visited_timestamp,
-     *                                       last_routed_timestamp
-     *                                       e.g., [["address_1", "asc"], ["last_name", "desc"]]
-     *
-     *   int    [limit]                    - Limit of the queried records number.
-     *   int    [offset]                   - Offset from the beginning of the queried records.
-     * @return ResponseAll
-     * @throws Exception\ApiError
-     */
-    public function getAddressesByBodyPayload(?array $options = null) : ResponseAll
-    {
-        $allBodyFields = ['fields', 'filter', 'order_by', 'limit', 'offset'];
-
-        return $this->toResponseAll(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_ALL,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
-        ]));
-    }
-
-    /**
-     * Get a paginated list of all Addresses.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   string [fields]                   - Comma-delimited list of the address
-     *                                       fields to be included into the search results
-     *                                       e.g., 'address_id, address_alias, address_1'.
-     *   string [display = 'all']          - Specify which Addresses to show in the
-     *                                       corresponding query results.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *   string [query]                    - Search in the Addresses by the
-     *                                       corresponding query phrase.
-     *   int    [page = 1]                 - Requested page.
-     *   int    [per_page = 30]            - Number of Addresses per page.
-     * @return ResponsePagination
-     * @throws Exception\ApiError
-     */
-    public function getAddressesPaginated(?array $options = null) : ResponsePagination
-    {
-        $allQueryFields = ['fields', 'display', 'query', 'page', 'per_page'];
-
-        return $this->toResponsePagination(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_PAGINATION,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
-        ]));
-    }
-
-    /**
-     * Get the paginated list of all Addresses filtered and sorted by sending the corresponding
-     * body payload, with the option to search by the specified areas.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   array  [fields = []]              - An array of the fields to be included
-     *                                       in the search result.
-     *                                       e.g., ['address_id', 'address_alias', 'address_1'].
-     *   array  [filter]                   - FIlter parameters
-     *     string [query]                  - Query string.
-     *     array  [selected_areas]         - Selected areas
-     *       string [type]                 - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *       array  [value]                - Area parameters.
-     *         e.g.,
-     *         'type' => 'circle',
-     *         'value' => [
-     *             'center' => ['lat' => 40, 'lng' => 80],
-     *             'distance' => 1000
-     *         ]
-     *
-     *         'type' => 'polygon',
-     *         'value' => [
-     *             'points' => [[74, 40], [88, 30], [90, 25]]
-     *         ]
-     *
-     *         'type' => 'rect',
-     *         'value' => [
-     *             'top_left' => [50, 90],
-     *             'bottom_right' => [48, 70]
-     *         ]
-     *
-     *     array  [bounding_box]           - Coordinates of bounding box
-     *       float [top]                   - Top
-     *       float [left]                  - Left
-     *       float [bottom                 - Bottom
-     *       float [right]                 - Right
-     *
-     *     array  [center]                 - GPS coordinates of central point.
-     *       float [lat]                   - Latitude.
-     *       float [lng]                   - Longitude.
-     *     float  [distance]               - Distance from the area center.
-     *     string [display]                - Display option of the contacts.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *     float  [assigned_member_id]     - A member the contact assigned to.
-     *     float  [is_assigned]            - If true, the contact assigned to a member.
-     *   array  [order_by]                 - Array of order fields
-     *                                       You can sort the results using the specified fields:
-     *                                       address_1, address_alias, first_name, last_name,
-     *                                       address_phone_number, address_email, address_group,
-     *                                       in_route_count, visited_count, last_visited_timestamp,
-     *                                       last_routed_timestamp
-     *                                       e.g., [["address_1", "asc"], ["last_name", "desc"]]
-     *
-     *   int    [page = 1]                 - Page number.
-     *   int    [per_page = 30]            - Records number per page.
-     * @return ResponsePagination
-     * @throws Exception\ApiError
-     */
-    public function getAddressesPaginatedByBodyPayload(?array $options = null) : ResponsePagination
-    {
-        $allBodyFields = ['fields', 'filter', 'order_by', 'page', 'per_page'];
-
-        return $this->toResponsePagination(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_PAGINATION,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
-        ]));
-    }
-
-    /**
-     * Get the Address clusters filtered by the corresponding query text, and with the option
-     * to filter the result by the 'routed' and 'unrouted' state.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   string [display = 'all']          - Specify which Addresses to show in the
-     *                                       corresponding query results.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *   string [query]                    - Search in the Addresses by the
-     * @return ResponseClustering
-     * @throws Exception\ApiError
-     */
-    public function getAddressClusters(?array $options = null) : ResponseClustering
-    {
-        $allQueryFields = ['display', 'query'];
-
-        return $this->toResponseClustering(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_CLUSTERING,
-            'method' => 'GET',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
-        ]));
-    }
-
-    /**
-     * Get the Address clusters by sending the corresponding body payload.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array [$options]            - Array of options.
-     *   array [clustering]                - Clustering
-     *     int    [precision = 5]          - Clusering precision.
-     *                                       Possible values from 1 to 12.
-     *   array  [filter]                   - FIlter parameters
-     *     string [query]                  - Query string.
-     *     array  [selected_areas]         - Selected areas
-     *       string [type]                 - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *       array  [value]                - Area parameters.
-     *         e.g.,
-     *         'type' => 'circle',
-     *         'value' => [
-     *             'center' => ['lat' => 40, 'lng' => 80],
-     *             'distance' => 1000
-     *         ]
-     *
-     *         'type' => 'polygon',
-     *         'value' => [
-     *             'points' => [[74, 40], [88, 30], [90, 25]]
-     *         ]
-     *
-     *         'type' => 'rect',
-     *         'value' => [
-     *             'top_left' => [50, 90],
-     *             'bottom_right' => [48, 70]
-     *         ]
-     *
-     *     array  [bounding_box]           - Coordinates of bounding box
-     *       float [top]                   - Top
-     *       float [left]                  - Left
-     *       float [bottom                 - Bottom
-     *       float [right]                 - Right
-     *
-     *     array  [center]                 - GPS coordinates of central point.
-     *       float [lat]                   - Latitude.
-     *       float [lng]                   - Longitude.
-     *     float  [distance]               - Distance from the area center.
-     *     string [display]                - Display option of the contacts.
-     *                                       Possible values:
-     *                                         'all' - all records;
-     *                                         'routed' - only routed records;
-     *                                         'unrouted' - only unrouted records.
-     *     float  [assigned_member_id]     - A member the contact assigned to.
-     *     float  [is_assigned]            - If true, the contact assigned to a member.
-     * @return ResponseClustering
-     * @throws Exception\ApiError
-     */
-    public function getAddressClustersByBodyPayload(?array $options = null) : ResponseClustering
-    {
-        $allBodyFields = ['clustering', 'filter'];
-
-        return $this->toResponseClustering(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_INDEX_CLUSTERING,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
-        ]));
-    }
-
-    /**
-     * Find an Address by sending the 'address_id' query parameter.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  int    $addressId           - The Address ID to be searched for.
-     * @return ResponseAddress
-     * @throws Exception\ApiError
-     */
-    public function getAddressById(int $addressId) : ResponseAddress
-    {
-        return $this->toResponseAddress(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_SHOW,
-            'method' => 'GET',
-            'query' => ['address_id' => $addressId]
-        ]));
-    }
-
-    /**
-     * Find multiple Addresses by sending a body payload with the array of
-     * the corresponding Address IDs.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array  $addressIds          - The array of Address IDs to be searched for.
-     * @return ResponseAll
-     * @throws Exception\ApiError
-     */
-    public function getAddressesByIds(array $addressIds) : ResponseAll
-    {
-        return $this->toResponseAll(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_SHOW,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => ['address_ids' => $addressIds]
-        ]));
-    }
-
-    /**
-     * Add a new Address Book Contact by sending a body payload with the corresponding parameters.
-     *
-     * @see {@link https://route4me.io/docs/#create-a-location}
-     *
-     * @param  $params_or_address           - Array of address's parameters or Address object
-     *   string address_1                   - The route Address Line 1.
-     *   float  cached_lat                  - Cached latitude.
-     *   float  cached_lng                  - Cached longitude.
-     *   string address_stop_type           - The type of stop that this is one of:
-     *                                        'DELIVERY', 'PICKUP', 'BREAK', 'MEETUP',
-     *                                        'SERVICE', 'VISIT' or 'DRIVEBY'.
-     *   int    [created_timestamp]         - When the contact created.
-     *   string [address_2]                 - The route Address Line 2 which is not used for geocoding.
-     *   int    [member_id]                 - Address book contact owner ID.
-     *   string [address_zip]               - The zip code the address is located in.
-     *   string [address_group]             - Address group.
-     *   string [address_alias]             - Address alias.
-     *   string [address_city]              - The city the address is located in.
-     *   string [address_state_id]          - The state the address is located in.
-     *   string [address_country_id]        - The country the address is located in.
-     *   string [first_name]                - The first name of the receiving address.
-     *   string [last_name]                 - The last name of the receiving party.
-     *   string [address_email]             - Address email.
-     *   string [address_phone_number]      - The phone number for the address.
-     *   float  [curbside_lat]              - Curbside latitude.
-     *   float  [curbside_lng]              - Curbside longitude.
-     *   array  [address_custom_data]       - Array of Address custom data, as 'key' => value
-     *   int    [local_time_window_start]   - Time Window Start in seconds, relative to the route start
-     *                                        date (midnight), UTC time zone. It is relative to start
-     *                                        date because start time changes would shift time windows.
-     *   int    [local_time_window_end]     - Time Window End in seconds, relative to the route start
-     *                                        date (midnight), UTC time zone. It is relative to start
-     *                                        datebecause start time changes would shift time windows.
-     *   int    [local_time_window_start_2] - See local_time_window_start
-     *   int    [local_time_window_end_2]   - See local_time_window_end
-     *   string [local_timezone_string]     - Local timezone string
-     *   int    [service_time]              - Consumed service time at an address.
-     *   string [color]                     - Color of an address, e.g., 'FF0000'.
-     *   string [address_icon]              - URL to an address icon file.
-     *   array  [schedule[]]                - Array of array of the trip schedules to a location.
-     *     bool   [enabled]                 - If true, the schedule is enabled.
-     *     string [mode]                    - Schedule mode.
-     *     array  [monthly]                 - Monthly.
-     *       int    [every]                 - Every.
-     *   array  [schedule_blacklist]        - Array of the dates, which should be excluded from a trip
-     *                                        schedule to a location. Also can be a date string with
-     *                                        the 'YYYY-MM-DD' format or null.
-     *   float  [address_cube]              - The cubic volume of the cargo being delivered or picked
-     *                                        up at the address.
-     *   float  [address_pieces]            - The item quantity of the cargo being delivered or picked
-     *                                        up at the address.
-     *   string [address_reference_no]      - The reference number for the address.
-     *   float  [address_revenue]           - The total revenue for the address
-     *   float  [address_weight]            - Weight of the cargo being delivered or picked up
-     *                                        at the address.
-     *   int    [address_priority]          - Priority of address 0 is the highest priority,
-     *                                        n has higher priority than n + 1
-     *   string [address_customer_po]       - The customer purchase order for the address
-     *   bool   [eligible_pickup]           - If true, the address is eligible to pickup.
-     *   bool   [eligible_depot]            - If true, the addrss is eligible to depot.
-     *   array  [assigned_to]               - Assigned to
-     *     int    [member_id]               - A member the address assigned to.
-     *     string [member_first_name]       - Member first name.
-     *     string [member_last_name]        - Member last name.
-     *     string [member_email]            - Member email.
-     *     string [until]                   - The assignment is valid until to.
-     * @return ResponseAddress
-     * @throws Exception\ApiError
-     */
-    public function addAddress($params_or_address) : ResponseAddress
-    {
-        $allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
-            'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
-            'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
-            'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
-            'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
-            'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
-            'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
-            'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
-            'eligible_depot', 'assigned_to'
-        ];
-
-        return $this->toResponseAddress(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params_or_address)
-        ]));
-    }
-
-    /**
-     * Add multiple new Address Book Contacts by sending a body payload with the array of
-     * the corresponding Address parameters.
-     *
-     * @see {@link https://route4me.io/docs/#create-a-location}
-     *
-     * @param  array  $arr                 - Array of Address for more information look addAddress.
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function addMultipleAddresses($arr) : bool
-    {
-        $allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
-            'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
-            'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
-            'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
-            'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
-            'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
-            'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
-            'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
-            'eligible_depot', 'assigned_to'
-        ];
-
-        $data = [];
-        foreach ($arr as $key => $value) {
-            $data[] = Route4Me::generateRequestParameters($allBodyFields, $value);
-        }
-
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_BATCH_CREATE,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => ['data' => $data]
-        ]);
-
-        if (is_array($result) && isset($result['status'])) {
-            return (bool)$result['status'];
-        }
-        return false;
-    }
-
-    /**
-     * Update the Address Book Contact by specifying the 'address_id' path parameter
-     * and by sending a body payload with the corresponding Address parameters.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  int    $addressId           - The Address ID to update.
-     * @param  array  $params              - Parameters of address to update, for more
-     *                                       information look addAddress
-     * @return ResponseAddress
-     * @throws Exception\ApiError
-     */
-    public function updateAddressById(int $addressId, $params) : ResponseAddress
-    {
-        $allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
-            'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
-            'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
-            'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
-            'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
-            'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
-            'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
-            'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
-            'eligible_depot', 'assigned_to'
-        ];
-
-        return $this->toResponseAddress(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES . '/' . $addressId,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Update multiple Address Book Contacts by sending a body payload with the array
-     * of the corresponding Address IDs and Address parameters.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array $address_ids           - An array of the address IDs (int).
-     * @param  $params_or_updateAddress     - Array of addresses parameters or "UpdateAddress" object
-     *                                        for more information look addAddress, requires only
-     *                                        one parameter service_time, all other are optional.
-     * @return ResponseAddress[]
-     * @throws Exception\ApiError
-     */
-    public function updateAddressesByIds(array $address_ids, $params_or_updateAddress) : array
-    {
-        $allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
-            'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
-            'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
-            'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
-            'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
-            'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
-            'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
-            'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
-            'eligible_depot'
-        ];
-
-        $params = Route4Me::generateRequestParameters($allBodyFields, $params_or_updateAddress);
-        $params['address_ids'] = $address_ids;
-
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_BATCH_UPDATE,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => $params
-        ]);
-
-        if (is_array($result)) {
-            $data = [];
-            foreach ($result as $key => $value) {
-                $data[] = $this->toResponseAddress($value);
-            }
-            return $data;
-        }
-        return [];
-    }
-
-    /**
-     * Update Address Book Contacts by sending a body payload with the corresponding query
-     * text and specified territory areas.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @todo request has uncheckable result - 403 forbidden
-     *
-     * @param  array  $filter              - FIlter parameters
-     *   string [query]                    - Search in the Addresses by the query phrase.
-     *   array  [bounding_box]             - Coordinates of bounding box
-     *     float [top]                     - Top
-     *     float [left]                    - Left
-     *     float [bottom                   - Bottom
-     *     float [right]                   - Right
-     *   array  [selected_areas]           - Selected areas
-     *     string [type]                   - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *     array  [value]                  - Area parameters.
-     *       e.g.,
-     *       'type' => 'circle',
-     *       'value' => [
-     *           'center' => ['lat' => 40, 'lng' => 80],
-     *           'distance' => 1000
-     *       ]
-     *
-     *       'type' => 'polygon',
-     *       'value' => [
-     *           'points' => [[74, 40], [88, 30], [90, 25]]
-     *       ]
-     *
-     *       'type' => 'rect',
-     *       'value' => [
-     *           'top_left' => [50, 90],
-     *           'bottom_right' => [48, 70]
-     *       ]
-     * @param  array  $params               - Parameters of address to update, for more
-     *                                        information look addAddresses
-     *   string [address_group]             - Address group.
-     *   string [address_alias]             - Address alias.
-     *   int    [member_id]                 - Address book contact owner ID.
-     *   string [first_name]                - The first name of the receiving address.
-     *   string [last_name]                 - The last name of the receiving party.
-     *   string [address_email]             - Address email.
-     *   string [address_phone_number]      - The phone number for the address.
-     *   array  [address_custom_data]       - Array of Address custom data, as 'key' => value
-     *   int    [local_time_window_start]   - Time Window Start in seconds, relative to the route start
-     *                                        date (midnight), UTC time zone. It is relative to start
-     *                                        date because start time changes would shift time windows.
-     *   int    [local_time_window_end]     - Time Window End in seconds, relative to the route start
-     *                                        date (midnight), UTC time zone. It is relative to start
-     *                                        datebecause start time changes would shift time windows.
-     *   int    [local_time_window_start_2] - See local_time_window_start
-     *   int    [local_time_window_end_2]   - See local_time_window_end
-     *   string [local_timezone_string]     - Local timezone string
-     *   int    [service_time]              - Consumed service time at an address.
-     *   string [color]                     - Color of an address, e.g., 'FF0000'.
-     *   string [address_icon]              - URL to an address icon file.
-     *   bool   [eligible_pickup]           - If true, the address is eligible to pickup.
-     *   bool   [eligible_depot]            - If true, the addrss is eligible to depot.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function updateAddressesByAreas(array $filter, array $params) : StatusChecker
-    {
-        $allFilterFields = ['query', 'bounding_box', 'selected_areas'];
-
-        $allParamsFields = ['member_id', 'address_group', 'address_alias', 'first_name', 'last_name',
-            'address_email', 'address_phone_number', 'address_custom_data', 'local_time_window_start',
-            'local_time_window_end', 'local_time_window_start_2', 'local_time_window_end_2',
-            'local_timezone_string', 'service_time', 'color', 'address_icon', 'eligible_pickup',
-            'eligible_depot'
-        ];
-
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_UPDATE_BY_AREAS,
-            'method' => 'PUT',
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
-            'return_headers' => ['location'],
-            'body' => [
-                'filter' => Route4Me::generateRequestParameters($allFilterFields, $filter),
-                'data' => Route4Me::generateRequestParameters($allParamsFields, $params)
-            ]
-        ]));
-    }
-
-    /**
-     * Delete multiple Address Book Contacts by sending a body payload with the
-     * array of the corresponding Address IDs.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array  addressIds           - The array of Address IDs to delete.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function deleteAddressesByIds(array $addressIds) : StatusChecker
-    {
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_DELETE,
-            'method' => 'DELETE',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'return_headers' => ['location', 'x-job-id'],
-            'body' => ['address_ids' => $addressIds]
-        ]));
-    }
-
-    /**
-     * Delete the Address Book Contacts located in the selected areas by sending
-     * the corresponding body payload.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @todo request has uncheckable result - 403 forbidden
-     *
-     * @param  array  $filter              - FIlter parameters
-     *   string [query]                    - Search in the Addresses by the query phrase.
-     *   array  [bounding_box]             - Coordinates of bounding box
-     *     float [top]                     - Top
-     *     float [left]                    - Left
-     *     float [bottom                   - Bottom
-     *     float [right]                   - Right
-     *   array  [selected_areas]           - Selected areas
-     *     string [type]                   - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *     array  [value]                  - Area parameters.
-     *       e.g.,
-     *       'type' => 'circle',
-     *       'value' => [
-     *           'center' => ['lat' => 40, 'lng' => 80],
-     *           'distance' => 1000
-     *       ]
-     *
-     *       'type' => 'polygon',
-     *       'value' => [
-     *           'points' => [[74, 40], [88, 30], [90, 25]]
-     *       ]
-     *
-     *       'type' => 'rect',
-     *       'value' => [
-     *           'top_left' => [50, 90],
-     *           'bottom_right' => [48, 70]
-     *       ]
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function deleteAddressesByAreas($filter) : StatusChecker
-    {
-        $allFilterFields = ['query', 'bounding_box', 'selected_areas'];
-
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_DELETE_BY_AREAS,
-            'method' => 'DELETE',
-            'return_headers' => ['location', 'x-job-id'],
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
-            'body' => ['filter' => Route4Me::generateRequestParameters($allFilterFields, $filter)]
-        ]));
-    }
-
-    /**
-     * Get all Address custom fields.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getAddressCustomFields() : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_CUSTOM_FIELDS,
-            'method' => 'GET'
-        ]);
-    }
-
-    /**
-     * Get depots Addresses.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getAddressesDepots() : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_DEPOTS,
-            'method' => 'GET'
-        ]);
-    }
-
-    /**
-     * Export Address Book Contacts to the specified file by sending a body
-     * payload with the array of the corresponding Address IDs.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  array  addressIds           - Array of addresses ID to export.
-     * @param  string filename             - The name of the file to export.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function exportAddressesByIds(array $addressIds, string $filename) : StatusChecker
-    {
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_EXPORT,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'return_headers' => ['location'],
-            'body' => ['ids' => $addressIds, 'filename' => $filename]
-        ]));
-    }
-
-    /**
-     * Export the Address Book Contacts located in the selected areas
-     * by sending the corresponding body payload.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @todo request has uncheckable result - 403 forbidden
-     *
-     * @param  array  $filter              - FIlter parameters
-     *   string [query]                    - Search in the Addresses by the query phrase.
-     *   array  [bounding_box]             - Coordinates of bounding box
-     *     float [top]                     - Top
-     *     float [left]                    - Left
-     *     float [bottom                   - Bottom
-     *     float [right]                   - Right
-     *   array  [selected_areas]           - Selected areas
-     *     string [type]                   - Area type.
-     *                                       Possible values: 'circle', 'polygon', 'rect'.
-     *     array  [value]                  - Area parameters.
-     *       e.g.,
-     *       'type' => 'circle',
-     *       'value' => [
-     *           'center' => ['lat' => 40, 'lng' => 80],
-     *           'distance' => 1000
-     *       ]
-     *
-     *       'type' => 'polygon',
-     *       'value' => [
-     *           'points' => [[74, 40], [88, 30], [90, 25]]
-     *       ]
-     *
-     *       'type' => 'rect',
-     *       'value' => [
-     *           'top_left' => [50, 90],
-     *           'bottom_right' => [48, 70]
-     *        ]
-     *   string filename                   - The name of the file to export.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function exportAddressesByAreas(array $filter) : StatusChecker
-    {
-        $allFilterFields = ['query', 'bounding_box', 'selected_areas', 'filename'];
-
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_EXPORT_BY_AREAS,
-            'method' => 'POST',
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
-            'return_headers' => ['location'],
-            'body' => ['filter' => Route4Me::generateRequestParameters($allFilterFields, $filter)]
-        ]));
-    }
-
-    /**
-     * Export Addresses by the specified area IDs.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @todo request has uncheckable result - 403 forbidden
-     *
-     * @param  array  territoryIds         - An array of the territory IDs.
-     * @param  string filename             - The name of the file to export.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function exportAddressesByAreaIds(array $territoryIds, string $filename) : StatusChecker
-    {
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_EXPORT_BY_AREA_IDS,
-            'method' => 'POST',
-            'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
-            'return_headers' => ['location'],
-            'body' => ['territory_ids' => $territoryIds, 'filename' => $filename]
-        ]));
-    }
-
-    /**
-     * Check the asynchronous job status by specifying the 'job_id' path parameter.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  int    filename             - Job ID to check status.
-     * @return StatusChecker
-     * @throws Exception\ApiError
-     */
-    public function getAddressesAsynchronousJobStatus(string $jobId) : StatusChecker
-    {
-        return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_JOB_TRACKER_STATUS . '/' . $jobId,
-            'method' => 'GET',
-            'HTTPHEADER' => 'Accept: application/json',
-            'return_headers' => ['X-R4M-Async-Job-Running-Time']
-        ]));
-    }
-
-    /**
-     * Get the asynchronous job result by specifying the 'job_id' path parameter.
-     *
-     * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
-     *
-     * @param  int    filename             - Job ID get result.
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function getAddressesAsynchronousJobResult(string $jobId) : bool
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_JOB_TRACKER_RESULT . '/' . $jobId,
-            'method' => 'GET'
-        ]);
-        return (is_array($result) && isset($result['status']) && $result['status'] ? $result['status'] : false);
-    }
-
-    private function toResponseAddress($result) : ResponseAddress
-    {
-        if (is_array($result)) {
-            return new ResponseAddress($result);
-        }
-        throw new ApiError('Can not convert result to ResponseAddress object.');
-    }
-
-    private function toResponseAll($result) : ResponseAll
-    {
-        if (is_array($result)) {
-            return new ResponseAll($result);
-        }
-        throw new ApiError('Can not convert result to ResponseAll object.');
-    }
-
-    private function toResponsePagination($result) : ResponsePagination
-    {
-        if (is_array($result)) {
-            return new ResponsePagination($result);
-        }
-        throw new ApiError('Can not convert result to ResponsePagination object.');
-    }
-
-    private function toResponseClustering($result) : ResponseClustering
-    {
-        if (is_array($result)) {
-            return new ResponseClustering($result);
-        }
-        throw new ApiError('Can not convert result to ResponseClustering object.');
-    }
+	public function __construct()
+	{
+		Route4Me::setBaseUrl('');
+	}
+
+	/**
+	 * Get all Addresses filtered by specifying the corresponding query parameters.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   string [fields]                   - Comma-delimited list of the address
+	 *                                       fields to be included into the search results
+	 *                                       e.g., 'address_id, address_alias, address_1'.
+	 *   string [display = 'all']          - Specify which Addresses to show in the
+	 *                                       corresponding query results.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *   string [query]                    - Search in the Addresses by the
+	 *                                       corresponding query phrase.
+	 *   int    [limit]                    - Limit of the queried records number.
+	 *   int    [offset]                   - Offset from the beginning of the queried records.
+	 * @return ResponseAll
+	 * @throws Exception\ApiError
+	 */
+	public function getAddresses(?array $options = null) : ResponseAll
+	{
+		$allQueryFields = ['fields', 'display', 'query', 'limit', 'offset'];
+
+		return $this->toResponseAll(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_ALL,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
+		]));
+	}
+
+	/**
+	 * Get all Addresses filtered and sorted by sending the corresponding body payload, with
+	 * the option to search by the specified areas.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   array  [fields = []]              - An array of the fields to be included
+	 *                                       in the search result.
+	 *                                       e.g., ['address_id', 'address_alias', 'address_1'].
+	 *   array  [filter]                   - FIlter parameters
+	 *     string [query]                  - Query string.
+	 *     array  [selected_areas]         - Selected areas
+	 *       string [type]                 - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *       array  [value]                - Area parameters.
+	 *         e.g.,
+	 *         'type' => 'circle',
+	 *         'value' => [
+	 *             'center' => ['lat' => 40, 'lng' => 80],
+	 *             'distance' => 1000
+	 *         ]
+	 *
+	 *         'type' => 'polygon',
+	 *         'value' => [
+	 *             'points' => [[74, 40], [88, 30], [90, 25]]
+	 *         ]
+	 *
+	 *         'type' => 'rect',
+	 *         'value' => [
+	 *             'top_left' => [50, 90],
+	 *             'bottom_right' => [48, 70]
+	 *         ]
+	 *
+	 *     array  [bounding_box]           - Coordinates of bounding box
+	 *       float [top]                   - Top
+	 *       float [left]                  - Left
+	 *       float [bottom                 - Bottom
+	 *       float [right]                 - Right
+	 *
+	 *     array  [center]                 - GPS coordinates of central point.
+	 *       float [lat]                   - Latitude.
+	 *       float [lng]                   - Longitude.
+	 *     float  [distance]               - Distance from the area center.
+	 *     string [display]                - Display option of the contacts.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *     float  [assigned_member_id]     - A member the contact assigned to.
+	 *     float  [is_assigned]            - If true, the contact assigned to a member.
+	 *   array  [order_by]                 - Array of order fields
+	 *                                       You can sort the results using the specified fields:
+	 *                                       address_1, address_alias, first_name, last_name,
+	 *                                       address_phone_number, address_email, address_group,
+	 *                                       in_route_count, visited_count, last_visited_timestamp,
+	 *                                       last_routed_timestamp
+	 *                                       e.g., [["address_1", "asc"], ["last_name", "desc"]]
+	 *
+	 *   int    [limit]                    - Limit of the queried records number.
+	 *   int    [offset]                   - Offset from the beginning of the queried records.
+	 * @return ResponseAll
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesByBodyPayload(?array $options = null) : ResponseAll
+	{
+		$allBodyFields = ['fields', 'filter', 'order_by', 'limit', 'offset'];
+
+		return $this->toResponseAll(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_ALL,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
+		]));
+	}
+
+	/**
+	 * Get a paginated list of all Addresses.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   string [fields]                   - Comma-delimited list of the address
+	 *                                       fields to be included into the search results
+	 *                                       e.g., 'address_id, address_alias, address_1'.
+	 *   string [display = 'all']          - Specify which Addresses to show in the
+	 *                                       corresponding query results.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *   string [query]                    - Search in the Addresses by the
+	 *                                       corresponding query phrase.
+	 *   int    [page = 1]                 - Requested page.
+	 *   int    [per_page = 30]            - Number of Addresses per page.
+	 * @return ResponsePagination
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesPaginated(?array $options = null) : ResponsePagination
+	{
+		$allQueryFields = ['fields', 'display', 'query', 'page', 'per_page'];
+
+		return $this->toResponsePagination(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_PAGINATION,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
+		]));
+	}
+
+	/**
+	 * Get the paginated list of all Addresses filtered and sorted by sending the corresponding
+	 * body payload, with the option to search by the specified areas.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   array  [fields = []]              - An array of the fields to be included
+	 *                                       in the search result.
+	 *                                       e.g., ['address_id', 'address_alias', 'address_1'].
+	 *   array  [filter]                   - FIlter parameters
+	 *     string [query]                  - Query string.
+	 *     array  [selected_areas]         - Selected areas
+	 *       string [type]                 - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *       array  [value]                - Area parameters.
+	 *         e.g.,
+	 *         'type' => 'circle',
+	 *         'value' => [
+	 *             'center' => ['lat' => 40, 'lng' => 80],
+	 *             'distance' => 1000
+	 *         ]
+	 *
+	 *         'type' => 'polygon',
+	 *         'value' => [
+	 *             'points' => [[74, 40], [88, 30], [90, 25]]
+	 *         ]
+	 *
+	 *         'type' => 'rect',
+	 *         'value' => [
+	 *             'top_left' => [50, 90],
+	 *             'bottom_right' => [48, 70]
+	 *         ]
+	 *
+	 *     array  [bounding_box]           - Coordinates of bounding box
+	 *       float [top]                   - Top
+	 *       float [left]                  - Left
+	 *       float [bottom                 - Bottom
+	 *       float [right]                 - Right
+	 *
+	 *     array  [center]                 - GPS coordinates of central point.
+	 *       float [lat]                   - Latitude.
+	 *       float [lng]                   - Longitude.
+	 *     float  [distance]               - Distance from the area center.
+	 *     string [display]                - Display option of the contacts.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *     float  [assigned_member_id]     - A member the contact assigned to.
+	 *     float  [is_assigned]            - If true, the contact assigned to a member.
+	 *   array  [order_by]                 - Array of order fields
+	 *                                       You can sort the results using the specified fields:
+	 *                                       address_1, address_alias, first_name, last_name,
+	 *                                       address_phone_number, address_email, address_group,
+	 *                                       in_route_count, visited_count, last_visited_timestamp,
+	 *                                       last_routed_timestamp
+	 *                                       e.g., [["address_1", "asc"], ["last_name", "desc"]]
+	 *
+	 *   int    [page = 1]                 - Page number.
+	 *   int    [per_page = 30]            - Records number per page.
+	 * @return ResponsePagination
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesPaginatedByBodyPayload(?array $options = null) : ResponsePagination
+	{
+		$allBodyFields = ['fields', 'filter', 'order_by', 'page', 'per_page'];
+
+		return $this->toResponsePagination(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_PAGINATION,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
+		]));
+	}
+
+	/**
+	 * Get the Address clusters filtered by the corresponding query text, and with the option
+	 * to filter the result by the 'routed' and 'unrouted' state.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   string [display = 'all']          - Specify which Addresses to show in the
+	 *                                       corresponding query results.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *   string [query]                    - Search in the Addresses by the
+	 * @return ResponseClustering
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressClusters(?array $options = null) : ResponseClustering
+	{
+		$allQueryFields = ['display', 'query'];
+
+		return $this->toResponseClustering(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_CLUSTERING,
+			'method' => 'GET',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $options)
+		]));
+	}
+
+	/**
+	 * Get the Address clusters by sending the corresponding body payload.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array [$options]            - Array of options.
+	 *   array [clustering]                - Clustering
+	 *     int    [precision = 5]          - Clusering precision.
+	 *                                       Possible values from 1 to 12.
+	 *   array  [filter]                   - FIlter parameters
+	 *     string [query]                  - Query string.
+	 *     array  [selected_areas]         - Selected areas
+	 *       string [type]                 - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *       array  [value]                - Area parameters.
+	 *         e.g.,
+	 *         'type' => 'circle',
+	 *         'value' => [
+	 *             'center' => ['lat' => 40, 'lng' => 80],
+	 *             'distance' => 1000
+	 *         ]
+	 *
+	 *         'type' => 'polygon',
+	 *         'value' => [
+	 *             'points' => [[74, 40], [88, 30], [90, 25]]
+	 *         ]
+	 *
+	 *         'type' => 'rect',
+	 *         'value' => [
+	 *             'top_left' => [50, 90],
+	 *             'bottom_right' => [48, 70]
+	 *         ]
+	 *
+	 *     array  [bounding_box]           - Coordinates of bounding box
+	 *       float [top]                   - Top
+	 *       float [left]                  - Left
+	 *       float [bottom                 - Bottom
+	 *       float [right]                 - Right
+	 *
+	 *     array  [center]                 - GPS coordinates of central point.
+	 *       float [lat]                   - Latitude.
+	 *       float [lng]                   - Longitude.
+	 *     float  [distance]               - Distance from the area center.
+	 *     string [display]                - Display option of the contacts.
+	 *                                       Possible values:
+	 *                                         'all' - all records;
+	 *                                         'routed' - only routed records;
+	 *                                         'unrouted' - only unrouted records.
+	 *     float  [assigned_member_id]     - A member the contact assigned to.
+	 *     float  [is_assigned]            - If true, the contact assigned to a member.
+	 * @return ResponseClustering
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressClustersByBodyPayload(?array $options = null) : ResponseClustering
+	{
+		$allBodyFields = ['clustering', 'filter'];
+
+		return $this->toResponseClustering(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_INDEX_CLUSTERING,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $options)
+		]));
+	}
+
+	/**
+	 * Find an Address by sending the 'address_id' query parameter.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  int    $addressId           - The Address ID to be searched for.
+	 * @return ResponseAddress
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressById(int $addressId) : ResponseAddress
+	{
+		return $this->toResponseAddress(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_SHOW,
+			'method' => 'GET',
+			'query' => ['address_id' => $addressId]
+		]));
+	}
+
+	/**
+	 * Find multiple Addresses by sending a body payload with the array of
+	 * the corresponding Address IDs.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array  $addressIds          - The array of Address IDs to be searched for.
+	 * @return ResponseAll
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesByIds(array $addressIds) : ResponseAll
+	{
+		return $this->toResponseAll(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_SHOW,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => ['address_ids' => $addressIds]
+		]));
+	}
+
+	/**
+	 * Add a new Address Book Contact by sending a body payload with the corresponding parameters.
+	 *
+	 * @see {@link https://route4me.io/docs/#create-a-location}
+	 *
+	 * @param  $params_or_address           - Array of address's parameters or Address object
+	 *   string address_1                   - The route Address Line 1.
+	 *   float  cached_lat                  - Cached latitude.
+	 *   float  cached_lng                  - Cached longitude.
+	 *   string address_stop_type           - The type of stop that this is one of:
+	 *                                        'DELIVERY', 'PICKUP', 'BREAK', 'MEETUP',
+	 *                                        'SERVICE', 'VISIT' or 'DRIVEBY'.
+	 *   int    [created_timestamp]         - When the contact created.
+	 *   string [address_2]                 - The route Address Line 2 which is not used for geocoding.
+	 *   int    [member_id]                 - Address book contact owner ID.
+	 *   string [address_zip]               - The zip code the address is located in.
+	 *   string [address_group]             - Address group.
+	 *   string [address_alias]             - Address alias.
+	 *   string [address_city]              - The city the address is located in.
+	 *   string [address_state_id]          - The state the address is located in.
+	 *   string [address_country_id]        - The country the address is located in.
+	 *   string [first_name]                - The first name of the receiving address.
+	 *   string [last_name]                 - The last name of the receiving party.
+	 *   string [address_email]             - Address email.
+	 *   string [address_phone_number]      - The phone number for the address.
+	 *   float  [curbside_lat]              - Curbside latitude.
+	 *   float  [curbside_lng]              - Curbside longitude.
+	 *   array  [address_custom_data]       - Array of Address custom data, as 'key' => value
+	 *   int    [local_time_window_start]   - Time Window Start in seconds, relative to the route start
+	 *                                        date (midnight), UTC time zone. It is relative to start
+	 *                                        date because start time changes would shift time windows.
+	 *   int    [local_time_window_end]     - Time Window End in seconds, relative to the route start
+	 *                                        date (midnight), UTC time zone. It is relative to start
+	 *                                        datebecause start time changes would shift time windows.
+	 *   int    [local_time_window_start_2] - See local_time_window_start
+	 *   int    [local_time_window_end_2]   - See local_time_window_end
+	 *   string [local_timezone_string]     - Local timezone string
+	 *   int    [service_time]              - Consumed service time at an address.
+	 *   string [color]                     - Color of an address, e.g., 'FF0000'.
+	 *   string [address_icon]              - URL to an address icon file.
+	 *   array  [schedule[]]                - Array of array of the trip schedules to a location.
+	 *     bool   [enabled]                 - If true, the schedule is enabled.
+	 *     string [mode]                    - Schedule mode.
+	 *     array  [monthly]                 - Monthly.
+	 *       int    [every]                 - Every.
+	 *   array  [schedule_blacklist]        - Array of the dates, which should be excluded from a trip
+	 *                                        schedule to a location. Also can be a date string with
+	 *                                        the 'YYYY-MM-DD' format or null.
+	 *   float  [address_cube]              - The cubic volume of the cargo being delivered or picked
+	 *                                        up at the address.
+	 *   float  [address_pieces]            - The item quantity of the cargo being delivered or picked
+	 *                                        up at the address.
+	 *   string [address_reference_no]      - The reference number for the address.
+	 *   float  [address_revenue]           - The total revenue for the address
+	 *   float  [address_weight]            - Weight of the cargo being delivered or picked up
+	 *                                        at the address.
+	 *   int    [address_priority]          - Priority of address 0 is the highest priority,
+	 *                                        n has higher priority than n + 1
+	 *   string [address_customer_po]       - The customer purchase order for the address
+	 *   bool   [eligible_pickup]           - If true, the address is eligible to pickup.
+	 *   bool   [eligible_depot]            - If true, the addrss is eligible to depot.
+	 *   array  [assigned_to]               - Assigned to
+	 *     int    [member_id]               - A member the address assigned to.
+	 *     string [member_first_name]       - Member first name.
+	 *     string [member_last_name]        - Member last name.
+	 *     string [member_email]            - Member email.
+	 *     string [until]                   - The assignment is valid until to.
+	 * @return ResponseAddress
+	 * @throws Exception\ApiError
+	 */
+	public function addAddress($params_or_address) : ResponseAddress
+	{
+		$allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
+			'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
+			'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
+			'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
+			'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
+			'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
+			'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
+			'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
+			'eligible_depot', 'assigned_to'
+		];
+
+		return $this->toResponseAddress(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params_or_address)
+		]));
+	}
+
+	/**
+	 * Add multiple new Address Book Contacts by sending a body payload with the array of
+	 * the corresponding Address parameters.
+	 *
+	 * @see {@link https://route4me.io/docs/#create-a-location}
+	 *
+	 * @param  array  $arr                 - Array of Address for more information look addAddress.
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function addMultipleAddresses($arr) : bool
+	{
+		$allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
+			'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
+			'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
+			'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
+			'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
+			'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
+			'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
+			'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
+			'eligible_depot', 'assigned_to'
+		];
+
+		$data = [];
+		foreach ($arr as $key => $value) {
+			$data[] = Route4Me::generateRequestParameters($allBodyFields, $value);
+		}
+
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_BATCH_CREATE,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => ['data' => $data]
+		]);
+
+		if (is_array($result) && isset($result['status'])) {
+			return (bool)$result['status'];
+		}
+		return false;
+	}
+
+	/**
+	 * Update the Address Book Contact by specifying the 'address_id' path parameter
+	 * and by sending a body payload with the corresponding Address parameters.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  int    $addressId           - The Address ID to update.
+	 * @param  array  $params              - Parameters of address to update, for more
+	 *                                       information look addAddress
+	 * @return ResponseAddress
+	 * @throws Exception\ApiError
+	 */
+	public function updateAddressById(int $addressId, $params) : ResponseAddress
+	{
+		$allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
+			'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
+			'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
+			'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
+			'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
+			'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
+			'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
+			'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
+			'eligible_depot', 'assigned_to'
+		];
+
+		return $this->toResponseAddress(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES . '/' . $addressId,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Update multiple Address Book Contacts by sending a body payload with the array
+	 * of the corresponding Address IDs and Address parameters.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array $address_ids           - An array of the address IDs (int).
+	 * @param  $params_or_updateAddress     - Array of addresses parameters or "UpdateAddress" object
+	 *                                        for more information look addAddress, requires only
+	 *                                        one parameter service_time, all other are optional.
+	 * @return ResponseAddress[]
+	 * @throws Exception\ApiError
+	 */
+	public function updateAddressesByIds(array $address_ids, $params_or_updateAddress) : array
+	{
+		$allBodyFields = ['address_1', 'cached_lat', 'cached_lng', 'address_stop_type', 'created_timestamp',
+			'address_2', 'member_id', 'address_zip', 'address_group', 'address_alias', 'address_city',
+			'address_state_id', 'address_country_id', 'first_name', 'last_name', 'address_email',
+			'address_phone_number', 'curbside_lat', 'curbside_lng', 'address_custom_data',
+			'local_time_window_start', 'local_time_window_end', 'local_time_window_start_2',
+			'local_time_window_end_2', 'local_timezone_string', 'service_time', 'color', 'address_icon',
+			'schedule', 'schedule_blacklist', 'address_cube', 'address_pieces', 'address_reference_no',
+			'address_revenue', 'address_weight', 'address_priority', 'address_customer_po', 'eligible_pickup',
+			'eligible_depot'
+		];
+
+		$params = Route4Me::generateRequestParameters($allBodyFields, $params_or_updateAddress);
+		$params['address_ids'] = $address_ids;
+
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_BATCH_UPDATE,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => $params
+		]);
+
+		if (is_array($result)) {
+			$data = [];
+			foreach ($result as $key => $value) {
+				$data[] = $this->toResponseAddress($value);
+			}
+			return $data;
+		}
+		return [];
+	}
+
+	/**
+	 * Update Address Book Contacts by sending a body payload with the corresponding query
+	 * text and specified territory areas.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @todo request has uncheckable result - 403 forbidden
+	 *
+	 * @param  array  $filter              - FIlter parameters
+	 *   string [query]                    - Search in the Addresses by the query phrase.
+	 *   array  [bounding_box]             - Coordinates of bounding box
+	 *     float [top]                     - Top
+	 *     float [left]                    - Left
+	 *     float [bottom                   - Bottom
+	 *     float [right]                   - Right
+	 *   array  [selected_areas]           - Selected areas
+	 *     string [type]                   - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *     array  [value]                  - Area parameters.
+	 *       e.g.,
+	 *       'type' => 'circle',
+	 *       'value' => [
+	 *           'center' => ['lat' => 40, 'lng' => 80],
+	 *           'distance' => 1000
+	 *       ]
+	 *
+	 *       'type' => 'polygon',
+	 *       'value' => [
+	 *           'points' => [[74, 40], [88, 30], [90, 25]]
+	 *       ]
+	 *
+	 *       'type' => 'rect',
+	 *       'value' => [
+	 *           'top_left' => [50, 90],
+	 *           'bottom_right' => [48, 70]
+	 *       ]
+	 * @param  array  $params               - Parameters of address to update, for more
+	 *                                        information look addAddresses
+	 *   string [address_group]             - Address group.
+	 *   string [address_alias]             - Address alias.
+	 *   int    [member_id]                 - Address book contact owner ID.
+	 *   string [first_name]                - The first name of the receiving address.
+	 *   string [last_name]                 - The last name of the receiving party.
+	 *   string [address_email]             - Address email.
+	 *   string [address_phone_number]      - The phone number for the address.
+	 *   array  [address_custom_data]       - Array of Address custom data, as 'key' => value
+	 *   int    [local_time_window_start]   - Time Window Start in seconds, relative to the route start
+	 *                                        date (midnight), UTC time zone. It is relative to start
+	 *                                        date because start time changes would shift time windows.
+	 *   int    [local_time_window_end]     - Time Window End in seconds, relative to the route start
+	 *                                        date (midnight), UTC time zone. It is relative to start
+	 *                                        datebecause start time changes would shift time windows.
+	 *   int    [local_time_window_start_2] - See local_time_window_start
+	 *   int    [local_time_window_end_2]   - See local_time_window_end
+	 *   string [local_timezone_string]     - Local timezone string
+	 *   int    [service_time]              - Consumed service time at an address.
+	 *   string [color]                     - Color of an address, e.g., 'FF0000'.
+	 *   string [address_icon]              - URL to an address icon file.
+	 *   bool   [eligible_pickup]           - If true, the address is eligible to pickup.
+	 *   bool   [eligible_depot]            - If true, the addrss is eligible to depot.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function updateAddressesByAreas(array $filter, array $params) : StatusChecker
+	{
+		$allFilterFields = ['query', 'bounding_box', 'selected_areas'];
+
+		$allParamsFields = ['member_id', 'address_group', 'address_alias', 'first_name', 'last_name',
+			'address_email', 'address_phone_number', 'address_custom_data', 'local_time_window_start',
+			'local_time_window_end', 'local_time_window_start_2', 'local_time_window_end_2',
+			'local_timezone_string', 'service_time', 'color', 'address_icon', 'eligible_pickup',
+			'eligible_depot'
+		];
+
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_UPDATE_BY_AREAS,
+			'method' => 'PUT',
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
+			'return_headers' => ['location'],
+			'body' => [
+				'filter' => Route4Me::generateRequestParameters($allFilterFields, $filter),
+				'data' => Route4Me::generateRequestParameters($allParamsFields, $params)
+			]
+		]));
+	}
+
+	/**
+	 * Delete multiple Address Book Contacts by sending a body payload with the
+	 * array of the corresponding Address IDs.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array  addressIds           - The array of Address IDs to delete.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function deleteAddressesByIds(array $addressIds) : StatusChecker
+	{
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_DELETE,
+			'method' => 'DELETE',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'return_headers' => ['location', 'x-job-id'],
+			'body' => ['address_ids' => $addressIds]
+		]));
+	}
+
+	/**
+	 * Delete the Address Book Contacts located in the selected areas by sending
+	 * the corresponding body payload.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @todo request has uncheckable result - 403 forbidden
+	 *
+	 * @param  array  $filter              - FIlter parameters
+	 *   string [query]                    - Search in the Addresses by the query phrase.
+	 *   array  [bounding_box]             - Coordinates of bounding box
+	 *     float [top]                     - Top
+	 *     float [left]                    - Left
+	 *     float [bottom                   - Bottom
+	 *     float [right]                   - Right
+	 *   array  [selected_areas]           - Selected areas
+	 *     string [type]                   - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *     array  [value]                  - Area parameters.
+	 *       e.g.,
+	 *       'type' => 'circle',
+	 *       'value' => [
+	 *           'center' => ['lat' => 40, 'lng' => 80],
+	 *           'distance' => 1000
+	 *       ]
+	 *
+	 *       'type' => 'polygon',
+	 *       'value' => [
+	 *           'points' => [[74, 40], [88, 30], [90, 25]]
+	 *       ]
+	 *
+	 *       'type' => 'rect',
+	 *       'value' => [
+	 *           'top_left' => [50, 90],
+	 *           'bottom_right' => [48, 70]
+	 *       ]
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function deleteAddressesByAreas($filter) : StatusChecker
+	{
+		$allFilterFields = ['query', 'bounding_box', 'selected_areas'];
+
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_DELETE_BY_AREAS,
+			'method' => 'DELETE',
+			'return_headers' => ['location', 'x-job-id'],
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
+			'body' => ['filter' => Route4Me::generateRequestParameters($allFilterFields, $filter)]
+		]));
+	}
+
+	/**
+	 * Get all Address custom fields.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressCustomFields() : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_CUSTOM_FIELDS,
+			'method' => 'GET'
+		]);
+	}
+
+	/**
+	 * Get depots Addresses.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesDepots() : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_DEPOTS,
+			'method' => 'GET'
+		]);
+	}
+
+	/**
+	 * Export Address Book Contacts to the specified file by sending a body
+	 * payload with the array of the corresponding Address IDs.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  array  addressIds           - Array of addresses ID to export.
+	 * @param  string filename             - The name of the file to export.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function exportAddressesByIds(array $addressIds, string $filename) : StatusChecker
+	{
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_EXPORT,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'return_headers' => ['location'],
+			'body' => ['ids' => $addressIds, 'filename' => $filename]
+		]));
+	}
+
+	/**
+	 * Export the Address Book Contacts located in the selected areas
+	 * by sending the corresponding body payload.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @todo request has uncheckable result - 403 forbidden
+	 *
+	 * @param  array  $filter              - FIlter parameters
+	 *   string [query]                    - Search in the Addresses by the query phrase.
+	 *   array  [bounding_box]             - Coordinates of bounding box
+	 *     float [top]                     - Top
+	 *     float [left]                    - Left
+	 *     float [bottom                   - Bottom
+	 *     float [right]                   - Right
+	 *   array  [selected_areas]           - Selected areas
+	 *     string [type]                   - Area type.
+	 *                                       Possible values: 'circle', 'polygon', 'rect'.
+	 *     array  [value]                  - Area parameters.
+	 *       e.g.,
+	 *       'type' => 'circle',
+	 *       'value' => [
+	 *           'center' => ['lat' => 40, 'lng' => 80],
+	 *           'distance' => 1000
+	 *       ]
+	 *
+	 *       'type' => 'polygon',
+	 *       'value' => [
+	 *           'points' => [[74, 40], [88, 30], [90, 25]]
+	 *       ]
+	 *
+	 *       'type' => 'rect',
+	 *       'value' => [
+	 *           'top_left' => [50, 90],
+	 *           'bottom_right' => [48, 70]
+	 *        ]
+	 *   string filename                   - The name of the file to export.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function exportAddressesByAreas(array $filter) : StatusChecker
+	{
+		$allFilterFields = ['query', 'bounding_box', 'selected_areas', 'filename'];
+
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_EXPORT_BY_AREAS,
+			'method' => 'POST',
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
+			'return_headers' => ['location'],
+			'body' => ['filter' => Route4Me::generateRequestParameters($allFilterFields, $filter)]
+		]));
+	}
+
+	/**
+	 * Export Addresses by the specified area IDs.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @todo request has uncheckable result - 403 forbidden
+	 *
+	 * @param  array  territoryIds         - An array of the territory IDs.
+	 * @param  string filename             - The name of the file to export.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function exportAddressesByAreaIds(array $territoryIds, string $filename) : StatusChecker
+	{
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_EXPORT_BY_AREA_IDS,
+			'method' => 'POST',
+			'HTTPHEADERS' => ['Content-Type: application/json', 'Accept: application/json'],
+			'return_headers' => ['location'],
+			'body' => ['territory_ids' => $territoryIds, 'filename' => $filename]
+		]));
+	}
+
+	/**
+	 * Check the asynchronous job status by specifying the 'job_id' path parameter.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  int    filename             - Job ID to check status.
+	 * @return StatusChecker
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesAsynchronousJobStatus(string $jobId) : StatusChecker
+	{
+		return new StatusChecker(Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_JOB_TRACKER_STATUS . '/' . $jobId,
+			'method' => 'GET',
+			'HTTPHEADER' => 'Accept: application/json',
+			'return_headers' => ['X-R4M-Async-Job-Running-Time']
+		]));
+	}
+
+	/**
+	 * Get the asynchronous job result by specifying the 'job_id' path parameter.
+	 *
+	 * @see {@link https://virtserver.swaggerhub.com/Route4Me/address-book/1.0.0}
+	 *
+	 * @param  int    filename             - Job ID get result.
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function getAddressesAsynchronousJobResult(string $jobId) : bool
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESSES_JOB_TRACKER_RESULT . '/' . $jobId,
+			'method' => 'GET'
+		]);
+		return (is_array($result) && isset($result['status']) && $result['status'] ? $result['status'] : false);
+	}
+
+	private function toResponseAddress($result) : ResponseAddress
+	{
+		if (is_array($result)) {
+			return new ResponseAddress($result);
+		}
+		throw new ApiError('Can not convert result to ResponseAddress object.');
+	}
+
+	private function toResponseAll($result) : ResponseAll
+	{
+		if (is_array($result)) {
+			return new ResponseAll($result);
+		}
+		throw new ApiError('Can not convert result to ResponseAll object.');
+	}
+
+	private function toResponsePagination($result) : ResponsePagination
+	{
+		if (is_array($result)) {
+			return new ResponsePagination($result);
+		}
+		throw new ApiError('Can not convert result to ResponsePagination object.');
+	}
+
+	private function toResponseClustering($result) : ResponseClustering
+	{
+		if (is_array($result)) {
+			return new ResponseClustering($result);
+		}
+		throw new ApiError('Can not convert result to ResponseClustering object.');
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -532,7 +532,7 @@ 
         ];
 
         return $this->toResponseAddress(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES . '/' . $addressId,
+            'url' => Endpoint::ADDRESSES.'/'.$addressId,
             'method' => 'PUT',
             'HTTPHEADER' => 'Content-Type: application/json',
             'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
@@ -886,7 +886,7 @@ 
     public function getAddressesAsynchronousJobStatus(string $jobId) : StatusChecker
     {
         return new StatusChecker(Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_JOB_TRACKER_STATUS . '/' . $jobId,
+            'url' => Endpoint::ADDRESSES_JOB_TRACKER_STATUS.'/'.$jobId,
             'method' => 'GET',
             'HTTPHEADER' => 'Accept: application/json',
             'return_headers' => ['X-R4M-Async-Job-Running-Time']
@@ -905,7 +905,7 @@ 
     public function getAddressesAsynchronousJobResult(string $jobId) : bool
     {
         $result = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESSES_JOB_TRACKER_RESULT . '/' . $jobId,
+            'url' => Endpoint::ADDRESSES_JOB_TRACKER_RESULT.'/'.$jobId,
             'method' => 'GET'
         ]);
         return (is_array($result) && isset($result['status']) && $result['status'] ? $result['status'] : false);

src/Route4Me/V5/Addresses/BundledItemResponse.php

Indentation +40 added lines, -40 removed lines

@@ -12,53 +12,53 @@
  */
 class BundledItemResponse extends \Route4Me\Common
 {
-    /** Summary cube value of the bundled addresses
-     * @var double $cube
-     */
-    public $cube;
+	/** Summary cube value of the bundled addresses
+	 * @var double $cube
+	 */
+	public $cube;
 
-    /** Summary revenue value of the bundled addresses
-     * @var double $revenue
-     */
-    public $revenue;
+	/** Summary revenue value of the bundled addresses
+	 * @var double $revenue
+	 */
+	public $revenue;
 
-    /** Summary pieces value of the bundled addresses
-     * @var integer $pieces
-     */
-    public $pieces;
+	/** Summary pieces value of the bundled addresses
+	 * @var integer $pieces
+	 */
+	public $pieces;
 
-    /** Summary weight value of the bundled addresses
-     * @var double $weight
-     */
-    public $weight;
+	/** Summary weight value of the bundled addresses
+	 * @var double $weight
+	 */
+	public $weight;
 
-    /** Summary cost value of the bundled addresses
-     * @var double $cost
-     */
-    public $cost;
+	/** Summary cost value of the bundled addresses
+	 * @var double $cost
+	 */
+	public $cost;
 
-    /** Service time of the bundled addresses
-     * @var integer $service_time
-     */
-    public $service_time;
+	/** Service time of the bundled addresses
+	 * @var integer $service_time
+	 */
+	public $service_time;
 
-    /** Time window start of the bundled addresses
-     * @var integer $time_window_start
-     */
-    public $time_window_start;
+	/** Time window start of the bundled addresses
+	 * @var integer $time_window_start
+	 */
+	public $time_window_start;
 
-    /** Time window emd of the bundled addresses
-     * @var integer $time_window_end
-     */
-    public $time_window_end;
+	/** Time window emd of the bundled addresses
+	 * @var integer $time_window_end
+	 */
+	public $time_window_end;
 
-    /** TO DO: Adjust description
-     * @var array $custom_data
-     */
-    public $custom_data = [];
+	/** TO DO: Adjust description
+	 * @var array $custom_data
+	 */
+	public $custom_data = [];
 
-    /** Array of the IDs of the bundeld addresses.
-     * @var integer[] $addresses_id
-     */
-    public $addresses_id = [];
+	/** Array of the IDs of the bundeld addresses.
+	 * @var integer[] $addresses_id
+	 */
+	public $addresses_id = [];
 }

src/Route4Me/V5/Addresses/RouteAdvancedConstraints.php

Indentation +48 added lines, -48 removed lines

@@ -11,60 +11,60 @@
  */
 class RouteAdvancedConstraints extends Common
 {
-    /**
-     * Maximum cargo volume per route.
-     * @var double
-     */
-    public $max_cargo_volume;
+	/**
+	 * Maximum cargo volume per route.
+	 * @var double
+	 */
+	public $max_cargo_volume;
 
-    /**
-     * Vehicle capacity.<br>
-     * How much total cargo can be transported per route (units, e.g. cubic meters)
-     * @var integer
-     */
-    public $max_capacity;
+	/**
+	 * Vehicle capacity.<br>
+	 * How much total cargo can be transported per route (units, e.g. cubic meters)
+	 * @var integer
+	 */
+	public $max_capacity;
 
-    /**
-     * Legacy feature which permits a user to request an example number of optimized routes.
-     * @var integer
-     */
-    public $members_count;
+	/**
+	 * Legacy feature which permits a user to request an example number of optimized routes.
+	 * @var integer
+	 */
+	public $members_count;
 
-    /**
-     * An array of the available time windows (e.g. [ [25200, 75000 ] )
-     * @var integer[]
-     */
-    public $available_time_windows;
+	/**
+	 * An array of the available time windows (e.g. [ [25200, 75000 ] )
+	 * @var integer[]
+	 */
+	public $available_time_windows;
 
-    /**
-     * The driver tags specified in a team member's custom data.<br>
-     * e.g. "driver skills":<br>
-     * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"]
-     * @var string[]
-     */
-    public $tags;
+	/**
+	 * The driver tags specified in a team member's custom data.<br>
+	 * e.g. "driver skills":<br>
+	 * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"]
+	 * @var string[]
+	 */
+	public $tags;
 
-    /**
-     * An array of the skilled driver IDs.
-     * @var integer[]
-     */
-    public $route4me_members_id;
+	/**
+	 * An array of the skilled driver IDs.
+	 * @var integer[]
+	 */
+	public $route4me_members_id;
 
-    /**
-     * An array containing Address objects.
-     * @var Address
-     */
-    public $depot_address;
+	/**
+	 * An array containing Address objects.
+	 * @var Address
+	 */
+	public $depot_address;
 
-    /**
-     * An array of locations.
-     * @var object[]
-     */
-    public $location_sequence_pattern;
+	/**
+	 * An array of locations.
+	 * @var object[]
+	 */
+	public $location_sequence_pattern;
 
-    /**
-     * Group.
-     * @var string
-     */
-    public $group;
+	/**
+	 * Group.
+	 * @var string
+	 */
+	public $group;
 }

src/Route4Me/V5/Addresses/Address.php

Indentation +649 added lines, -649 removed lines

@@ -14,653 +14,653 @@
  */
 class Address extends \Route4Me\Common
 {
-    /**
-     * Route destination ID
-     * @var integer
-     */
-    public $route_destination_id;
-
-    /**
-     * Route alias
-     * @var string
-     */
-    public $alias;
-
-    /**
-     * The ID of the member inside the Route4Me system.
-     * @var integer
-     */
-    public $member_id;
-
-    /**
-     * Route destination address
-     * @var string
-     */
-    public $address;
-
-    /**
-     * Designate this stop as a depot.
-     * A route may have multiple depots/points of origin.
-     * @var boolean
-     */
-    public $is_depot;
-
-    /**
-     * Timeframe violation state
-     * @var integer
-     */
-    public $timeframe_violation_state;
-
-    /**
-     * Timeframe violation time
-     * @var integer
-     */
-    public $timeframe_violation_time;
-
-    /**
-     * Timeframe violation rate
-     * @var double
-     */
-    public $timeframe_violation_rate;
-
-    /**
-     * The latitude of this address
-     * @var double
-     */
-    public $lat;
-
-    /**
-     * The longitude of this address
-     * @var double
-     */
-    public $lng;
-
-    /**
-     * Curbside latitude.
-     * Generate optimal routes and driving directions to this curbside latitude.
-     * @var double
-     */
-    public $curbside_lat;
-
-    /**
-     * Curbside longitude.
-     * Generate optimal routes and driving directions to the curbside longitude.
-     * @var double
-     */
-    public $curbside_lng;
-
-    /**
-     * If present, the priority will sequence addresses in all the optimal routes so that
-     * higher priority addresses are general at the beginning of the route sequence.
-     * 1 is the highest priority, 100000 is the lowest.
-     * @var integer
-     */
-    public $priority;
-
-    /**
-     * The ID of the route being viewed, modified, or erased.
-     * @var string
-     */
-    public $route_id;
-
-    /**
-     * If this route was duplicated from an existing route,
-     * this value would have the original route's ID.
-     * @var string
-     */
-    public $original_route_id;
-
-    /**
-     * Route name of a depot address.
-     * @var string
-     */
-    public $route_name;
-
-    /**
-     * The ID of the optimization request that was used to initially instantiate this route.
-     * @var string
-     */
-    public $optimization_problem_id;
-
-    /**
-     * The destination's sequence number in the route.
-     * @var integer
-     */
-    public $sequence_no;
-
-    /**
-     * True if the address is geocoded.
-     * @var boolean
-     */
-    public $geocoded;
-
-    /**
-     * The preferred geocoding number.
-     * @var integer
-     */
-    public $preferred_geocoding;
-
-    /**
-     * True if geocoding failed.
-     * @var boolean
-     */
-    public $failed_geocoding;
-
-    /**
-     * An array containing Geocoding objects.
-     * @var Geocoding[]
-     */
-    public $geocodings = [];
-
-    /**
-     * When planning a route from the address book or using existing address book IDs,
-     * pass the address book ID (contact_id) for an address so that Route4Me can run
-     * analytics on the address book addresses that were used to plan routes, and to find previous visits to
-     * favorite addresses.
-     * @var integer
-     */
-    public $contact_id;
-
-    /**
-     * The address order ID
-     * @var integer
-     */
-    public $order_id;
-
-    /**
-     * Route address stop type
-     * @var string
-     */
-    public $address_stop_type;
-
-    /**
-     * The status flag to mark an address as visited (aka check in).
-     * @var boolean
-     */
-    public $is_visited;
-
-    /**
-     * The last known visited timestamp of this address.
-     * @var integer
-     */
-    public $timestamp_last_visited;
-
-    /**
-     * Latitude of the visited address
-     * @var double
-     */
-    public $visited_lat;
-
-    /**
-     * Longitude of the visited address
-     * @var double
-     */
-    public $visited_lng;
-
-    /**
-     * The status flag to mark an address as departed (aka check out).
-     * @var boolean
-     */
-    public $is_departed;
-
-    /**
-     * Departed address latitude
-     * @var double
-     */
-    public $departed_lat;
-
-    /** Departed address longitude
-     * @var double
-     */
-    public $departed_lng;
-
-    /**
-     * he last known departed timestamp of this address.
-     * @var integer
-     */
-    public $timestamp_last_departed;
-
-    /**
-     * The address group
-     * @var string
-     */
-    public $group;
-
-    /**
-     * Pass-through data about this route destination.<br>
-     * The data will be visible on the manifest, website, and mobile apps.
-     * @var string
-     */
-    public $customer_po;
-
-    /**
-     * Pass-through data about this route destination.<br>
-     * The data will be visible on the manifest, website, and mobile apps.
-     * @var string
-     */
-    public $invoice_no;
-
-    /**
-     * Pass-through data about this route destination.<br>
-     * The data will be visible on the manifest, website, and mobile apps.
-     * @var string
-     */
-    public $reference_no;
-
-    /**
-     * Pass-through data about this route destination.<br>
-     * The data will be visible on the manifest, website, and mobile apps.
-     * @var string
-     */
-    public $order_no;
-
-    /**
-     * The address cargo weight
-     * @var double
-     */
-    public $weight;
-
-    /**
-     * The address cost
-     * @var double
-     */
-    public $cost;
-
-    /**
-     * The address revenue
-     * @var double
-     */
-    public $revenue;
-
-    /**
-     * The cubic volume that this destination/order/line-item consumes/contains.<br>
-     * This is how much space it will take up on a vehicle.
-     * @var double
-     */
-    public $cube;
-
-    /**
-     * The number of pieces/palllets that this destination/order/line-item consumes/contains on a vehicle.
-     * @var integer
-     */
-    public $pieces;
-
-    /**
-     * First name
-     * @var string
-     */
-    public $first_name;
-
-    /**
-     * Last name
-     * @var string
-     */
-    public $last_name;
-
-    /**
-     * Pass-through data about this route destination.
-     * The data will be visible on the manifest, website, and mobile apps.
-     * Also used to email clients when vehicles are approaching (future capability).
-     * @var string
-     */
-    public $email;
-
-    /**
-     * Pass-through data about this route destination.
-     * The data will be visible on the manifest, website, and mobile apps.
-     * Also used to send SMS messages to clients when vehicles are approaching (future capability).
-     * @var string
-     */
-    public $phone;
-
-    /**
-     * The number of notes that are already associated with this address on the route.
-     * @var integer
-     */
-    public $destination_note_count;
-
-    /**
-     * Server-side generated amount of km/miles that
-     * it will take to get to the next location on the route.
-     * @var integer
-     */
-    public $drive_time_to_next_destination;
-
-    /**
-     * Abnormal traffic time to next destination.
-     * @var integer
-     */
-    public $abnormal_traffic_time_to_next_destination;
-
-    /**
-     * Uncongested time to next destination.
-     * @var integer
-     */
-    public $uncongested_time_to_next_destination;
-
-    /**
-     * Traffic time to next destination.
-     * @var integer
-     */
-    public $traffic_time_to_next_destination;
-
-    /**
-     * Server-side generated amount of seconds
-     * that it will take to get to the next location.
-     * @var double
-     */
-    public $distance_to_next_destination;
-
-    /**
-     * The unique socket channel name which
-     * should be used to get real time alerts.
-     * @var string
-     */
-    public $channel_name;
-
-    /**
-     * Alias of a pickup point.
-     * @var string
-     */
-    public $pickup;
-
-    /**
-     * Alias of the paired pickup point.
-     * @var string
-     */
-    public $dropoff;
-
-    /**
-     * If equal to 1, the pickup and dropoff addresses are joint
-     * (one by one despite the regular pickup-dropoff addresses
-     * when it's possible to have multiple pickup addresses with one dropoff address).
-     * @var integer
-     */
-    public $joint;
-
-    /**
-     * Generated time window start.
-     * @var integer
-     */
-    public $generated_time_window_start;
-
-    /**
-     * Estimated time window end based on the optimization engine,
-     * after all the sequencing has been completed.
-     * @var integer
-     */
-    public $generated_time_window_end;
-
-    /**
-     * The address time window start.
-     * @var integer
-     */
-    public $time_window_start;
-
-    /**
-     * The address time window end.
-     * @var integer
-     */
-    public $time_window_end;
-
-    /**
-     * The address time window start 2.
-     * @var integer
-     */
-    public $time_window_start_2;
-
-    /**
-     * The address time window end 2.
-     * @var integer
-     */
-    public $time_window_end_2;
-
-    /**
-     * Geofence detected visited timestamp
-     * @var integer
-     */
-    public $geofence_detected_visited_timestamp;
-
-    /**
-     * Geofence detected departed timestamp
-     * @var integer
-     */
-    public $geofence_detected_departed_timestamp;
-
-    /**
-     * Geofence detected service time
-     * @var integer
-     */
-    public $geofence_detected_service_time;
-
-    /**
-     * Geofence detected visited latitude
-     * @var double
-     */
-    public $geofence_detected_visited_lat;
-
-    /**
-     * Geofence detected visited longitude
-     * @var double
-     */
-    public $geofence_detected_visited_lng;
-
-    /**
-     * Geofence detected departed latitude
-     * @var double
-     */
-    public $geofence_detected_departed_lat;
-
-    /**
-     * Geofence detected departed longitude
-     * @var double
-     */
-    public $geofence_detected_departed_lng;
-
-    /**
-     * The expected amount of time that will be spent
-     * at this address by the driver/user.
-     * @var integer
-     */
-    public $time;
-
-    /**
-     * System-wide unique code, which permits end-users (recipients)
-     * to track the status of their order.
-     * @var string
-     */
-    public $tracking_number;
-
-    /**
-     * The address custom fields.
-     * @var array
-     */
-    public $custom_fields = [];
-
-    /**
-     * The custom fields configuration in JSON format.
-     * @var string
-     */
-    public $custom_fields_str_json;
-
-    /**
-     * The custom fields configuration.
-     * @var string[]
-     */
-    public $custom_fields_config = [];
-
-    /**
-     * The custom fields configuration in JSON format.
-     * @var string
-     */
-    public $custom_fields_config_str_json;
-
-    /**
-     * The address notes
-     * @var AddressNote[]
-     */
-    public $notes = [];
-
-    /**
-     * Bundle count
-     * @var integer
-     */
-    public $bundle_count;
-
-    /**
-     * Bundle items
-     * @var BundledItemResponse[]
-     */
-    public $bundle_items;
-
-    /**
-     * List of the order inventories
-     * @var OrderInventory[]
-     */
-    public $order_inventory;
-
-    /**
-     * UDU distance to next destination.
-     * @var double
-     */
-    public $udu_distance_to_next_destination;
-
-    /**
-     * Wait time to next destination.
-     * @var integer
-     */
-    public $wait_time_to_next_destination;
-
-    /**
-     * Manifest of a route address.
-     * @var AddressManifest
-     */
-    public $manifest;
-
-    /**
-     * An array of the required driver skills for the address.
-     * @var array
-     */
-    public $required_skills = [];
-
-    public $additional_status;
-
-    public function __construct()
-    {
-        // TO DO: replace with API 5 endpoint after finishing.
-        Route4Me::setBaseUrl(Endpoint4::BASE_URL);
-    }
-
-    public static function getAddress($routeId, $addressId)
-    {
-        $address = Route4Me::makeRequst([
-            'url' => Endpoint4::ADDRESS_V4,
-            'method' => 'GET',
-            'query' => [
-                'route_id' => $routeId,
-                'route_destination_id' => $addressId,
-            ],
-        ]);
-
-        return self::fromArray($address);
-    }
-
-    public function update()
-    {
-        $addressUpdate = Route4Me::makeRequst([
-            'url' => Endpoint4::ADDRESS_V4,
-            'method' => 'PUT',
-            'body' => $this->toArray(),
-            'query' => [
-                'route_id' => $this->route_id,
-                'route_destination_id' => $this->route_destination_id,
-            ],
-        ]);
-
-        return self::fromArray($addressUpdate);
-    }
-
-    /**
-     * Marks an address as marked as visited/as departed
-     * depending on which parameter is specified: 'is_visited' or 'is_departed'.
-     */
-    public function markAddress($params)
-    {
-        $allQueryFields = ['route_id', 'route_destination_id'];
-        $allBodyFields = ['is_visited', 'is_departed'];
-
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint4::ADDRESS_V4,
-            'method' => 'PUT',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * Marks an address as departed.
-     */
-    public function markAsDeparted($params)
-    {
-        $allQueryFields = ['route_id', 'address_id', 'is_departed', 'member_id'];
-
-        $address = Route4Me::makeRequst([
-            'url' => Endpoint4::MARK_ADDRESS_DEPARTED,
-            'method' => 'PUT',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $address;
-    }
-
-    /**
-     * Marks an address as visited.
-     */
-    public function markAsVisited($params)
-    {
-        $allQueryFields = ['route_id', 'address_id', 'is_visited', 'member_id'];
-
-        $address = Route4Me::makeRequst([
-            'url' => Endpoint4::UPDATE_ADDRESS_VISITED,
-            'method' => 'PUT',
-            'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $address;
-    }
-
-    public function deleteAddress()
-    {
-        $address = Route4Me::makeRequst([
-            'url' => Endpoint4::ADDRESS_V4,
-            'method' => 'DELETE',
-            'query' => [
-                'route_id' => $this->route_id,
-                'route_destination_id' => $this->route_destination_id,
-            ],
-        ]);
-
-        return (bool)$address['deleted'];
-    }
-
-    public function moveDestinationToRoute($params)
-    {
-        $allBodyFields = ['to_route_id', 'route_destination_id', 'after_destination_id'];
-
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint4::MOVE_ROUTE_DESTINATION,
-            'method' => 'POST',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER' => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
-
-    public function getAddressId()
-    {
-        return $this->route_destination_id;
-    }
+	/**
+	 * Route destination ID
+	 * @var integer
+	 */
+	public $route_destination_id;
+
+	/**
+	 * Route alias
+	 * @var string
+	 */
+	public $alias;
+
+	/**
+	 * The ID of the member inside the Route4Me system.
+	 * @var integer
+	 */
+	public $member_id;
+
+	/**
+	 * Route destination address
+	 * @var string
+	 */
+	public $address;
+
+	/**
+	 * Designate this stop as a depot.
+	 * A route may have multiple depots/points of origin.
+	 * @var boolean
+	 */
+	public $is_depot;
+
+	/**
+	 * Timeframe violation state
+	 * @var integer
+	 */
+	public $timeframe_violation_state;
+
+	/**
+	 * Timeframe violation time
+	 * @var integer
+	 */
+	public $timeframe_violation_time;
+
+	/**
+	 * Timeframe violation rate
+	 * @var double
+	 */
+	public $timeframe_violation_rate;
+
+	/**
+	 * The latitude of this address
+	 * @var double
+	 */
+	public $lat;
+
+	/**
+	 * The longitude of this address
+	 * @var double
+	 */
+	public $lng;
+
+	/**
+	 * Curbside latitude.
+	 * Generate optimal routes and driving directions to this curbside latitude.
+	 * @var double
+	 */
+	public $curbside_lat;
+
+	/**
+	 * Curbside longitude.
+	 * Generate optimal routes and driving directions to the curbside longitude.
+	 * @var double
+	 */
+	public $curbside_lng;
+
+	/**
+	 * If present, the priority will sequence addresses in all the optimal routes so that
+	 * higher priority addresses are general at the beginning of the route sequence.
+	 * 1 is the highest priority, 100000 is the lowest.
+	 * @var integer
+	 */
+	public $priority;
+
+	/**
+	 * The ID of the route being viewed, modified, or erased.
+	 * @var string
+	 */
+	public $route_id;
+
+	/**
+	 * If this route was duplicated from an existing route,
+	 * this value would have the original route's ID.
+	 * @var string
+	 */
+	public $original_route_id;
+
+	/**
+	 * Route name of a depot address.
+	 * @var string
+	 */
+	public $route_name;
+
+	/**
+	 * The ID of the optimization request that was used to initially instantiate this route.
+	 * @var string
+	 */
+	public $optimization_problem_id;
+
+	/**
+	 * The destination's sequence number in the route.
+	 * @var integer
+	 */
+	public $sequence_no;
+
+	/**
+	 * True if the address is geocoded.
+	 * @var boolean
+	 */
+	public $geocoded;
+
+	/**
+	 * The preferred geocoding number.
+	 * @var integer
+	 */
+	public $preferred_geocoding;
+
+	/**
+	 * True if geocoding failed.
+	 * @var boolean
+	 */
+	public $failed_geocoding;
+
+	/**
+	 * An array containing Geocoding objects.
+	 * @var Geocoding[]
+	 */
+	public $geocodings = [];
+
+	/**
+	 * When planning a route from the address book or using existing address book IDs,
+	 * pass the address book ID (contact_id) for an address so that Route4Me can run
+	 * analytics on the address book addresses that were used to plan routes, and to find previous visits to
+	 * favorite addresses.
+	 * @var integer
+	 */
+	public $contact_id;
+
+	/**
+	 * The address order ID
+	 * @var integer
+	 */
+	public $order_id;
+
+	/**
+	 * Route address stop type
+	 * @var string
+	 */
+	public $address_stop_type;
+
+	/**
+	 * The status flag to mark an address as visited (aka check in).
+	 * @var boolean
+	 */
+	public $is_visited;
+
+	/**
+	 * The last known visited timestamp of this address.
+	 * @var integer
+	 */
+	public $timestamp_last_visited;
+
+	/**
+	 * Latitude of the visited address
+	 * @var double
+	 */
+	public $visited_lat;
+
+	/**
+	 * Longitude of the visited address
+	 * @var double
+	 */
+	public $visited_lng;
+
+	/**
+	 * The status flag to mark an address as departed (aka check out).
+	 * @var boolean
+	 */
+	public $is_departed;
+
+	/**
+	 * Departed address latitude
+	 * @var double
+	 */
+	public $departed_lat;
+
+	/** Departed address longitude
+	 * @var double
+	 */
+	public $departed_lng;
+
+	/**
+	 * he last known departed timestamp of this address.
+	 * @var integer
+	 */
+	public $timestamp_last_departed;
+
+	/**
+	 * The address group
+	 * @var string
+	 */
+	public $group;
+
+	/**
+	 * Pass-through data about this route destination.<br>
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * @var string
+	 */
+	public $customer_po;
+
+	/**
+	 * Pass-through data about this route destination.<br>
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * @var string
+	 */
+	public $invoice_no;
+
+	/**
+	 * Pass-through data about this route destination.<br>
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * @var string
+	 */
+	public $reference_no;
+
+	/**
+	 * Pass-through data about this route destination.<br>
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * @var string
+	 */
+	public $order_no;
+
+	/**
+	 * The address cargo weight
+	 * @var double
+	 */
+	public $weight;
+
+	/**
+	 * The address cost
+	 * @var double
+	 */
+	public $cost;
+
+	/**
+	 * The address revenue
+	 * @var double
+	 */
+	public $revenue;
+
+	/**
+	 * The cubic volume that this destination/order/line-item consumes/contains.<br>
+	 * This is how much space it will take up on a vehicle.
+	 * @var double
+	 */
+	public $cube;
+
+	/**
+	 * The number of pieces/palllets that this destination/order/line-item consumes/contains on a vehicle.
+	 * @var integer
+	 */
+	public $pieces;
+
+	/**
+	 * First name
+	 * @var string
+	 */
+	public $first_name;
+
+	/**
+	 * Last name
+	 * @var string
+	 */
+	public $last_name;
+
+	/**
+	 * Pass-through data about this route destination.
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * Also used to email clients when vehicles are approaching (future capability).
+	 * @var string
+	 */
+	public $email;
+
+	/**
+	 * Pass-through data about this route destination.
+	 * The data will be visible on the manifest, website, and mobile apps.
+	 * Also used to send SMS messages to clients when vehicles are approaching (future capability).
+	 * @var string
+	 */
+	public $phone;
+
+	/**
+	 * The number of notes that are already associated with this address on the route.
+	 * @var integer
+	 */
+	public $destination_note_count;
+
+	/**
+	 * Server-side generated amount of km/miles that
+	 * it will take to get to the next location on the route.
+	 * @var integer
+	 */
+	public $drive_time_to_next_destination;
+
+	/**
+	 * Abnormal traffic time to next destination.
+	 * @var integer
+	 */
+	public $abnormal_traffic_time_to_next_destination;
+
+	/**
+	 * Uncongested time to next destination.
+	 * @var integer
+	 */
+	public $uncongested_time_to_next_destination;
+
+	/**
+	 * Traffic time to next destination.
+	 * @var integer
+	 */
+	public $traffic_time_to_next_destination;
+
+	/**
+	 * Server-side generated amount of seconds
+	 * that it will take to get to the next location.
+	 * @var double
+	 */
+	public $distance_to_next_destination;
+
+	/**
+	 * The unique socket channel name which
+	 * should be used to get real time alerts.
+	 * @var string
+	 */
+	public $channel_name;
+
+	/**
+	 * Alias of a pickup point.
+	 * @var string
+	 */
+	public $pickup;
+
+	/**
+	 * Alias of the paired pickup point.
+	 * @var string
+	 */
+	public $dropoff;
+
+	/**
+	 * If equal to 1, the pickup and dropoff addresses are joint
+	 * (one by one despite the regular pickup-dropoff addresses
+	 * when it's possible to have multiple pickup addresses with one dropoff address).
+	 * @var integer
+	 */
+	public $joint;
+
+	/**
+	 * Generated time window start.
+	 * @var integer
+	 */
+	public $generated_time_window_start;
+
+	/**
+	 * Estimated time window end based on the optimization engine,
+	 * after all the sequencing has been completed.
+	 * @var integer
+	 */
+	public $generated_time_window_end;
+
+	/**
+	 * The address time window start.
+	 * @var integer
+	 */
+	public $time_window_start;
+
+	/**
+	 * The address time window end.
+	 * @var integer
+	 */
+	public $time_window_end;
+
+	/**
+	 * The address time window start 2.
+	 * @var integer
+	 */
+	public $time_window_start_2;
+
+	/**
+	 * The address time window end 2.
+	 * @var integer
+	 */
+	public $time_window_end_2;
+
+	/**
+	 * Geofence detected visited timestamp
+	 * @var integer
+	 */
+	public $geofence_detected_visited_timestamp;
+
+	/**
+	 * Geofence detected departed timestamp
+	 * @var integer
+	 */
+	public $geofence_detected_departed_timestamp;
+
+	/**
+	 * Geofence detected service time
+	 * @var integer
+	 */
+	public $geofence_detected_service_time;
+
+	/**
+	 * Geofence detected visited latitude
+	 * @var double
+	 */
+	public $geofence_detected_visited_lat;
+
+	/**
+	 * Geofence detected visited longitude
+	 * @var double
+	 */
+	public $geofence_detected_visited_lng;
+
+	/**
+	 * Geofence detected departed latitude
+	 * @var double
+	 */
+	public $geofence_detected_departed_lat;
+
+	/**
+	 * Geofence detected departed longitude
+	 * @var double
+	 */
+	public $geofence_detected_departed_lng;
+
+	/**
+	 * The expected amount of time that will be spent
+	 * at this address by the driver/user.
+	 * @var integer
+	 */
+	public $time;
+
+	/**
+	 * System-wide unique code, which permits end-users (recipients)
+	 * to track the status of their order.
+	 * @var string
+	 */
+	public $tracking_number;
+
+	/**
+	 * The address custom fields.
+	 * @var array
+	 */
+	public $custom_fields = [];
+
+	/**
+	 * The custom fields configuration in JSON format.
+	 * @var string
+	 */
+	public $custom_fields_str_json;
+
+	/**
+	 * The custom fields configuration.
+	 * @var string[]
+	 */
+	public $custom_fields_config = [];
+
+	/**
+	 * The custom fields configuration in JSON format.
+	 * @var string
+	 */
+	public $custom_fields_config_str_json;
+
+	/**
+	 * The address notes
+	 * @var AddressNote[]
+	 */
+	public $notes = [];
+
+	/**
+	 * Bundle count
+	 * @var integer
+	 */
+	public $bundle_count;
+
+	/**
+	 * Bundle items
+	 * @var BundledItemResponse[]
+	 */
+	public $bundle_items;
+
+	/**
+	 * List of the order inventories
+	 * @var OrderInventory[]
+	 */
+	public $order_inventory;
+
+	/**
+	 * UDU distance to next destination.
+	 * @var double
+	 */
+	public $udu_distance_to_next_destination;
+
+	/**
+	 * Wait time to next destination.
+	 * @var integer
+	 */
+	public $wait_time_to_next_destination;
+
+	/**
+	 * Manifest of a route address.
+	 * @var AddressManifest
+	 */
+	public $manifest;
+
+	/**
+	 * An array of the required driver skills for the address.
+	 * @var array
+	 */
+	public $required_skills = [];
+
+	public $additional_status;
+
+	public function __construct()
+	{
+		// TO DO: replace with API 5 endpoint after finishing.
+		Route4Me::setBaseUrl(Endpoint4::BASE_URL);
+	}
+
+	public static function getAddress($routeId, $addressId)
+	{
+		$address = Route4Me::makeRequst([
+			'url' => Endpoint4::ADDRESS_V4,
+			'method' => 'GET',
+			'query' => [
+				'route_id' => $routeId,
+				'route_destination_id' => $addressId,
+			],
+		]);
+
+		return self::fromArray($address);
+	}
+
+	public function update()
+	{
+		$addressUpdate = Route4Me::makeRequst([
+			'url' => Endpoint4::ADDRESS_V4,
+			'method' => 'PUT',
+			'body' => $this->toArray(),
+			'query' => [
+				'route_id' => $this->route_id,
+				'route_destination_id' => $this->route_destination_id,
+			],
+		]);
+
+		return self::fromArray($addressUpdate);
+	}
+
+	/**
+	 * Marks an address as marked as visited/as departed
+	 * depending on which parameter is specified: 'is_visited' or 'is_departed'.
+	 */
+	public function markAddress($params)
+	{
+		$allQueryFields = ['route_id', 'route_destination_id'];
+		$allBodyFields = ['is_visited', 'is_departed'];
+
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint4::ADDRESS_V4,
+			'method' => 'PUT',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * Marks an address as departed.
+	 */
+	public function markAsDeparted($params)
+	{
+		$allQueryFields = ['route_id', 'address_id', 'is_departed', 'member_id'];
+
+		$address = Route4Me::makeRequst([
+			'url' => Endpoint4::MARK_ADDRESS_DEPARTED,
+			'method' => 'PUT',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $address;
+	}
+
+	/**
+	 * Marks an address as visited.
+	 */
+	public function markAsVisited($params)
+	{
+		$allQueryFields = ['route_id', 'address_id', 'is_visited', 'member_id'];
+
+		$address = Route4Me::makeRequst([
+			'url' => Endpoint4::UPDATE_ADDRESS_VISITED,
+			'method' => 'PUT',
+			'query' => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $address;
+	}
+
+	public function deleteAddress()
+	{
+		$address = Route4Me::makeRequst([
+			'url' => Endpoint4::ADDRESS_V4,
+			'method' => 'DELETE',
+			'query' => [
+				'route_id' => $this->route_id,
+				'route_destination_id' => $this->route_destination_id,
+			],
+		]);
+
+		return (bool)$address['deleted'];
+	}
+
+	public function moveDestinationToRoute($params)
+	{
+		$allBodyFields = ['to_route_id', 'route_destination_id', 'after_destination_id'];
+
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint4::MOVE_ROUTE_DESTINATION,
+			'method' => 'POST',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER' => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
+
+	public function getAddressId()
+	{
+		return $this->route_destination_id;
+	}
 }

src/Route4Me/V5/Addresses/AddressNote.php

Indentation +201 added lines, -201 removed lines

@@ -13,207 +13,207 @@
  */
 class AddressNote extends \Route4Me\Common
 {
-    /** An unique ID of a note
-     * @var integer $note_id
-     */
-    public $note_id;
-
-    /** The route ID
-     * @var string $route_id
-     */
-    public $route_id;
-
-    /** The route destination ID
-     * @var integer $route_destination_id
-     */
-    public $route_destination_id;
-
-    /** An unique ID of an uploaded file
-     * @var string $upload_id
-     */
-    public $upload_id;
-
-    /** When the note was added
-     * @var integer $ts_added
-     */
-    public $ts_added;
-
-    /** The position latitude where the address note was added
-     * @var double $lat
-     */
-    public $lat;
-
-    /** The position longitude where the address note was added
-     * @var double $lng
-     */
-    public $lng;
-
-    /** The activity type
-     * @var string $activity_type
-     */
-    public $activity_type;
-
-    /** The note text contents
-     * @var string $contents
-     */
-    public $contents;
-
-    /** An upload type of the note
-     * @var string $upload_type
-     */
-    public $upload_type;
-
-    /** An upload url - where a file-note was uploaded.
-     * @var string $upload_url
-     */
-    public $upload_url;
-
-    /** An extension of the uploaded file.
-     * @var string $upload_extension
-     */
-    public $upload_extension;
-
-    /** The device a note was uploaded from
-     * @var string $device_type
-     */
-    public $device_type;
-
-    /** Array of the custom type notes
-     * @var AddressCustomNote[] $custom_types
-     */
-    public $custom_types = [];
-
-    public function __construct()
-    {
-    }
-
-    /*Get notes from the specified route destination
+	/** An unique ID of a note
+	 * @var integer $note_id
+	 */
+	public $note_id;
+
+	/** The route ID
+	 * @var string $route_id
+	 */
+	public $route_id;
+
+	/** The route destination ID
+	 * @var integer $route_destination_id
+	 */
+	public $route_destination_id;
+
+	/** An unique ID of an uploaded file
+	 * @var string $upload_id
+	 */
+	public $upload_id;
+
+	/** When the note was added
+	 * @var integer $ts_added
+	 */
+	public $ts_added;
+
+	/** The position latitude where the address note was added
+	 * @var double $lat
+	 */
+	public $lat;
+
+	/** The position longitude where the address note was added
+	 * @var double $lng
+	 */
+	public $lng;
+
+	/** The activity type
+	 * @var string $activity_type
+	 */
+	public $activity_type;
+
+	/** The note text contents
+	 * @var string $contents
+	 */
+	public $contents;
+
+	/** An upload type of the note
+	 * @var string $upload_type
+	 */
+	public $upload_type;
+
+	/** An upload url - where a file-note was uploaded.
+	 * @var string $upload_url
+	 */
+	public $upload_url;
+
+	/** An extension of the uploaded file.
+	 * @var string $upload_extension
+	 */
+	public $upload_extension;
+
+	/** The device a note was uploaded from
+	 * @var string $device_type
+	 */
+	public $device_type;
+
+	/** Array of the custom type notes
+	 * @var AddressCustomNote[] $custom_types
+	 */
+	public $custom_types = [];
+
+	public function __construct()
+	{
+	}
+
+	/*Get notes from the specified route destination
      * Returns an address object with notes, if an address exists, otherwise - return null.
      */
-    public static function GetAddressesNotes($noteParams)
-    {
-        $address = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_V4,
-            'method'    => 'GET',
-            'query'     => [
-                'route_id'              => isset($noteParams['route_id']) ? $noteParams['route_id'] : null,
-                'route_destination_id'  => isset($noteParams['route_destination_id'])
-                    ? $noteParams['route_destination_id'] : null,
-                'notes' => 1,
-            ],
-        ]);
-
-        return $address;
-    }
-
-    public function createCustomNoteType($params)
-    {
-        $allBodyFields = ['type', 'values'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    public function removeCustomNoteType($params)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'DELETE',
-            'body'      => [
-                'id' => isset($params['id']) ? $params['id'] : null,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function getAllCustomNoteTypes()
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'GET',
-        ]);
-
-        return $result;
-    }
-
-    public function getCustomNoteTypeByKey($params)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'GET',
-        ]);
-
-        if (is_null($result) || !is_array($result)) return null;
-
-        foreach ($result as $custNoteType) {
-            if (isset($custNoteType["note_custom_type"]) && $custNoteType["note_custom_type"] == $params) {
-                return $custNoteType;
-            }
-        }
-    }
-
-    public function AddAddressNote($params)
-    {
-        $allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
-        $allBodyFields = ['strNoteContents', 'strUpdateType'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
-
-    public function AddNoteFile($params)
-    {
-        $fname = isset($params['strFilename']) ? $params['strFilename'] : null;
-
-        $allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
-        $allBodyFields = ['strFilename', 'strUpdateType', 'strNoteContents'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'FILE'          => $fname,
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data'
-        ]);
-
-        return $result;
-    }
-
-    public function addCustomNoteToRoute($params)
-    {
-        $customArray = [];
-
-        foreach ($params as $key => $value) {
-            if (false !== strpos($key, 'custom_note_type')) {
-                $customArray[$key] = $value;
-            }
-        }
-
-        $allQueryFields = ['route_id', 'address_id', 'format', 'dev_lat', 'dev_lng'];
-        $allBodyFields = ['strUpdateType', 'strUpdateType', 'strNoteContents'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => array_merge(Route4Me::generateRequestParameters($allBodyFields, $params), $customArray),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
+	public static function GetAddressesNotes($noteParams)
+	{
+		$address = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_V4,
+			'method'    => 'GET',
+			'query'     => [
+				'route_id'              => isset($noteParams['route_id']) ? $noteParams['route_id'] : null,
+				'route_destination_id'  => isset($noteParams['route_destination_id'])
+					? $noteParams['route_destination_id'] : null,
+				'notes' => 1,
+			],
+		]);
+
+		return $address;
+	}
+
+	public function createCustomNoteType($params)
+	{
+		$allBodyFields = ['type', 'values'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $result;
+	}
+
+	public function removeCustomNoteType($params)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'DELETE',
+			'body'      => [
+				'id' => isset($params['id']) ? $params['id'] : null,
+			],
+		]);
+
+		return $result;
+	}
+
+	public function getAllCustomNoteTypes()
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'GET',
+		]);
+
+		return $result;
+	}
+
+	public function getCustomNoteTypeByKey($params)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'GET',
+		]);
+
+		if (is_null($result) || !is_array($result)) return null;
+
+		foreach ($result as $custNoteType) {
+			if (isset($custNoteType["note_custom_type"]) && $custNoteType["note_custom_type"] == $params) {
+				return $custNoteType;
+			}
+		}
+	}
+
+	public function AddAddressNote($params)
+	{
+		$allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
+		$allBodyFields = ['strNoteContents', 'strUpdateType'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
+
+	public function AddNoteFile($params)
+	{
+		$fname = isset($params['strFilename']) ? $params['strFilename'] : null;
+
+		$allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
+		$allBodyFields = ['strFilename', 'strUpdateType', 'strNoteContents'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'FILE'          => $fname,
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data'
+		]);
+
+		return $result;
+	}
+
+	public function addCustomNoteToRoute($params)
+	{
+		$customArray = [];
+
+		foreach ($params as $key => $value) {
+			if (false !== strpos($key, 'custom_note_type')) {
+				$customArray[$key] = $value;
+			}
+		}
+
+		$allQueryFields = ['route_id', 'address_id', 'format', 'dev_lat', 'dev_lng'];
+		$allBodyFields = ['strUpdateType', 'strUpdateType', 'strNoteContents'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => array_merge(Route4Me::generateRequestParameters($allBodyFields, $params), $customArray),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
 }

src/Route4Me/V5/TelematicsPlatform/Connection.php

Indentation +112 added lines, -112 removed lines

@@ -9,117 +9,117 @@
  */
 class Connection extends Common
 {
-    /**
-     * Telemetics connection name
-     * @var type string
-     */
-    public $name;
-    
-    /**
-     * Telemetics connection type
-     * @var type string
-     */
-    public $vendor;
+	/**
+	 * Telemetics connection name
+	 * @var type string
+	 */
+	public $name;
+    
+	/**
+	 * Telemetics connection type
+	 * @var type string
+	 */
+	public $vendor;
    
-    /**
-     * Telematics connection access host
-     * @var type string
-     */
-    public $host;
-    
-    /**
-     * Telematics connection access api_key
-     * @var type string
-     */
-    public $api_key;
-    
-    /**
-     * Telematics connection access account ID.
-     * @var type string
-     */
-    public $account_id;
-    
-    /**
-     * Telematics connection access username
-     * @var type string
-     */
-    public $username;
-    
-    /**
-     * Telematics connection access password
-     * @var type string
-     */
-    public $password;
-    
-    /**
-     * Telematics connection access token
-     * @var type string
-     */
-    public $connection_token;
-    
-    /**
-     * Telemetics connection type ID
-     * @var type integer
-     */
-    public $vendor_id;
-    
-    /**
-     * Disable/enable vehicle tracking
-     * @var type Boolean
-     */
-    public $is_enabled;
-    
-    /**
-     * Vehicle tracking interval in seconds
-     * @var type integer
-     */
-    public $vehicle_position_refresh_rate;
-    
-    /**
-     * Maximum idle time
-     * @var type integer
-     */
-    public $max_idle_time;
-    
-    /**
-     * Syncronized vehicles count
-     * @var type integer
-     */
-    public $synced_vehicles_count;
-    
-    /**
-     * Total vehicles count
-     * @var type integer
-     */
-    public $total_vehicles_count;
-    
-    /**
-     * Total addresses count
-     * @var type integer
-     */
-    public $total_addresses_count;
-    
-    /**
-     * The last timestamp the vehicles reloaded
-     * @var type string
-     */
-    public $last_vehicles_reload;
-    
-    /**
-     * The last timestamp the addresses reloaded
-     * @var type string
-     */
-    public $last_addresses_reload;
-    
-    /**
-     * The last timestamp the postions reloaded
-     * @var type string
-     */
-    public $last_position_reload;
-    
-    /**
-     * Metadata, custom key-value storage.
-     * @var type array
-     */
-    public $metadata = [];
+	/**
+	 * Telematics connection access host
+	 * @var type string
+	 */
+	public $host;
+    
+	/**
+	 * Telematics connection access api_key
+	 * @var type string
+	 */
+	public $api_key;
+    
+	/**
+	 * Telematics connection access account ID.
+	 * @var type string
+	 */
+	public $account_id;
+    
+	/**
+	 * Telematics connection access username
+	 * @var type string
+	 */
+	public $username;
+    
+	/**
+	 * Telematics connection access password
+	 * @var type string
+	 */
+	public $password;
+    
+	/**
+	 * Telematics connection access token
+	 * @var type string
+	 */
+	public $connection_token;
+    
+	/**
+	 * Telemetics connection type ID
+	 * @var type integer
+	 */
+	public $vendor_id;
+    
+	/**
+	 * Disable/enable vehicle tracking
+	 * @var type Boolean
+	 */
+	public $is_enabled;
+    
+	/**
+	 * Vehicle tracking interval in seconds
+	 * @var type integer
+	 */
+	public $vehicle_position_refresh_rate;
+    
+	/**
+	 * Maximum idle time
+	 * @var type integer
+	 */
+	public $max_idle_time;
+    
+	/**
+	 * Syncronized vehicles count
+	 * @var type integer
+	 */
+	public $synced_vehicles_count;
+    
+	/**
+	 * Total vehicles count
+	 * @var type integer
+	 */
+	public $total_vehicles_count;
+    
+	/**
+	 * Total addresses count
+	 * @var type integer
+	 */
+	public $total_addresses_count;
+    
+	/**
+	 * The last timestamp the vehicles reloaded
+	 * @var type string
+	 */
+	public $last_vehicles_reload;
+    
+	/**
+	 * The last timestamp the addresses reloaded
+	 * @var type string
+	 */
+	public $last_addresses_reload;
+    
+	/**
+	 * The last timestamp the postions reloaded
+	 * @var type string
+	 */
+	public $last_position_reload;
+    
+	/**
+	 * Metadata, custom key-value storage.
+	 * @var type array
+	 */
+	public $metadata = [];
 }

src/Route4Me/V5/TelematicsPlatform/ConnectionParameters.php

Indentation +67 added lines, -67 removed lines

@@ -10,83 +10,83 @@
  */
 class ConnectionParameters extends Common
 {
-    /**
-     * Telemetics connection type
-     * @var type string
-     */
-    public $vendor;
+	/**
+	 * Telemetics connection type
+	 * @var type string
+	 */
+	public $vendor;
     
-    /**
-     * Telemetics connection type ID
-     * @var type integer
-     */
-    public $vendor_id;
+	/**
+	 * Telemetics connection type ID
+	 * @var type integer
+	 */
+	public $vendor_id;
     
-    /**
-     * Telemetics connection name
-     * Required for telematics connection registration.
-     * @var type string
-     */
-    public $name;
+	/**
+	 * Telemetics connection name
+	 * Required for telematics connection registration.
+	 * @var type string
+	 */
+	public $name;
     
-    /**
-     * Telematics connection access host.
-     * @var type string
-     */
-    public $host;
+	/**
+	 * Telematics connection access host.
+	 * @var type string
+	 */
+	public $host;
     
-    /**
-     * Telematics connection access api_key.
-     * @var type string
-     */
-    public $api_key;
+	/**
+	 * Telematics connection access api_key.
+	 * @var type string
+	 */
+	public $api_key;
     
-    /**
-     * Telematics connection access account_id.
-     * @var type string
-     */
-    public $account_id;
+	/**
+	 * Telematics connection access account_id.
+	 * @var type string
+	 */
+	public $account_id;
     
-    /**
-     * Telematics connection access username
-     * @var type string
-     */
-    public $username;
+	/**
+	 * Telematics connection access username
+	 * @var type string
+	 */
+	public $username;
     
-    /**
-     * Telematics connection access password.
-     * @var type string
-     */
-    public $password;
+	/**
+	 * Telematics connection access password.
+	 * @var type string
+	 */
+	public $password;
     
-    /**
-     * Vehicle tracking interval in seconds (default value 60).
-     * @var type integer
-     */
-    public $vehicle_position_refresh_rate;
+	/**
+	 * Vehicle tracking interval in seconds (default value 60).
+	 * @var type integer
+	 */
+	public $vehicle_position_refresh_rate;
     
-    /**
-     * Validate connections credentials.
-     * @var type Boolean
-     */
-    public $validate_remote_credentials;
+	/**
+	 * Validate connections credentials.
+	 * @var type Boolean
+	 */
+	public $validate_remote_credentials;
     
-    /**
-     * Disable/enable vehicle tracking.
-     * @var type Boolean
-     */
-    public $is_enabled;
+	/**
+	 * Disable/enable vehicle tracking.
+	 * @var type Boolean
+	 */
+	public $is_enabled;
     
-    /**
-     * Metadata
-     * @var type string
-     */
-    public $metadata;
+	/**
+	 * Metadata
+	 * @var type string
+	 */
+	public $metadata;
     
-    /**
-     * Telematics connection access token.
-     * Required to show specified connection.
-     * @var type string
-     */
-    public $connection_token;
+	/**
+	 * Telematics connection access token.
+	 * Required to show specified connection.
+	 * @var type string
+	 */
+	public $connection_token;
 }