Permit creating leads with email (#316)

* Allow adding leads with email
- Create interface CreateLeadData

* Add test for creating lead with email address

* rm email from CreateUserData & CreateLeadData

Co-authored-by: Johnny Nader <[email protected]>
Co-authored-by: Johnny Nader <[email protected]>

Author: drewwatkins11

lib/contact.ts

@@ -52,6 +52,7 @@ export default class Contact {
         const requestData: CreateContactRequest = {
             role: Role.LEAD,
             phone: data?.phone,
+            email: data?.email,
             name: data?.name,
             avatar: data?.avatar,
             signed_up_at: data?.signedUpAt,
@@ -190,6 +191,7 @@ type CreateContactRequest = Pick<ContactObject, 'role'> &
 interface CreateUserDataBase {
     phone?: CreateContactRequest['phone'];
     name?: CreateContactRequest['name'];
+    email?: CreateContactRequest['email'];
     avatar?: CreateContactRequest['avatar'];
     signedUpAt?: CreateContactRequest['signed_up_at'];
     lastSeenAt?: CreateContactRequest['last_seen_at'];
@@ -199,11 +201,11 @@ interface CreateUserDataBase {
 }
 
 interface CreateUserData extends CreateUserDataBase {
-    email?: string;
     externalId?: string;
 }
 
 type CreateLeadData = CreateUserDataBase;
+
 //
 interface RetrieveContactData {
     id: string;
@@ -290,8 +292,8 @@ interface SearchContactOrder {
 
 interface SearchContactRequest {
     data: GenericSearchFilters &
-        Partial<SearchContactPagination> &
-        Partial<SearchContactOrder>;
+    Partial<SearchContactPagination> &
+    Partial<SearchContactOrder>;
 }
 
 type SearchContactResponse = Paginated<ContactObject>;

test/unit/contact.test.ts

@@ -101,6 +101,29 @@ describe('contacts', () => {
         assert.deepStrictEqual(expectedReply, response);
     });
 
+    it('should create a contact with lead role with email', async () => {
+        const contact = {
+            role: 'lead',
+            email: '[email protected]',
+        };
+
+        const expectedReply = {};
+
+        nock('https://api.intercom.io')
+            .post('/contacts', contact)
+            .reply(200, expectedReply);
+
+        const client = new Client({
+            usernameAuth: { username: 'foo', password: 'bar' },
+        });
+
+        const response = await client.contacts.createLead({
+            email: contact.email,
+        });
+
+        assert.deepStrictEqual(expectedReply, response);
+    });
+
     it('should retrieve a contact by id', async () => {
         const id = '536e564f316c83104c000020';