Create conversation without contact reply (#319)

* Added "create_conversation_without_admin_reply" to messages.create

* Made createConversation ... optional

* Add integration test

* Documentation updated to reflect addition

* Message can be created without conversation + clean up

Author: MangeFre

README.md

@@ -1013,6 +1013,24 @@ const response = await client.messages.create({
 });
 ```
 
+#### [Create conversation without contact reply](https://developers.intercom.com/intercom-api-reference/reference/admin-initiated-conversation)
+
+```typescript
+const response = await client.messages.create({
+    messageType: 'inapp',
+    body: 'Look at me, I am a conversation now',
+    from: {
+        type: 'admin',
+        id: '394051',
+    },
+    to: {
+        type: 'user',
+        id: '536e564f316c83104c000020',
+    },
+    createConversationWithoutContactReply: true,
+});
+```
+
 ### Notes
 
 #### [Create a note](https://developers.intercom.com/intercom-api-reference/reference/create-note-for-contact)

lib/message.ts

@@ -15,6 +15,8 @@ export default class Message {
         template,
         from,
         to,
+        createConversationWithoutContactReply:
+            create_conversation_without_contact_reply,
     }: CreateMessageBody) {
         const data: CreateMessageRequest = {
             message_type,
@@ -23,6 +25,7 @@ export default class Message {
             template,
             from,
             to,
+            create_conversation_without_contact_reply,
         };
 
         return this.client.post<MessageObject>({
@@ -39,10 +42,16 @@ interface CreateMessageRequest {
     to: Recepient;
     subject?: string;
     template?: string;
+    create_conversation_without_contact_reply?: boolean;
 }
 
-interface CreateMessageBody extends Omit<CreateMessageRequest, 'message_type'> {
+interface CreateMessageBody
+    extends Omit<
+        CreateMessageRequest,
+        'message_type' | 'create_conversation_without_contact_reply'
+    > {
     messageType: MessageType;
+    createConversationWithoutContactReply?: boolean;
 }
 
 type Recepient = {

test/integration/messages.test.ts

@@ -0,0 +1,85 @@
+import { token } from './utils/config';
+import { Client, Operators } from '../../dist';
+import { randomString } from './utils/random';
+import { MessageType } from '../../lib/message/message.types';
+import { RecepientType } from '../../lib/message';
+import assert from 'assert';
+
+describe('Messages', () => {
+    let adminId: string;
+    let userIntercomId: string;
+    const client = new Client({
+        tokenAuth: { token },
+    });
+
+    before(async () => {
+        const adminList = await client.admins.list();
+        adminId = adminList.admins[0].id;
+
+        const createdUser = await client.contacts.createUser({
+            externalId: randomString(),
+            name: 'Message Test User',
+        });
+        userIntercomId = createdUser.id;
+    });
+
+    it('Message that creates a converation', async () => {
+        const requestBody = {
+            message_type: MessageType.INAPP,
+            body: 'Hey, look at me! I am the conversations creator now!',
+            from: {
+                type: RecepientType.ADMIN,
+                id: adminId,
+            },
+            to: {
+                type: RecepientType.USER,
+                id: userIntercomId,
+            },
+        };
+        const response = await client.messages.create({
+            messageType: requestBody.message_type,
+            body: requestBody.body,
+            from: requestBody.from,
+            to: requestBody.to,
+            createConversationWithoutContactReply: true,
+        });
+
+        const messageId = response.id;
+
+        // Give Intercom a few seconds to index conversation
+        await new Promise((resolve) => setTimeout(resolve, 5000));
+
+        const searchResults = await client.conversations.search({
+            data: {
+                query: {
+                    field: 'source.id',
+                    operator: Operators.EQUALS,
+                    value: messageId,
+                },
+            },
+        });
+        assert.equal(searchResults.total_count > 0, true);
+    });
+
+    it('Create message, no conversation', async () => {
+        const requestBody = {
+            message_type: MessageType.INAPP,
+            body: 'Message without creating conversation',
+            from: {
+                type: RecepientType.ADMIN,
+                id: adminId,
+            },
+            to: {
+                type: RecepientType.USER,
+                id: userIntercomId,
+            },
+        };
+        const response = await client.messages.create({
+            messageType: requestBody.message_type,
+            body: requestBody.body,
+            from: requestBody.from,
+            to: requestBody.to,
+        });
+        assert.notEqual(response, undefined);
+    });
+});