Merge branch 'master' into patch-1

Author: johnnynader

.circleci/config.yml

@@ -3,16 +3,65 @@ jobs:
     build:
         docker:
             - image: circleci/node:14-browsers
-
         working_directory: ~/intercom-node
-
         steps:
             - checkout
             - run: export PATH="${PATH}:/home/circleci/.yarn/bin"
             - run: npm install --prefix=$HOME/.local --global corepack
+            - restore_cache:
+                  key: dependency-cache-{{ checksum "yarn.lock" }}
             - run: yarn
+            - save_cache:
+                  key: dependency-cache-{{ checksum "yarn.lock" }}
+                  paths:
+                      - node_modules
+                      - .yarn/cache
+            - restore_cache:
+                  key: dist-cache-{{ .Environment.CIRCLE_SHA1 }}
             - run: yarn prepublish
-            - run: yarn test
+            - save_cache:
+                  key: dist-cache-{{ .Environment.CIRCLE_SHA1 }}
+                  paths:
+                      - dist
+    unit_test:
+        docker:
+            - image: circleci/node:14-browsers
+        working_directory: ~/intercom-node
+        steps:
+            - checkout
+            - restore_cache:
+                  key: dependency-cache-{{ checksum "yarn.lock" }}
+            - run: yarn test:unit
+    integration_test:
+        docker:
+            - image: circleci/node:14-browsers
+              environment:
+                  API_TOKEN: $API_TOKEN
+        working_directory: ~/intercom-node
+
+        steps:
+            - checkout
+            - restore_cache:
+                  key: dependency-cache-{{ checksum "yarn.lock" }}
+            - restore_cache:
+                  key: dist-cache-{{ .Environment.CIRCLE_SHA1 }}
+            - run: yarn test:integration
+
+workflows:
+    version: 2
+    build_and_test:
+        jobs:
+            - build
+            - unit_test:
+                  requires:
+                      - build
+            - integration_test_approval:
+                  requires:
+                      - unit_test
+                  type: approval
+            - integration_test:
+                  requires:
+                      - integration_test_approval
 
 notify:
     webhooks:

.eslintrc

