Add MFA support

Author: pdziewa

README.md

@@ -28,6 +28,7 @@ try {
   * Contact fields
   * Contact groups
 * Hlr
+* MFA
 * MMS
 * Profile
 * Sendernames

src/modules/mfa/index.spec.ts

@@ -0,0 +1,100 @@
+import nock from 'nock';
+
+import { API_URL } from '../../constants';
+import { SMSAPI } from '../../smsapi';
+
+describe('MFA', () => {
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  describe('generateCode', () => {
+    it('should generate MFA code without options', async () => {
+      // given
+      const smsapi = new SMSAPI('someToken');
+      const phoneNumber = '+48123456789';
+
+      const req = nock(API_URL)
+        .post('/mfa/codes', {
+          phone_number: phoneNumber,
+        })
+        .reply(200, {
+          id: 'someId',
+          code: '123456',
+          phone_number: phoneNumber,
+          from: null,
+        });
+
+      // when
+      const response = await smsapi.mfa.generateCode(phoneNumber);
+
+      // then
+      expect(req.isDone()).toBeTruthy();
+      expect(response).toEqual({
+        id: 'someId',
+        code: '123456',
+        phoneNumber: phoneNumber,
+        from: null,
+      });
+    });
+
+    it('should generate MFA code with options', async () => {
+      // given
+      const smsapi = new SMSAPI('someToken');
+      const phoneNumber = '+48123456789';
+      const options = {
+        content: 'Your code is: [%code%]',
+        fast: true,
+        from: 'Test',
+      };
+
+      const req = nock(API_URL)
+        .post('/mfa/codes', {
+          phone_number: phoneNumber,
+          content: options.content,
+          fast: options.fast,
+          from: options.from,
+        })
+        .reply(200, {
+          id: 'someId',
+          code: '654321',
+          phone_number: phoneNumber,
+          from: 'Test',
+        });
+
+      // when
+      const response = await smsapi.mfa.generateCode(phoneNumber, options);
+
+      // then
+      expect(req.isDone()).toBeTruthy();
+      expect(response).toEqual({
+        id: 'someId',
+        code: '654321',
+        phoneNumber: phoneNumber,
+        from: 'Test',
+      });
+    });
+  });
+
+  describe('verifyCode', () => {
+    it('should verify MFA code', async () => {
+      // given
+      const smsapi = new SMSAPI('someToken');
+      const phoneNumber = '+48123456789';
+      const code = '123456';
+
+      const req = nock(API_URL)
+        .post('/mfa/codes/verifications', {
+          phone_number: phoneNumber,
+          code: code,
+        })
+        .reply(204);
+
+      // when
+      await smsapi.mfa.verifyCode(phoneNumber, code);
+
+      // then
+      expect(req.isDone()).toBeTruthy();
+    });
+  });
+});

src/modules/mfa/index.ts

@@ -0,0 +1,19 @@
+import { BaseModule } from '../baseModule';
+import { MfaGenerateCodeOptions } from './types/MfaGenerateCodeOptions';
+import { MfaResponse } from './types/MfaResponse';
+
+export class Mfa extends BaseModule {
+  async generateCode(number: string, options?: MfaGenerateCodeOptions): Promise<MfaResponse> {
+    return await this.httpClient.post<MfaResponse>('/mfa/codes', {
+      phone_number: number,
+      ...options,
+    });
+  }
+
+  async verifyCode(number: string, code: string): Promise<void> {
+    return await this.httpClient.post<void>('/mfa/codes/verifications', {
+      phone_number: number,
+      code,
+    });
+  }
+}

src/modules/mfa/types/MfaGenerateCodeOptions.ts

@@ -0,0 +1,5 @@
+export interface MfaGenerateCodeOptions {
+  content?: string;
+  fast?: boolean;
+  from?: string;
+}

src/modules/mfa/types/MfaResponse.ts

@@ -0,0 +1,6 @@
+export interface MfaResponse {
+  id: string;
+  code: string;
+  phoneNumber: string;
+  from: string | null;
+}

src/smsapi/index.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { Contacts } from '../modules/contacts';
 import { Hlr } from '../modules/hlr';
+import { Mfa } from '../modules/mfa';
 import { Mms } from '../modules/mms';
 import { Profile } from '../modules/profile';
 import { Sendernames } from '../modules/sendernames';
@@ -23,6 +24,7 @@ export class SMSAPI {
 
   public contacts: Contacts;
   public hlr: Hlr;
+  public mfa: Mfa;
   public mms: Mms;
   public profile: Profile;
   public sendernames: Sendernames;
@@ -39,6 +41,7 @@ export class SMSAPI {
 
     this.contacts = new Contacts(this.getHttpClient());
     this.hlr = new Hlr(this.httpClient);
+    this.mfa = new Mfa(this.httpClient);
     this.mms = new Mms(this.httpClient);
     this.profile = new Profile(this.httpClient);
     this.sendernames = new Sendernames(this.httpClient);