intercom-client 6.0.0-beta.3 → 6.1.0

package/api/resources/segments/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("./Segment"), exports);

package/api/resources/subscriptionTypes/client/Client.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Intercom from "../../../index";
+export declare namespace SubscriptionTypes {
+    interface Options {
+        environment?: core.Supplier<environments.IntercomEnvironment | string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+    }
+}
+/**
+ * Everything about subscription types
+ */
+export declare class SubscriptionTypes {
+    protected readonly _options: SubscriptionTypes.Options;
+    constructor(_options?: SubscriptionTypes.Options);
+    /**
+     * You can list all subscription types. A list of subscription type objects will be returned.
+     *
+     * @param {SubscriptionTypes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.subscriptionTypes.list()
+     */
+    list(requestOptions?: SubscriptionTypes.RequestOptions): Promise<Intercom.SubscriptionTypeList>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

package/api/resources/subscriptionTypes/client/Client.js

@@ -0,0 +1,119 @@
+"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 (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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionTypes = 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 subscription types
+ */
+class SubscriptionTypes {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * You can list all subscription types. A list of subscription type objects will be returned.
+     *
+     * @param {SubscriptionTypes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.subscriptionTypes.list()
+     */
+    list(requestOptions) {
+        var _a, _b, _c, _d, _e;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.IntercomEnvironment.UsProduction, "subscription_types"),
+                method: "GET",
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "intercom-client", "X-Fern-SDK-Version": "6.1.0", "User-Agent": "intercom-client/6.1.0", "Intercom-Version": (_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : "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 _response.body;
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 401:
+                        throw new Intercom.UnauthorizedError(_response.error.body);
+                    default:
+                        throw new errors.IntercomError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.IntercomError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.IntercomTimeoutError("Timeout exceeded when calling GET /subscription_types.");
+                case "unknown":
+                    throw new errors.IntercomError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            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 INTERCOM_API_KEY when instantiating the client.",
+                });
+            }
+            return `Bearer ${bearer}`;
+        });
+    }
+}
+exports.SubscriptionTypes = SubscriptionTypes;

package/api/resources/subscriptionTypes/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/api/resources/subscriptionTypes/client/index.js

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

package/api/resources/subscriptionTypes/index.d.ts

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

package/api/resources/subscriptionTypes/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/api/resources/subscriptionTypes/types/SubscriptionType.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.
+ */
+export interface SubscriptionType {
+    /** The type of the object - subscription */
+    type: "subscription";
+    /** The unique identifier representing the subscription type. */
+    id: string;
+    /** The state of the subscription type. */
+    state: SubscriptionType.State;
+    default_translation: Intercom.Translation;
+    /** An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. */
+    translations: Intercom.Translation[];
+    /** Describes the type of consent. */
+    consent_type: SubscriptionType.ConsentType;
+    /** The message types that this subscription supports - can contain `email` or `sms_message`. */
+    content_types: SubscriptionType.ContentTypes.Item[];
+}
+export declare namespace SubscriptionType {
+    /**
+     * The state of the subscription type.
+     */
+    type State = "live" | "draft" | "archived";
+    const State: {
+        readonly Live: "live";
+        readonly Draft: "draft";
+        readonly Archived: "archived";
+    };
+    /**
+     * Describes the type of consent.
+     */
+    type ConsentType = "opt_out" | "opt_in";
+    const ConsentType: {
+        readonly OptOut: "opt_out";
+        readonly OptIn: "opt_in";
+    };
+    type ContentTypes = ContentTypes.Item[];
+    namespace ContentTypes {
+        type Item = "email" | "sms_message";
+        const Item: {
+            readonly Email: "email";
+            readonly SmsMessage: "sms_message";
+        };
+    }
+}

package/api/resources/subscriptionTypes/types/SubscriptionType.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionType = void 0;
+var SubscriptionType;
+(function (SubscriptionType) {
+    SubscriptionType.State = {
+        Live: "live",
+        Draft: "draft",
+        Archived: "archived",
+    };
+    SubscriptionType.ConsentType = {
+        OptOut: "opt_out",
+        OptIn: "opt_in",
+    };
+    let ContentTypes;
+    (function (ContentTypes) {
+        ContentTypes.Item = {
+            Email: "email",
+            SmsMessage: "sms_message",
+        };
+    })(ContentTypes = SubscriptionType.ContentTypes || (SubscriptionType.ContentTypes = {}));
+})(SubscriptionType = exports.SubscriptionType || (exports.SubscriptionType = {}));

