backend/feat/#146 : Adding extra params to send sms

lib/mobility-core/src/Kernel/External/SMS/ExotelSms/Flow.hs

@@ -19,6 +19,7 @@ import EulerHS.Prelude
 import EulerHS.Types as ET
 import qualified Kernel.External.SMS.ExotelSms.API as API
 import Kernel.External.SMS.ExotelSms.Types
+import qualified Kernel.External.SMS.Interface.Types as IT
 import Kernel.Tools.Metrics.CoreMetrics (CoreMetrics)
 import Kernel.Types.Common
 import Kernel.Types.Error
@@ -49,16 +50,19 @@ sendOTPApi ::
   Text ->
   Text ->
   Text ->
-  m
-    SubmitSmsResp
+  IT.SMSType ->
+  IT.PriorityType ->
+  m SubmitSmsResp
 sendOTPApi
   url
   authData
   sid
   otpSmsTemplate
   phoneNumber
-  sender = do
-    let submitSmsReq = SubmitSmsReq sender phoneNumber otpSmsTemplate
+  sender
+  smsType
+  priority = do
+    let submitSmsReq = SubmitSmsReq sender phoneNumber otpSmsTemplate (toUrlPiece smsType) (toUrlPiece priority)
     let auth = authData
     callExotelAPI
       (defaultBaseUrlSms sid url)

lib/mobility-core/src/Kernel/External/SMS/ExotelSms/Types.hs

@@ -29,8 +29,8 @@ import Data.Aeson.Casing
 import Data.Aeson.TH
 import Data.OpenApi (ToSchema)
 import Data.Text as T
-import Data.Text.Conversions
-import EulerHS.Prelude
+import Data.Text.Conversions (FromText (..))
+import EulerHS.Prelude hiding (fromStrict)
 import Kernel.External.Call.Exotel.Types (ExotelAccountSID)
 import Kernel.Storage.Esqueleto (derivePersistField)
 import Kernel.Utils.JSON
@@ -55,17 +55,23 @@ data SubmitSmsReq = SubmitSmsReq
     to :: Text,
     -- Mobile number to which SMS has to be sent. Preferably in E.164 format. If not set, our system will try to match it with a
     -- country and route the SMS
-    body :: Text
+    body :: Text,
     -- 	String; Content of your SMS; Max Length of the body cannot exceed
     -- 2000 characters
+    smsType :: Text,
+    -- String; Type of sms
+    priority :: Text
+    -- String: normal or high
   }
   deriving (Generic, Eq, Show)
 
 instance ToForm SubmitSmsReq where
   toForm SubmitSmsReq {..} =
     [ ("From", toQueryParam from),
       ("To", toQueryParam to),
-      ("Body", toQueryParam body)
+      ("Body", toQueryParam body),
+      ("SMSType", toQueryParam smsType),
+      ("Priority", toQueryParam priority)
     ]
 
 -- | SMS direction

lib/mobility-core/src/Kernel/External/SMS/Interface/ExotelSms.hs

@@ -51,7 +51,9 @@ sendOTP exoCfg SendSMSReq {..} = do
         BasicAuthData
           (DT.encodeUtf8 apiKey)
           (DT.encodeUtf8 apiToken)
-  res <- Ex.sendOTPApi exoUrl authData sid exoOtpSmsTemplate exoPhoneNumber senderName
+      exoSmsType = IT.Transactional
+      exoPriority = IT.High
+  res <- Ex.sendOTPApi exoUrl authData sid exoOtpSmsTemplate exoPhoneNumber senderName exoSmsType exoPriority
   return $ returnSmsResultExo res.exoSMSMessage.exoStatus
 
 returnSmsResultExo :: ExotelSmsStatus -> IT.SendSMSRes

lib/mobility-core/src/Kernel/External/SMS/Interface/Types.hs

@@ -21,6 +21,7 @@ module Kernel.External.SMS.Interface.Types
 where
 
 import Data.ByteString.Lazy (fromStrict, toStrict)
+import Data.OpenApi
 import qualified Data.Text as T
 import qualified Data.Text.Encoding as T
 import Deriving.Aeson
@@ -29,6 +30,7 @@ import qualified Kernel.External.SMS.MyValueFirst.Config as MyValueFirst
 import qualified Kernel.External.SMS.Types as T
 import Kernel.Prelude
 import Kernel.Types.Servant
+import Kernel.Utils.JSON (constructorsWithSnakeCase)
 import Servant
 
 data SmsHandler m = SmsHandler
@@ -45,7 +47,16 @@ data SendSMSReq = SendSMSReq
     phoneNumber :: Text,
     sender :: Text
   }
-  deriving (Generic, FromJSON, ToJSON, ToSchema)
+  deriving (Generic, FromJSON, ToJSON)
+
+instance ToSchema SendSMSReq where
+  declareNamedSchema = genericDeclareNamedSchema $ fromAesonOptions constructorsWithSnakeCase
+
+instance ToSchema SMSType where
+  declareNamedSchema = genericDeclareNamedSchema $ fromAesonOptions constructorsWithSnakeCase
+
+instance ToSchema PriorityType where
+  declareNamedSchema = genericDeclareNamedSchema $ fromAesonOptions constructorsWithSnakeCase
 
 data SendSMSRes = Success | Fail | Pending | UnknownError
   deriving (Generic, FromJSON, ToJSON, Show, Eq)
@@ -69,3 +80,17 @@ sendOtpResToText = \case
   Fail -> "Fail"
   Pending -> "Pending"
   UnknownError -> "unknown request"
+
+data SMSType = Transactional | Promotional | TransactionalOptIn
+  deriving (Generic, FromJSON, ToJSON, Show, Eq)
+
+data PriorityType = Normal | High
+  deriving (Generic, FromJSON, ToJSON, Show, Eq)
+
+instance ToHttpApiData SMSType where
+  toUrlPiece Transactional = "transactional"
+  toUrlPiece Promotional = "promotional"
+  toUrlPiece TransactionalOptIn = "transaction_opt_in"
+
+instance ToHttpApiData PriorityType where
+  toUrlPiece = T.toLower . show