Merge pull request #5 from Olman62/Editing2

feat: added new library features, examples and tests

Author: pwnded

route4me-csharp-sdk/Route4MeSDKLibrary/Consts.cs

@@ -92,10 +92,13 @@ public static class R4MEInfrastructureSettingsV5
         public const string ApiVersion = "5";
 
         public const string MainHost = "https://wh.route4me.com/modules/api/v5.0";
+        public const string MainHost51 = "https://wh.route4me.com/modules/api/v5.1";
 
         public const string MainHostWeb = "https://wh.route4me.com/modules/webapi/v5.0";
 
         public const string Routes = MainHost + "/routes";
+        public const string Routes51 = MainHost51 + "/routes";
+
         public const string RoutesDuplicate = MainHost + "/routes/duplicate";
         public const string RoutesMerge = MainHost + "/routes/merge";
         public const string RoutesPaginate = MainHost + "/routes/paginate";
@@ -107,6 +110,7 @@ public static class R4MEInfrastructureSettingsV5
         public const string RoutesDatatableConfig = MainHost + "/routes/datatable/config";
         public const string RoutesDatatableConfigFallback = MainHost + "/routes/fallback/datatable/config";
         public const string RouteBreaks = MainHost + "/route-breaks";
+        public const string RouteAddressDynamicInsert = MainHost + "/routes/lookup-for-new-destination";
 
         public const string TeamUsers = MainHost + "/team/users";
 
@@ -120,18 +124,40 @@ public static class R4MEInfrastructureSettingsV5
 
         public const string Vehicles = MainHost + "/vehicles";
 
+        public const string VehiclePaginated = MainHost + "/vehicles/paginate";
+
         public const string VehicleTemporary = MainHost + "/vehicles/assign";
 
         public const string VehicleExecuteOrder = MainHost + "/vehicles/execute";
 
         public const string VehicleLocation = MainHost + "/vehicles/location";
 
-        public const string VehicleProfiles = MainHost + "/vehicle-profiles";
+        public const string VehicleSyncTelematics = MainHost + "/vehicles/sync/pending";
 
         public const string VehicleLicense = MainHost + "/vehicles/license";
 
         public const string VehicleSearch = MainHost + "/vehicles/search";
 
+
+        public const string VehicleProfiles = MainHost + "/vehicle-profiles";
+
+        public const string VehicleCapacityProfiles = MainHost + "/vehicle-capacity-profiles";
+
+
+        public const string VehicleBulkActivate = MainHost + "/vehicles/bulk/activate";
+
+        public const string VehicleBulkDeactivate = MainHost + "/vehicles/bulk/deactivate";
+
+        public const string VehicleBulkDelete = MainHost + "/vehicles/bulk/delete";
+
+        public const string VehicleBulkRestore = MainHost + "/vehicles/bulk/restore";
+
+        public const string VehicleBulkUpdate = MainHost + "/vehicles/bulk/update";
+
+        public const string VehicleJobResult = MainHost + "/vehicles/job-tracker/result";
+
+        public const string VehicleJobStatus = MainHost + "/vehicles/job-tracker/status";
+
         #endregion
 
         #region Telematics Platform
@@ -214,8 +240,8 @@ public static class R4MEInfrastructureSettingsV5
         public const string ContactsExport = ContactHost + "/addresses/export";
         public const string ContactsExportByAreas = ContactHost + "/addresses/export-by-areas";
         public const string ContactsExportByAreaIds = ContactHost + "/addresses/export-by-area-ids";
-        public const string ContactsGetAsyncJobStatus = ContactHost + "/addresses/job-tracker/status/{job_id}";
-        public const string ContactsGetAsyncJobResult = ContactHost + "/addresses/job-tracker/result/{job_id}";
+        public const string ContactsGetAsyncJobStatus = ContactHost + "/job-tracker/status";
+        public const string ContactsGetAsyncJobResult = ContactHost + "/job-tracker/result";
         public const string AddressBookDepots = ContactHost + "/addresses/depots";
 
         #endregion

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/Enums.cs

@@ -251,13 +251,15 @@ public enum TerritoryType : uint
     ///     <para>Coordinates = 2, group locations by coordinates</para>
     ///     <para>AddressId = 3, group locations by list of the address IDs</para>
     ///     <para>Address = 4, group locations by address custom fields</para>
