intercom-client 6.0.0-beta.3 → 6.0.0

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

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

package/api/resources/conversations/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/api/resources/conversations/client/requests/AttachContactToConversationRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         admin_id: "12345",
+ *         customer: {
+ *             intercom_user_id: "667d61168a68186f43bafe0d"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         admin_id: "12345",
+ *         customer: {
+ *             intercom_user_id: "667d61188a68186f43bafe0e"
+ *         }
+ *     }
+ */
+export interface AttachContactToConversationRequest {
+    /**
+     * The identifier for the conversation as given by Intercom.
+     */
+    conversation_id: string;
+    /** The `id` of the admin who is adding the new participant. */
+    admin_id?: string;
+    customer?: AttachContactToConversationRequest.Customer;
+}
+export declare namespace AttachContactToConversationRequest {
+    type Customer = {
+        intercom_user_id: string;
+        customer?: Intercom.CustomerRequest | undefined;
+    } | {
+        user_id: string;
+        customer?: Intercom.CustomerRequest | undefined;
+    } | {
+        email: string;
+        customer?: Intercom.CustomerRequest | undefined;
+    };
+}

package/api/resources/conversations/client/requests/AttachContactToConversationRequest.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/api/resources/conversations/client/requests/AutoAssignConversationRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         conversation_id: "123"
+ *     }
+ */
+export interface AutoAssignConversationRequest {
+    /**
+     * The identifier for the conversation as given by Intercom.
+     */
+    conversation_id: string;
+}

package/api/resources/conversations/client/requests/AutoAssignConversationRequest.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/api/resources/conversations/client/requests/ConvertConversationToTicketRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         ticket_type_id: "79"
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         ticket_type_id: "80"
+ *     }
+ */
+export interface ConvertConversationToTicketRequest {
+    /**
+     * The id of the conversation to target
+     */
+    conversation_id: string;
+    /** The ID of the type of ticket you want to convert the conversation to */
+    ticket_type_id: string;
+    attributes?: Intercom.TicketRequestCustomAttributes;
+}

package/api/resources/conversations/client/requests/ConvertConversationToTicketRequest.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/api/resources/conversations/client/requests/CreateConversationRequest.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         from: {
+ *             type: "user",
+ *             id: "667d60d18a68186f43bafddd"
+ *         },
+ *         body: "Hello there"
+ *     }
+ *
+ * @example
+ *     {
+ *         from: {
+ *             type: "user",
+ *             id: "123_doesnt_exist"
+ *         },
+ *         body: "Hello there"
+ *     }
+ */
+export interface CreateConversationRequest {
+    from: CreateConversationRequest.From;
+    /** The content of the message. HTML is not supported. */
+    body: string;
+}
+export declare namespace CreateConversationRequest {
+    interface From {
+        /** The role associated to the contact - user or lead. */
+        type: From.Type;
+        /** The identifier for the contact which is given by Intercom. */
+        id: string;
+    }
+    namespace From {
+        /**
+         * The role associated to the contact - user or lead.
+         */
+        type Type = "lead" | "user" | "contact";
+        const Type: {
+            readonly Lead: "lead";
+            readonly User: "user";
+            readonly Contact: "contact";
+        };
+    }
+}

package/api/resources/conversations/client/requests/CreateConversationRequest.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateConversationRequest = void 0;
+var CreateConversationRequest;
+(function (CreateConversationRequest) {
+    let From;
+    (function (From) {
+        From.Type = {
+            Lead: "lead",
+            User: "user",
+            Contact: "contact",
+        };
+    })(From = CreateConversationRequest.From || (CreateConversationRequest.From = {}));
+})(CreateConversationRequest = exports.CreateConversationRequest || (exports.CreateConversationRequest = {}));

