Merge 2394ca5 into 7b35a47

zenvia · Aug 31, 2021 · f64432c · f64432c
2 parents 7b35a47 + 2394ca5
commit f64432c
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 107 deletions.
diff --git a/examples/template-get.js b/examples/template-get.js
@@ -8,9 +8,9 @@
 // const { Client } = require('@zenvia/sdk');
 const { Client } = require('../dist');
 
-const client = new Client(process.env.ZENVIA_API_TOKEN);
+const client = new Client('GKkj0dSHDN60yLdkZzVyj4-osKlMQXQj-5d4');
 
-client.getTemplate('template-identifier')
+client.getTemplate('eb5f5a45-c4f2-4086-8f41-6cc423d4fac8')
 .then(response => {
   console.log('Response:', response);
 })

diff --git a/examples/template-list.js b/examples/template-list.js
@@ -7,7 +7,7 @@
 
 const { Client } = require('../dist');
 
-const client = new Client(process.env.ZENVIA_API_TOKEN);
+const client = new Client('GKkj0dSHDN60yLdkZzVyj4-osKlMQXQj-5d4');
 
 client.listTemplates()
 .then(response => {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@zenvia/sdk",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/src/lib/client.ts b/src/lib/client.ts
@@ -156,15 +156,7 @@ export class Client {
    */
   async listTemplates(): Promise<ITemplate[]> {
     const path = '/v2/templates';
-    return request.get(this.token, path, this.logger)
-    .then((templates) => {
-      templates.forEach((template) => {
-        template.channels.forEach((channel) => {
-          (channel.type as any) = channel.type.toLowerCase();
-        });
-      });
-      return templates;
-    });
+    return request.get(this.token, path, this.logger);
   }
 
   /**
@@ -175,13 +167,7 @@ export class Client {
    */
   async getTemplate(id: string): Promise<ITemplate> {
     const path = `/v2/templates/${id}`;
-    return request.get(this.token, path, this.logger)
-    .then((template: ITemplate) => {
-      template.channels.forEach((channel) => {
-        (channel.type as any) = channel.type.toLowerCase();
-      });
-      return template;
-    });
+    return request.get(this.token, path, this.logger);
   }
 
   /**

diff --git a/src/types/zenvia.ts b/src/types/zenvia.ts
@@ -273,15 +273,17 @@ export interface ITemplate {
   name: string;
   locale: string;
   channel: string;
+  senderId: string;
   category: string;
-  textReference?: string;
   components: IComponents;
-  senderId: string;
-  status?: TemplateStatus;
+  examples?: {
+    [fieldName: string]: string;
+  };
   notificationEmail?: string;
+  text?: string;
+  fields?: string[];
+  status?: TemplateStatus;
   comments?: IComment[];
-  suggestions?: ISuggestions[];
-  channels?: IChannels[];
   createdAt?: string;
   updatedAt?: string;
 }

diff --git a/test/lib/client.spec.ts b/test/lib/client.spec.ts
@@ -727,7 +727,7 @@ describe('Client', () => {
         };
 
         const expected = /^----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="batch"\r\nContent-Type: application\/json\r\n\r\n{"name":"SOME_BATCH","channel":"sms","message":{"from":"FROM","contents":\[{"type":"text","text":"some text message"}\]},"columnMapper":{"recipient_header_name":"recipient_number_column","name":"recipient_name_column","protocol":"protocol_column"}}\r\n----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="contacts"; filename="file\.csv"\r\nContent-Type: text\/csv\r\n\r\ntelefone\n5511999999999\r\n----------------------------[0-9]{24}--\r\n$/m;
-        
+
         const zenviaNock = nock('https://api.zenvia.com')
         .post('/v2/message-batches', expected)
         .matchHeader('X-API-Token', 'SOME_TOKEN')
@@ -781,7 +781,7 @@ describe('Client', () => {
         };
 
         const expected = /^----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="batch"\r\nContent-Type: application\/json\r\n\r\n{"name":"SOME_BATCH","channel":"sms","message":{"from":"FROM","contents":\[{"type":"text","text":"some text message"}\]},"columnMapper":{"recipient_header_name":"recipient_number_column","name":"recipient_name_column","protocol":"protocol_column"}}\r\n----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="contacts"; filename="contacts\.csv"\r\nContent-Type: text\/csv\r\n\r\ntelefone\n5511999999999\r\n----------------------------[0-9]{24}--\r\n$/m;
-        
+
         const zenviaNock = nock('https://api.zenvia.com')
         .post('/v2/message-batches', expected)
         .matchHeader('X-API-Token', 'SOME_TOKEN')
@@ -945,7 +945,7 @@ describe('Client', () => {
         };
 
         const expected = /^----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="batch"\r\nContent-Type: application\/json\r\n\r\n{"name":"SOME_BATCH","channel":"whatsapp","message":{"from":"FROM","contents":\[{"type":"template","templateId":"a whatsapp template id"}\]},"columnMapper":{"recipient_header_name":"recipient_number_column","name":"recipient_name_column","protocol":"protocol_column"}}\r\n----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="contacts"; filename="file\.csv"\r\nContent-Type: text\/csv\r\n\r\ntelefone\n5511999999999\r\n----------------------------[0-9]{24}--\r\n$/m;
-        
+
         const zenviaNock = nock('https://api.zenvia.com')
         .post('/v2/message-batches', expected)
         .matchHeader('X-API-Token', 'SOME_TOKEN')
@@ -999,7 +999,7 @@ describe('Client', () => {
         };
 
         const expected = /^----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="batch"\r\nContent-Type: application\/json\r\n\r\n{"name":"SOME_BATCH","channel":"whatsapp","message":{"from":"FROM","contents":\[{"type":"template","templateId":"a whatsapp template id"}\]},"columnMapper":{"recipient_header_name":"recipient_number_column","name":"recipient_name_column","protocol":"protocol_column"}}\r\n----------------------------[0-9]{24}\r\nContent-Disposition: form-data; name="contacts"; filename="contacts\.csv"\r\nContent-Type: text\/csv\r\n\r\ntelefone\n5511999999999\r\n----------------------------[0-9]{24}--\r\n$/m;
-        
+
         const zenviaNock = nock('https://api.zenvia.com')
         .post('/v2/message-batches', expected)
         .matchHeader('X-API-Token', 'SOME_TOKEN')
@@ -1470,37 +1470,8 @@ describe('Client', () => {
   describe('Templates', () => {
 
     it('should list templates', async () => {
-      const requestTemplates = [{
-        name: 'Sandbox - Shipping Update',
-        locale: 'pt_BR',
-        channel: 'WHATSAPP',
-        category: 'SHIPPING_UPDATE',
-        text: '{{name}}, informamos que o seu produto {{productName}} foi enviado para a transportadora e tem previsão de chegada em {{deliveryDate}}.',
-        components: {
-          body: {
-            type: 'TEXT_TEMPLATE',
-            text: '{{name}}, informamos que o seu produto {{productName}} foi enviado para a transportadora e tem previsão de chegada em {{deliveryDate}}.'
-          },
-        },
-        senderId: 'detailed-gasosaurus',
-        fields: [
-          'name',
-          'productName',
-          'deliveryDate',
-        ],
-        status: 'APPROVED',
-        comments: [],
-        channels: [
-          {
-            type: 'WHATSAPP',
-            senderId: 'detailed-gasosaurus',
-            status: 'APPROVED',
-          },
-        ],
-        createdAt: '2020-06-22T20:35:05.491Z',
-        updatedAt: '2020-06-22T20:35:05.491Z',
-      }];
-      const responseTemplates = [{
+      const responseTemplates: ITemplate[] = [{
+        id: 'SOME_ID',
         name: 'Sandbox - Shipping Update',
         locale: 'pt_BR',
         channel: 'WHATSAPP',
@@ -1520,20 +1491,13 @@ describe('Client', () => {
         ],
         status: 'APPROVED',
         comments: [],
-        channels: [
-          {
-            type: 'whatsapp',
-            senderId: 'detailed-gasosaurus',
-            status: 'APPROVED',
-          },
-        ],
         createdAt: '2020-06-22T20:35:05.491Z',
         updatedAt: '2020-06-22T20:35:05.491Z',
       }];
       const zenviaNock = nock('https://api.zenvia.com')
       .get('/v2/templates')
       .matchHeader('X-API-Token', 'SOME_TOKEN')
-      .reply(200, requestTemplates);
+      .reply(200, responseTemplates);
 
       const client = new Client('SOME_TOKEN');
       const actualMessageResponse = await client.listTemplates();
@@ -1542,37 +1506,8 @@ describe('Client', () => {
     });
 
     it('should get template with id', async () => {
-      const requestTemplates = {
-        name: 'Sandbox - Shipping Update',
-        locale: 'pt_BR',
-        channel: 'WHATSAPP',
-        category: 'SHIPPING_UPDATE',
-        text: '{{name}}, informamos que o seu produto {{productName}} foi enviado para a transportadora e tem previsão de chegada em {{deliveryDate}}.',
-        components: {
-          body: {
-            type: 'TEXT_TEMPLATE',
-            text: '{{name}}, informamos que o seu produto {{productName}} foi enviado para a transportadora e tem previsão de chegada em {{deliveryDate}}.'
-          },
-        },
-        senderId: 'detailed-gasosaurus',
-        fields: [
-          'name',
-          'productName',
-          'deliveryDate',
-        ],
-        status: 'APPROVED',
-        comments: [],
-        channels: [
-          {
-            type: 'WHATSAPP',
-            senderId: 'detailed-gasosaurus',
-            status: 'APPROVED',
-          },
-        ],
-        createdAt: '2020-06-22T20:35:05.491Z',
-        updatedAt: '2020-06-22T20:35:05.491Z',
-      };
-      const responseTemplates = {
+      const responseTemplates: ITemplate = {
+        id: 'SOME_ID',
         name: 'Sandbox - Shipping Update',
         locale: 'pt_BR',
         channel: 'WHATSAPP',
@@ -1592,20 +1527,13 @@ describe('Client', () => {
         ],
         status: 'APPROVED',
         comments: [],
-        channels: [
-          {
-            type: 'whatsapp',
-            senderId: 'detailed-gasosaurus',
-            status: 'APPROVED',
-          },
-        ],
         createdAt: '2020-06-22T20:35:05.491Z',
         updatedAt: '2020-06-22T20:35:05.491Z',
       };
       const zenviaNock = nock('https://api.zenvia.com')
       .get('/v2/templates/SOME_TEMPLATE_ID')
       .matchHeader('X-API-Token', 'SOME_TOKEN')
-      .reply(200, requestTemplates);
+      .reply(200, responseTemplates);
 
       const client = new Client('SOME_TOKEN');
       const actualMessageResponse = await client.getTemplate('SOME_TEMPLATE_ID');