+    ///     <para>MultipleFields = 5, group locations by multiple address fields</para>
     /// </summary>
     public enum AddressBundlingMode : uint
     {
         Address = 1,
         Coordinates = 2,
         AddressId = 3,
-        AddressCustomField = 4
+        AddressCustomField = 4,
+        MultipleFields = 5
     }
 
     /// <summary>
@@ -314,4 +316,39 @@ public enum TelematicsVendorType : uint
     }
 
     #endregion
+
+    /// <summary>
+    ///     Enumeration of the order statuses
+    /// </summary>
+    public enum OrderStatuses : uint
+    {
+        New = 0,
+        InboundScan = 1,
+        SortedByTerritory = 2,
+        Loaded = 3,
+        Missing = 4,
+        Damaged = 5,
+        ManuallyLoaded = 6,
+        Routed = 7,
+        Unrouted = 8,
+        SortedByRoute = 9,
+        RouteStarted = 10,
+        Failed = 11,
+        Skipped = 12,
+        Done = 13,
+        Cancelled = 14,
+        Scheduled = 15
+    }
+
+    /// <summary>
+    /// Route balancing modes
+    /// </summary>
+    public enum BalanceModes : uint
+    {
+        [Description("distance")] Distance,
+
+        [Description("time")] Time,
+
+        [Description("destinations_count")] DestinationsCount
+    }
 }

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/OrderCustomField.cs

@@ -1,5 +1,4 @@
-using System.Collections.Generic;
-using System.Runtime.Serialization;
+using System.Runtime.Serialization;
 
 namespace Route4MeSDK.DataTypes
 {
@@ -47,11 +46,33 @@ public sealed class OrderCustomField
 
         /// <summary>
         ///     Information about an order's custom field.
-        ///     You can specify the propertiesof the different types in this property,
+        ///     You can specify the properties of the different types in this property,
         ///     but the property "short_label" is reserved - it specifies custom field column header
         ///     in the orders table in the page: https://route4me.com/orders
         /// </summary>
         [DataMember(Name = "order_custom_field_type_info", EmitDefaultValue = false)]
-        public Dictionary<string, object> OrderCustomFieldTypeInfo { get; set; }
+        public CustomOrderTypeInfo OrderCustomFieldTypeInfo { get; set; }
+    }
+
+    [DataContract]
+    public class CustomOrderTypeInfo
+    {
+        /// <summary>
+        ///     Short label.
+        /// </summary>
+        [DataMember(Name = "short_label", EmitDefaultValue = false)]
+        public string ShortLabel { get; set; }
+
+        /// <summary>
+        ///     Short caption.
+        /// </summary>
+        [DataMember(Name = "short_caption", EmitDefaultValue = false)]
+        public string ShortCaption { get; set; }
+
+        /// <summary>
+        ///     Allowed values.
+        /// </summary>
+        [DataMember(Name = "allowed_values", EmitDefaultValue = false)]
+        public string[] AllowedValues { get; set; }
     }
 }

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/RouteParameters.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.Runtime.Serialization;
@@ -263,8 +264,6 @@ public sealed class RouteParameters
         [DataMember(Name = "metric", EmitDefaultValue = false)]
         public Metric Metric { get; set; }
 
-        //the type of algorithm to use when optimizing the route
-
         /// <summary>
         ///     The algorithm type to use when optimizing the route. See <see cref="DataTypes.AlgorithmType" />
         /// </summary>
@@ -666,6 +665,18 @@ public sealed class RouteParameters
         [DataMember(Name = "use_mixed_pickup_delivery_demands", EmitDefaultValue = false)]
         [DefaultValue(false)]
         public bool UseMixedPickupDeliveryDemands { get; set; }
+
+        /// <summary>
+        /// Route balancing.
+        /// </summary>
+        [DataMember(Name = "balance", EmitDefaultValue = false)]
+        public Balance Balance { get; set; }
+
+        /// <summary>
+        /// Specifies a maximum number of the routes by advanced constraint groups.
+        /// </summary>
+        [DataMember(Name = "group_max_routes", EmitDefaultValue = false)]
+        public List<object[]> GroupMaxRoutes { get; set; }
     }
 
     /// <summary>
@@ -729,4 +740,13 @@ public SlowdownParams()
         [DataMember(Name = "travel_time", EmitDefaultValue = false)]
         public int? TravelTime { get; set; }
     }