package/api/resources/conversations/client/requests/DetachContactFromConversationRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         contact_id: "123",
+ *         admin_id: "5017690"
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         contact_id: "123",
+ *         admin_id: "5017690"
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         contact_id: "123",
+ *         admin_id: "5017690"
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         contact_id: "123",
+ *         admin_id: "5017690"
+ *     }
+ */
+export interface DetachContactFromConversationRequest {
+    /**
+     * The identifier for the conversation as given by Intercom.
+     */
+    conversation_id: string;
+    /**
+     * The identifier for the contact as given by Intercom.
+     */
+    contact_id: string;
+    /** The `id` of the admin who is performing the action. */
+    admin_id: string;
+}

package/api/resources/conversations/client/requests/DetachContactFromConversationRequest.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/api/resources/conversations/client/requests/FindConversationRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         display_as: "plaintext"
+ *     }
+ */
+export interface FindConversationRequest {
+    /**
+     * The id of the conversation to target
+     */
+    conversation_id: string;
+    /**
+     * Set to plaintext to retrieve conversation messages in plain text.
+     */
+    display_as?: string;
+}

package/api/resources/conversations/client/requests/FindConversationRequest.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/api/resources/conversations/client/requests/ListConversationsRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ListConversationsRequest {
+    /**
+     * How many results per page
+     */
+    per_page?: number;
+    /**
+     * String used to get the next page of conversations.
+     */
+    starting_after?: string;
+}

package/api/resources/conversations/client/requests/ListConversationsRequest.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/api/resources/conversations/client/requests/ManageConversationPartsRequest.d.ts

