Merge pull request #331 from intercom/seanhealy/addSwitch

Add switch api + data export api

Author: SeanHealy33

README.md

@@ -82,8 +82,8 @@ If you are using the european instance of intercom and would like to call it dir
 ```typescript
 const client = new Client({ tokenAuth: { token: 'my_token' } });
 client.useRequestOpts({
-    baseUrl: 'https://api.eu.intercom.io'
-})
+    baseUrl: 'https://api.eu.intercom.io',
+});
 ```
 
 ## Examples
@@ -845,6 +845,29 @@ const response = await client.dataAttributes.list({
 });
 ```
 
+### Data Exports
+
+#### [Create a export job](https://developers.intercom.com/intercom-api-reference/reference/creating-an-export-job)
+
+```typescript
+const response = await client.dataExport.create({
+    createdAtAfter: 1527811200,
+    createdAtBefore: 1530316800,
+});
+```
+
+#### [Retrieve a job status](https://developers.intercom.com/intercom-api-reference/reference/retrieve-a-job-status)
+
+```typescript
+const response = await client.dataExport.find({id: export.id})
+```
+
+#### [Cancel a job](https://developers.intercom.com/intercom-api-reference/reference/the-export-job-model)
+
+```typescript
+const response = await client.dataExport.cancel({id: export.id})
+```
+
 ### Events
 
 #### [Submit a data event](https://developers.intercom.com/intercom-api-reference/reference/list-data-attributes)
@@ -1078,6 +1101,16 @@ const response = await client.segments.list({
 });
 ```
 
+### PhoneCallRedirects
+
+#### [Create a phone call redirect](https://developers.intercom.com/intercom-api-reference/reference/create-a-phone-switch)
+
+```typescript
+const response = await client.phoneCallRedirect.create({
+    phone: '+353871234567',
+});
+```
+
 ### Tags
 
 #### [Create or update a tag](https://developers.intercom.com/intercom-api-reference/reference/create-and-update-tags)

lib/client.ts

@@ -8,6 +8,7 @@ import Contact from './contact';
 import Conversation from './conversation';
 import Count from './count';
 import DataAttribute from './dataAttribute';
+import DataExport from './dataExport';
 import Event from './event';
 import HelpCenter from './helpCenter';
 import Message from './message';
@@ -16,6 +17,7 @@ import Segment from './segment';
 import Team from './team';
 import Tag from './tag';
 import Visitor from './visitor';
+import PhoneCallRedirect from './phoneCallRedirect';
 
 import * as packageJson from '../package.json';
 
@@ -58,6 +60,7 @@ export default class Client {
     conversations: Conversation;
     counts: Count;
     dataAttributes: DataAttribute;
+    dataExport: DataExport;
     events: Event;
     helpCenter: HelpCenter;
     messages: Message;
@@ -70,6 +73,7 @@ export default class Client {
     teams: Team;
     usernamePart?: string;
     visitors: Visitor;
+    phoneCallRedirect: PhoneCallRedirect;
 
     constructor(args: Constructor) {
         const [usernamePart, passwordPart] = Client.getAuthDetails(args);
@@ -90,6 +94,7 @@ export default class Client {
         this.conversations = new Conversation(this);
         this.counts = new Count(this);
         this.dataAttributes = new DataAttribute(this);
+        this.dataExport = new DataExport(this);
         this.events = new Event(this);
         this.helpCenter = new HelpCenter(this);
         this.messages = new Message(this);
@@ -98,6 +103,7 @@ export default class Client {
         this.tags = new Tag(this);
         this.teams = new Team(this);
         this.visitors = new Visitor(this);
+        this.phoneCallRedirect = new PhoneCallRedirect(this);
         this.requestOpts = {
             baseURL: 'https://api.intercom.io',
         };

lib/dataExport.ts

@@ -0,0 +1,43 @@
+import { Client } from '.';
+import { DataExportObject } from './dataExport/dataExport.types';
+import { OperationById } from './common/common.types';
+
+export default class DataExport {
+    public readonly baseUrl = 'export';
+
+    constructor(private readonly client: Client) {
+        this.client = client;
+    }
+
+    find({ id }: DataExportByIdData) {
+        return this.client.get<DataExportObject>({
+            url: `/${this.baseUrl}/content/data/${id}`,
+        });
+    }
+
+    create({ createdAtBefore, createdAtAfter }: CreateDataExportData) {
+        const data = {
+            created_at_before: createdAtBefore,
+            created_at_after: createdAtAfter,
+        };
+
+        return this.client.post<DataExportObject>({
+            url: `/${this.client.dataExport.baseUrl}/content/data/`,
+            data,
+        });
+    }
+
+    cancel({ id }: DataExportByIdData) {
+        return this.client.post<DataExportObject>({
+            url: `/${this.baseUrl}/cancel/${id}`,
+            data: {},
+        });
+    }
+}
+
+interface CreateDataExportData {
+    createdAtBefore: string;
+    createdAtAfter: string;
+}
+
+type DataExportByIdData = OperationById;

lib/dataExport/dataExport.types.ts

@@ -0,0 +1,6 @@
+export type DataExportObject = {
+    job_identifier: string;
+    status: string;
+    download_url: string;
+    download_expires_at: string;
+};

lib/phoneCallRedirect.ts

@@ -0,0 +1,27 @@
+import { Client } from '.';
+import { PhoneCallRedirectObject } from './phoneCallRedirect/phoneCallRedirect.types';
+import { JavascriptObject } from './common/common.types';
+
+export default class PhoneCallRedirect {
+    public readonly baseUrl = 'phone_call_redirects';
+
+    constructor(private readonly client: Client) {
+        this.client = client;
+    }
+
+    create({ phone, customAttributes }: CreatePhoneRedirectData) {
+        const data = {
+            phone,
+            customAttributes,
+        };
+        return this.client.post<PhoneCallRedirectObject>({
+            url: `/${this.client.phoneCallRedirect.baseUrl}/`,
+            data,
+        });
+    }
+}
+
+interface CreatePhoneRedirectData {
+    phone: string;
+    customAttributes: JavascriptObject;
+}

lib/phoneCallRedirect/phoneCallRedirect.types.ts

@@ -0,0 +1,4 @@
+export type PhoneCallRedirectObject = {
+    type: 'phone_call_redirect';
+    url: string;
+};

test/integration/dataExport.test.ts

@@ -0,0 +1,29 @@
+import { Client} from '../../dist';
+import assert from 'assert';
+import { token } from './utils/config';
+
+describe('dataExport', () => {
+    const client = new Client({ tokenAuth: { token } });
+    let dataExport: string;
+
+    it('create', async () => {
+        const response = await client.dataExport.create({
+          phone: '+353871234567'
+        });
+        dataExport = response.id;
+
+        assert.notEqual(response, undefined);
+    });
+
+    it('find', async () => {
+        const response = await client.dataExport.find({ id: dataExport });
+
+        assert.notEqual(response, undefined);
+    });
+
+    it('delete', async () => {
+        const response = await client.dataExport.cancel({ id: dataExport });
+
+        assert.notEqual(response, undefined);
+    });
+});

test/integration/phoneCallRedirect.test.ts

@@ -0,0 +1,15 @@
+import { Client} from '../../dist';
+import assert from 'assert';
+import { token } from './utils/config';
+
+describe('phoneCallRedirect', () => {
+    const client = new Client({ tokenAuth: { token } });
+
+    it('create', async () => {
+        const response = await client.phoneCallRedirect.create({
+          phone: '+353871234567'
+        });
+
+        assert.notEqual(response, undefined);
+    });
+});