+
+    public class Balance
+    {
+        /// <summary>
+        /// Route balancing modes. <see cref="BalanceModes"/>
+        /// </summary>
+        [DataMember(Name = "mode", EmitDefaultValue = false)]
+        public string Mode { get; set; }
+    }
 }

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/TimePredictionModel.cs

@@ -18,7 +18,7 @@ public sealed class TimePredictionModel
         /// Time-consuming prediction for an action model.
         /// </summary>
         [DataMember(Name = "value", EmitDefaultValue = false)]
-        public long Value { get; set; }
+        public long? Value { get; set; }
 
         /// <summary>
         /// Time unit (e.g. 'seconds', 'minutes')

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/V5/Address/Address.cs

@@ -21,11 +21,17 @@ public class Address : GenericParameters
         [DataMember(Name = "route_destination_id", EmitDefaultValue = false)]
         public long? RouteDestinationId { get; set; }
 
+        string _alias;
+
         /// <summary>
         ///     Address alias
         /// </summary>
         [DataMember(Name = "alias", EmitDefaultValue = false)]
-        public string Alias { get; set; }
+        public string Alias 
+        { 
+            get { return _alias;  }
+            set { _alias = value=="" ? null : value;  } 
+        }
 
         /// <summary>
         ///     Member ID
@@ -49,13 +55,13 @@ public class Address : GenericParameters
         /// <summary>
         ///     Route destination address
         /// </summary>
-        [DataMember(Name = "address")]
+        [DataMember(Name = "address", EmitDefaultValue = false)]
         public string AddressString { get; set; }
 
         /// <summary>
         ///     Route address stop type
         /// </summary>
-        [DataMember(Name = "address_stop_type")]
+        [DataMember(Name = "address_stop_type", EmitDefaultValue = false)]
         public string AddressStopType { get; set; }
 
         /// <summary>
@@ -472,14 +478,14 @@ public class Address : GenericParameters
         ///     Curbside latitude.
         ///     Generate optimal routes and driving directions to this curbside latitude.
         /// </summary>
-        [DataMember(Name = "curbside_lat")]
+        [DataMember(Name = "curbside_lat", EmitDefaultValue = false)]
         public double? CurbsideLatitude { get; set; }
 
         /// <summary>
         ///     Curbside longitude.
         ///     Generate optimal routes and driving directions to the curbside longitude.
         /// </summary>
-        [DataMember(Name = "curbside_lng")]
+        [DataMember(Name = "curbside_lng", EmitDefaultValue = false)]
         public double? CurbsideLongitude { get; set; }
 
         /// <summary>

route4me-csharp-sdk/Route4MeSDKLibrary/DataTypes/V5/DriverReview.cs

@@ -4,6 +4,19 @@
 
 namespace Route4MeSDK.DataTypes.V5
 {
+    /// <summary>
+    ///     The data structure of a driver review response (create, update).
+    /// </summary>
+    [DataContract]
+    public sealed class DriverReviewResponse
+    {
+        /// <summary>
+        ///     The data object containing a driver review object.
+        /// </summary>
+        [DataMember(Name = "data")]
+        public DriverReview Data { get; set; }
+    }
+
     /// <summary>
     ///     The data structure of a retrieved driver review.
     /// </summary>
@@ -46,6 +59,7 @@ public sealed class DriverReview : GenericParameters
     /// <summary>
     ///     The data structure of a retrieved driver reviews list.
     /// </summary>
+    [DataContract]
     public sealed class DriverReviewsResponse
     {
         /// <summary>
@@ -70,6 +84,7 @@ public sealed class DriverReviewsResponse
     /// <summary>
     ///     Data structure of the response pagination info.
     /// </summary>
+    [DataContract]
     public sealed class SimplePaginationData
     {
         /// <summary>
@@ -92,14 +107,15 @@ public sealed class SimplePaginationData
 
         [DataMember(Name = "first")] public string First { get; set; }
 
-        [DataMember(Name = "prev")] public int? Previous { get; set; }
+        [DataMember(Name = "prev")] public string Previous { get; set; }
 
-        [DataMember(Name = "next")] public int? Next { get; set; }
+        [DataMember(Name = "next")] public string Next { get; set; }
     }
 
     /// <summary>
     ///     Driver rating quantity by types.
     /// </summary>
+    [DataContract]
     public sealed class TypeQuantity
     {
         [DataMember(Name = "type")] public int Type { get; set; }