package/api/resources/subscriptionTypes/types/index.d.ts

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

package/api/resources/subscriptionTypes/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("./SubscriptionType"), exports);

package/api/resources/tags/client/Client.d.ts

@@ -0,0 +1,234 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Intercom from "../../../index";
+export declare namespace Tags {
+    interface Options {
+        environment?: core.Supplier<environments.IntercomEnvironment | string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+    }
+}
+/**
+ * Everything about tags
+ */
+export declare class Tags {
+    protected readonly _options: Tags.Options;
+    constructor(_options?: Tags.Options);
+    /**
+     * You can tag a specific contact. This will return a tag object for the tag that was added to the contact.
+     *
+     * @param {Intercom.TagContactRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.tagContact({
+     *         contact_id: "63a07ddf05a32042dffac965",
+     *         id: "7522907"
+     *     })
+     *
+     * @example
+     *     await client.tags.tagContact({
+     *         contact_id: "63a07ddf05a32042dffac965",
+     *         id: "123"
+     *     })
+     */
+    tagContact(request: Intercom.TagContactRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.
+     *
+     * @param {Intercom.UntagContactRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.untagContact({
+     *         contact_id: "63a07ddf05a32042dffac965",
+     *         tag_id: "7522907"
+     *     })
+     */
+    untagContact(request: Intercom.UntagContactRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.
+     *
+     * @param {Intercom.TagConversationRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.tagConversation({
+     *         conversation_id: "64619700005694",
+     *         id: "7522907",
+     *         admin_id: "780"
+     *     })
+     */
+    tagConversation(request: Intercom.TagConversationRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.
+     *
+     * @param {Intercom.UntagConversationRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.untagConversation({
+     *         conversation_id: "64619700005694",
+     *         tag_id: "7522907",
+     *         admin_id: "123"
+     *     })
+     */
+    untagConversation(request: Intercom.UntagConversationRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can fetch a list of all tags for a given workspace.
+     *
+     *
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.tags.list()
+     */
+    list(requestOptions?: Tags.RequestOptions): Promise<Intercom.TagList>;
+    /**
+     * You can use this endpoint to perform the following operations:
+     *
+     *   **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.
+     *
+     *   **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.
+     *
+     *   **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.
+     *
+     *   **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.
+     *
+     *   **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.
+     *
+     * Each operation will return a tag object.
+     *
+     * @param {Intercom.TagsCreateRequestBody} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.BadRequestError}
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.create({
+     *         name: "test"
+     *     })
+     *
+     * @example
+     *     await client.tags.create({
+     *         name: "Independent"
+     *     })
+     *
+     * @example
+     *     await client.tags.create({
+     *         name: "test",
+     *         companies: [{
+     *                 company_id: "123"
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.tags.create({
+     *         name: "test",
+     *         users: [{
+     *                 id: "123"
+     *             }]
+     *     })
+     */
+    create(request: Intercom.TagsCreateRequestBody, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can fetch the details of tags that are on the workspace by their id.
+     * This will return a tag object.
+     *
+     * @param {Intercom.FindTagRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.find({
+     *         tag_id: "123"
+     *     })
+     */
+    find(request: Intercom.FindTagRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can delete the details of tags that are on the workspace by passing in the id.
+     *
+     * @param {Intercom.DeleteTagRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.BadRequestError}
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.delete({
+     *         tag_id: "123"
+     *     })
+     */
+    delete(request: Intercom.DeleteTagRequest, requestOptions?: Tags.RequestOptions): Promise<void>;
+    /**
+     * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.
+     *
+     * @param {Intercom.TagTicketRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.tagTicket({
+     *         ticket_id: "64619700005694",
+     *         id: "7522907",
+     *         admin_id: "780"
+     *     })
+     */
+    tagTicket(request: Intercom.TagTicketRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    /**
+     * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.
+     *
+     * @param {Intercom.UntagTicketRequest} request
+     * @param {Tags.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.tags.untagTicket({
+     *         ticket_id: "64619700005694",
+     *         tag_id: "7522907",
+     *         admin_id: "123"
+     *     })
+     */
+    untagTicket(request: Intercom.UntagTicketRequest, requestOptions?: Tags.RequestOptions): Promise<Intercom.Tag>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}