intercom-client 3.2.0 → 4.0.0

package/dist/client.js

@@ -0,0 +1,325 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var axios_1 = __importDefault(require("axios"));
+var lodash_1 = require("lodash");
+var article_1 = __importDefault(require("./article"));
+var admin_1 = __importDefault(require("./admin"));
+var company_1 = __importDefault(require("./company"));
+var contact_1 = __importDefault(require("./contact"));
+var conversation_1 = __importDefault(require("./conversation"));
+var count_1 = __importDefault(require("./count"));
+var dataAttribute_1 = __importDefault(require("./dataAttribute"));
+var dataExport_1 = __importDefault(require("./dataExport"));
+var event_1 = __importDefault(require("./event"));
+var helpCenter_1 = __importDefault(require("./helpCenter"));
+var message_1 = __importDefault(require("./message"));
+var note_1 = __importDefault(require("./note"));
+var segment_1 = __importDefault(require("./segment"));
+var subscription_1 = __importDefault(require("./subscription"));
+var team_1 = __importDefault(require("./team"));
+var tag_1 = __importDefault(require("./tag"));
+var visitor_1 = __importDefault(require("./visitor"));
+var phoneCallRedirect_1 = __importDefault(require("./phoneCallRedirect"));
+var packageJson = __importStar(require("../package.json"));
+var badResponse_error_1 = require("./errors/badResponse.error");
+var Client = /** @class */ (function () {
+    function Client(args) {
+        var _a = __read(Client.getAuthDetails(args), 2), usernamePart = _a[0], passwordPart = _a[1];
+        this.usernamePart = usernamePart;
+        this.passwordPart = passwordPart;
+        if (!this.usernamePart || this.passwordPart === undefined) {
+            throw new Error('Could not construct a client with those parameters');
+        }
+        this.admins = new admin_1.default(this);
+        this.articles = new article_1.default(this);
+        this.companies = new company_1.default(this);
+        this.contacts = new contact_1.default(this);
+        this.conversations = new conversation_1.default(this);
+        this.counts = new count_1.default(this);
+        this.dataAttributes = new dataAttribute_1.default(this);
+        this.dataExport = new dataExport_1.default(this);
+        this.events = new event_1.default(this);
+        this.helpCenter = new helpCenter_1.default(this);
+        this.messages = new message_1.default(this);
+        this.notes = new note_1.default(this);
+        this.segments = new segment_1.default(this);
+        this.subscriptions = new subscription_1.default(this);
+        this.tags = new tag_1.default(this);
+        this.teams = new team_1.default(this);
+        this.visitors = new visitor_1.default(this);
+        this.phoneCallRedirect = new phoneCallRedirect_1.default(this);
+        this.requestOpts = {
+            baseURL: 'https://api.intercom.io',
+        };
+        this.propertiesToOmitInRequestOpts = ['headers.common.Accept'];
+        this.axiosInstance = this.initiateAxiosInstance();
+    }
+    Client.prototype.initiateAxiosInstance = function () {
+        var defaultHeaders = {
+            'User-Agent': "intercom-node-client/".concat(packageJson.version),
+            Accept: 'application/json',
+        };
+        var axiosInstance = axios_1.default.create({
+            auth: {
+                username: this.usernamePart,
+                password: this.passwordPart,
+            },
+            baseURL: this.requestOpts.baseURL,
+        });
+        axiosInstance.defaults.headers.common = (0, lodash_1.merge)(axiosInstance.defaults.headers.common, defaultHeaders);
+        return axiosInstance;
+    };
+    Client.prototype.useRequestOpts = function (opts) {
+        var filteredOpts = this.filterUnwantedProperties(opts);
+        this.requestOpts = (0, lodash_1.merge)(this.requestOpts, filteredOpts);
+        this.updateAxiosInstanceDefaults();
+        return this;
+    };
+    Client.prototype.updateAxiosInstanceDefaults = function () {
+        this.axiosInstance.defaults = (0, lodash_1.merge)(this.axiosInstance.defaults, this.requestOpts);
+    };
+    Client.prototype.filterUnwantedProperties = function (opts) {
+        return (0, lodash_1.omit)(opts, this.propertiesToOmitInRequestOpts);
+    };
+    Client.prototype.ping = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_1, error;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.get('/admins')];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_1 = _a.sent();
+                        error = err_1.response
+                            ? this.checkOnErrorInResponse(err_1.response)
+                            : err_1;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.put = function (_a) {
+        var url = _a.url, data = _a.data;
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_2, error;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.put(url, data)];
+                    case 1:
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_2 = _b.sent();
+                        error = err_2.response
+                            ? this.checkOnErrorInResponse(err_2.response)
+                            : err_2;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.post = function (_a) {
+        var url = _a.url, data = _a.data;
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_3, error;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.post(url, data)];
+                    case 1:
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_3 = _b.sent();
+                        error = err_3.response
+                            ? this.checkOnErrorInResponse(err_3.response)
+                            : err_3;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.get = function (_a) {
+        var url = _a.url, data = _a.data, params = _a.params;
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_4, error;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.get(url, {
+                                params: params,
+                                data: data,
+                            })];
+                    case 1:
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_4 = _b.sent();
+                        error = err_4.response
+                            ? this.checkOnErrorInResponse(err_4.response)
+                            : err_4;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.nextPage = function (paginationObject) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_5, error;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.get(paginationObject.next, { baseURL: undefined })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_5 = _a.sent();
+                        error = err_5.response
+                            ? this.checkOnErrorInResponse(err_5.response)
+                            : err_5;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.delete = function (_a) {
+        var url = _a.url, data = _a.data, params = _a.params;
+        return __awaiter(this, void 0, void 0, function () {
+            var response, err_6, error;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.axiosInstance.delete(url, {
+                                data: data,
+                                params: params,
+                            })];
+                    case 1:
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
+                    case 2:
+                        err_6 = _b.sent();
+                        error = err_6.response
+                            ? this.checkOnErrorInResponse(err_6.response)
+                            : err_6;
+                        throw error;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Client.prototype.checkOnErrorInResponse = function (_a) {
+        var data = _a.data, headers = _a.headers, status = _a.status;
+        if (data.type !== 'error.list') {
+            return undefined;
+        }
+        var message = Array.isArray(data.errors) && data.errors[0].message
+            ? data.errors[0].message
+            : null;
+        return new badResponse_error_1.BadResponseError(message || 'Response error', data, headers, status);
+    };
+    Client.getAuthDetails = function (args) {
+        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];
+    };
+    return Client;
+}());
+exports.default = Client;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../lib/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAmE;AACnE,iCAAqC;AAErC,sDAAgC;AAChC,kDAA4B;AAC5B,sDAAgC;AAChC,sDAAgC;AAChC,gEAA0C;AAC1C,kDAA4B;AAC5B,kEAA4C;AAC5C,4DAAsC;AACtC,kDAA4B;AAC5B,4DAAsC;AACtC,sDAAgC;AAChC,gDAA0B;AAC1B,sDAAgC;AAChC,gEAA0C;AAC1C,gDAA0B;AAC1B,8CAAwB;AACxB,sDAAgC;AAChC,0EAAoD;AAEpD,2DAA+C;AAE/C,gEAA8D;AA8B9D;IAyBI,gBAAY,IAAiB;QACnB,IAAA,KAAA,OAA+B,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAA,EAAzD,YAAY,QAAA,EAAE,YAAY,QAA+B,CAAC;QAEjE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACvD,MAAM,IAAI,KAAK,CACX,oDAAoD,CACvD,CAAC;SACL;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,IAAI,2BAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,WAAW,GAAG;YACf,OAAO,EAAE,yBAAyB;SACrC,CAAC;QACF,IAAI,CAAC,6BAA6B,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAE/D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtD,CAAC;IACD,sCAAqB,GAArB;QACI,IAAM,cAAc,GAAG;YACnB,YAAY,EAAE,+BAAwB,WAAW,CAAC,OAAO,CAAE;YAC3D,MAAM,EAAE,kBAAkB;SAC7B,CAAC;QAEF,IAAM,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAC/B,IAAI,EAAE;gBACF,QAAQ,EAAE,IAAI,CAAC,YAAsB;gBACrC,QAAQ,EAAE,IAAI,CAAC,YAAsB;aACxC;YACD,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;SACpC,CAAC,CAAC;QAEH,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,IAAA,cAAK,EACzC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EACrC,cAAc,CACjB,CAAC;QAEF,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,+BAAc,GAAd,UAAe,IAA4B;QACvC,IAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAEzD,IAAI,CAAC,WAAW,GAAG,IAAA,cAAK,EAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAEnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,4CAA2B,GAA3B;QACI,IAAI,CAAC,aAAa,CAAC,QAAQ,GAAG,IAAA,cAAK,EAC/B,IAAI,CAAC,aAAa,CAAC,QAAQ,EAC3B,IAAI,CAAC,WAAW,CACnB,CAAC;IACN,CAAC;IAED,yCAAwB,GAAxB,UACI,IAA4B;QAE5B,OAAO,IAAA,aAAI,EAAC,IAAI,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC1D,CAAC;IAEK,qBAAI,GAAV;;;;;;;wBAEyB,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAA;;wBAAlD,QAAQ,GAAG,SAAuC;wBAExD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,oBAAG,GAAT,UAAa,EAA6B;YAA3B,GAAG,SAAA,EAAE,IAAI,UAAA;;;;;;;wBAEC,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;wBAAlD,QAAQ,GAAG,SAAuC;wBAExD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,qBAAI,GAAV,UAAc,EAA6B;YAA3B,GAAG,SAAA,EAAE,IAAI,UAAA;;;;;;;wBAEA,qBAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;wBAAnD,QAAQ,GAAG,SAAwC;wBAEzD,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,oBAAG,GAAT,UAAa,EAAqC;YAAnC,GAAG,SAAA,EAAE,IAAI,UAAA,EAAE,MAAM,YAAA;;;;;;;wBAEP,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE;gCAC/C,MAAM,QAAA;gCACN,IAAI,MAAA;6BACP,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBAEF,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,yBAAQ,GAAd,UAAkB,gBAAkC;;;;;;;wBAE3B,qBAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CACzC,gBAAgB,CAAC,IAAI,EACrB,EAAE,OAAO,EAAE,SAAS,EAAE,CACzB,EAAA;;wBAHK,QAAQ,GAAG,SAGhB;wBAED,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEK,uBAAM,GAAZ,UAAgB,EAAqC;YAAnC,GAAG,SAAA,EAAE,IAAI,UAAA,EAAE,MAAM,YAAA;;;;;;;wBAEV,qBAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE;gCAClD,IAAI,MAAA;gCACJ,MAAM,QAAA;6BACT,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBAEF,sBAAO,QAAQ,CAAC,IAAI,EAAC;;;wBAEf,KAAK,GAAG,KAAG,CAAC,QAAQ;4BACtB,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAG,CAAC,QAAQ,CAAC;4BAC3C,CAAC,CAAC,KAAG,CAAC;wBAEV,MAAM,KAAK,CAAC;;;;;KAEnB;IAEO,uCAAsB,GAA9B,UAA+B,EAIf;YAHZ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,MAAM,YAAA;QAEN,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE;YAC5B,OAAO,SAAS,CAAC;SACpB;QAED,IAAM,OAAO,GACT,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;YAChD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;YACxB,CAAC,CAAC,IAAI,CAAC;QACf,OAAO,IAAI,oCAAgB,CACvB,OAAO,IAAI,gBAAgB,EAC3B,IAAI,EACJ,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAEc,qBAAc,GAA7B,UACI,IAAiB;QAEjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;SAC7D;QACD,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SACrC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;SACnE;QAED,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;IACL,aAAC;AAAD,CAAC,AA3OD,IA2OC"}

