Node client notes and call logs API support[sc-55272]

https://app.shortcut.com/chartmogul/story/55272/node-client-notes-and-call-logs-api-support
chartmogul · Dec 11, 2023 · 7b30b2e · 7b30b2e
1 parent 3512acd
commit 7b30b2e
Show file tree

Hide file tree

Showing 5 changed files with 179 additions and 0 deletions.
diff --git a/lib/chartmogul.js b/lib/chartmogul.js
@@ -4,6 +4,7 @@ const errors = require('./chartmogul/errors');
 const Metrics = require('./chartmogul/metrics');
 
 const Customer = require('./chartmogul/customer');
+const CustomerNote = require('./chartmogul/customer-note');
 const Contact = require('./chartmogul/contact');
 const DataSource = require('./chartmogul/data-source');
 const Plan = require('./chartmogul/plan');
@@ -30,6 +31,7 @@ const ChartMogul = {
   Config,
   CustomAttribute,
   Customer,
+  CustomerNote,
   Contact,
   DataSource,
   Enrichment,

diff --git a/lib/chartmogul/customer-note.js b/lib/chartmogul/customer-note.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const Resource = require('./resource');
+
+class CustomerNote extends Resource {
+  static get path () {
+    return '/v1/customer_notes{/noteUuid}';
+  }
+}
+
+module.exports = CustomerNote;
diff --git a/lib/chartmogul/customer.js b/lib/chartmogul/customer.js
@@ -27,6 +27,16 @@ class Customer extends Resource {
     const path = util.expandPath(this.path, [customerId, 'contacts']);
     return Resource.request(config, 'POST', path, params, callback);
   }
+
+  static notes (config, customerId, params, callback) {
+    const path = util.expandPath(this.path, [customerId, 'notes']);
+    return Resource.request(config, 'GET', path, params, callback);
+  }
+
+  static createrNote (config, customerId, params, callback) {
+    const path = util.expandPath(this.path, [customerId, 'notes']);
+    return Resource.request(config, 'POST', path, params, callback);
+  }
 }
 
 // @Override

diff --git a/test/chartmogul/customer-note.js b/test/chartmogul/customer-note.js
@@ -0,0 +1,100 @@
+'use strict';
+
+const ChartMogul = require('../../lib/chartmogul');
+const config = new ChartMogul.Config('token');
+const expect = require('chai').expect;
+const nock = require('nock');
+const CustomerNote = ChartMogul.CustomerNote;
+
+describe('CustomerNote', () => {
+  it('creates a new note', () => {
+    const postBody = {
+      /* eslint-disable camelcase */
+      customer_uuid: 'cus_919d5d7c-9e23-11ed-a936-97fbf69ba02b',
+      type: 'note',
+      text: 'This is a note',
+      auther_email: '[email protected]'
+      /* eslint-enable camelcase */
+    };
+
+    nock(config.API_BASE)
+      .post('/v1/customer_notes', postBody)
+      .reply(200, {
+        /* eslint-disable camelcase */
+        uuid: 'note_00000000-0000-0000-0000-000000000000',
+        customer_uuid: 'cus_919d5d7c-9e23-11ed-a936-97fbf69ba02b',
+        type: 'note',
+        text: 'This is a note',
+        created_at: '2021-10-20T14:00:00.000Z',
+        updated_at: '2021-10-20T14:00:00.000Z',
+        author: 'John Doe ([email protected])'
+        /* eslint-enable camelcase */
+      });
+
+    CustomerNote.create(config, postBody)
+      .then(res => {
+        expect(res).to.have.property('uuid');
+      });
+  });
+
+  it('retrieves a customer note', () => {
+    const uuid = 'note_00000000-0000-0000-0000-000000000000';
+
+    nock(config.API_BASE)
+      .get('/v1/customer_notes' + '/' + uuid)
+      .reply(200, {
+        /* eslint-disable camelcase */
+        uuid: uuid,
+        customer_uuid: 'cus_00000000-0000-0000-0000-000000000000',
+        type: 'note',
+        text: 'This is a note',
+        created_at: '2021-10-20T14:00:00.000Z',
+        updated_at: '2021-10-20T14:00:00.000Z',
+        author: 'John Doe ([email protected])'
+        /* eslint-enable camelcase */
+      });
+
+      CustomerNote.retrieve(config, uuid).then(res => {
+        expect(res).to.have.property('uuid');
+      });
+  });
+
+  it('updates a customer note', () => {
+    const uuid = 'note_00000000-0000-0000-0000-000000000000';
+    const postBody = {
+      text: 'This is a note'
+    };
+
+    nock(config.API_BASE)
+      .patch('/v1/customer_notes' + '/' + uuid, postBody)
+      .reply(200, {
+        /* eslint-disable camelcase */
+        uuid: uuid,
+        customer_uuid: 'cus_00000000-0000-0000-0000-000000000000',
+        type: 'note',
+        text: 'This is a note',
+        created_at: '2021-10-20T14:00:00.000Z',
+        updated_at: '2021-10-20T14:00:00.000Z',
+        author: 'John Doe ([email protected])'
+        /* eslint-enable camelcase */
+      });
+
+      CustomerNote.patch(config, uuid, postBody)
+        .then(res => {
+          expect(res['text']).to.be.equal('This is a note');
+        });
+  });
+
+  it('deletes a customer note', () => {
+    const uuid = 'con_00000000-0000-0000-0000-000000000000';
+
+    nock(config.API_BASE)
+      .delete('/v1/customer_notes' + '/' + uuid)
+      .reply(204);
+
+    CustomerNote.destroy(config, uuid)
+      .then(res => {
+        expect(res).to.be.equal({});
+      });
+  });
+});
diff --git a/test/chartmogul/customer.js b/test/chartmogul/customer.js
@@ -187,6 +187,62 @@ describe('Customer', () => {
         expect(res.has_more).to.eql(false);
       });
   });
