Merge pull request #17 from intercom/update/to-api-v2.4

Update/to api v2.4

Author: hypeofpipe

README.md

@@ -2,7 +2,7 @@
 
 [![Circle CI](https://circleci.com/gh/intercom/intercom-node.png?style=shield)](https://circleci.com/gh/intercom/intercom-node)
 [![npm](https://img.shields.io/npm/v/intercom-client)](https://www.npmjs.com/package/intercom-client)
-![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.3-blue)
+![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.4-blue)
 ![Typescript Supported](https://img.shields.io/badge/Typescript-Supported-lightgrey)
 
 > Official Node bindings to the [Intercom API](https://api.intercom.io/docs)
@@ -11,7 +11,7 @@
 
 ### Maintenance
 
-Current repository is a new WIP version of Node SDK, that supports latest API version (v2.3 as of 14/12/2021)
+Current repository is a new WIP version of Node SDK, that supports latest API version (v2.4 as of 14/01/2022)
 
 ## Installation
 
@@ -70,7 +70,7 @@ We version our API (see the "Choose Version" section of the [API & Webhooks Refe
 const client = new Client({ token: 'my_token' });
 client.useRequestOpts({
     headers: {
-        'Intercom-Version': 2.3,
+        'Intercom-Version': 2.4,
     },
 });
 ```

lib/client.ts

@@ -101,7 +101,7 @@ export default class Client {
     initiateAxiosInstance(): Axios {
         // TO-DO: Revise the params
         const defaultHeaders = {
-            'User-Agent': 'intercom-node-client/2.0.0',
+            'User-Agent': 'intercom-node-client/3.0.0',
             Accept: 'application/json',
         };
 

lib/company.ts

@@ -59,16 +59,20 @@ export default class Company {
         industry,
         customAttributes,
     }: UpdateCompanyData) {
-        return this.create({
-            createdAt,
-            companyId,
+        const data = {
+            remote_created_at: createdAt,
             name,
-            monthlySpend,
+            monthly_spend: monthlySpend,
             plan,
             size,
             website,
             industry,
-            customAttributes,
+            custom_attributes: customAttributes,
+        };
+
+        return this.client.put<CompanyObject>({
+            url: `/${this.baseUrl}/${companyId}`,
+            data,
         });
     }
     find({ companyId, name }: FindCompanyData) {

lib/contact/contact.types.ts

@@ -45,13 +45,21 @@ export interface ContactObject {
     tags: AddressableList;
     notes: AddressableList;
     companies: AddressableList;
+    referrer: string;
+    utm_campaign: string | null;
+    utm_content: string | null;
+    utm_medium: string | null;
+    utm_source: string | null;
+    utm_term: string | null;
 }
 
 interface LocationObject {
     type: 'location';
     country: string;
     region: string;
     city: string;
+    country_code: string;
+    continent_code: string;
 }
 
 interface SocialProfileObject {

lib/conversation/conversation.types.ts

@@ -158,4 +158,5 @@ enum AuthorType {
     USER = 'user',
     ADMIN = 'admin',
     BOT = 'bot',
+    TEAM = 'team',
 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "intercom-client",
-    "version": "2.11.2",
+    "version": "3.0.0",
     "description": "Official Node bindings to the Intercom API",
     "homepage": "https://github.com/intercom/intercom-node",
     "bugs:": "https://github.com/intercom/intercom-node/issues",

test/company.ts

@@ -28,10 +28,8 @@ const dummyCompany = {
     custom_attributes: {},
 };
 describe('companies', () => {
-    let client: Client;
-    before(() => {
-        client = new Client('foo', 'bar');
-    });
+    const client = new Client('foo', 'bar');
+
     it('should be created', async () => {
         const requestBody = {
             remote_created_at: dateToUnixTimestamp(new Date()),
@@ -66,7 +64,6 @@ describe('companies', () => {
     it('should be updated', async () => {
         const company_id = '46029';
         const requestBody = {
-            company_id,
             remote_created_at: dateToUnixTimestamp(new Date()),
             name: 'BestCompanyInc.',
             monthly_spend: 9001,
@@ -78,7 +75,7 @@ describe('companies', () => {
         };
 
         nock('https://api.intercom.io')
-            .post('/companies', requestBody)
+            .put(`/companies/${company_id}`, requestBody)
             .reply(200, {});
 
         const response = await client.companies.update({