package/dist/common/common.types.d.ts

@@ -0,0 +1,69 @@
+export declare type StringifiedTimestamp = string;
+export declare type Timestamp = number;
+export declare type Seconds = number;
+export declare type JavascriptObject = Record<string | number, unknown>;
+export declare enum Role {
+    USER = "user",
+    LEAD = "lead"
+}
+export declare type PaginatedBase = {
+    type: string;
+    pages: {
+        type: 'pages';
+        next?: {
+            page: number;
+            starting_after?: string;
+        };
+        page: number;
+        per_page: number;
+        total_pages: number;
+    };
+    total_count: number;
+};
+export declare type Paginated<T> = PaginatedBase & {
+    data: T[];
+};
+export declare enum Operators {
+    AND = "AND",
+    OR = "OR",
+    EQUALS = "=",
+    NOT_EQUALS = "!=",
+    IN = "IN",
+    NIN = "NIN",
+    GREATER_THAN = ">",
+    LESS_THAN = "<",
+    CONTAINS = "~",
+    NOT_CONTAINS = "!~",
+    STARTS_WITH = "^",
+    ENDS_WITH = "$"
+}
+interface FlatQuery {
+    field: string;
+    operator: Operators;
+    value: string | number | string[] | number[] | null;
+}
+interface NestedQueries {
+    operator: Operators;
+    value: Array<FlatQuery | NestedQueries> | string | number | string[] | number[] | null;
+}
+export interface GenericSearchFilters {
+    query: FlatQuery | NestedQueries;
+}
+export declare enum Order {
+    DESC = "desc",
+    ASC = "asc"
+}
+export interface PaginationParams {
+    page?: number;
+    perPage?: number;
+}
+export interface GenericDeletedResponse<ObjectType extends string> {
+    id: string;
+    object: ObjectType;
+    deleted: boolean;
+}
+export interface OperationById {
+    id: string;
+}
+export {};
+//# sourceMappingURL=common.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.d.ts","sourceRoot":"","sources":["../../../lib/common/common.types.ts"],"names":[],"mappings":"AAAA,oBAAY,oBAAoB,GAAG,MAAM,CAAC;AAC1C,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhE,oBAAY,IAAI;IACZ,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED,oBAAY,aAAa,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACH,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,CAAC,EAAE;YACH,IAAI,EAAE,MAAM,CAAC;YACb,cAAc,CAAC,EAAE,MAAM,CAAC;SAC3B,CAAC;QACF,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,oBAAY,SAAS,CAAC,CAAC,IAAI,aAAa,GAAG;IACvC,IAAI,EAAE,CAAC,EAAE,CAAC;CACb,CAAC;AAEF,oBAAY,SAAS;IACjB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,MAAM,MAAM;IACZ,UAAU,OAAO;IACjB,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,YAAY,MAAM;IAClB,SAAS,MAAM;IACf,QAAQ,MAAM;IACd,YAAY,OAAO;IACnB,WAAW,MAAM;IACjB,SAAS,MAAM;CAClB;AAED,UAAU,SAAS;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;CACvD;AAED,UAAU,aAAa;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,KAAK,EACC,KAAK,CAAC,SAAS,GAAG,aAAa,CAAC,GAChC,MAAM,GACN,MAAM,GACN,MAAM,EAAE,GACR,MAAM,EAAE,GACR,IAAI,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACjC,KAAK,EAAE,SAAS,GAAG,aAAa,CAAC;CACpC;AAED,oBAAY,KAAK;IACb,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,MAAM;IAC7D,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;CACd"}

