ANnotations for JSON serialisation to ensure the json is serialised in the manner the API expects

NULL values should be ignored. Enums must be passed as their string name, not that int value. DateTimes should be nullable so that DateTime.MinValue is not sent, which would be bad for the expiry time.

Author: David Edgar

MessageMedia.SDK.Messages/Models/Message.cs

@@ -1,73 +1,78 @@
 using System;
 using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace MessageMedia.Messages.Models
 {
     public struct Message
     {
-        [JsonProperty("message_id")] public string MessageId { get; set; }
+        [JsonProperty("message_id", NullValueHandling = NullValueHandling.Ignore)] public string MessageId { get; set; }
 
         /// <summary>
         /// Urls of the media files to send in the Message
         /// 
         /// <remarks>Only valid if the Format is MMS</remarks>
         /// </summary>
-        [JsonProperty("media")] public string[] Media { get; set; }
+        [JsonProperty("media", NullValueHandling = NullValueHandling.Ignore)] public string[] Media { get; set; }
 
         /// <summary>
         /// Subject of the Message
         /// 
         /// <remarks>Only valid if the Format is MMS</remarks>
         /// </summary>
-        [JsonProperty("subject")] public string Subject { get; set; }
+        [JsonProperty("subject", NullValueHandling = NullValueHandling.Ignore)] public string Subject { get; set; }
 
-        [JsonProperty("status")] public MessageStatus Status { get; set; }
+        [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)]
+        [JsonConverter(typeof(StringEnumConverter))]
+        public MessageStatus? Status { get; set; }
 
         /// <summary>
         /// Replies and delivery reports for this message will be pushed to the URL"
         /// </summary>
-        [JsonProperty("callback_url")] public string CallbackUrl { get; set; }
+        [JsonProperty("callback_url", NullValueHandling = NullValueHandling.Ignore)] public string CallbackUrl { get; set; }
 
         /// <summary>
         /// Content of the message
         /// <example>Hello world!</example>
         /// </summary>
-        [JsonProperty("content")] public string Content { get; set; }
+        [JsonProperty("content", NullValueHandling = NullValueHandling.Ignore)] public string Content { get; set; }
 
         /// <summary>
         /// Destination number of the message
         /// <example>+61491570156</example>
         /// </summary>
-        [JsonProperty("destination_number")] public string DestinationNumber { get; set; }
+        [JsonProperty("destination_number", NullValueHandling = NullValueHandling.Ignore)] public string DestinationNumber { get; set; }
 
         /// <summary>
         /// Request a delivery report for this message
         /// </summary>
-        [JsonProperty("delivery_report")] public bool DeliveryReport { get; set; }
+        [JsonProperty("delivery_report", NullValueHandling = NullValueHandling.Ignore)] public bool DeliveryReport { get; set; }
 
         /// <summary>
         /// Format of message, SMS or TTS (Text To Speech).
         /// </summary>
-        [JsonProperty("format")] public MessageFormat Format { get; set; }
+        [JsonProperty("format", NullValueHandling = NullValueHandling.Ignore)]
+        [JsonConverter(typeof(StringEnumConverter))]
+        public MessageFormat Format { get; set; }
 
         /// <summary>
         /// Date time after which the message expires and will not be sent
         /// </summary>
-        [JsonProperty("message_expiry_timestamp")]
-        public DateTime MessageExpiryTimestamp { get; set; }
+        [JsonProperty("message_expiry_timestamp", NullValueHandling = NullValueHandling.Ignore)]
+        public DateTime? MessageExpiryTimestamp { get; set; }
 
         /// <summary>
         /// Metadata for the message specified as a set of key value pairs.
         /// 
         /// <remarks>Each key can be up to 100 characters long and each value can be up to 256 characters long.</remarks>
         /// </summary>
-        [JsonProperty("metadata")] public Dictionary<string, string> Metadata { get; set; }
+        [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)] public Dictionary<string, string> Metadata { get; set; }
 
         /// <summary>
         /// Scheduled delivery date time of the message
         /// </summary>
-        [JsonProperty("scheduled")] public DateTime Scheduled { get; set; }
+        [JsonProperty("scheduled", NullValueHandling = NullValueHandling.Ignore)] public DateTime? Scheduled { get; set; }
 
         /// <summary>
         /// Source of the message
@@ -77,11 +82,13 @@ public struct Message
         /// 
         /// <remarks>By default this feature is not available and will be ignored in the request. Please contact [email protected] for more information. Specifying a source number is optional and a by default a source number will be assigned to the message.</remarks>
         /// </summary>
-        [JsonProperty("source_number")] public string SourceNumber { get; set; }
+        [JsonProperty("source_number", NullValueHandling = NullValueHandling.Ignore)] public string SourceNumber { get; set; }
 
         /// <summary>
         /// Type of source address specified
         /// </summary>
-        [JsonProperty("source_number_type")] public NumberType SourceNumberType { get; set; }
+        [JsonProperty("source_number_type", NullValueHandling = NullValueHandling.Ignore)]
+        [JsonConverter(typeof(StringEnumConverter))]
+        public NumberType SourceNumberType { get; set; }
     }
 }