intercom-client 3.1.4 → 3.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![Circle CI](https://circleci.com/gh/intercom/intercom-node.png?style=shield)](https://circleci.com/gh/intercom/intercom-node)
 [![npm](https://img.shields.io/npm/v/intercom-client)](https://www.npmjs.com/package/intercom-client)
-![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.4-blue)
+![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.5-blue)
 ![Typescript Supported](https://img.shields.io/badge/Typescript-Supported-lightgrey)
 
 > Official Node bindings to the [Intercom API](https://api.intercom.io/docs)
@@ -11,7 +11,7 @@
 
 ## Breaking changes
 
-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).
+The Node SDK has been updated to support latest API version (2.5). 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
 
@@ -75,6 +75,17 @@ client.useRequestOpts({
 });
 ```
 
+### Setting the API base url
+
+If you are using the european instance of intercom and would like to call it directly and not be redirected through our US instance, you can set the `baseUrl` as follows:
+
+```typescript
+const client = new Client({ tokenAuth: { token: 'my_token' } });
+client.useRequestOpts({
+    baseUrl: 'https://api.eu.intercom.io',
+});
+```
+
 ## Examples
 
 ### Admins
@@ -834,6 +845,29 @@ const response = await client.dataAttributes.list({
 });
 ```
 
+### Data Exports
+
+#### [Create a export job](https://developers.intercom.com/intercom-api-reference/reference/creating-an-export-job)
+
+```typescript
+const response = await client.dataExport.create({
+    createdAtAfter: 1527811200,
+    createdAtBefore: 1530316800,
+});
+```
+
+#### [Retrieve a job status](https://developers.intercom.com/intercom-api-reference/reference/retrieve-a-job-status)
+
+```typescript
+const response = await client.dataExport.find({id: export.id})
+```
+
+#### [Cancel a job](https://developers.intercom.com/intercom-api-reference/reference/the-export-job-model)
+
+```typescript
+const response = await client.dataExport.cancel({id: export.id})
+```
+
 ### Events
 
 #### [Submit a data event](https://developers.intercom.com/intercom-api-reference/reference/list-data-attributes)
@@ -1002,6 +1036,24 @@ const response = await client.messages.create({
 });
 ```
 
+#### [Create conversation without contact reply](https://developers.intercom.com/intercom-api-reference/reference/admin-initiated-conversation)
+
+```typescript
+const response = await client.messages.create({
+    messageType: 'inapp',
+    body: 'Look at me, I am a conversation now',
+    from: {
+        type: 'admin',
+        id: '394051',
+    },
+    to: {
+        type: 'user',
+        id: '536e564f316c83104c000020',
+    },
+    createConversationWithoutContactReply: true,
+});
+```
+
 ### Notes
 
 #### [Create a note](https://developers.intercom.com/intercom-api-reference/reference/create-note-for-contact)
@@ -1049,6 +1101,24 @@ 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)
+
+```typescript
+const response = await client.phoneCallRedirect.create({
+    phone: '+353871234567',
+});
+```
+
 ### Tags
 
 #### [Create or update a tag](https://developers.intercom.com/intercom-api-reference/reference/create-and-update-tags)

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "intercom-client",
-    "version": "3.1.4",
+    "version": "3.2.0",
     "description": "Official Node bindings to the Intercom API",
     "homepage": "https://github.com/intercom/intercom-node",
     "bugs:": "https://github.com/intercom/intercom-node/issues",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "intercom-client",
-    "version": "3.1.4",
+    "version": "3.2.0",
     "description": "Official Node bindings to the Intercom API",
     "homepage": "https://github.com/intercom/intercom-node",
     "bugs:": "https://github.com/intercom/intercom-node/issues",

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

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

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

@@ -1 +0,0 @@
-{"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

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=admin.types.js.map

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

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

package/dist/admin.d.ts

@@ -1,48 +0,0 @@
-import { Client } from '.';
-import { AdminObject } from './admin/admin.types';
-export default class Admin {
-    private readonly client;
-    readonly baseUrl = "admins";
-    constructor(client: Client);
-    find({ id }: AdminGetByIdData): Promise<AdminObject>;
-    away({ adminId, enableAwayMode, enableReassignMode }: SetAdminAwayData): Promise<AdminObject>;
-    listAllActivityLogs({ before, after }: ListAllActivityLogsData): Promise<ListAllActivityLogsResponse>;
-    list(): Promise<ListAllResponse>;
-}
-interface AdminGetByIdData {
-    id: string;
-}
-interface SetAdminAwayData {
-    adminId: string;
-    enableAwayMode: boolean;
-    enableReassignMode: boolean;
-}
-interface ListAllActivityLogsData {
-    after: Date;
-    before?: Date;
-}
-interface ListAllActivityLogsResponse {
-    type: 'activity_log.list';
-    activityLogs: Array<ActivityObject>;
-    pages?: Pages;
-}
-interface ActivityObject {
-    id: string;
-    activity_type: string;
-    activity_description: string;
-    metadata: Record<string | number, string | number>;
-    performed_by: AdminObject;
-}
-interface Pages {
-    type: 'pages';
-    next: unknown | null;
-    page: number;
-    per_page: number;
-    total_pages: number;
-}
-interface ListAllResponse {
-    type: 'admin.list';
-    admins: AdminObject[];
-}
-export {};
-//# sourceMappingURL=admin.d.ts.map

package/dist/admin.d.ts.map

@@ -1 +0,0 @@
-{"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

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var time_1 = require("./util/time");
-var Admin = /** @class */ (function () {
-    function Admin(client) {
-        this.client = client;
-        this.baseUrl = 'admins';
-        this.client = client;
-    }
-    Admin.prototype.find = function (_a) {
-        var id = _a.id;
-        return this.client.get({ url: "/".concat(this.baseUrl, "/").concat(id) });
-    };
-    Admin.prototype.away = function (_a) {
-        var adminId = _a.adminId, enableAwayMode = _a.enableAwayMode, enableReassignMode = _a.enableReassignMode;
-        var data = {
-            away_mode_enabled: enableAwayMode,
-            away_mode_reassign: enableReassignMode,
-        };
-        return this.client.put({
-            url: "/".concat(this.baseUrl, "/").concat(adminId, "/away"),
-            data: data,
-        });
-    };
-    Admin.prototype.listAllActivityLogs = function (_a) {
-        var before = _a.before, after = _a.after;
-        var params = {
-            created_at_after: (0, time_1.dateToUnixTimestamp)(after),
-            created_at_before: before ? (0, time_1.dateToUnixTimestamp)(before) : undefined,
-        };
-        return this.client.get({
-            url: "/".concat(this.baseUrl, "/activity_logs"),
-            params: params,
-        });
-    };
-    Admin.prototype.list = function () {
-        return this.client.get({ url: "/".concat(this.baseUrl) });
-    };
-    return Admin;
-}());
-exports.default = Admin;
-//# sourceMappingURL=admin.js.map

package/dist/admin.js.map

@@ -1 +0,0 @@
-{"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

@@ -1,87 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,45 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,34 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,69 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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"}

package/dist/client.d.ts

@@ -1,76 +0,0 @@
-import { Axios, AxiosDefaults } from 'axios';
-import Article from './article';
-import Admin from './admin';
-import Company from './company';
-import Contact from './contact';
-import Conversation from './conversation';
-import Count from './count';
-import DataAttribute from './dataAttribute';
-import Event from './event';
-import HelpCenter from './helpCenter';
-import Message from './message';
-import Note from './note';
-import Segment from './segment';
-import Team from './team';
-import Tag from './tag';
-import Visitor from './visitor';
-interface RequestOptions {
-    url: string;
-    data?: any;
-    params?: any;
-}
-declare type Constructor = {
-    usernameAuth?: UsernameAuth;
-    tokenAuth?: TokenAuth;
-    apiKeyAuth?: ApiKeyAuth;
-};
-declare type UsernameAuth = {
-    username: string;
-    password: string;
-};
-declare type TokenAuth = {
-    token: string;
-};
-declare type ApiKeyAuth = {
-    appId: string;
-    appApiKey: string;
-};
-export default class Client {
-    articles: Article;
-    admins: Admin;
-    axiosInstance: Axios;
-    companies: Company;
-    contacts: Contact;
-    conversations: Conversation;
-    counts: Count;
-    dataAttributes: DataAttribute;
-    events: Event;
-    helpCenter: HelpCenter;
-    messages: Message;
-    notes: Note;
-    segments: Segment;
-    passwordPart?: string;
-    propertiesToOmitInRequestOpts: string[];
-    requestOpts: Partial<AxiosDefaults>;
-    tags: Tag;
-    teams: Team;
-    usernamePart?: string;
-    visitors: Visitor;
-    constructor(args: Constructor);
-    initiateAxiosInstance(): Axios;
-    useRequestOpts(opts: Partial<AxiosDefaults>): this;
-    updateAxiosInstanceDefaults(): void;
-    filterUnwantedProperties(opts: Partial<AxiosDefaults>): Partial<AxiosDefaults>;
-    ping<T>(): Promise<T>;
-    put<T>({ url, data }: RequestOptions): Promise<T>;
-    post<T>({ url, data }: RequestOptions): Promise<T>;
-    get<T>({ url, data, params }: RequestOptions): Promise<T>;
-    nextPage<T>(paginationObject: {
-        next: string;
-    }): Promise<T>;
-    delete<T>({ url, data, params }: RequestOptions): Promise<T>;
-    private checkOnErrorInResponse;
-    private static getAuthDetails;
-}
-export {};
-//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../lib/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAGnE,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,OAAO,MAAM,WAAW,CAAC;AAMhC,UAAU,cAAc;IACpB,GAAG,EAAE,MAAM,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,MAAM,CAAC,EAAE,GAAG,CAAC;CAChB;AAED,aAAK,WAAW,GAAG;IACf,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEF,aAAK,YAAY,GAAG;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,aAAK,SAAS,GAAG;IACb,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,aAAK,UAAU,GAAG;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;IACd,aAAa,EAAE,KAAK,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,EAAE,YAAY,CAAC;IAC5B,MAAM,EAAE,KAAK,CAAC;IACd,cAAc,EAAE,aAAa,CAAC;IAC9B,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,IAAI,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B,EAAE,MAAM,EAAE,CAAC;IACxC,WAAW,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,IAAI,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;gBAEN,IAAI,EAAE,WAAW;IAkC7B,qBAAqB,IAAI,KAAK;IAsB9B,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC;IAS3C,2BAA2B,IAAI,IAAI;IAOnC,wBAAwB,CACpB,IAAI,EAAE,OAAO,CAAC,aAAa,CAAC,GAC7B,OAAO,CAAC,aAAa,CAAC;IAInB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;IAcrB,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAcjD,IAAI,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAclD,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBzD,QAAQ,CAAC,CAAC,EAAE,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAiB3D,MAAM,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBlE,OAAO,CAAC,sBAAsB;IAqB9B,OAAO,CAAC,MAAM,CAAC,cAAc;CAehC"}