intercom-client 6.0.0-beta.3 → 6.0.0

package/dist/api/types/ConversationSource.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.
+ */
+export interface ConversationSource {
+    /** This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. */
+    type: string;
+    /** The id representing the message. */
+    id: string;
+    /** The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email). */
+    delivered_as: string;
+    /** Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. */
+    subject: string;
+    /** The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. */
+    body?: string;
+    author: Intercom.ConversationPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.PartAttachment[];
+    /** The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank. */
+    url?: string;
+    /** Whether or not the source message has been redacted. Only applicable for contact initiated messages. */
+    redacted: boolean;
+}

package/dist/api/types/ConversationSource.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/types/ConversationStatistics.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A Statistics object containing all information required for reporting, with timestamps and calculated metrics.
+ */
+export interface ConversationStatistics {
+    /** */
+    type: "conversation_statistics";
+    /** Duration until last assignment before first admin reply. In seconds. */
+    time_to_assignment?: number;
+    /** Duration until first admin reply. Subtracts out of business hours. In seconds. */
+    time_to_admin_reply?: number;
+    /** Duration until conversation was closed first time. Subtracts out of business hours. In seconds. */
+    time_to_first_close?: number;
+    /** Duration until conversation was closed last time. Subtracts out of business hours. In seconds. */
+    time_to_last_close?: number;
+    /** Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds. */
+    median_time_to_reply?: number;
+    /** Time of first text conversation part from a contact. */
+    first_contact_reply_at?: number;
+    /** Time of first assignment after first_contact_reply_at. */
+    first_assignment_at?: number;
+    /** Time of first admin reply after first_contact_reply_at. */
+    first_admin_reply_at?: number;
+    /** Time of first close after first_contact_reply_at. */
+    first_close_at?: number;
+    /** Time of last assignment after first_contact_reply_at. */
+    last_assignment_at?: number;
+    /** Time of first admin reply since most recent assignment. */
+    last_assignment_admin_reply_at?: number;
+    /** Time of the last conversation part from a contact. */
+    last_contact_reply_at?: number;
+    /** Time of the last conversation part from an admin. */
+    last_admin_reply_at?: number;
+    /** Time of the last conversation close. */
+    last_close_at?: number;
+    /** The last admin who closed the conversation. Returns a reference to an Admin object. */
+    last_closed_by_id?: string;
+    /** Number of reopens after first_contact_reply_at. */
+    count_reopens?: number;
+    /** Number of assignments after first_contact_reply_at. */
+    count_assignments?: number;
+    /** Total number of conversation parts. */
+    count_conversation_parts?: number;
+}

package/dist/api/types/ConversationStatistics.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/types/ConversationTeammates.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The list of teammates who participated in the conversation (wrote at least one conversation part).
+ */
+export interface ConversationTeammates {
+    /** The type of the object - `admin.list`. */
+    type: string;
+    /** The list of teammates who participated in the conversation (wrote at least one conversation part). */
+    teammates: Intercom.Reference[];
+}

package/dist/api/types/ConversationTeammates.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/types/CreateContactRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload to create a contact
+ */
+export declare type CreateContactRequest = {
+    email: string;
+    phone?: string | undefined;
+    name?: string | undefined;
+    avatar?: string | undefined;
+    signed_up_at?: number | undefined;
+    last_seen_at?: number | undefined;
+    owner_id?: number | undefined;
+    unsubscribed_from_emails?: boolean | undefined;
+    custom_attributes?: Record<string, unknown> | undefined;
+} | {
+    external_id: string;
+    phone?: string | undefined;
+    name?: string | undefined;
+    avatar?: string | undefined;
+    signed_up_at?: number | undefined;
+    last_seen_at?: number | undefined;
+    owner_id?: number | undefined;
+    unsubscribed_from_emails?: boolean | undefined;
+    custom_attributes?: Record<string, unknown> | undefined;
+} | {
+    role: string;
+    phone?: string | undefined;
+    name?: string | undefined;
+    avatar?: string | undefined;
+    signed_up_at?: number | undefined;
+    last_seen_at?: number | undefined;
+    owner_id?: number | undefined;
+    unsubscribed_from_emails?: boolean | undefined;
+    custom_attributes?: Record<string, unknown> | undefined;
+};

package/dist/api/types/CreateContactRequest.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/types/CreateDataEventRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ *
+ */
+export declare type CreateDataEventRequest = {
+    id: string;
+    event_name: string;
+    created_at: number;
+    metadata?: Record<string, string> | undefined;
+} | {
+    user_id: string;
+    event_name: string;
+    created_at: number;
+    metadata?: Record<string, string> | undefined;
+} | {
+    email: string;
+    event_name: string;
+    created_at: number;
+    metadata?: Record<string, string> | undefined;
+};

package/dist/api/types/CreateDataEventRequest.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/types/CreateMessageRequest.d.ts

