intercom-client 6.3.0 → 6.4.0

package/dist/api/resources/unstable/types/CreateTicketRequestBody.d.ts

@@ -0,0 +1,43 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * You can create a Ticket
+ */
+export interface CreateTicketRequestBody {
+    /** The ID of the type of ticket you want to create */
+    ticket_type_id: string;
+    /** The list of contacts (users or leads) affected by this ticket. Currently only one is allowed */
+    contacts: CreateTicketRequestBody.Contacts.Item[];
+    /**
+     * The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:
+     *  - conversation | back-office ticket
+     *  - customer tickets | non-shared back-office ticket
+     *  - conversation | tracker ticket
+     *  - customer ticket | tracker ticket
+     */
+    conversation_to_link_id?: string;
+    /** The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom */
+    company_id?: string;
+    /** The time the ticket was created. If not provided, the current time will be used. */
+    created_at?: number;
+    assignment?: CreateTicketRequestBody.Assignment;
+}
+export declare namespace CreateTicketRequestBody {
+    type Contacts = Contacts.Item[];
+    namespace Contacts {
+        type Item = {
+            id: string;
+        } | {
+            external_id: string;
+        } | {
+            email: string;
+        };
+    }
+    interface Assignment {
+        /** The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned. */
+        admin_assignee_id?: string;
+        /** The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned. */
+        team_assignee_id?: string;
+    }
+}

package/dist/api/resources/unstable/types/CreateTicketRequestBody.js

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

package/dist/api/resources/unstable/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.unstable.StartingAfterPaging;
+    /** Number of results per page */
+    per_page?: number;
+    /** Total number of pages */
+    total_pages?: number;
+}

package/dist/api/resources/unstable/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/resources/unstable/types/CustomActionFinished.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contains details about final status of the completed action for conversation part type <code>custom_action_finished</code>.
+ */
+export interface CustomActionFinished {
+    action?: CustomActionFinished.Action;
+}
+export declare namespace CustomActionFinished {
+    interface Action {
+        /** Name of the action */
+        name?: string;
+        /** Status of the action */
+        result?: Action.Result;
+    }
+    namespace Action {
+        /**
+         * Status of the action
+         */
+        type Result = "success" | "failed";
+        const Result: {
+            readonly Success: "success";
+            readonly Failed: "failed";
+        };
+    }
+}

package/dist/api/resources/unstable/types/CustomActionFinished.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomActionFinished = void 0;
+var CustomActionFinished;
+(function (CustomActionFinished) {
+    let Action;
+    (function (Action) {
+        Action.Result = {
+            Success: "success",
+            Failed: "failed",
+        };
+    })(Action = CustomActionFinished.Action || (CustomActionFinished.Action = {}));
+})(CustomActionFinished || (exports.CustomActionFinished = CustomActionFinished = {}));

package/dist/api/resources/unstable/types/CustomActionStarted.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contains details about name of the action that was initiated for conversation part type <code>custom_action_started</code>.
+ */
+export interface CustomActionStarted {
+    action?: CustomActionStarted.Action;
+}
+export declare namespace CustomActionStarted {
+    interface Action {
+        /** Name of the action */
+        name?: string;
+    }
+}

package/dist/api/resources/unstable/types/CustomActionStarted.js

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

package/dist/api/resources/unstable/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 type CustomAttributes = Record<string, CustomAttributes.Value>;
+export declare namespace CustomAttributes {
+    type Value = string | number | Intercom.unstable.Datetime | Intercom.unstable.CustomObjectInstanceList;
+}

package/dist/api/resources/unstable/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/resources/unstable/types/CustomChannelAttribute.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CustomChannelAttribute {
+    /** Identifier for the attribute being collected. */
+    id: string;
+    /** Value provided by the user for the attribute. */
+    value: string;
+}

package/dist/api/resources/unstable/types/CustomChannelAttribute.js

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

package/dist/api/resources/unstable/types/CustomChannelBaseEvent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+export interface CustomChannelBaseEvent {
+    /** Unique identifier for the event. */
+    event_id: string;
+    /** Identifier for the conversation in your application. */
+    external_conversation_id: string;
+    contact: Intercom.unstable.CustomChannelContact;
+}

package/dist/api/resources/unstable/types/CustomChannelBaseEvent.js

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

