intercom-client 3.0.0-2 → 3.1.1

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/installing-intercom/docs/intercom-for-web) 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)
@@ -676,6 +746,62 @@ const response = await client.conversations.redactConversationPart({
 });
 ```
 
+### Counts
+
+#### [App Total Count](https://developers.intercom.com/intercom-api-reference/reference/company-user-counts)
+
+```typescript
+const response = await client.counts.forApp();
+```
+
+#### [Conversation Count Model](https://developers.intercom.com/intercom-api-reference/reference/conversation-counts)
+
+```typescript
+const response = await client.counts.countConversation();
+```
+
+#### [Admin Conversation Count Model](https://developers.intercom.com/intercom-api-reference/reference/admin-conversations)
+
+```typescript
+const response = await client.counts.countAdminConversation();
+```
+
+#### [User Segment/Tag Count Model](https://developers.intercom.com/intercom-api-reference/reference/user-tag-counts)
+
+##### Count User Segment
+
+```typescript
+const response = await client.counts.countUserSegment();
+```
+
+##### Count User Tag
+
+```typescript
+const response = await client.counts.countUserTag();
+```
+
+#### [Company User/Segment/Tag Count Model](https://developers.intercom.com/intercom-api-reference/reference/company-tag-counts)
+
+##### Count Company Segment
+
+```typescript
+const response = await client.counts.countCompanySegment();
+const response = await client.counts.countCompanyTag();
+const response = await client.counts.countCompanyUser();
+```
+
+##### Count Company Tag
+
+```typescript
+const response = await client.counts.countCompanyTag();
+```
+
+##### Count Company User
+
+```typescript
+const response = await client.counts.countCompanyUser();
+```
+
 ### Data Attributes
 
 #### [Create Data Attribute](https://developers.intercom.com/intercom-api-reference/reference/create-data-attributes)
@@ -745,6 +871,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',
+    translatedContent: {
+        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',
+    parentId: '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',
+    parentId: '456',
+    translatedContent: {
+        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)
@@ -766,6 +1004,34 @@ const response = await client.messages.create({
 });
 ```
 
+### Notes
+
+#### [Create a note](https://developers.intercom.com/intercom-api-reference/reference/create-note-for-contact)
+
+```typescript
+const response = await client.notes.create({
+    adminId: '12345',
+    body: 'Shiny',
+    contactId: '5678',
+});
+```
+
+#### [Retrieve a note](https://developers.intercom.com/intercom-api-reference/reference/view-a-note)
+
+```typescript
+const response = await client.notes.find({ id: '123' });
+```
+
+#### [List all notes](https://developers.intercom.com/intercom-api-reference/reference/list-notes-of-contact)
+
+```typescript
+const response = await client.notes.list({
+    contactId: '123',
+    page: 2,
+    perPage: 3,
+});
+```
+
 ### Segments
 
 #### [Retrieve a segment](https://developers.intercom.com/intercom-api-reference/reference/view-a-segment)