@@ -0,0 +1,104 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * You can create a message
+ */
+export declare type CreateMessageRequest = Intercom.CreateMessageRequest.Email | Intercom.CreateMessageRequest.Inapp;
+export declare namespace CreateMessageRequest {
+    interface Email {
+        message_type: "email";
+        /** The title of the email. */
+        subject: string;
+        /** The content of the message. HTML and plaintext are supported. */
+        body: string;
+        /** The style of the outgoing message. Possible values `plain` or `personal`. */
+        template: string;
+        /** The sender of the message. If not provided, the default sender will be used. */
+        from: CreateMessageRequestWithEmail.From;
+        /** The sender of the message. If not provided, the default sender will be used. */
+        to: CreateMessageRequestWithEmail.To;
+        /** The time the message was created. If not provided, the current time will be used. */
+        created_at?: number;
+        /** Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided. */
+        create_conversation_without_contact_reply?: boolean;
+    }
+    namespace CreateMessageRequestWithEmail {
+        /**
+         * The sender of the message. If not provided, the default sender will be used.
+         */
+        interface From {
+            /** Always `admin`. */
+            type: "admin";
+            /** The identifier for the admin which is given by Intercom. */
+            id: number;
+        }
+        /**
+         * The sender of the message. If not provided, the default sender will be used.
+         */
+        interface To {
+            /** The role associated to the contact - `user` or `lead`. */
+            type: To.Type;
+            /** The identifier for the contact which is given by Intercom. */
+            id: string;
+        }
+        namespace To {
+            /**
+             * The role associated to the contact - `user` or `lead`.
+             */
+            type Type = "user" | "lead";
+            const Type: {
+                readonly User: "user";
+                readonly Lead: "lead";
+            };
+        }
+    }
+    interface Inapp {
+        message_type: "inapp";
+        /** The title of the email. */
+        subject?: string;
+        /** The content of the message. HTML and plaintext are supported. */
+        body: string;
+        /** The style of the outgoing message. Possible values `plain` or `personal`. */
+        template?: string;
+        /** The sender of the message. If not provided, the default sender will be used. */
+        from: CreateMessageRequestWithInapp.From;
+        /** The sender of the message. If not provided, the default sender will be used. */
+        to: CreateMessageRequestWithInapp.To;
+        /** The time the message was created. If not provided, the current time will be used. */
+        created_at?: number;
+        /** Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided. */
+        create_conversation_without_contact_reply?: boolean;
+    }
+    namespace CreateMessageRequestWithInapp {
+        /**
+         * The sender of the message. If not provided, the default sender will be used.
+         */
+        interface From {
+            /** Always `admin`. */
+            type: "admin";
+            /** The identifier for the admin which is given by Intercom. */
+            id: number;
+        }
+        /**
+         * The sender of the message. If not provided, the default sender will be used.
+         */
+        interface To {
+            /** The role associated to the contact - `user` or `lead`. */
+            type: To.Type;
+            /** The identifier for the contact which is given by Intercom. */
+            id: string;
+        }
+        namespace To {
+            /**
+             * The role associated to the contact - `user` or `lead`.
+             */
+            type Type = "user" | "lead";
+            const Type: {
+                readonly User: "user";
+                readonly Lead: "lead";
+            };
+        }
+    }
+}

package/dist/api/types/CreateMessageRequest.js

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

package/dist/api/types/CreateOrUpdateTagRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * You can create or update an existing tag.
+ */
+export interface CreateOrUpdateTagRequest {
+    /** The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive. */
+    name: string;
+    /** The id of tag to updates. */
+    id?: string;
+}

package/dist/api/types/CreateOrUpdateTagRequest.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/types/CreateTicketReplyWithCommentRequest.d.ts

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

package/dist/api/types/CreateTicketReplyWithCommentRequest.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/types/CursorPages.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.
+ * A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
+ */
+export interface CursorPages {
+    /** the type of object `pages`. */
+    type: "pages";
+    /** The current page */
+    page?: number;
+    next?: Intercom.StartingAfterPaging;
+    /** Number of results per page */
+    per_page?: number;
+    /** Total number of pages */
+    total_pages?: number;
+}

package/dist/api/types/CursorPages.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/types/CustomAttributes.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.
+ */
+export declare type CustomAttributes = Record<string, CustomAttributes.Value>;
+export declare namespace CustomAttributes {
+    type Value = string | Intercom.CustomObjectInstance;
+}

package/dist/api/types/CustomAttributes.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/types/CustomerRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type CustomerRequest = {
+    intercom_user_id: string;
+} | {
+    user_id: string;
+} | {
+    email: string;
+};

package/dist/api/types/CustomerRequest.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/types/DataAttributeList.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A list of all data attributes belonging to a workspace for contacts, companies or conversations.
+ */
+export interface DataAttributeList {
+    /** The type of the object */
+    type: "list";
+    /** A list of data attributes */
+    data: Intercom.DataAttribute[];
+}

