fix: Correct our return types when sending SMS

packages/sms/__tests__/classes/Error/MessageSendPartialFalure.test.ts

@@ -17,6 +17,7 @@ describe('SMS Partial Failure Error', () => {
     test('can get messages', async () => {
         const resp = {
             'message-count': '2',
+            messageCount: 2,
             messages: [
                 {
                     to: '447700900000',

packages/sms/__tests__/sms.test.ts

@@ -60,5 +60,44 @@ describe('SMS', () => {
             text: 'Sample SMS Text',
         })
         expect(results['message-count']).toEqual('1')
+        expect(results.messageCount).toEqual(1)
+        for (let i = 0; i < results.messages.length; i++) {
+            expect(resp.messages[i].to).toEqual(results.messages[i].to)
+            expect(resp.messages[i]['message-id']).toEqual(
+                results.messages[i].messageId
+            )
+            expect(resp.messages[i]['message-id']).toEqual(
+                results.messages[i]['message-id']
+            )
+            expect(resp.messages[i].status).toEqual(results.messages[i].status)
+            expect(resp.messages[i]['remaining-balance']).toEqual(
+                results.messages[i].remainingBalance
+            )
+            expect(resp.messages[i]['remaining-balance']).toEqual(
+                results.messages[i]['remaining-balance']
+            )
+            expect(resp.messages[i]['message-price']).toEqual(
+                results.messages[i].messagePrice
+            )
+            expect(resp.messages[i]['message-price']).toEqual(
+                results.messages[i]['message-price']
+            )
+            expect(resp.messages[i].network).toEqual(
+                results.messages[i].network
+            )
+            expect(resp.messages[i]['client-ref']).toEqual(
+                results.messages[i]['client-ref']
+            )
+            expect(resp.messages[i]['client-ref']).toEqual(
+                results.messages[i].clientRef
+            )
+            expect(resp.messages[i]['account-ref']).toEqual(
+                results.messages[i].accountRef
+            )
+            expect(resp.messages[i]['account-ref']).toEqual(
+                results.messages[i]['account-ref']
+            )
+        }
+        expect(results.messageCount).toEqual(1)
     })
 })

packages/sms/lib/sms.ts

@@ -1,7 +1,7 @@
 import { Client } from '@vonage/server-client'
 import { MessageSendAllFailure } from './classes/Error/MessageSendAllFailure'
 import { MessageSendPartialFailure } from './classes/Error/MessageSendPartialFailure'
-import { SMSParams, SendSMSResponse } from './types'
+import { SMSParams, SendSMSResponse, Message } from './types'
 
 export class SMS extends Client {
     public async send(params?: SMSParams): Promise<SendSMSResponse> {
@@ -12,26 +12,51 @@ export class SMS extends Client {
 
         let failures: number = 0
         const messageCount: number = parseInt(resp.data['message-count'], 10)
+        const messageData: SendSMSResponse = {
+            messageCount,
+            'message-count': resp.data['message-count'],
+            messages: [],
+        }
+        for (const element of resp.data.messages) {
+            const message: Message = element
+            if (element['message-id']) {
+                message.messageId = element['message-id']
+            }
+            if (element['remaining-balance']) {
+                message.remainingBalance = element['remaining-balance']
+            }
+            if (element['message-price']) {
+                message.messagePrice = element['message-price']
+            }
+            if (element['client-ref']) {
+                message.clientRef = element['client-ref']
+            }
+            if (element['account-ref']) {
+                message.accountRef = element['account-ref']
+            }
+            messageData.messages.push(message)
+        }
+
         for (let i = 0; i < messageCount; i++) {
-            if (resp.data.messages[i].status !== '0') {
+            if (messageData.messages[i].status !== '0') {
                 failures++
             }
         }
 
         if (failures === messageCount) {
             throw new MessageSendAllFailure(
                 'All SMS messages failed to send',
-                resp.data
+                messageData
             )
         }
 
         if (failures > 0) {
             throw new MessageSendPartialFailure(
                 'Some SMS messages failed to send',
-                resp.data
+                messageData
             )
         }
 
-        return resp.data
+        return messageData
     }
 }

packages/sms/lib/types.ts

@@ -19,7 +19,11 @@ export interface SMSGeneralResponse {
 }
 
 export interface SendSMSResponse {
+    /**
+     * @deprecated Use messageCount instead
+     */
     'message-count': string
+    messageCount: number
     messages: Message[]
 }
 
@@ -78,12 +82,32 @@ export interface InboundMessage {
 export interface Message {
     to?: string
     messageId?: string
+    /**
+     * @deprecated Use messageId instead
+     */
+    'message-id'?: string
     status?: string
     remainingBalance?: string
+    /**
+     * @deprecated Use remainingBalance instead
+     */
+    'remaining-balance'?: string
     messagePrice?: string
+    /**
+     * @deprecated Use messagePrice
+     */
+    'message-price'?: string
     network?: string
     clientRef?: string
+    /**
+     * @deprecated Use clientRef instead
+     */
+    'client-ref'?: string
     accountRef?: string
+    /**
+     * @deprecated Use accountRef instead
+     */
+    'account-ref'?: string
 }
 
 export interface ModelError {