package/dist/common/common.types.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Order = exports.Operators = exports.Role = void 0;
+var Role;
+(function (Role) {
+    Role["USER"] = "user";
+    Role["LEAD"] = "lead";
+})(Role = exports.Role || (exports.Role = {}));
+var Operators;
+(function (Operators) {
+    Operators["AND"] = "AND";
+    Operators["OR"] = "OR";
+    Operators["EQUALS"] = "=";
+    Operators["NOT_EQUALS"] = "!=";
+    Operators["IN"] = "IN";
+    Operators["NIN"] = "NIN";
+    Operators["GREATER_THAN"] = ">";
+    Operators["LESS_THAN"] = "<";
+    Operators["CONTAINS"] = "~";
+    Operators["NOT_CONTAINS"] = "!~";
+    Operators["STARTS_WITH"] = "^";
+    Operators["ENDS_WITH"] = "$";
+})(Operators = exports.Operators || (exports.Operators = {}));
+var Order;
+(function (Order) {
+    Order["DESC"] = "desc";
+    Order["ASC"] = "asc";
+})(Order = exports.Order || (exports.Order = {}));
+//# sourceMappingURL=common.types.js.map

package/dist/common/common.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../lib/common/common.types.ts"],"names":[],"mappings":";;;AAKA,IAAY,IAGX;AAHD,WAAY,IAAI;IACZ,qBAAa,CAAA;IACb,qBAAa,CAAA;AACjB,CAAC,EAHW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGf;AAqBD,IAAY,SAaX;AAbD,WAAY,SAAS;IACjB,wBAAW,CAAA;IACX,sBAAS,CAAA;IACT,yBAAY,CAAA;IACZ,8BAAiB,CAAA;IACjB,sBAAS,CAAA;IACT,wBAAW,CAAA;IACX,+BAAkB,CAAA;IAClB,4BAAe,CAAA;IACf,2BAAc,CAAA;IACd,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,4BAAe,CAAA;AACnB,CAAC,EAbW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAapB;AAuBD,IAAY,KAGX;AAHD,WAAY,KAAK;IACb,sBAAa,CAAA;IACb,oBAAW,CAAA;AACf,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB"}

