intercom-client
Version:
Official Node bindings to the Intercom API
224 lines (223 loc) • 10.5 kB
JavaScript
;
/**
* 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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Messages = 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 messages
*/
class Messages {
constructor(_options = {}) {
this._options = _options;
}
/**
* You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.
*
* > 🚧 Sending for visitors
* >
* > There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.
*
* This will return the Message model that has been created.
*
* > 🚧 Retrieving Associated Conversations
* >
* > As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.
*
* @param {Intercom.CreateMessageRequest} request
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Intercom.BadRequestError}
* @throws {@link Intercom.UnauthorizedError}
* @throws {@link Intercom.ForbiddenError}
* @throws {@link Intercom.UnprocessableEntityError}
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "Thanks for everything",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "536e564f316c83104c000020"
* }
* })
*
* @example
* await client.messages.create({
* message_type: "inapp",
* subject: "heyy",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "667d616d8a68186f43bafe53"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "Thanks for everything",
* body: "hey there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "536e564f316c83104c000020"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*
* @example
* await client.messages.create({
* message_type: "email",
* subject: "heyy",
* body: "Hello there",
* template: "plain",
* from: {
* type: "admin",
* id: 394051
* },
* to: {
* type: "user",
* id: "667d616e8a68186f43bafe55"
* },
* created_at: 1590000000,
* create_conversation_without_contact_reply: true
* })
*/
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, "messages"),
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);
case 403:
throw new Intercom.ForbiddenError(_response.error.body, _response.rawResponse);
case 422:
throw new Intercom.UnprocessableEntityError(_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 /messages.");
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.Messages = Messages;