npm - intercom-client - Versions diffs - 6.0.0-beta.3 → 6.1.0 - Mend

intercom-client 6.0.0-beta.3 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2375) hide show

package/api/resources/tickets/client/requests/ReplyToTicketRequest.d.ts ADDED Viewed

@@ -0,0 +1,81 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d619d8a68186f43bafe82"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "note",
+ *             type: "admin",
+ *             body: "<html> <body>  <h2>An Unordered HTML List</h2>  <ul>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ul>    <h2>An Ordered HTML List</h2>  <ol>   <li>Coffee</li>   <li>Tea</li>   <li>Milk</li> </ol>   </body> </html>",
+ *             admin_id: "3156780"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "quick_reply",
+ *             type: "admin",
+ *             admin_id: "3156780",
+ *             reply_options: [{
+ *                     text: "Yes",
+ *                     uuid: "22d6d1f4-1a19-41d0-94c2-e54031f78aca"
+ *                 }, {
+ *                     text: "No",
+ *                     uuid: "fbc3dbe0-ec0c-4fb6-826d-e19127191906"
+ *                 }]
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d61a68a68186f43bafe85"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d619d8a68186f43bafe82"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "123",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d619d8a68186f43bafe82"
+ *         }
+ *     }
+ */
+export interface ReplyToTicketRequest {
+    ticket_id: string;
+    body: Intercom.TicketsReplyRequestBody;
+}

package/api/resources/tickets/client/requests/ReplyToTicketRequest.js ADDED Viewed

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

package/api/resources/tickets/client/requests/UpdateTicketRequest.d.ts ADDED Viewed

