Merge pull request #4551 from parveshsaini/feature/bandwidth-sms

feat(provider): bandwidth SMS provider added

apps/web/src/pages/integrations/components/multi-provider/sort-providers.ts

@@ -67,6 +67,7 @@ const providers: Record<ChannelTypeEnum, ProvidersIdEnum[]> = {
       SmsProviderIdEnum.Termii,
       SmsProviderIdEnum.AfricasTalking,
       SmsProviderIdEnum.Novu,
+      SmsProviderIdEnum.Bandwidth,
     ].sort(),
   ],
 };

libs/shared/src/consts/providers/channels/sms.ts

@@ -19,6 +19,7 @@ import {
   africasTalkingConfig,
   sendchampConfig,
   clickSendConfig,
+  bandwidthConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -188,4 +189,13 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://developers.clicksend.com/docs/rest/v3/?javascript--nodejs#send-sms',
     logoFileName: { light: 'clicksend.png', dark: 'clicksend.png' },
   },
+  {
+    id: SmsProviderIdEnum.Bandwidth,
+    displayName: `Bandwidth`,
+    channel: ChannelTypeEnum.SMS,
+    credentials: bandwidthConfig,
+    betaVersion: true,
+    docReference: 'https://dev.bandwidth.com/docs/messaging/createMessage',
+    logoFileName: { light: 'bandwidth.png', dark: 'bandwidth.png' },
+  },
 ];

libs/shared/src/consts/providers/credentials/provider-credentials.ts

@@ -767,3 +767,26 @@ export const clickSendConfig: IConfigCredentials[] = [
   },
   ...smsConfigBase,
 ];
+
+export const bandwidthConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.User,
+    displayName: 'Username',
+    description: 'Your Bandwidth account username',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.Password,
+    displayName: 'Password',
+    type: 'password',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.AccountSid,
+    displayName: 'Account ID',
+    type: 'text',
+    required: true,
+  },
+  ...smsConfigBase,
+];

libs/shared/src/consts/providers/provider.enum.ts

@@ -73,6 +73,7 @@ export enum SmsProviderIdEnum {
   Novu = 'novu-sms',
   Sendchamp = 'sendchamp',
   Clicksend = 'clicksend',
+  Bandwidth = 'bandwidth',
 }
 
 export enum ChatProviderIdEnum {

packages/application-generic/package.json

@@ -49,6 +49,7 @@
     "@google-cloud/storage": "^6.2.3",
     "@novu/africas-talking": "^0.20.0",
     "@novu/apns": "^0.20.0",
+    "@novu/bandwidth": "^0.20.0",
     "@novu/burst-sms": "^0.20.0",
     "@novu/clickatell": "^0.20.0",
     "@novu/clicksend": "^0.20.0",

packages/application-generic/src/factories/sms/handlers/bandwidth.handler.ts

@@ -0,0 +1,19 @@
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { BandwidthSmsProvider } from '@novu/bandwidth';
+import { BaseSmsHandler } from './base.handler';
+
+export class BandwidthHandler extends BaseSmsHandler {
+  constructor() {
+    super('bandwidth', ChannelTypeEnum.SMS);
+  }
+
+  buildProvider(credentials: ICredentials) {
+    const config = {
+      username: credentials.user,
+      password: credentials.password,
+      accountId: credentials.accountSid,
+    };
+
+    this.provider = new BandwidthSmsProvider(config);
+  }
+}

packages/application-generic/src/factories/sms/handlers/index.ts

@@ -16,4 +16,5 @@ export * from './sms-central.handler';
 export * from './africas-talking.handler';
 export * from './sendchamp.handler';
 export * from './clicksend.handler';
+export * from './bandwidth.handler';
 export * from './novu.handler';

packages/application-generic/src/factories/sms/sms.factory.ts

@@ -19,6 +19,7 @@ import {
   AfricasTalkingSmsHandler,
   SendchampSmsHandler,
   ClicksendSmsHandler,
+  BandwidthHandler,
   NovuSmsHandler,
 } from './handlers';
 
@@ -42,6 +43,7 @@ export class SmsFactory implements ISmsFactory {
     new AfricasTalkingSmsHandler(),
     new SendchampSmsHandler(),
     new ClicksendSmsHandler(),
+    new BandwidthHandler(),
     new NovuSmsHandler(),
   ];