intercom-client 3.0.0-2 → 3.0.0

package/README.md

@@ -9,9 +9,9 @@
 
 ## Project Updates
 
-### Maintenance
+## Breaking changes
 
-Current repository is a new WIP version of Node SDK, that supports latest API version (v2.4 as of 14/01/2022)
+The Node SDK has been updated to support latest API version (2.4). The update also contains requested features, such like Typescript support. You can find more information on how-to migrate and what has changed in the [migration guide](https://github.com/intercom/intercom-node/wiki/Migration-guide).
 
 ## Installation
 
@@ -19,7 +19,7 @@ Current repository is a new WIP version of Node SDK, that supports latest API ve
 yarn add intercom-client
 ```
 
-**This client is intended for server side use only. Please use the [Intercom Javascript SDK](https://developers.intercom.com/v2.0/docs/intercom-javascript) for client-side operations.**
+**This client is intended for server side use only. Please use the [Intercom Javascript SDK](https://developers.intercom.com/v2.4/docs/intercom-javascript) for client-side operations.**
 
 ## Testing
 
@@ -110,6 +110,76 @@ await client.admins.listAllActivityLogs({
 const admins = await client.admins.list();
 ```
 
+### Articles
+
+#### [Create an article](https://developers.intercom.com/intercom-api-reference/reference/create-an-article)
+
+```typescript
+const article = await client.articles.create({
+    title: 'Thanks for everything',
+    description: 'English description',
+    body: '<p>This is the body in html</p>',
+    authorId: 1,
+    state: 'published',
+    parentId: 1,
+    parentType: 'collection',
+    translatedContent: {
+        fr: {
+            title: 'Allez les verts',
+            description: 'French description',
+            body: '<p>French body in html</p>',
+            author_id: 1,
+            state: 'published',
+        },
+    },
+});
+```
+
+#### [Retrieve an article](https://developers.intercom.com/intercom-api-reference/reference/retrieve-an-article)
+
+```typescript
+const response = await client.articles.find({ id: '123' });
+```
+
+#### [Update an article](https://developers.intercom.com/intercom-api-reference/reference/update-an-article)
+
+```typescript
+const article = await client.articles.update({
+    id: '123',
+    title: 'Thanks for everything',
+    description: 'English description',
+    body: '<p>This is the body in html</p>',
+    authorId: 1,
+    state: 'published',
+    parentId: 1,
+    parentType: 'collection',
+    translatedContent: {
+        fr: {
+            title: 'Allez les verts',
+            description: 'French description',
+            body: '<p>French body in html</p>',
+            author_id: 1,
+            state: 'published',
+        },
+    },
+});
+```
+
+#### [Delete an article](https://developers.intercom.com/intercom-api-reference/reference/delete-an-article)
+
+```typescript
+await client.articles.delete({ id: '123' });
+```
+
+#### [List all articles](https://developers.intercom.com/intercom-api-reference/reference/list-all-articles)
+
+```typescript
+const response = await client.articles.list({
+    page: 3,
+    perPage: 12,
+});
+```
+
 ### Companies
 
 #### [Create a company](https://developers.intercom.com/intercom-api-reference/reference/create-or-update-company)
@@ -745,6 +815,118 @@ const response = await client.events.listBy({
 });
 ```
 
+### Help Center - Collections
+
+#### [Create a collection](https://developers.intercom.com/intercom-api-reference/reference/create-a-collection)
+
+```typescript
+const collection = await client.helpCenter.collections.create({
+    name: 'Thanks for everything',
+    description: 'English description',
+    translatedContent: {
+        fr: {
+            name: 'Allez les verts',
+            description: 'French description',
+        },
+    },
+});
+```
+
+#### [Retrieve a collection](https://developers.intercom.com/intercom-api-reference/reference/retrieve-a-collection)
+
+```typescript
+const response = await client.helpCenter.collections.find({ id: '123' });
+```
+
+#### [Update a collection](https://developers.intercom.com/intercom-api-reference/reference/update-a-collection)
+
+```typescript
+const article = await client.helpCenter.collections.update({
+    id: '123',
+    name: 'Thanks for everything',
+    description: 'English description',
+    translated_content: {
+        fr: {
+            name: 'Allez les verts',
+            description: 'French description',
+        },
+    },
+});
+```
+
+#### [Delete a collection](https://developers.intercom.com/intercom-api-reference/reference/delete-a-collection)
+
+```typescript
+await client.helpCenter.collections.delete({
+    id: '123',
+});
+```
+
+#### [List all collections](https://developers.intercom.com/intercom-api-reference/reference/list-all-collections)
+
+```typescript
+const response = client.helpCenter.collections.list({
+    page: 3,
+    perPage: 12,
+});
+```
+
+## Help Center - Sections
+
+#### [Create a section](https://developers.intercom.com/intercom-api-reference/reference/create-a-section)
+
+```typescript
+const collection = await client.helpCenter.sections.create({
+    name: 'Thanks for everything',
+    parent_id: '1234',
+    translatedContent: {
+        fr: {
+            name: 'Allez les verts',
+            description: 'French description',
+        },
+    },
+});
+```
+
+#### [Retrieve a section](https://developers.intercom.com/intercom-api-reference/reference/retrieve-a-section)
+
+```typescript
+const response = await client.helpCenter.sections.find({ id: '123' });
+```
+
+#### [Update a section](https://developers.intercom.com/intercom-api-reference/reference/update-a-section)
+
+```typescript
+const article = await client.helpCenter.sections.update({
+    id: '123',
+    name: 'Thanks for everything',
+    parent_id: '456',
+    translated_content: {
+        fr: {
+            name: 'Allez les verts',
+            description: 'French description',
+        },
+    },
+});
+```
+
+#### [Delete a section](https://developers.intercom.com/intercom-api-reference/reference/delete-a-section)
+
+```typescript
+await client.helpCenter.sections.delete({
+    id: '123',
+});
+```
+
+#### [List all sections](https://developers.intercom.com/intercom-api-reference/reference/list-all-sections)
+
+```typescript
+const response = client.helpCenter.sections.list({
+    page: 3,
+    perPage: 12,
+});
+```
+
 ### Messages
 
 #### [Create a message](https://developers.intercom.com/intercom-api-reference/reference/admin-initiated-conversation)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "intercom-client",
-    "version": "3.0.0-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",
@@ -43,9 +43,11 @@
         "typescript": "^4.5.3"
     },
     "scripts": {
+        "clean": "rm -r dist",
         "static": "eslint .",
         "compile_ts": "tsc",
-        "prepublish": "yarn static && yarn compile_ts",
+        "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",
         "coverage": "nyc yarn test"
     },