@@ -885,6 +1151,54 @@ const response = await client.teams.find({
 const response = await client.teams.list();
 ```
 
+### Visitors
+
+#### [Retrieve a Visitor](https://developers.intercom.com/intercom-api-reference/reference/view-a-visitor)
+
+```typescript
+const response = await client.visitors.find({ id: '123' });
+```
+
+OR
+
+```typescript
+const response = await client.visitors.find({ userId: '123' });
+```
+
+#### [Update a Visitor](https://developers.intercom.com/intercom-api-reference/reference/update-a-visitor)
+
+```typescript
+const response = await client.visitors.update({
+    userId: '123',
+    name: 'anonymous bruh',
+    customAttributes: {
+        paid_subscriber: true,
+    },
+});
+```
+
+#### [Delete a Visitor](https://developers.intercom.com/intercom-api-reference/reference/delete-a-visitor)
+
+```typescript
+const response = await client.visitors.delete({
+    id,
+});
+```
+
+#### [Convert a Visitor](https://developers.intercom.com/intercom-api-reference/reference/convert-a-visitor-to-a-user)
+
+```typescript
+const response = await client.visitors.mergeToContact({
+    visitor: {
+        id: '123',
+    },
+    user: {
+        userId: '123',
+    },
+    type: Role.USER,
+});
+```
+
 ### Identity verification
 
 `intercom-node` provides a helper for using [identity verification](https://docs.intercom.com/configure-intercom-for-your-product-or-site/staying-secure/enable-identity-verification-on-your-web-product):

package/dist/admin/admin.types.d.ts

@@ -1,5 +1,5 @@
 export interface AdminObject {
-    type: "admin";
+    type: 'admin';
     id: string;
     name: string;
     email: string;
@@ -8,6 +8,8 @@ export interface AdminObject {
     away_mode_reassign: boolean;
     has_inbox_seat: boolean;
     team_ids: Array<number>;
-    avatar: string;
+    avatar: string | {
+        image_url: string;
+    };
 }
 //# sourceMappingURL=admin.types.d.ts.map

package/dist/admin/admin.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.types.d.ts","sourceRoot":"","sources":["../../lib/admin/admin.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB"}
+{"version":3,"file":"admin.types.d.ts","sourceRoot":"","sources":["../../../lib/admin/admin.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C"}

package/dist/admin/admin.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin.types.js","sourceRoot":"","sources":["../../lib/admin/admin.types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"admin.types.js","sourceRoot":"","sources":["../../../lib/admin/admin.types.ts"],"names":[],"mappings":""}

package/dist/admin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../lib/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,MAAM,CAAC,OAAO,OAAO,KAAK;IAGV,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,YAAY;gBAEN,MAAM,EAAE,MAAM;IAI3C,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,gBAAgB;IAG7B,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,gBAAgB;IAWtE,mBAAmB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAW9D,IAAI;CAGP;AAED,UAAU,gBAAgB;IACtB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,gBAAgB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,UAAU,uBAAuB;IAC7B,KAAK,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,IAAI,CAAC;CACjB;AAED,UAAU,2BAA2B;IACjC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,YAAY,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAED,UAAU,cAAc;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACnD,YAAY,EAAE,WAAW,CAAC;CAC7B;AAED,UAAU,KAAK;IACX,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,UAAU,eAAe;IACrB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB"}
+{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../lib/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,MAAM,CAAC,OAAO,OAAO,KAAK;IAGV,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,YAAY;gBAEN,MAAM,EAAE,MAAM;IAI3C,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,gBAAgB;IAG7B,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,gBAAgB;IAWtE,mBAAmB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAW9D,IAAI;CAGP;AAED,UAAU,gBAAgB;IACtB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,gBAAgB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,UAAU,uBAAuB;IAC7B,KAAK,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,IAAI,CAAC;CACjB;AAED,UAAU,2BAA2B;IACjC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,YAAY,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAED,UAAU,cAAc;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACnD,YAAY,EAAE,WAAW,CAAC;CAC7B;AAED,UAAU,KAAK;IACX,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,UAAU,eAAe;IACrB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB"}

package/dist/admin.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin.js","sourceRoot":"","sources":["../lib/admin.ts"],"names":[],"mappings":";;AAEA,oCAAkD;AAElD;IAGI,eAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,QAAQ,CAAC;QAG/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,oBAAI,GAAJ,UAAK,EAAwB;YAAtB,EAAE,QAAA;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAc,EAAE,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IACD,oBAAI,GAAJ,UAAK,EAAiE;YAA/D,OAAO,aAAA,EAAE,cAAc,oBAAA,EAAE,kBAAkB,wBAAA;QAC9C,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,cAAc;YACjC,kBAAkB,EAAE,kBAAkB;SACzC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAc;YAChC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,OAAO,UAAO;YACvC,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,mCAAmB,GAAnB,UAAoB,EAA0C;YAAxC,MAAM,YAAA,EAAE,KAAK,WAAA;QAC/B,IAAM,MAAM,GAAG;YACX,gBAAgB,EAAE,IAAA,0BAAmB,EAAC,KAAK,CAAC;YAC5C,iBAAiB,EAAE,MAAM,CAAC,CAAC,CAAC,IAAA,0BAAmB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACtE,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA8B;YAChD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,mBAAgB;YACrC,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,oBAAI,GAAJ;QACI,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAkB,EAAE,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IACL,YAAC;AAAD,CAAC,AAnCD,IAmCC"}
+{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../lib/admin.ts"],"names":[],"mappings":";;AAEA,oCAAkD;AAElD;IAGI,eAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,QAAQ,CAAC;QAG/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,oBAAI,GAAJ,UAAK,EAAwB;YAAtB,EAAE,QAAA;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAc,EAAE,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IACD,oBAAI,GAAJ,UAAK,EAAiE;YAA/D,OAAO,aAAA,EAAE,cAAc,oBAAA,EAAE,kBAAkB,wBAAA;QAC9C,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,cAAc;YACjC,kBAAkB,EAAE,kBAAkB;SACzC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAc;YAChC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,OAAO,UAAO;YACvC,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,mCAAmB,GAAnB,UAAoB,EAA0C;YAAxC,MAAM,YAAA,EAAE,KAAK,WAAA;QAC/B,IAAM,MAAM,GAAG;YACX,gBAAgB,EAAE,IAAA,0BAAmB,EAAC,KAAK,CAAC;YAC5C,iBAAiB,EAAE,MAAM,CAAC,CAAC,CAAC,IAAA,0BAAmB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACtE,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA8B;YAChD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,mBAAgB;YACrC,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,oBAAI,GAAJ;QACI,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAkB,EAAE,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE,EAAE,CAAC,CAAC;IACzE,CAAC;IACL,YAAC;AAAD,CAAC,AAnCD,IAmCC"}

package/dist/article/article.types.d.ts

@@ -0,0 +1,87 @@
+import { Timestamp } from '../common/common.types';
+export declare type ArticleObject = {
+    type: 'article';
+    id: string;
+    workspace_id: string;
+    title: string;
+    description: string;
+    body: string;
+    author_id: string;
+    state: string;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    url: string;
+    parent_id: string;
+    parent_type: string;
+    default_locale: string;
+    translated_content: TranslatedContentObject;
+    statistics: StatisticsObject;
+};
+export declare enum Locales {
+    ARABIC = "ar",
+    BULGARIAN = "bg",
+    BOSNIAN = "bs",
+    CATALAN = "ca",
+    CZECH = "cs",
+    DANISH = "da",
+    GERMAN = "de",
+    DE_FORM = "de-form",
+    GREEK = "el",
+    ENGLISH = "en",
+    SPANISH = "es",
+    ESTONIAN = "et",
+    FINNISH = "fi",
+    FRENCH = "fr",
+    HEBREW = "he",
+    CROATIAN = "hr",
+    HUNGARIAN = "hu",
+    INDONESIAN = "id",
+    ITALIAN = "it",
+    JAPANESE = "ja",
+    KOREAN = "ko",
+    LITHUANIAN = "lt",
+    LATVIAN = "lv",
+    MONGOLIAN = "mn",
+    NORWEGIAN = "nb",
+    DUTCH = "nl",
+    POLISH = "pl",
+    PORTUGUESE_BRAZIL = "pt-BR",
+    PORTUGUESE = "pt",
+    ROMANIAN = "ro",
+    RUSSIAN = "ru",
+    SLOVENIAN = "sl",
+    SERBIAN = "sr",
+    SWEDISH = "sv",
+    TURKISH = "tr",
+    VIETNAMESE = "vi",
+    CHINESE_S = "zh-CN",
+    CHINESE_T = "zh-TW"
+}
+export interface ContentObject {
+    type?: 'article_content';
+    title: string;
+    description: string;
+    body: string;
+    author?: string;
+    author_id?: number;
+    state: string;
+    created_at?: Timestamp;
+    updated_at?: Timestamp;
+    url?: string;
+}
+export declare type ArticleLocalesMapping = {
+    [key in Locales]: ContentObject;
+};
+export declare type TranslatedContentObject = {
+    type: 'article_translated_content';
+} & Partial<ArticleLocalesMapping>;
+export declare type StatisticsObject = {
+    type: 'article_statistics';
+    views: number;
+    conversations: number;
+    reactions: number;
+    happy_reaction_percentage: number;
+    neutral_reaction_percentage: number;
+    sad_reaction_percentage: number;
+};
+//# sourceMappingURL=article.types.d.ts.map

package/dist/article/article.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.types.d.ts","sourceRoot":"","sources":["../../../lib/article/article.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,oBAAY,aAAa,GAAG;IACxB,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,uBAAuB,CAAC;IAC5C,UAAU,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAEF,oBAAY,OAAO;IACf,MAAM,OAAO;IACb,SAAS,OAAO;IAChB,OAAO,OAAO;IACd,OAAO,OAAO;IACd,KAAK,OAAO;IACZ,MAAM,OAAO;IACb,MAAM,OAAO;IACb,OAAO,YAAY;IACnB,KAAK,OAAO;IACZ,OAAO,OAAO;IACd,OAAO,OAAO;IACd,QAAQ,OAAO;IACf,OAAO,OAAO;IACd,MAAM,OAAO;IACb,MAAM,OAAO;IACb,QAAQ,OAAO;IACf,SAAS,OAAO;IAChB,UAAU,OAAO;IACjB,OAAO,OAAO;IACd,QAAQ,OAAO;IACf,MAAM,OAAO;IACb,UAAU,OAAO;IACjB,OAAO,OAAO;IACd,SAAS,OAAO;IAChB,SAAS,OAAO;IAChB,KAAK,OAAO;IACZ,MAAM,OAAO;IACb,iBAAiB,UAAU;IAC3B,UAAU,OAAO;IACjB,QAAQ,OAAO;IACf,OAAO,OAAO;IACd,SAAS,OAAO;IAChB,OAAO,OAAO;IACd,OAAO,OAAO;IACd,OAAO,OAAO;IACd,UAAU,OAAO;IACjB,SAAS,UAAU;IACnB,SAAS,UAAU;CACtB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,qBAAqB,GAAG;KAC/B,GAAG,IAAI,OAAO,GAAG,aAAa;CAClC,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IAClC,IAAI,EAAE,4BAA4B,CAAC;CACtC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAEnC,oBAAY,gBAAgB,GAAG;IAC3B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,yBAAyB,EAAE,MAAM,CAAC;IAClC,2BAA2B,EAAE,MAAM,CAAC;IACpC,uBAAuB,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/dist/article/article.types.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Locales = void 0;
+var Locales;
+(function (Locales) {
+    Locales["ARABIC"] = "ar";
+    Locales["BULGARIAN"] = "bg";
+    Locales["BOSNIAN"] = "bs";
+    Locales["CATALAN"] = "ca";
+    Locales["CZECH"] = "cs";
+    Locales["DANISH"] = "da";
+    Locales["GERMAN"] = "de";
+    Locales["DE_FORM"] = "de-form";
+    Locales["GREEK"] = "el";
+    Locales["ENGLISH"] = "en";
+    Locales["SPANISH"] = "es";
+    Locales["ESTONIAN"] = "et";
+    Locales["FINNISH"] = "fi";
+    Locales["FRENCH"] = "fr";
+    Locales["HEBREW"] = "he";
+    Locales["CROATIAN"] = "hr";
+    Locales["HUNGARIAN"] = "hu";
+    Locales["INDONESIAN"] = "id";
+    Locales["ITALIAN"] = "it";
+    Locales["JAPANESE"] = "ja";
+    Locales["KOREAN"] = "ko";
+    Locales["LITHUANIAN"] = "lt";
+    Locales["LATVIAN"] = "lv";
+    Locales["MONGOLIAN"] = "mn";
+    Locales["NORWEGIAN"] = "nb";
+    Locales["DUTCH"] = "nl";
+    Locales["POLISH"] = "pl";
+    Locales["PORTUGUESE_BRAZIL"] = "pt-BR";
+    Locales["PORTUGUESE"] = "pt";
+    Locales["ROMANIAN"] = "ro";
+    Locales["RUSSIAN"] = "ru";
+    Locales["SLOVENIAN"] = "sl";
+    Locales["SERBIAN"] = "sr";
+    Locales["SWEDISH"] = "sv";
+    Locales["TURKISH"] = "tr";
+    Locales["VIETNAMESE"] = "vi";
+    Locales["CHINESE_S"] = "zh-CN";
+    Locales["CHINESE_T"] = "zh-TW";
+})(Locales = exports.Locales || (exports.Locales = {}));
+//# sourceMappingURL=article.types.js.map

package/dist/article/article.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.types.js","sourceRoot":"","sources":["../../../lib/article/article.types.ts"],"names":[],"mappings":";;;AAqBA,IAAY,OAuCX;AAvCD,WAAY,OAAO;IACf,wBAAa,CAAA;IACb,2BAAgB,CAAA;IAChB,yBAAc,CAAA;IACd,yBAAc,CAAA;IACd,uBAAY,CAAA;IACZ,wBAAa,CAAA;IACb,wBAAa,CAAA;IACb,8BAAmB,CAAA;IACnB,uBAAY,CAAA;IACZ,yBAAc,CAAA;IACd,yBAAc,CAAA;IACd,0BAAe,CAAA;IACf,yBAAc,CAAA;IACd,wBAAa,CAAA;IACb,wBAAa,CAAA;IACb,0BAAe,CAAA;IACf,2BAAgB,CAAA;IAChB,4BAAiB,CAAA;IACjB,yBAAc,CAAA;IACd,0BAAe,CAAA;IACf,wBAAa,CAAA;IACb,4BAAiB,CAAA;IACjB,yBAAc,CAAA;IACd,2BAAgB,CAAA;IAChB,2BAAgB,CAAA;IAChB,uBAAY,CAAA;IACZ,wBAAa,CAAA;IACb,sCAA2B,CAAA;IAC3B,4BAAiB,CAAA;IACjB,0BAAe,CAAA;IACf,yBAAc,CAAA;IACd,2BAAgB,CAAA;IAChB,yBAAc,CAAA;IACd,yBAAc,CAAA;IACd,yBAAc,CAAA;IACd,4BAAiB,CAAA;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACvB,CAAC,EAvCW,OAAO,GAAP,eAAO,KAAP,eAAO,QAuClB"}

package/dist/article.d.ts

@@ -0,0 +1,34 @@
+import { Client } from '.';
+import { ArticleObject, TranslatedContentObject } from './article/article.types';
+import { GenericDeletedResponse, OperationById, Paginated } from './common/common.types';
+export default class Article {
+    private readonly client;
+    readonly baseUrl = "articles";
+    constructor(client: Client);
+    create({ title, description, body, authorId, state, parentId, parentType, translatedContent, }: CreateArticleData): Promise<ArticleObject>;
+    find({ id }: ArticleFindByIdData): Promise<ArticleObject>;
+    update({ id, title, description, body, authorId, state, parentId, parentType, translatedContent, }: UpdateArticleData): Promise<ArticleObject>;
+    delete({ id }: ArticleDeleteByIdData): Promise<ArticleDeleteByIdResponse>;
+    list({ page, perPage: per_page }: ArticleListData): Promise<ArticleListResponse>;
+}
+interface CreateArticleData {
+    title: string;
+    authorId: number;
+    description?: string;
+    body?: string;
+    state?: string;
+    parentId?: number;
+    parentType?: string;
+    translatedContent?: Omit<TranslatedContentObject, 'type'>;
+}
+declare type ArticleFindByIdData = OperationById;
+declare type UpdateArticleData = Partial<CreateArticleData> & OperationById;
+declare type ArticleDeleteByIdData = OperationById;
+declare type ArticleDeleteByIdResponse = GenericDeletedResponse<'article'>;
+declare type ArticleListData = {
+    page?: number;
+    perPage?: number;
+};
+declare type ArticleListResponse = Paginated<ArticleObject>;
+export {};
+//# sourceMappingURL=article.d.ts.map

package/dist/article.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.d.ts","sourceRoot":"","sources":["../../lib/article.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EACH,aAAa,EACb,uBAAuB,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,sBAAsB,EACtB,aAAa,EACb,SAAS,EACZ,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,OAAO;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,cAAc;gBAER,MAAM,EAAE,MAAM;IAI3C,MAAM,CAAC,EACH,KAAK,EACL,WAAW,EACX,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,iBAAiB,GACpB,EAAE,iBAAiB;IAiBpB,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAKhC,MAAM,CAAC,EACH,EAAE,EACF,KAAK,EACL,WAAW,EACX,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,iBAAiB,GACpB,EAAE,iBAAiB;IAiBpB,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,qBAAqB;IAKpC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,eAAe;CAWpD;AAED,UAAU,iBAAiB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;CAC7D;AAED,aAAK,mBAAmB,GAAG,aAAa,CAAC;AAEzC,aAAK,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC;AAEpE,aAAK,qBAAqB,GAAG,aAAa,CAAC;AAE3C,aAAK,yBAAyB,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAEnE,aAAK,eAAe,GAAG;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,mBAAmB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC"}

package/dist/article.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Article = /** @class */ (function () {
+    function Article(client) {
+        this.client = client;
+        this.baseUrl = 'articles';
+        this.client = client;
+    }
+    Article.prototype.create = function (_a) {
+        var title = _a.title, description = _a.description, body = _a.body, authorId = _a.authorId, state = _a.state, parentId = _a.parentId, parentType = _a.parentType, translatedContent = _a.translatedContent;
+        var data = {
+            title: title,
+            description: description,
+            body: body,
+            author_id: authorId,
+            state: state,
+            parent_id: parentId,
+            parent_type: parentType,
+            translated_content: translatedContent,
+        };
+        return this.client.post({
+            url: "/".concat(this.baseUrl),
+            data: data,
+        });
+    };
+    Article.prototype.find = function (_a) {
+        var id = _a.id;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+        });
+    };
+    Article.prototype.update = function (_a) {
+        var id = _a.id, title = _a.title, description = _a.description, body = _a.body, authorId = _a.authorId, state = _a.state, parentId = _a.parentId, parentType = _a.parentType, translatedContent = _a.translatedContent;
+        var data = {
+            title: title,
+            description: description,
+            body: body,
+            author_id: authorId,
+            state: state,
+            parent_id: parentId,
+            parent_type: parentType,
+            translated_content: translatedContent,
+        };
+        return this.client.put({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+            data: data,
+        });
+    };
+    Article.prototype.delete = function (_a) {
+        var id = _a.id;
+        return this.client.delete({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+        });
+    };
+    Article.prototype.list = function (_a) {
+        var page = _a.page, per_page = _a.perPage;
+        var params = {
+            page: page,
+            per_page: per_page,
+        };
+        return this.client.get({
+            url: "/".concat(this.baseUrl),
+            params: params,
+        });
+    };
+    return Article;
+}());
+exports.default = Article;
+//# sourceMappingURL=article.js.map

package/dist/article.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.js","sourceRoot":"","sources":["../../lib/article.ts"],"names":[],"mappings":";;AAWA;IAGI,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,UAAU,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,wBAAM,GAAN,UAAO,EASa;YARhB,KAAK,WAAA,EACL,WAAW,iBAAA,EACX,IAAI,UAAA,EACJ,QAAQ,cAAA,EACR,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,iBAAiB,uBAAA;QAEjB,IAAM,IAAI,GAAG;YACT,KAAK,OAAA;YACL,WAAW,aAAA;YACX,IAAI,MAAA;YACJ,SAAS,EAAE,QAAQ;YACnB,KAAK,OAAA;YACL,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,UAAU;YACvB,kBAAkB,EAAE,iBAAiB;SACxC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA2B;YAAzB,EAAE,QAAA;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAUa;YAThB,EAAE,QAAA,EACF,KAAK,WAAA,EACL,WAAW,iBAAA,EACX,IAAI,UAAA,EACJ,QAAQ,cAAA,EACR,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,iBAAiB,uBAAA;QAEjB,IAAM,IAAI,GAAG;YACT,KAAK,OAAA;YACL,WAAW,aAAA;YACX,IAAI,MAAA;YACJ,SAAS,EAAE,QAAQ;YACnB,KAAK,OAAA;YACL,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,UAAU;YACvB,kBAAkB,EAAE,iBAAiB;SACxC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;YAC7B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAA6B;YAA3B,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAA4B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA4C;YAA1C,IAAI,UAAA,EAAW,QAAQ,aAAA;QAC1B,IAAM,MAAM,GAAG;YACX,IAAI,MAAA;YACJ,QAAQ,UAAA;SACX,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsB;YACxC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AAjFD,IAiFC"}