UNPKG

intercom-client

Version:

Official Node bindings to the Intercom API

537 lines (536 loc) 31.4 kB
"use strict"; /** * This file was auto-generated by Fern from our API Definition. */ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (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 () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __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 __rest = (this && this.__rest) || function (s, e) { var t = {}; for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p]; if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) { if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]]; } return t; }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.Articles = void 0; const environments = __importStar(require("../../../../environments")); const core = __importStar(require("../../../../core")); const Intercom = __importStar(require("../../../index")); const url_join_1 = __importDefault(require("url-join")); const errors = __importStar(require("../../../../errors/index")); /** * Everything about your Articles */ class Articles { constructor(_options = {}) { this._options = _options; } /** * You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. * * > 📘 How are the articles sorted and ordered? * > * > Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first. * * @param {Intercom.ListArticlesRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.UnauthorizedError} * * @example * await client.articles.list() */ list() { return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) { const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d, _e, _f; const { page, per_page: perPage } = request; const _queryParams = {}; if (page != null) { _queryParams["page"] = page.toString(); } if (perPage != null) { _queryParams["per_page"] = perPage.toString(); } const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "articles"), method: "GET", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", queryParameters: _queryParams, requestType: "json", timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling GET /articles."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } })); let _offset = (request === null || request === void 0 ? void 0 : request.page) != null ? request === null || request === void 0 ? void 0 : request.page : 1; const dataWithRawResponse = yield list(request).withRawResponse(); return new core.Pageable({ response: dataWithRawResponse.data, rawResponse: dataWithRawResponse.rawResponse, hasNextPage: (response) => { var _a; return ((_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []).length > 0; }, getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []; }, loadPage: (_response) => { _offset += 1; return list(core.setObjectProperty(request, "page", _offset)); }, }); }); } /** * You can create a new article by making a POST request to `https://api.intercom.io/articles`. * * @param {Intercom.CreateArticleRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.BadRequestError} * @throws {@link Intercom.UnauthorizedError} * * @example * await client.articles.create({ * title: "Thanks for everything", * description: "Description of the Article", * body: "Body of the Article", * author_id: 991267407, * state: "published", * parent_id: 145, * parent_type: "collection", * translated_content: { * fr: { * type: "article_content", * title: "Merci pour tout", * description: "Description de l'article", * body: "Corps de l'article", * author_id: 991267407, * state: "published" * } * } * }) * * @example * await client.articles.create({ * title: "Thanks for everything", * description: "Description of the Article", * body: "Body of the Article", * author_id: 1295, * state: "published" * }) */ create(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions)); } __create(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d, _e, _f; const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "articles"), method: "POST", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", requestType: "json", body: request, timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 400: throw new Intercom.BadRequestError(_response.error.body, _response.rawResponse); case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling POST /articles."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`. * * @param {Intercom.FindArticleRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.UnauthorizedError} * @throws {@link Intercom.NotFoundError} * * @example * await client.articles.find({ * article_id: "123" * }) */ find(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__find(request, requestOptions)); } __find(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d, _e, _f; const { article_id: articleId } = request; const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, `articles/${encodeURIComponent(articleId)}`), method: "GET", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", requestType: "json", timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); case 404: throw new Intercom.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling GET /articles/{article_id}."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`. * * @param {Intercom.UpdateArticleRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.UnauthorizedError} * @throws {@link Intercom.NotFoundError} * * @example * await client.articles.update({ * article_id: "123", * title: "Christmas is here!", * body: "<p>New gifts in store for the jolly season</p>" * }) */ update(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions)); } __update(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d, _e, _f; const { article_id: articleId } = request, _body = __rest(request, ["article_id"]); const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, `articles/${encodeURIComponent(articleId)}`), method: "PUT", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", requestType: "json", body: _body, timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); case 404: throw new Intercom.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling PUT /articles/{article_id}."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`. * * @param {Intercom.DeleteArticleRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.UnauthorizedError} * @throws {@link Intercom.NotFoundError} * * @example * await client.articles.delete({ * article_id: "123" * }) */ delete(request, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions)); } __delete(request, requestOptions) { return __awaiter(this, void 0, void 0, function* () { var _a, _b, _c, _d, _e, _f; const { article_id: articleId } = request; const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, `articles/${encodeURIComponent(articleId)}`), method: "DELETE", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", requestType: "json", timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); case 404: throw new Intercom.NotFoundError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling DELETE /articles/{article_id}."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } /** * You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. * * @param {Intercom.SearchArticlesRequest} request * @param {Articles.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Intercom.UnauthorizedError} * * @example * await client.articles.search({ * phrase: "Getting started", * state: "published" * }) */ search(request = {}, requestOptions) { return core.HttpResponsePromise.fromPromise(this.__search(request, requestOptions)); } __search() { return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) { var _a, _b, _c, _d, _e, _f; const { phrase, state, help_center_id: helpCenterId, highlight } = request; const _queryParams = {}; if (phrase != null) { _queryParams["phrase"] = phrase; } if (state != null) { _queryParams["state"] = state; } if (helpCenterId != null) { _queryParams["help_center_id"] = helpCenterId.toString(); } if (highlight != null) { _queryParams["highlight"] = highlight.toString(); } const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({ url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.IntercomEnvironment.UsProduction, "articles/search"), method: "GET", headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "intercom-client/6.4.0", "Intercom-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.version) !== null && _f !== void 0 ? _f : "2.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers), contentType: "application/json", queryParameters: _queryParams, requestType: "json", timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 20000, maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries, abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal, }); if (_response.ok) { return { data: _response.body, rawResponse: _response.rawResponse }; } if (_response.error.reason === "status-code") { switch (_response.error.statusCode) { case 401: throw new Intercom.UnauthorizedError(_response.error.body, _response.rawResponse); default: throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.body, rawResponse: _response.rawResponse, }); } } switch (_response.error.reason) { case "non-json": throw new errors.IntercomError({ statusCode: _response.error.statusCode, body: _response.error.rawBody, rawResponse: _response.rawResponse, }); case "timeout": throw new errors.IntercomTimeoutError("Timeout exceeded when calling GET /articles/search."); case "unknown": throw new errors.IntercomError({ message: _response.error.errorMessage, rawResponse: _response.rawResponse, }); } }); } _getAuthorizationHeader() { return __awaiter(this, void 0, void 0, function* () { var _a; const bearer = (_a = (yield core.Supplier.get(this._options.token))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["INTERCOM_API_KEY"]; if (bearer == null) { throw new errors.IntercomError({ message: "Please specify a bearer by either passing it in to the constructor or initializing a INTERCOM_API_KEY environment variable", }); } return `Bearer ${bearer}`; }); } } exports.Articles = Articles;