package/dist/company/company.types.d.ts

@@ -0,0 +1,37 @@
+import { JavascriptObject, Paginated, Timestamp } from '../common/common.types';
+import { SegmentObject } from '../segment/segment.types';
+import { TagObject } from '../tag/tag.types';
+export interface CompanyObject {
+    type: 'company';
+    company_id: string;
+    id: string;
+    app_id: string;
+    name: string;
+    remote_created_at: Timestamp;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    last_request_at: Timestamp;
+    monthly_spend: number;
+    session_count: number;
+    user_count: number;
+    size: number;
+    website: string;
+    industry: string;
+    tags: {
+        type: 'tag.list';
+        tags: TagObject;
+    };
+    segments: {
+        type: 'segment.list';
+        segments: SegmentObject;
+    };
+    plan: PlanObject;
+    custom_attributes: JavascriptObject;
+}
+export interface PlanObject {
+    type: 'plan';
+    id: string;
+    name: string;
+}
+export declare type ListCompaniesResponse = Paginated<CompanyObject>;
+//# sourceMappingURL=company.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"company.types.d.ts","sourceRoot":"","sources":["../../../lib/company/company.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,SAAS,CAAC;IAC7B,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,eAAe,EAAE,SAAS,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,SAAS,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE;QACN,IAAI,EAAE,cAAc,CAAC;QACrB,QAAQ,EAAE,aAAa,CAAC;KAC3B,CAAC;IACF,IAAI,EAAE,UAAU,CAAC;IACjB,iBAAiB,EAAE,gBAAgB,CAAC;CACvC;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,qBAAqB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC"}

