Check if response is error

Author: Kewin Polok

src/modules/baseMessageModule/index.ts

@@ -7,6 +7,7 @@ import snakeCase from 'lodash/snakeCase';
 
 import { BaseModule } from '../baseModule';
 import { SmsDetails } from '../sms/types/SmsDetails';
+import { ErrorResponse, isErrorResponse } from '../../types/ErrorResponse';
 import { MessageResponse } from '../../types/MessageResponse';
 
 import {
@@ -39,7 +40,7 @@ export class BaseMessageModule extends BaseModule {
     content: MessageContent,
     recipient: Recipient,
     details?: SmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     const body: Record<string, unknown> = {
       details: true,
       encoding: 'utf-8',
@@ -88,15 +89,15 @@ export class BaseMessageModule extends BaseModule {
         }
       );
 
-      return this.formatSmsResponse(data);
+      return this.formatResponse(data);
     }
 
-    const data = await this.httpClient.post<MessageResponse, MessageResponse>(
-      this.endpoint,
-      body
-    );
+    const data = await this.httpClient.post<
+      MessageResponse | ErrorResponse,
+      MessageResponse | ErrorResponse
+    >(this.endpoint, body);
 
-    return this.formatSmsResponse(data);
+    return this.formatResponse(data);
   }
 
   private isNumberRecipient(
@@ -192,7 +193,13 @@ export class BaseMessageModule extends BaseModule {
     });
   }
 
-  protected formatSmsResponse(response: MessageResponse): MessageResponse {
+  protected formatResponse(
+    response: MessageResponse | ErrorResponse
+  ): MessageResponse | ErrorResponse {
+    if (isErrorResponse(response)) {
+      return response;
+    }
+
     return {
       ...response,
       list: response.list.map((sms) => ({

src/modules/vms/index.ts

@@ -1,5 +1,6 @@
 import { BaseMessageModule } from '../baseMessageModule';
 import { MessageResponse } from '../../types/MessageResponse';
+import { ErrorResponse } from '../../types/ErrorResponse';
 
 import { VmsTtsLector } from './types/VmsTtsLector';
 import { VmsDetails } from './types/VmsDetails';
@@ -12,7 +13,7 @@ export class Vms extends BaseMessageModule {
     tts: string,
     ttsLector?: VmsTtsLector,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         tts,
@@ -29,7 +30,7 @@ export class Vms extends BaseMessageModule {
     numbers: string | string[],
     pathToLocaleFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         localPath: pathToLocaleFile,
@@ -45,7 +46,7 @@ export class Vms extends BaseMessageModule {
     numbers: string | string[],
     pathToRemoteFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         remotePath: pathToRemoteFile,
@@ -62,7 +63,7 @@ export class Vms extends BaseMessageModule {
     tts: string,
     ttsLector?: VmsTtsLector,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         tts,
@@ -79,7 +80,7 @@ export class Vms extends BaseMessageModule {
     groups: string | string[],
     pathToLocaleFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         localPath: pathToLocaleFile,
@@ -95,7 +96,7 @@ export class Vms extends BaseMessageModule {
     groups: string | string[],
     pathToRemoteFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse> {
+  ): Promise<MessageResponse | ErrorResponse> {
     return await this.send(
       {
         remotePath: pathToRemoteFile,

src/types/ErrorResponse.ts

@@ -0,0 +1,8 @@
+export function isErrorResponse(response: any): response is ErrorResponse {
+  return response.error !== undefined && response.message !== undefined;
+}
+
+export interface ErrorResponse {
+  error: number;
+  message: string;
+}

src/types/index.ts

@@ -16,12 +16,14 @@ import { SubuserPoints } from '../modules/subusers/types/SubuserPoints';
 import { Template } from '../modules/templates/types/Template';
 import { UpdateSubuser } from '../modules/subusers/types/UpdateSubuser';
 
+import { ErrorResponse } from './ErrorResponse';
 import { MessageStatus } from './MessageStatus';
 import { MessageResponse } from './MessageResponse';
 import { ApiCollection } from './ApiCollection';
 
 export {
   ApiCollection,
+  ErrorResponse,
   HlrCheck,
   HlrCheckError,
   HlrCheckResponse,