package/dist/api/types/DataAttributeList.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/types/DataEventList.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * This will return a list of data events for the App.
+ */
+export interface DataEventList {
+    /** The type of the object */
+    type: "event.list";
+    /** A list of data events */
+    events: Intercom.DataEvent[];
+    /** Pagination */
+    pages?: DataEventList.Pages;
+}
+export declare namespace DataEventList {
+    /**
+     * Pagination
+     */
+    interface Pages {
+        next?: string;
+        since?: string;
+    }
+}

package/dist/api/types/DataEventList.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/types/DataEventSummary.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * This will return a summary of data events for the App.
+ */
+export interface DataEventSummary {
+    /** The type of the object */
+    type: "event.summary";
+    /** The email address of the user */
+    email: string;
+    /** The Intercom user ID of the user */
+    intercom_user_id: string;
+    /** The user ID of the user */
+    user_id: string;
+    /** A summary of data events */
+    events: Intercom.DataEventSummaryItem[];
+}

package/dist/api/types/DataEventSummary.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/types/DataEventSummaryItem.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * This will return a summary of a data event for the App.
+ */
+export interface DataEventSummaryItem {
+    /** The name of the event */
+    name: string;
+    /** The first time the event was sent */
+    first: string;
+    /** The last time the event was sent */
+    last: string;
+    /** The number of times the event was sent */
+    count: number;
+    /** The description of the event */
+    description: string;
+}

package/dist/api/types/DataEventSummaryItem.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/types/DataExportCsv.d.ts

@@ -0,0 +1,60 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A CSV output file
+ */
+export interface DataExportCsv {
+    /** The user_id of the user who was sent the message. */
+    user_id: string;
+    /** The external_user_id of the user who was sent the message */
+    user_external_id?: string;
+    /** The company ID of the user in relation to the message that was sent. Will return -1 if no company is present. */
+    company_id: string;
+    /** The users email who was sent the message. */
+    email: string;
+    /** The full name of the user receiving the message */
+    name: string;
+    /** The id of the message. */
+    ruleset_id: string;
+    /** The specific content that was received. In an A/B test each version has its own Content ID. */
+    content_id: string;
+    /** Email, Chat, Post etc. */
+    content_type: string;
+    /** The title of the content you see in your Intercom workspace. */
+    content_title: string;
+    /** As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received. */
+    ruleset_version_id?: string;
+    /** ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message. */
+    receipt_id?: string;
+    /** Timestamp for when the receipt was recorded. */
+    received_at?: number;
+    /** The id of the series that this content is part of. Will return -1 if not part of a series. */
+    series_id?: string;
+    /** The title of the series that this content is part of. */
+    series_title?: string;
+    /** The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id. */
+    node_id?: string;
+    /** The first time a user replied to this message if the content was able to receive replies. */
+    first_reply?: number;
+    /** The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys. */
+    first_completion?: number;
+    /** The first time the series this message was a part of was completed by the user. */
+    first_series_completion?: number;
+    /** The first time the series this message was a part of was disengaged by the user. */
+    first_series_disengagement?: number;
+    /** The first time the series this message was a part of was exited by the user. */
+    first_series_exit?: number;
+    /** The first time the user met this messages associated goal if one exists. */
+    first_goal_success?: number;
+    /** The first time the user opened this message. */
+    first_open?: number;
+    /** The first time the series the user clicked on a link within this message. */
+    first_click?: number;
+    /** The first time the series the user dismissed this message. */
+    first_dismisall?: number;
+    /** The first time the user unsubscribed from this message. */
+    first_unsubscribe?: number;
+    /** The first time this message hard bounced for this user */
+    first_hard_bounce?: number;
+}

package/dist/api/types/DataExportCsv.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/types/DeletedArticleObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when an object is deleted
+ */
+export interface DeletedArticleObject {
+    /** The unique identifier for the article which you provided in the URL. */
+    id: string;
+    /** The type of object which was deleted. - article */
+    object: "article";
+    /** Whether the article was deleted successfully or not. */
+    deleted: boolean;
+}

package/dist/api/types/DeletedArticleObject.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/types/DeletedCollectionObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when an object is deleted
+ */
+export interface DeletedCollectionObject {
+    /** The unique identifier for the collection which you provided in the URL. */
+    id: string;
+    /** The type of object which was deleted. - `collection` */
+    object: "collection";
+    /** Whether the collection was deleted successfully or not. */
+    deleted: boolean;
+}

package/dist/api/types/DeletedCollectionObject.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/types/DeletedCompanyObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when an object is deleted
+ */
+export interface DeletedCompanyObject {
+    /** The unique identifier for the company which is given by Intercom. */
+    id: string;
+    /** The type of object which was deleted. - `company` */
+    object: "company";
+    /** Whether the company was deleted successfully or not. */
+    deleted: boolean;
+}