package/dist/company/company.types.js

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

package/dist/company/company.types.js.map

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

package/dist/company.d.ts

@@ -0,0 +1,63 @@
+import { Client } from '.';
+import { PaginationParams, JavascriptObject, Order, Paginated, Timestamp, GenericDeletedResponse } from './common/common.types';
+import { CompanyObject, ListCompaniesResponse } from './company/company.types';
+import { ContactObject } from './contact/contact.types';
+import Scroll from './scroll';
+import { SegmentObject } from './segment/segment.types';
+export default class Company {
+    private readonly client;
+    readonly baseUrl = "companies";
+    readonly scroll: Scroll<Company>;
+    constructor(client: Client);
+    create({ createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes, }: CreateCompanyData): Promise<CompanyObject>;
+    update({ createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes, }: UpdateCompanyData): Promise<CompanyObject>;
+    find({ companyId, name }: FindCompanyData): Promise<CompanyObject>;
+    delete({ id }: DeleteCompanyData): Promise<DeleteCompanyResponse>;
+    list({ page, perPage: per_page, order, tagId: tag_id, segmentId: segment_id, }: ListCompaniesData): Promise<ListCompaniesResponse>;
+    attachContact({ contactId, companyId }: AttachContactData): Promise<CompanyObject>;
+    detachContact({ contactId, companyId }: DetachContactData): Promise<CompanyObject>;
+    listAttachedContacts({ companyId, page, perPage, }: ListAttachedContactsData): Promise<Paginated<ContactObject>>;
+    listAttachedSegments({ companyId }: ListAttachedSegmentsData): Promise<ListAttachedSegmentsResponse>;
+}
+interface CreateCompanyData {
+    createdAt: Timestamp;
+    companyId: string;
+    name: string;
+    monthlySpend: number;
+    plan: string;
+    size: number;
+    website: string;
+    industry: string;
+    customAttributes: JavascriptObject;
+}
+declare type UpdateCompanyData = CreateCompanyData;
+interface FindCompanyData {
+    companyId?: string;
+    name?: string;
+}
+interface DeleteCompanyData {
+    id: string;
+}
+declare type DeleteCompanyResponse = GenericDeletedResponse<'company'>;
+interface ListCompaniesData extends PaginationParams {
+    order?: Order;
+    tagId?: string;
+    segmentId?: string;
+}
+interface AttachContactData {
+    contactId: string;
+    companyId: string;
+}
+declare type DetachContactData = AttachContactData;
+interface ListAttachedContactsData extends PaginationParams {
+    companyId: string;
+}
+interface ListAttachedSegmentsData {
+    companyId: string;
+}
+interface ListAttachedSegmentsResponse {
+    type: 'list';
+    data: SegmentObject[];
+}
+export {};
+//# sourceMappingURL=company.d.ts.map