@@ -1,7 +1,7 @@
 {
     "root": true,
     "parser": "@typescript-eslint/parser",
-    "plugins": ["@typescript-eslint"],
+    "plugins": ["@typescript-eslint", "no-only-tests"],
     "rules": {
         "keyword-spacing": 2,
         "array-bracket-spacing": [2, "never"],
@@ -33,7 +33,9 @@
         "no-sparse-arrays": 2,
         "no-unreachable": 2,
         "use-isnan": 2,
-        "valid-typeof": 2
+        "valid-typeof": 2,
+        "require-await": "error",
+        "no-only-tests/no-only-tests": "error"
     },
     "extends": [
         "eslint:recommended",

README.md

@@ -738,12 +738,10 @@ const response = await client.conversations.search({
 
 ```typescript
 const response = await client.conversations.list({
-    query: {
-        order: Order.DESC,
-        sort: SortBy.UpdatedAt,
-        page: 1,
-        perPage: 10,
-    },
+    order: Order.DESC,
+    sort: SortBy.UpdatedAt,
+    page: 1,
+    perPage: 10,
 });
 ```
 

lib/client.ts

@@ -1,4 +1,3 @@
-import { deprecate } from 'util';
 import axios, { Axios, AxiosDefaults, AxiosResponse } from 'axios';
 import { merge, omit } from 'lodash';
 
@@ -69,7 +68,6 @@ export default class Client {
     requestOpts: Partial<AxiosDefaults>;
     tags: Tag;
     teams: Team;
-    usebaseURL: (baseURL: string) => this;
     usernamePart?: string;
     visitors: Visitor;
 
@@ -105,11 +103,6 @@ export default class Client {
         };
         this.propertiesToOmitInRequestOpts = ['headers.common.Accept'];
 
-        this.usebaseURL = deprecate(
-            (baseURL) => this.useRequestOpts({ baseURL }),
-            'intercom-client - client.usebaseURL(url): Use client.useRequestOpts({ baseURL: url }) instead'
-        );
-
         this.axiosInstance = this.initiateAxiosInstance();
     }
     initiateAxiosInstance(): Axios {

lib/conversation.ts

@@ -1,6 +1,5 @@
 import Client from './client';
 import {
-    Paginated,
     StringifiedTimestamp,
     GenericSearchFilters,
     Order,
@@ -257,9 +256,7 @@ export default class Conversation {
             data,
         });
     }
-    list({
-        query: { order, sort, page, perPage: per_page },
-    }: ListConversationData) {
+    list({ order, sort, page, perPage: per_page }: ListConversationData) {
         const params = { order, sort, page, per_page };
 
         return this.client.get<ListConversationResponse>({
@@ -521,15 +518,15 @@ export enum SortBy {
 }
 
 interface ListConversationData {
-    query: {
-        order: Order;
-        sort: SortBy;
-        page?: number;
-        perPage?: number;
-    };
+    order?: Order;
+    sort?: SortBy;
+    page?: number;
+    perPage?: number;
 }
 
-type ListConversationResponse = Paginated<ConversationObjectWithoutParts>;
+type ListConversationResponse = PaginatedBase & {
+    conversations: ConversationObjectWithoutParts[];
+};
 //
 export enum RedactConversationPartType {
     CONVERSATION_PART = 'conversation_part',

lib/scroll.ts

@@ -10,6 +10,7 @@ export default class Scroll<EntityType> {
         this.scrollParam = scrollParam;
     }
 
+    // eslint-disable-next-line require-await
     async each(params: EachData): Promise<EntityType[]> {
         this.scrollParam = params.scrollParam ?? undefined;
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "intercom-client",
-    "version": "3.1.2",
+    "version": "3.1.4",
     "description": "Official Node bindings to the Intercom API",
     "homepage": "https://github.com/intercom/intercom-node",
     "bugs:": "https://github.com/intercom/intercom-node/issues",
@@ -32,6 +32,7 @@
         "@typescript-eslint/parser": "^5.7.0",
         "eslint": "^8.2.0",
         "eslint-config-prettier": "^8.3.0",
+        "eslint-plugin-no-only-tests": "^2.6.0",
         "merge2": "^1.4.1",
         "mocha": "^9.2.0",
         "nock": "^13.0.11",
@@ -48,7 +49,8 @@
         "compile_ts": "tsc",
         "move_compiled_to_dist": "mv dist/lib/* dist && rmdir dist/lib",
         "prepublish": "yarn clean && yarn static && yarn compile_ts && yarn move_compiled_to_dist",
-        "test": "mocha -r ts-node/register test/*.ts",
+        "test:unit": "mocha -r ts-node/register test/unit/*.test.ts --reporter=nyan",
+        "test:integration": "mocha -r ts-node/register test/integration/**/*.test.ts --timeout=30000",
         "coverage": "nyc yarn test"
     },
     "engines": {

test/integration/admins.test.ts

@@ -0,0 +1,48 @@
+import { token } from './utils/config';
+import { Client } from '../../dist';
+import assert from 'assert';
+
+describe('Admins', () => {
+    let adminId: string;
+    const client = new Client({
+        tokenAuth: { token },
+    });
+
+    it('list', async () => {
+        const response = await client.admins.list();
+
+        adminId = response.admins[0].id;
+
+        assert.notEqual(response, undefined);
+    });
+    it('find', async () => {
+        const response = await client.admins.find({ id: adminId });
+
+        assert.notEqual(response, undefined);
+    });
+    it('listAllActivityLogs', async () => {
+        const response = await client.admins.listAllActivityLogs({
+            after: new Date('2021-12-12'),
+        });
+
+        assert.notEqual(response, undefined);
+    });
+    it('away - ON', async () => {
+        const response = await client.admins.away({
+            adminId,
+            enableAwayMode: true,
+            enableReassignMode: true,
+        });
+
+        assert.notEqual(response, undefined);
+    });
+    it('away - OFF', async () => {
+        const response = await client.admins.away({
+            adminId,
+            enableAwayMode: false,
+            enableReassignMode: false,
+        });
+
+        assert.notEqual(response, undefined);
+    });
+});

test/integration/articles.test.ts

@@ -0,0 +1,69 @@
+import { Client } from '../../dist';
+import assert from 'assert';
+import { token } from './utils/config';
+import { randomString } from './utils/random';
+
+describe('Articles', () => {
+    let newArticleId: string;
+    let parentId: number;
+    let adminId: number;
+
+    before(async () => {
+        const randomCollections = await client.helpCenter.collections.list({
+            perPage: 1,
+        });
+        const randomAdmins = await client.admins.list();
+
+        parentId = parseInt(randomCollections.data[0].id, 10);
+        adminId = parseInt(randomAdmins.admins[0].id, 10);
+    });
+
+    const client = new Client({ tokenAuth: { token } });
+
+    it('create', async () => {
+        const response = await client.articles.create({
+            title: randomString(),
+            description: randomString(),
+            body: '<b>Eins Zwei</b>',
+            authorId: adminId,
+            state: 'draft',
+            parentId,
+            parentType: 'collection',
+            translatedContent: {
+                fr: {
+                    title: 'Allez les verts',
+                    description: 'French description',
+                    body: '<p>French body in html</p>',
+                    author_id: adminId,
+                    state: 'draft',
+                },
+            },
+        });
+
+        newArticleId = response.id;
+        assert.notEqual(response, undefined);
+    });
+    it('find', async () => {
+        const response = await client.articles.find({ id: newArticleId });
+
+        assert.notEqual(response, undefined);
+    });
+    it('update', async () => {
+        const response = await client.articles.update({
+            id: newArticleId,
+            title: 'Biba & Boba',
+        });
+
+        assert.notEqual(response, undefined);
+    });
+    it('delete', async () => {
+        const response = await client.articles.delete({ id: newArticleId });
+
+        assert.notEqual(response, undefined);
+    });
+    it('list', async () => {
+        const response = await client.articles.list({ page: 1, perPage: 12 });
+
+        assert.notEqual(response, undefined);
+    });
+});