+
+  it('creates a new note from a customer', () => {
+    const customerUuid = 'cus_00000000-0000-0000-0000-000000000000';
+    const postBody = {
+      type: 'note',
+      author_email: '[email protected]',
+      note: 'This is a note'
+    };
+
+    nock(config.API_BASE)
+      .post(`/v1/customers/${customerUuid}/notes`, postBody)
+      .reply(200, {
+        /* eslint-disable camelcase */
+        uuid: 'note_00000000-0000-0000-0000-000000000000',
+        customer_uuid: 'cus_00000000-0000-0000-0000-000000000000',
+        author: 'John Doe ([email protected])',
+        text: 'This is a note',
+        created_at: '2015-01-01T12:00:00-05:00',
+        updated_at: '2015-01-01T12:00:00-05:00',
+        type: 'note'
+        /* eslint-enable camelcase */
+      });
+
+    Customer.createrNote(config, customerUuid, postBody)
+      .then(res => {
+        expect(res).to.have.property('uuid');
+      });
+  });
+
+  it('gets all notes from a customer', () => {
+    const customerUuid = 'cus_00000000-0000-0000-0000-000000000000';
+
+    nock(config.API_BASE)
+      .get(`/v1/customers/${customerUuid}/notes`)
+      .reply(200, {
+        /* eslint-disable camelcase */
+        entries: [{
+          uuid: 'note_00000000-0000-0000-0000-000000000000',
+          customer_uuid: 'cus_00000000-0000-0000-0000-000000000000',
+          author: 'John Doe ([email protected])',
+          text: 'This is a note',
+          created_at: '2015-01-01T12:00:00-05:00',
+          updated_at: '2015-01-01T12:00:00-05:00',
+          type: 'note'
+        }]
+        /* eslint-enable camelcase */
+    });
+
+    Customer.notes(config, customerUuid)
+      .then(res => {
+        expect(res).to.have.property('entries');
+        expect(res.entries).to.be.instanceof(Array);
+        expect(res.cursor).to.eql('MjAyMy0wMy0xM1QxMjowMTozMi44MD==');
+        expect(res.has_more).to.eql(false);
+      });
+  });
 });
 
 /** Suite that originally belonged in the Enrichment module.