@@ -0,0 +1,72 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         body: {
+ *             message_type: "assignment",
+ *             type: "admin",
+ *             admin_id: "12345",
+ *             assignee_id: "4324241",
+ *             body: "Goodbye :)"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         body: {
+ *             message_type: "assignment",
+ *             type: "admin",
+ *             admin_id: "12345",
+ *             assignee_id: "4324241",
+ *             body: "Let me pass you over to one of my colleagues."
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         body: {
+ *             message_type: "assignment",
+ *             type: "admin",
+ *             admin_id: "12345",
+ *             assignee_id: "4324241",
+ *             body: "Let me pass you over to one of my colleagues."
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         body: {
+ *             message_type: "assignment",
+ *             type: "admin",
+ *             admin_id: "12345",
+ *             assignee_id: "4324241",
+ *             body: "Let me pass you over to one of my colleagues."
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         body: {
+ *             message_type: "assignment",
+ *             type: "admin",
+ *             admin_id: "12345",
+ *             assignee_id: "4324241",
+ *             body: "Goodbye :)"
+ *         }
+ *     }
+ */
+export interface ManageConversationPartsRequest {
+    /**
+     * The identifier for the conversation as given by Intercom.
+     */
+    conversation_id: string;
+    body: Intercom.ConversationsManageRequestBody;
+}

package/api/resources/conversations/client/requests/ManageConversationPartsRequest.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/api/resources/conversations/client/requests/ReplyToConversationRequest.d.ts

@@ -0,0 +1,89 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f18a68186f43bafdf4"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         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
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f78a68186f43bafdf7"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f98a68186f43bafdf8"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f18a68186f43bafdf4"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f18a68186f43bafdf4"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123 or \"last\"",
+ *         body: {
+ *             message_type: "comment",
+ *             type: "user",
+ *             body: "Thanks again :)",
+ *             intercom_user_id: "667d60f18a68186f43bafdf4"
+ *         }
+ *     }
+ */
+export interface ReplyToConversationRequest {
+    /**
+     * The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation
+     */
+    conversation_id: string;
+    body: Intercom.ReplyConversationRequest;
+}

package/api/resources/conversations/client/requests/ReplyToConversationRequest.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/api/resources/conversations/client/requests/UpdateConversationRequest.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../index";
+/**
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         display_as: "plaintext",
+ *         read: true,
+ *         custom_attributes: {
+ *             "issue_type": "Billing",
+ *             "priority": "High"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         conversation_id: "123",
+ *         display_as: "plaintext",
+ *         read: true,
+ *         custom_attributes: {
+ *             "issue_type": "Billing",
+ *             "priority": "High"
+ *         }
+ *     }
+ */
+export interface UpdateConversationRequest {
+    /**
+     * The id of the conversation to target
+     */
+    conversation_id: string;
+    /**
+     * Set to plaintext to retrieve conversation messages in plain text.
+     */
+    display_as?: string;
+    /** Mark a conversation as read within Intercom. */
+    read?: boolean;
+    custom_attributes?: Intercom.CustomAttributes;
+}

package/api/resources/conversations/client/requests/UpdateConversationRequest.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/api/resources/conversations/client/requests/index.d.ts

@@ -0,0 +1,10 @@
+export { type ListConversationsRequest } from "./ListConversationsRequest";
+export { type CreateConversationRequest } from "./CreateConversationRequest";
+export { type FindConversationRequest } from "./FindConversationRequest";
+export { type UpdateConversationRequest } from "./UpdateConversationRequest";
+export { type ReplyToConversationRequest } from "./ReplyToConversationRequest";
+export { type ManageConversationPartsRequest } from "./ManageConversationPartsRequest";
+export { type AutoAssignConversationRequest } from "./AutoAssignConversationRequest";
+export { type AttachContactToConversationRequest } from "./AttachContactToConversationRequest";
+export { type DetachContactFromConversationRequest } from "./DetachContactFromConversationRequest";
+export { type ConvertConversationToTicketRequest } from "./ConvertConversationToTicketRequest";

package/api/resources/conversations/client/requests/index.js

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

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

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

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

@@ -0,0 +1,68 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.
+ */
+export interface Conversation {
+    /** Always conversation. */
+    type?: "conversation";
+    /** The id representing the conversation. */
+    id: string;
+    /** The title given to the conversation. */
+    title?: string;
+    /** The time the conversation was created. */
+    created_at: number;
+    /** The last time the conversation was updated. */
+    updated_at: number;
+    /** The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin. */
+    waiting_since?: number;
+    /** If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time. */
+    snoozed_until?: number;
+    /** Indicates whether a conversation is open (true) or closed (false). */
+    open: boolean;
+    /** Can be set to "open", "closed" or "snoozed". */
+    state: Conversation.State;
+    /** Indicates whether a conversation has been read. */
+    read: boolean;
+    /** If marked as priority, it will return priority or else not_priority. */
+    priority?: Conversation.Priority;
+    /** The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null. */
+    admin_assignee_id?: number;
+    /** The id of the team assigned to the conversation. If it's not assigned to a team it will return null. */
+    team_assignee_id?: string;
+    tags?: Intercom.Tags;
+    conversation_rating?: Intercom.ConversationRating;
+    source: Intercom.ConversationSource;
+    contacts: Intercom.ConversationContacts;
+    teammates: Intercom.ConversationTeammates;
+    custom_attributes: Intercom.CustomAttributes;
+    first_contact_reply?: Intercom.ConversationFirstContactReply;
+    sla_applied?: Intercom.SlaApplied;
+    statistics?: Intercom.ConversationStatistics;
+    conversation_parts?: Intercom.ConversationParts;
+    linked_objects?: Intercom.LinkedObjectList;
+    /** Indicates whether the AI Agent participated in the conversation. */
+    ai_agent_participated?: boolean;
+    ai_agent?: Intercom.AiAgent;
+}
+export declare namespace Conversation {
+    /**
+     * Can be set to "open", "closed" or "snoozed".
+     */
+    type State = "open" | "closed" | "snoozed";
+    const State: {
+        readonly Open: "open";
+        readonly Closed: "closed";
+        readonly Snoozed: "snoozed";
+    };
+    /**
+     * If marked as priority, it will return priority or else not_priority.
+     */
+    type Priority = "priority" | "not_priority";
+    const Priority: {
+        readonly Priority: "priority";
+        readonly NotPriority: "not_priority";
+    };
+}

package/api/resources/conversations/types/Conversation.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Conversation = void 0;
+var Conversation;
+(function (Conversation) {
+    Conversation.State = {
+        Open: "open",
+        Closed: "closed",
+        Snoozed: "snoozed",
+    };
+    Conversation.Priority = {
+        Priority: "priority",
+        NotPriority: "not_priority",
+    };
+})(Conversation = exports.Conversation || (exports.Conversation = {}));