DEVEXP-435: Support 'Accept-Language' header for SMS Verification (#94)

sinch · May 21, 2024 · 404ad49 · 404ad49
1 parent 2360660
commit 404ad49
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/examples/simple-examples/src/verification/verifications/sms/start-sms.ts b/examples/simple-examples/src/verification/verifications/sms/start-sms.ts
@@ -16,6 +16,9 @@ import {
   const requestData = Verification.startVerificationHelper.buildSmsRequest(
     verificationIdentity,
     `test-reference-for-sms-verification_${verificationIdentity}`,
+    {
+      locale: 'sv-SE',
+    },
   );
 
   const verificationService = initVerificationService();

diff --git a/packages/verification/src/models/v1/start-verification-request/start-verification-request.ts b/packages/verification/src/models/v1/start-verification-request/start-verification-request.ts
@@ -36,6 +36,8 @@ export interface SmsOptions {
   codeType?: CodeType;
   /** The SMS template must include a placeholder `{{CODE}}` where the verification code will be inserted, and it can otherwise be customized as desired. */
   template?: string;
+  /** A `language-region` identifier according to [IANA](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). Only a subset of those identifiers is accepted. */
+  locale?: string;
 }
 
 export type CodeType = 'Numeric' | 'Alpha' | 'Alphanumeric';

diff --git a/packages/verification/src/rest/v1/verifications/verifications-api.ts b/packages/verification/src/rest/v1/verifications/verifications-api.ts
@@ -254,6 +254,9 @@ export class VerificationsApi extends VerificationDomainApi {
       'Content-Type': 'application/json; charset=UTF-8',
       'Accept': 'application/json',
     };
+    if (data.startVerificationWithSmsRequestBody.smsOptions?.locale !== undefined) {
+      headers['Accept-Language'] = data.startVerificationWithSmsRequestBody.smsOptions.locale;
+    }
 
     // Special fields handling: see method for details
     const requestDataBody = this.performStartSmsRequestBodyTransformation(data.startVerificationWithSmsRequestBody);
@@ -284,6 +287,8 @@ export class VerificationsApi extends VerificationDomainApi {
         requestDataBody.smsOptions.expiry = this.formatTime(expiry);
       }
     }
+    // Remove the `locale` property from the body as it is used as a header parameter for the API call
+    delete requestDataBody.smsOptions?.locale;
 
     return requestDataBody;
   }

diff --git a/packages/verification/tests/rest/v1/verifications/verifications-api.test.ts b/packages/verification/tests/rest/v1/verifications/verifications-api.test.ts
@@ -35,12 +35,15 @@ describe('VerificationsApi', () => {
   describe ('startVerification', () => {
     it('should make a POST request to start a verification with an SMS', async () => {
       // Given
-      const requestData = Verification.startVerificationHelper.buildSmsRequest('+46700000000');
+      const smsOptions: Verification.SmsOptions = {
+        locale: 'sv-SE',
+      };
+      const requestData = Verification.startVerificationHelper.buildSmsRequest('+46700000000', undefined, smsOptions);
       const expectedResponse: Verification.StartSmsVerificationResponse = {
         id: 'some_verification_id',
         method: 'sms',
         sms: {
-          template: 'Your verification code is {{CODE}}. Verified by Sinch',
+          template: 'Din verifieringskod är {{CODE}}.',
           interceptionTimeout: 298,
         },
         _links,