Messaging "send()" return types (#516)

* add Messaging "send" return types * add types
signalwire · Apr 29, 2022 · 484d7fc · 484d7fc
1 parent 6ebf3f6
commit 484d7fc
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/.changeset/tender-snakes-kiss.md b/.changeset/tender-snakes-kiss.md
@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+Add `Messaging.send()` return types
diff --git a/packages/realtime-api/src/messaging/Messaging.ts b/packages/realtime-api/src/messaging/Messaging.ts
@@ -26,12 +26,24 @@ interface InternalMessagingSendParams
   to_number: string
 }
 
+interface MessagingSendResult {
+  message: string
+  code: string
+  messageId: string
+}
+
+interface MessagingSendError {
+  message: string
+  code: string
+  errors: Record<any, any>
+}
+
 /** @internal */
 export interface Messaging
   extends DisconnectableClientContract<Messaging, MessagingClientApiEvents> {
   /** @internal */
   _session: RealtimeClient
-  send(params: MessagingSendParams): Promise<any>
+  send(params: MessagingSendParams): Promise<MessagingSendResult>
 }
 
 /** @internal */
@@ -101,10 +113,10 @@ class MessagingAPI extends BaseComponent<MessagingClientApiEvents> {
         params: sendParams,
       })
 
-      return toExternalJSON(response)
+      return toExternalJSON<MessagingSendResult>(response)
     } catch (error) {
       this.logger.error('Error sending message', error.jsonrpc)
-      throw error.jsonrpc
+      throw error.jsonrpc as MessagingSendError
     }
   }
 }