@@ -0,0 +1,82 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         ticket_id: "ticket_id",
+ *         ticket_attributes: {
+ *             "_default_title_": "example",
+ *             "_default_description_": "there is a problem"
+ *         },
+ *         state: "in_progress",
+ *         open: true,
+ *         snoozed_until: 1673609604,
+ *         assignment: {
+ *             admin_id: "991267883",
+ *             assignee_id: "991267885"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "ticket_id",
+ *         ticket_attributes: {
+ *             "_default_title_": "example",
+ *             "_default_description_": "there is a problem"
+ *         },
+ *         state: "in_progress",
+ *         assignment: {
+ *             admin_id: "123",
+ *             assignee_id: "991267893"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         ticket_id: "ticket_id",
+ *         ticket_attributes: {
+ *             "_default_title_": "example",
+ *             "_default_description_": "there is a problem"
+ *         },
+ *         state: "in_progress",
+ *         assignment: {
+ *             admin_id: "991267899",
+ *             assignee_id: "456"
+ *         }
+ *     }
+ */
+export interface UpdateTicketRequest {
+    /**
+     * The unique identifier for the ticket which is given by Intercom
+     */
+    ticket_id: string;
+    /** The attributes set on the ticket. */
+    ticket_attributes?: Record<string, unknown>;
+    /** The state of the ticket. */
+    state?: UpdateTicketRequest.State;
+    /** Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. */
+    open?: boolean;
+    /** Specify whether the ticket is visible to users. */
+    is_shared?: boolean;
+    /** The time you want the ticket to reopen. */
+    snoozed_until?: number;
+    assignment?: UpdateTicketRequest.Assignment;
+}
+export declare namespace UpdateTicketRequest {
+    /**
+     * The state of the ticket.
+     */
+    type State = "in_progress" | "waiting_on_customer" | "resolved";
+    const State: {
+        readonly InProgress: "in_progress";
+        readonly WaitingOnCustomer: "waiting_on_customer";
+        readonly Resolved: "resolved";
+    };
+    interface Assignment {
+        /** The ID of the admin performing the action. */
+        admin_id?: string;
+        /** The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. */
+        assignee_id?: string;
+    }
+}

package/api/resources/tickets/client/requests/UpdateTicketRequest.js ADDED Viewed

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateTicketRequest = void 0;
+var UpdateTicketRequest;
+(function (UpdateTicketRequest) {
+    UpdateTicketRequest.State = {
+        InProgress: "in_progress",
+        WaitingOnCustomer: "waiting_on_customer",
+        Resolved: "resolved",
+    };
+})(UpdateTicketRequest = exports.UpdateTicketRequest || (exports.UpdateTicketRequest = {}));

package/api/resources/tickets/client/requests/index.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+export { type ReplyToTicketRequest } from "./ReplyToTicketRequest";
+export { type CreateTicketRequest } from "./CreateTicketRequest";
+export { type FindTicketRequest } from "./FindTicketRequest";
+export { type UpdateTicketRequest } from "./UpdateTicketRequest";

package/api/resources/tickets/client/requests/index.js ADDED Viewed

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

package/api/resources/tickets/index.d.ts ADDED Viewed

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

package/api/resources/tickets/index.js ADDED Viewed

@@ -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/tickets/types/Ticket.d.ts ADDED Viewed

@@ -0,0 +1,63 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Tickets are how you track requests from your users.
+ */
+export interface Ticket {
+    /** Always ticket */
+    type: "ticket";
+    /** The unique identifier for the ticket which is given by Intercom. */
+    id: string;
+    /** The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries. */
+    ticket_id: string;
+    /** Category of the Ticket. */
+    category: Ticket.Category;
+    ticket_attributes: Intercom.TicketCustomAttributes;
+    /** The state the ticket is currently in */
+    ticket_state: Ticket.TicketState;
+    ticket_type: Intercom.TicketType;
+    contacts: Intercom.TicketContacts;
+    /** The id representing the admin assigned to the ticket. */
+    admin_assignee_id?: string;
+    /** The id representing the team assigned to the ticket. */
+    team_assignee_id?: string;
+    /** The time the ticket was created as a UTC Unix timestamp. */
+    created_at?: number;
+    /** The last time the ticket was updated as a UTC Unix timestamp. */
+    updated_at?: number;
+    /** Whether or not the ticket is open. If false, the ticket is closed. */
+    open?: boolean;
+    /** The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed. */
+    snoozed_until?: number;
+    linked_objects?: Intercom.LinkedObjectList;
+    ticket_parts?: Intercom.TicketParts;
+    /** Whether or not the ticket is shared with the customer. */
+    is_shared?: boolean;
+    /** The state the ticket is currently in, in a human readable form - visible in Intercom */
+    ticket_state_internal_label?: string;
+    /** The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal. */
+    ticket_state_external_label?: string;
+}
+export declare namespace Ticket {
+    /**
+     * Category of the Ticket.
+     */
+    type Category = "Customer" | "Back-office" | "Tracker";
+    const Category: {
+        readonly Customer: "Customer";
+        readonly BackOffice: "Back-office";
+        readonly Tracker: "Tracker";
+    };
+    /**
+     * The state the ticket is currently in
+     */
+    type TicketState = "submitted" | "in_progress" | "waiting_on_customer" | "resolved";
+    const TicketState: {
+        readonly Submitted: "submitted";
+        readonly InProgress: "in_progress";
+        readonly WaitingOnCustomer: "waiting_on_customer";
+        readonly Resolved: "resolved";
+    };
+}

package/api/resources/tickets/types/Ticket.js ADDED Viewed

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ticket = void 0;
+var Ticket;
+(function (Ticket) {
+    Ticket.Category = {
+        Customer: "Customer",
+        BackOffice: "Back-office",
+        Tracker: "Tracker",
+    };
+    Ticket.TicketState = {
+        Submitted: "submitted",
+        InProgress: "in_progress",
+        WaitingOnCustomer: "waiting_on_customer",
+        Resolved: "resolved",
+    };
+})(Ticket = exports.Ticket || (exports.Ticket = {}));

package/api/resources/tickets/types/TicketContacts.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * The list of contacts affected by a ticket.
+ */
+export interface TicketContacts {
+    /** always contact.list */
+    type: "contact.list";
+    /** The list of contacts affected by this ticket. */
+    contacts: Intercom.ContactReference[];
+}

package/api/resources/tickets/types/TicketContacts.js ADDED Viewed

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

package/api/resources/tickets/types/TicketPart.d.ts ADDED Viewed

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * A Ticket Part represents a message in the ticket.
+ */
+export interface TicketPart {
+    /** Always ticket_part */
+    type: "ticket_part";
+    /** The id representing the ticket part. */
+    id: string;
+    /** The type of ticket part. */
+    part_type: string;
+    /** The message body, which may contain HTML. */
+    body?: string;
+    /** The previous state of the ticket. */
+    previous_ticket_state?: TicketPart.PreviousTicketState;
+    /** The state of the ticket. */
+    ticket_state: TicketPart.TicketState;
+    /** The time the ticket part was created. */
+    created_at: number;
+    /** The last time the ticket part was updated. */
+    updated_at?: number;
+    /** The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.) */
+    assigned_to?: Intercom.Reference;
+    author?: Intercom.TicketPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.PartAttachment[];
+    /** The external id of the ticket part */
+    external_id?: string;
+    /** Whether or not the ticket part has been redacted. */
+    redacted?: boolean;
+}
+export declare namespace TicketPart {
+    /**
+     * The previous state of the ticket.
+     */
+    type PreviousTicketState = "submitted" | "in_progress" | "waiting_on_customer" | "resolved";
+    const PreviousTicketState: {
+        readonly Submitted: "submitted";
+        readonly InProgress: "in_progress";
+        readonly WaitingOnCustomer: "waiting_on_customer";
+        readonly Resolved: "resolved";
+    };
+    /**
+     * The state of the ticket.
+     */
+    type TicketState = "submitted" | "in_progress" | "waiting_on_customer" | "resolved";
+    const TicketState: {
+        readonly Submitted: "submitted";
+        readonly InProgress: "in_progress";
+        readonly WaitingOnCustomer: "waiting_on_customer";
+        readonly Resolved: "resolved";
+    };
+}

package/api/resources/tickets/types/TicketPart.js ADDED Viewed

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TicketPart = void 0;
+var TicketPart;
+(function (TicketPart) {
+    TicketPart.PreviousTicketState = {
+        Submitted: "submitted",
+        InProgress: "in_progress",
+        WaitingOnCustomer: "waiting_on_customer",
+        Resolved: "resolved",
+    };
+    TicketPart.TicketState = {
+        Submitted: "submitted",
+        InProgress: "in_progress",
+        WaitingOnCustomer: "waiting_on_customer",
+        Resolved: "resolved",
+    };
+})(TicketPart = exports.TicketPart || (exports.TicketPart = {}));

package/api/resources/tickets/types/TicketType.d.ts ADDED Viewed

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * A ticket type, used to define the data fields to be captured in a ticket.
+ */
+export interface TicketType {
+    /** String representing the object's type. Always has the value `ticket_type`. */
+    type: "ticket_type";
+    /** The id representing the ticket type. */
+    id: string;
+    /** Category of the Ticket Type. */
+    category: TicketType.Category;
+    /** The name of the ticket type */
+    name: string;
+    /** The description of the ticket type */
+    description: string;
+    /** The icon of the ticket type */
+    icon: string;
+    /** The id of the workspace that the ticket type belongs to. */
+    workspace_id: string;
+    ticket_type_attributes: Intercom.TicketTypeAttributeList;
+    /** Whether the ticket type is archived or not. */
+    archived: boolean;
+    /** The date and time the ticket type was created. */
+    created_at: number;
+    /** The date and time the ticket type was last updated. */
+    updated_at?: number;
+}
+export declare namespace TicketType {
+    /**
+     * Category of the Ticket Type.
+     */
+    type Category = "Customer" | "Back-office" | "Tracker";
+    const Category: {
+        readonly Customer: "Customer";
+        readonly BackOffice: "Back-office";
+        readonly Tracker: "Tracker";
+    };
+}

package/api/resources/tickets/types/TicketType.js ADDED Viewed

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TicketType = void 0;
+var TicketType;
+(function (TicketType) {
+    TicketType.Category = {
+        Customer: "Customer",
+        BackOffice: "Back-office",
+        Tracker: "Tracker",
+    };
+})(TicketType = exports.TicketType || (exports.TicketType = {}));

package/api/resources/tickets/types/TicketsReplyRequestBody.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+export declare type TicketsReplyRequestBody = Intercom.ContactReplyTicketRequest | Intercom.AdminReplyTicketRequest;

package/api/resources/tickets/types/TicketsReplyRequestBody.js ADDED Viewed

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

package/api/resources/tickets/types/index.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+export * from "./TicketsReplyRequestBody";
+export * from "./Ticket";
+export * from "./TicketContacts";
+export * from "./TicketPart";
+export * from "./TicketType";

package/api/resources/tickets/types/index.js ADDED Viewed

@@ -0,0 +1,21 @@
+"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("./TicketsReplyRequestBody"), exports);
+__exportStar(require("./Ticket"), exports);
+__exportStar(require("./TicketContacts"), exports);
+__exportStar(require("./TicketPart"), exports);
+__exportStar(require("./TicketType"), exports);

package/api/resources/visitors/client/Client.d.ts ADDED Viewed

@@ -0,0 +1,101 @@
+/**
+ * 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 Visitors {
+    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 your Visitors
+ */
+export declare class Visitors {
+    protected readonly _options: Visitors.Options;
+    constructor(_options?: Visitors.Options);
+    /**
+     * You can fetch the details of a single visitor.
+     *
+     * @param {Intercom.FindVisitorRequest} request
+     * @param {Visitors.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.visitors.find({
+     *         user_id: "user_id"
+     *     })
+     */
+    find(request: Intercom.FindVisitorRequest, requestOptions?: Visitors.RequestOptions): Promise<Intercom.Visitor>;
+    /**
+     * Sending a PUT request to `/visitors` will result in an update of an existing Visitor.
+     *
+     * **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.
+     *
+     * **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.
+     *
+     * @param {Intercom.UpdateVisitorRequest} request
+     * @param {Visitors.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.visitors.update({
+     *         id: "667d61cc8a68186f43bafe95",
+     *         name: "Gareth Bale"
+     *     })
+     *
+     * @example
+     *     await client.visitors.update({
+     *         user_id: "fail",
+     *         name: "Christian Fail"
+     *     })
+     */
+    update(request: Intercom.UpdateVisitorRequest, requestOptions?: Visitors.RequestOptions): Promise<Intercom.Visitor>;
+    /**
+     * You can merge a Visitor to a Contact of role type `lead` or `user`.
+     *
+     * > 📘 What happens upon a visitor being converted?
+     * >
+     * > If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.
+     *
+     * @param {Intercom.MergeVisitorToContactRequest} request
+     * @param {Visitors.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.visitors.mergeToContact({
+     *         type: "user",
+     *         user: {
+     *             id: "8a88a590-e1c3-41e2-a502-e0649dbf721c",
+     *             email: "foo@bar.com"
+     *         },
+     *         visitor: {
+     *             user_id: "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"
+     *         }
+     *     })
+     */
+    mergeToContact(request: Intercom.MergeVisitorToContactRequest, requestOptions?: Visitors.RequestOptions): Promise<Intercom.Contact>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}