Merge pull request #327 from lukasbals/lu/implement-list-subscription-types

Implement the list all subscripition types functionality

Author: suma-prakash

README.md

@@ -1101,6 +1101,14 @@ const response = await client.segments.list({
 });
 ```
 
+
+### Subscriptions
+
+#### [List all subscription types](https://developers.intercom.com/intercom-api-reference/reference/list-all-subscription-types)
+
+```typescript
+const response = await client.subscriptions.listTypes();
+```
 ### PhoneCallRedirects
 
 #### [Create a phone call redirect](https://developers.intercom.com/intercom-api-reference/reference/create-a-phone-switch)

lib/client.ts

@@ -14,6 +14,7 @@ import HelpCenter from './helpCenter';
 import Message from './message';
 import Note from './note';
 import Segment from './segment';
+import Subscription from './subscription';
 import Team from './team';
 import Tag from './tag';
 import Visitor from './visitor';
@@ -66,6 +67,7 @@ export default class Client {
     messages: Message;
     notes: Note;
     segments: Segment;
+    subscriptions: Subscription;
     passwordPart?: string;
     propertiesToOmitInRequestOpts: string[];
     requestOpts: Partial<AxiosDefaults>;
@@ -100,6 +102,7 @@ export default class Client {
         this.messages = new Message(this);
         this.notes = new Note(this);
         this.segments = new Segment(this);
+        this.subscriptions = new Subscription(this);
         this.tags = new Tag(this);
         this.teams = new Team(this);
         this.visitors = new Visitor(this);

lib/subscription.ts

@@ -0,0 +1,20 @@
+import { Client } from '.';
+import { SubscriptionObject } from './subscription/subscription.types';
+
+export default class Subscription {
+    public readonly baseUrl = 'subscription_types';
+
+    constructor(private readonly client: Client) {
+        this.client = client;
+    }
+    listTypes() {
+        return this.client.get<ListResponse>({
+            url: `/${this.baseUrl}`,
+        });
+    }
+}
+
+interface ListResponse {
+    type: 'list';
+    data: SubscriptionObject[];
+}

test/integration/subscriptions.test.ts

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

test/unit/subscription.test.ts

@@ -0,0 +1,18 @@
+import assert from 'assert';
+import { Client } from '../../lib';
+import nock from 'nock';
+
+describe('subscriptions', () => {
+    const client = new Client({
+        usernameAuth: { username: 'foo', password: 'bar' },
+    });
+
+    it('should be listed', async () => {
+        nock('https://api.intercom.io')
+            .get('/subscription_types')
+            .reply(200, { type: 'list', data: [] });
+        const response = await client.subscriptions.listTypes();
+
+        assert.deepStrictEqual({ type: 'list', data: [] }, response);
+    });
+});