intercom-client 6.3.0 → 6.4.0

package/dist/api/resources/unstable/resources/messages/client/Client.js

@@ -0,0 +1,370 @@
+"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 __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, an email or sms.
+     *
+     * > 🚧 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.CreateMessageRequestTwo} request
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.BadRequestError}
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     * @throws {@link Intercom.unstable.ForbiddenError}
+     * @throws {@link Intercom.unstable.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "user",
+     *             "id": "6762f2341bb69f9f2193bc17"
+     *         },
+     *         "body": "heyy",
+     *         "referer": "https://twitter.com/bob"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "lead",
+     *             "id": "6762f2371bb69f9f2193bc18"
+     *         },
+     *         "body": "heyy",
+     *         "referer": "https://twitter.com/bob"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267816"
+     *         },
+     *         "to": [
+     *             {
+     *                 "type": "user",
+     *                 "id": "6762f2391bb69f9f2193bc19"
+     *             },
+     *             {
+     *                 "type": "lead",
+     *                 "id": "6762f23c1bb69f9f2193bc1b"
+     *             },
+     *             {
+     *                 "type": "user",
+     *                 "id": "6762f23d1bb69f9f2193bc1c"
+     *             }
+     *         ],
+     *         "cc": [
+     *             {
+     *                 "type": "user",
+     *                 "id": "6762f23e1bb69f9f2193bc1d"
+     *             },
+     *             {
+     *                 "type": "user",
+     *                 "id": "6762f23f1bb69f9f2193bc1e"
+     *             }
+     *         ],
+     *         "bcc": [
+     *             {
+     *                 "type": "user",
+     *                 "id": "6762f23e1bb69f9f2193bc2f"
+     *             }
+     *         ],
+     *         "message_type": "conversation",
+     *         "body": "heyy"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267817"
+     *         },
+     *         "to": {
+     *             "type": "user",
+     *             "id": "6762f23a1bb69f9f2193bc1a"
+     *         },
+     *         "message_type": "sms",
+     *         "body": "heyy"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267818"
+     *         },
+     *         "to": {
+     *             "type": "user",
+     *             "id": "6762f23b1bb69f9f2193bc1a"
+     *         },
+     *         "message_type": "inapp",
+     *         "subject": "heyy"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267819"
+     *         },
+     *         "to": {
+     *             "type": "user",
+     *             "user_id": "70"
+     *         },
+     *         "message_type": "email",
+     *         "body": "hey there"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267820"
+     *         },
+     *         "to": {
+     *             "type": "user",
+     *             "id": "6762f23d1bb69f9f2193bc1c"
+     *         },
+     *         "message_type": "email",
+     *         "subject": "heyy"
+     *     })
+     *
+     * @example
+     *     await client.unstable.messages.createMessage({
+     *         "from": {
+     *             "type": "admin",
+     *             "id": "991267821"
+     *         },
+     *         "to": {
+     *             "type": "user",
+     *             "id": "6762f23b1bb69f9f2193bc1d"
+     *         },
+     *         "message_type": "sms",
+     *         "body": "heyy https://picsum.photos/200/300"
+     *     })
+     */
+    createMessage(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createMessage(request, requestOptions));
+    }
+    __createMessage(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.unstable.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Intercom.unstable.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Intercom.unstable.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Intercom.unstable.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,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.
+     *
+     *
+     * This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing
+     * information about delivery state and related message details.
+     *
+     * @param {Intercom.unstable.GetWhatsAppMessageStatusRequest} request
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.BadRequestError}
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     * @throws {@link Intercom.unstable.ForbiddenError}
+     * @throws {@link Intercom.unstable.InternalServerError}
+     *
+     * @example
+     *     await client.unstable.messages.getWhatsAppMessageStatus({
+     *         ruleset_id: "ruleset_id"
+     *     })
+     */
+    getWhatsAppMessageStatus(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getWhatsAppMessageStatus(request, requestOptions));
+    }
+    __getWhatsAppMessageStatus(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f;
+            const { ruleset_id: rulesetId, per_page: perPage, starting_after: startingAfter } = request;
+            const _queryParams = {};
+            _queryParams["ruleset_id"] = rulesetId;
+            if (perPage != null) {
+                _queryParams["per_page"] = perPage.toString();
+            }
+            if (startingAfter != null) {
+                _queryParams["starting_after"] = startingAfter;
+            }
+            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/status"),
+                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 400:
+                        throw new Intercom.unstable.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Intercom.unstable.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Intercom.unstable.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Intercom.unstable.InternalServerError(_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 /messages/status.");
+                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;

package/dist/api/resources/unstable/resources/messages/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/dist/api/resources/unstable/resources/messages/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/api/resources/unstable/resources/messages/client/requests/GetWhatsAppMessageStatusRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         ruleset_id: "ruleset_id"
+ *     }
+ */
+export interface GetWhatsAppMessageStatusRequest {
+    /**
+     * The unique identifier for the set of messages to check status for
+     */
+    ruleset_id: string;
+    /**
+     * Number of results per page (default 50, max 100)
+     */
+    per_page?: number;
+    /**
+     * Cursor for pagination, used to fetch the next page of results
+     */
+    starting_after?: string;
+}

package/dist/api/resources/unstable/resources/messages/client/requests/GetWhatsAppMessageStatusRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/unstable/resources/messages/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type GetWhatsAppMessageStatusRequest } from "./GetWhatsAppMessageStatusRequest";

package/dist/api/resources/unstable/resources/messages/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/unstable/resources/messages/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./client";

package/dist/api/resources/unstable/resources/messages/index.js

@@ -0,0 +1,18 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/resources/unstable/resources/messages/types/Message.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.
+ */
+export interface Message {
+    /** The type of the message */
+    type: string;
+    /** The id representing the message. */
+    id: string;
+    /** The time the conversation was created. */
+    created_at: number;
+    /** The subject of the message. Only present if message_type: email. */
+    subject?: string;
+    /** The message body, which may contain HTML. */
+    body: string;
+    /** The type of message that was sent. Can be email, inapp, facebook ,twitter or sms. */
+    message_type: Message.MessageType;
+    /** The associated conversation_id */
+    conversation_id?: string;
+}
+export declare namespace Message {
+    /**
+     * The type of message that was sent. Can be email, inapp, facebook ,twitter or sms.
+     */
+    type MessageType = "email" | "inapp" | "facebook" | "twitter" | "sms";
+    const MessageType: {
+        readonly Email: "email";
+        readonly Inapp: "inapp";
+        readonly Facebook: "facebook";
+        readonly Twitter: "twitter";
+        readonly Sms: "sms";
+    };
+}

package/dist/api/resources/unstable/resources/messages/types/Message.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Message = void 0;
+var Message;
+(function (Message) {
+    Message.MessageType = {
+        Email: "email",
+        Inapp: "inapp",
+        Facebook: "facebook",
+        Twitter: "twitter",
+        Sms: "sms",
+    };
+})(Message || (exports.Message = Message = {}));

package/dist/api/resources/unstable/resources/messages/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./Message";

package/dist/api/resources/unstable/resources/messages/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Message"), exports);