Clean up code

Author: Volo

README.md

@@ -46,15 +46,15 @@ import { Client } from './dist/index';
 Create a client using access tokens:
 
 ```typescript
-const client = new Client({ token: 'my_token' });
+const client = new Client({ tokenAuth: { token: 'my_token' } });
 ```
 
 ## Request Options
 
 This client library also supports passing in [`request` options](https://github.com/axios/axios#request-config):
 
 ```typescript
-const client = new Client({ token: 'my_token' });
+const client = new Client({ tokenAuth: { token: 'my_token' } });
 client.useRequestOpts({
     baseURL: 'http://local.test-server.com',
 });
@@ -67,7 +67,7 @@ Note that certain request options (such as `json`, and certain `headers` names c
 We version our API (see the "Choose Version" section of the [API & Webhooks Reference](https://developers.intercom.com/intercom-api-reference/reference) for details). You can specify which version of the API to use when performing API requests using request options:
 
 ```typescript
-const client = new Client({ token: 'my_token' });
+const client = new Client({ tokenAuth: { token: 'my_token' } });
 client.useRequestOpts({
     headers: {
         'Intercom-Version': 2.4,

lib/client.ts

@@ -1,91 +1,88 @@
 import { deprecate } from 'util';
-import User from './user';
-import Event from './event';
+import axios, { Axios, AxiosDefaults, AxiosResponse } from 'axios';
+import { merge, omit } from 'lodash';
+
+import Admin from './admin';
 import Company from './company';
+import Conversation from './conversation';
 import Contact from './contact';
-import Visitor from './visitor';
-import Counts from './counts';
-import Admin from './admin';
-import Tag from './tag';
+import DataAttribute from './dataAttribute';
+import Event from './event';
 import Segment from './segment';
 import Message from './message';
-import Conversation from './conversation';
-import Note from './note';
-import Customer from './customer';
-import DataAttribute from './dataAttribute';
 import Team from './team';
-
-import axios, { Axios, AxiosDefaults, AxiosResponse } from 'axios';
-import { merge, omit } from 'lodash';
+import Tag from './tag';
 
 import { BadResponseError } from './errors/badResponse.error';
 
 interface RequestOptions {
     url: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     data?: any;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     params?: any;
 }
 
+type Constructor = {
+    usernameAuth?: UsernameAuth;
+    tokenAuth?: TokenAuth;
+    apiKeyAuth?: ApiKeyAuth;
+};
+
+type UsernameAuth = {
+    username: string;
+    password: string;
+};
+
+type TokenAuth = {
+    token: string;
+};
+
+type ApiKeyAuth = {
+    appId: string;
+    appApiKey: string;
+};
+
 export default class Client {
     admins: Admin;
     axiosInstance: Axios;
     companies: Company;
     contacts: Contact;
     conversations: Conversation;
-    counts: any;
-    customers: any;
-    leads: any;
-    users: any;
-    events: Event;
     dataAttributes: DataAttribute;
+    events: Event;
+    messages: Message;
     segments: Segment;
-    messages: any;
-    notes: any;
     passwordPart?: string;
     propertiesToOmitInRequestOpts: string[];
     requestOpts: Partial<AxiosDefaults>;
     tags: Tag;
     teams: Team;
-    usebaseURL: (baseURL: any) => this;
+    usebaseURL: (baseURL: string) => this;
     usernamePart?: string;
-    visitors: any;
-
-    // TO-DO: Fix any
-    constructor(...args: any) {
-        // TO-DO: Refactor it!
-        if (args.length === 2) {
-            this.usernamePart = args[0];
-            this.passwordPart = args[1];
-        } else if (args.length === 1) {
-            if (args[0].token) {
-                this.usernamePart = args[0].token;
-                this.passwordPart = '';
-            } else {
-                this.usernamePart = args[0].appId;
-                this.passwordPart = args[0].appApiKey;
-            }
-        }
+
+    constructor(args: Constructor) {
+        const [usernamePart, passwordPart] = Client.getAuthDetails(args);
+
+        this.usernamePart = usernamePart;
+        this.passwordPart = passwordPart;
+
         if (!this.usernamePart || this.passwordPart === undefined) {
             throw new Error(
                 'Could not construct a client with those parameters'
             );
         }
-        this.users = new User(this);
-        this.events = new Event(this);
+
+        this.admins = new Admin(this);
         this.companies = new Company(this);
         this.contacts = new Contact(this);
-        this.leads = new Contact(this);
-        this.visitors = new Visitor(this);
-        this.counts = new Counts(this);
-        this.admins = new Admin(this);
-        this.segments = new Segment(this);
-        this.messages = new Message(this);
         this.conversations = new Conversation(this);
-        this.notes = new Note(this);
-        this.customers = new Customer(this);
+        this.dataAttributes = new DataAttribute(this);
+        this.events = new Event(this);
+        this.messages = new Message(this);
+        this.segments = new Segment(this);
         this.tags = new Tag(this);
         this.teams = new Team(this);
-        this.dataAttributes = new DataAttribute(this);
         this.requestOpts = {
             baseURL: 'https://api.intercom.io',
         };
@@ -99,7 +96,6 @@ export default class Client {
         this.axiosInstance = this.initiateAxiosInstance();
     }
     initiateAxiosInstance(): Axios {
-        // TO-DO: Revise the params
         const defaultHeaders = {
             'User-Agent': 'intercom-node-client/3.0.0',
             Accept: 'application/json',
@@ -256,4 +252,20 @@ export default class Client {
             status
         );
     }
+
+    private static getAuthDetails(
+        args: Constructor
+    ): [username: string | undefined, password: string | undefined] {
+        if (args.apiKeyAuth) {
+            return [args.apiKeyAuth.appId, args.apiKeyAuth.appApiKey];
+        }
+        if (args.tokenAuth) {
+            return [args.tokenAuth.token, ''];
+        }
+        if (args.usernameAuth) {
+            return [args.usernameAuth.username, args.usernameAuth.password];
+        }
+
+        return [undefined, undefined];
+    }
 }

lib/conversation/conversation.types.ts

@@ -1,3 +1,4 @@
+import { AdminObject } from '../admin/admin.types';
 import { JavascriptObject, Seconds, Timestamp } from '../common/common.types';
 
 export interface ConversationObject {
@@ -88,7 +89,7 @@ interface StatisticsObject {
     last_contact_reply_at: Seconds;
     last_admin_reply_at: Seconds;
     last_close_at: Seconds;
-    last_closed_by: JavascriptObject; // TO-DO : Admin reference
+    last_closed_by: AdminObject;
     count_reopens: number;
     count_assignments: number;
     count_conversations_parts: number;

lib/counts.js

@@ -42,15 +42,14 @@ export default class Event {
             summary,
         };
 
-        // TO-DO: Change to `params` from `data: params`
         return summary
             ? this.client.get<ListParamsWithSummaryResponse>({
                   url: `/${this.baseUrl}`,
-                  data: params,
+                  params,
               })
             : this.client.get<ListParamsResponse>({
                   url: `/${this.baseUrl}`,
-                  data: params,
+                  params,
               });
     }
 }

lib/customer.js

@@ -1,14 +1,14 @@
 export { default as Client } from './client';
-export { default as User } from './user';
-export { default as Snippet } from './snippet';
-export { default as UserData } from './user-data';
-
 import crypto from 'crypto';
 
 export class IdentityVerification {
-    static userHash(params: any) {
-        let secretKey = params.secretKey;
-        let identifier = params.identifier;
+    static userHash({
+        secretKey,
+        identifier,
+    }: {
+        secretKey?: string;
+        identifier?: string;
+    }) {
         if (!secretKey) {
             throw new Error('secretKey must be provided');
         }

lib/event.ts

@@ -12,17 +12,15 @@ export default class Segment {
 
         return this.client.get<ListResponse>({
             url: `/${this.baseUrl}`,
-            //TO-DO: Change to `params`
-            data: params,
+            params,
         });
     }
     find({ id, includeCount: include_count }: FindSegmentData) {
         const params = { include_count };
 
         return this.client.get<SegmentObject>({
             url: `/${this.baseUrl}/${id}`,
-            //TO-DO: Change to `params`
-            data: params,
+            params,
         });
     }
 }