package/dist/api/resources/unstable/types/CustomChannelContact.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CustomChannelContact {
+    /** Type of contact, must be "user" or "lead". */
+    type: CustomChannelContact.Type;
+    /** External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it. */
+    external_id: string;
+    /** Name of the contact. */
+    name: string;
+    /** Email address of the contact. */
+    email: string;
+}
+export declare namespace CustomChannelContact {
+    /**
+     * Type of contact, must be "user" or "lead".
+     */
+    type Type = "user" | "lead";
+    const Type: {
+        readonly User: "user";
+        readonly Lead: "lead";
+    };
+}

package/dist/api/resources/unstable/types/CustomChannelContact.js

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

package/dist/api/resources/unstable/types/CustomChannelNotificationResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CustomChannelNotificationResponse {
+    /** The external conversation ID provided in the notification request */
+    external_conversation_id: string;
+    /** The Intercom conversation ID mapped to the external conversation ID */
+    conversation_id: string;
+    /** The external contact ID provided in the notification request */
+    external_contact_id: string;
+    /** The Intercom contact ID mapped to the external contact ID */
+    contact_id: string;
+}

package/dist/api/resources/unstable/types/CustomChannelNotificationResponse.js

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

package/dist/api/resources/unstable/types/CustomObjectInstanceDeleted.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * deleted custom object instance object
+ */
+export interface CustomObjectInstanceDeleted {
+    /** The unique identifier of the Custom Object type that defines the structure of the Custom Object instance. */
+    object?: string;
+    /** The Intercom defined id representing the Custom Object instance. */
+    id?: string;
+    /** Whether the Custom Object instance is deleted or not. */
+    deleted?: boolean;
+}

package/dist/api/resources/unstable/types/CustomObjectInstanceDeleted.js

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

package/dist/api/resources/unstable/types/CustomObjectInstanceList.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * The list of associated custom object instances for a given reference attribute on the parent object.
+ */
+export interface CustomObjectInstanceList {
+    type?: string;
+    /** The list of associated custom object instances for a given reference attribute on the parent object. */
+    instances?: (Intercom.unstable.CustomObjectInstance | undefined)[];
+}

package/dist/api/resources/unstable/types/CustomObjectInstanceList.js

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

package/dist/api/resources/unstable/types/CustomerRequest.d.ts

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

package/dist/api/resources/unstable/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/resources/unstable/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.unstable.DataAttribute[];
+}

package/dist/api/resources/unstable/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/resources/unstable/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.unstable.DataEvent[];
+    /** Pagination */
+    pages?: DataEventList.Pages;
+}
+export declare namespace DataEventList {
+    /**
+     * Pagination
+     */
+    interface Pages {
+        next?: string;
+        since?: string;
+    }
+}

package/dist/api/resources/unstable/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/resources/unstable/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.unstable.DataEventSummaryItem | undefined)[];
+}

package/dist/api/resources/unstable/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/resources/unstable/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/resources/unstable/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/resources/unstable/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/resources/unstable/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/resources/unstable/types/Datetime.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type Datetime = 
+/**
+ * A date and time following the ISO8601 notation. */
+string
+/**
+ * A date and time as UNIX timestamp notation. */
+ | number;

package/dist/api/resources/unstable/types/Datetime.js

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

package/dist/api/resources/unstable/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/resources/unstable/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/resources/unstable/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/resources/unstable/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/resources/unstable/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;
+}

package/dist/api/resources/unstable/types/DeletedCompanyObject.js

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

package/dist/api/resources/unstable/types/DeletedObject.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 DeletedObject {
+    /** The unique identifier for the news item which you provided in the URL. */
+    id?: string;
+    /** The type of object which was deleted - news-item. */
+    object?: "news-item";
+    /** Whether the news item was deleted successfully or not. */
+    deleted?: boolean;
+}

package/dist/api/resources/unstable/types/DeletedObject.js

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

package/dist/api/resources/unstable/types/EmailAddressHeader.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contains data for an email address header for a conversation part that was sent as an email.
+ */
+export interface EmailAddressHeader {
+    /** The type of email address header */
+    type?: string;
+    /** The email address */
+    email_address?: string;
+    /** The name associated with the email address */
+    name?: string;
+}

package/dist/api/resources/unstable/types/EmailAddressHeader.js

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

package/dist/api/resources/unstable/types/EmailMessageMetadata.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Contains metadata if the message was sent as an email
+ */
+export interface EmailMessageMetadata {
+    /** The subject of the email */
+    subject?: string;
+    /** A list of an email address headers. */
+    email_address_headers?: Intercom.unstable.EmailAddressHeader[];
+}