package/dist/company.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../lib/company.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,EACL,SAAS,EACT,SAAS,EACT,sBAAsB,EACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,MAAM,CAAC,OAAO,OAAO,OAAO;IAIZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHnC,SAAgB,OAAO,eAAe;IACtC,SAAgB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBAEX,MAAM,EAAE,MAAM;IAI3C,MAAM,CAAC,EACH,SAAS,EACT,SAAS,EACT,IAAI,EACJ,YAAY,EACZ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,gBAAgB,GACnB,EAAE,iBAAiB;IAkBpB,MAAM,CAAC,EACH,SAAS,EACT,SAAS,EACT,IAAI,EACJ,YAAY,EACZ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,gBAAgB,GACnB,EAAE,iBAAiB;IAiBpB,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,eAAe;IAazC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB;IAKhC,IAAI,CAAC,EACD,IAAI,EACJ,OAAO,EAAE,QAAQ,EACjB,KAAK,EACL,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,UAAU,GACxB,EAAE,iBAAiB;IAcpB,aAAa,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,iBAAiB;IAUzD,aAAa,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,iBAAiB;IAKzD,oBAAoB,CAAC,EACjB,SAAS,EACT,IAAI,EACJ,OAAO,GACV,EAAE,wBAAwB;IAQ3B,oBAAoB,CAAC,EAAE,SAAS,EAAE,EAAE,wBAAwB;CAK/D;AAED,UAAU,iBAAiB;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,gBAAgB,CAAC;CACtC;AAED,aAAK,iBAAiB,GAAG,iBAAiB,CAAC;AAE3C,UAAU,eAAe;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,iBAAiB;IACvB,EAAE,EAAE,MAAM,CAAC;CACd;AACD,aAAK,qBAAqB,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAE/D,UAAU,iBAAkB,SAAQ,gBAAgB;IAChD,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,iBAAiB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,aAAK,iBAAiB,GAAG,iBAAiB,CAAC;AAE3C,UAAU,wBAAyB,SAAQ,gBAAgB;IACvD,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,wBAAwB;IAC9B,SAAS,EAAE,MAAM,CAAC;CACrB;AACD,UAAU,4BAA4B;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,EAAE,CAAC;CACzB"}