intercom-client 6.0.0-beta.3 → 6.1.0

package/dist/api/types/ContactSegments.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/ContactSocialProfiles.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 social profiles that a contact has.
+ */
+export interface ContactSocialProfiles {
+    /** A list of social profiles objects associated with the contact. */
+    data: Intercom.SocialProfile[];
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.
+ */
+export interface ContactSubscriptionTypes {
+    /** This object represents the subscriptions attached to a contact. */
+    data: Intercom.AddressableList[];
+    /** Url to get more subscription type resources for this contact */
+    url: string;
+    /** Int representing the total number of subscription types attached to this contact */
+    total_count: number;
+    /** Whether there's more Addressable Objects to be viewed. If true, use the url to view all */
+    has_more: boolean;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.
+ */
+export interface ContactTags {
+    /** This object represents the tags attached to a contact. */
+    data: Intercom.AddressableList[];
+    /** url to get more tag resources for this contact */
+    url: string;
+    /** Int representing the total number of tags attached to this contact */
+    total_count: number;
+    /** Whether there's more Addressable Objects to be viewed. If true, use the url to view all */
+    has_more: boolean;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * unarchived contact object
+ */
+export interface ContactUnarchived {
+    /** always contact */
+    type: "contact";
+    /** The unique identifier for the contact which is given by Intercom. */
+    id: string;
+    /** The unique identifier for the contact which is provided by the Client. */
+    external_id?: string;
+    /** Whether the contact is archived or not. */
+    archived: boolean;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The content object is where you specify the UI of your app. You provide us with a set of `components` in a components array that we then render.
+ *
+ * The content object should usually be returned within the [canvas object](https://developers.intercom.com/docs/references/canvas-kit/responseobjects/canvas). If you're responding to a Live Canvas request however, then you should only respond with the content object.
+ */
+export interface ContentObject {
+    /** The list of components to be rendered. */
+    components: Intercom.Component[];
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export interface ContentSourcesList {
+    type: "content_source.list";
+    /** The total number of content sources used by AI Agent in the conversation. */
+    total_count: number;
+    /** The content sources used by AI Agent in the conversation. */
+    content_sources: Intercom.ContentSource[];
+}

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

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The context object provides additional details on where the app has been added (or is currently being used), what page the app is being used on, and information on the Messenger settings. This is in order for you give a fully customised experience based on the customers use case.
+ *
+ * If the `location` is `conversation` then you will also be given a `conversation_id`. If you need to use details about the conversation, then you have to use the `conversation_id` to [make a call to our Conversations API and retrieve the conversation object](https://developers.intercom.com/intercom-api-reference/reference#get-a-single-conversation).
+ */
+export interface Context {
+    /** The id of the conversation where the app is added or being used. */
+    conversation_id?: number;
+    /** Where the app is added or the action took place. Can be either 'conversation', 'home', 'message', or 'operator'. */
+    location?: Context.Location;
+    /** The default end-user language of the Messenger. Use to localise Messenger App content. */
+    locale?: string;
+    /** The messengers action colour. Use in Sheets and Icons to make a Messenger App experience feel part of the host Messenger. */
+    messenger_action_colour?: string;
+    /** The messengers background colour. Use in Sheets and Icons to make a Messenger App experience feel part of the host Messenger. */
+    messenger_background_colour?: string;
+    /** The current page URL where the app is being used. */
+    referrer?: string;
+}
+export declare namespace Context {
+    /**
+     * Where the app is added or the action took place. Can be either 'conversation', 'home', 'message', or 'operator'.
+     */
+    type Location = "conversation" | "home" | "message" | "operator";
+    const Location: {
+        readonly Conversation: "conversation";
+        readonly Home: "home";
+        readonly Message: "message";
+        readonly Operator: "operator";
+    };
+}

package/dist/api/types/Context.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+var Context;
+(function (Context) {
+    Context.Location = {
+        Conversation: "conversation",
+        Home: "home",
+        Message: "message",
+        Operator: "operator",
+    };
+})(Context = exports.Context || (exports.Context = {}));

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Properties of the attachment files in a conversation part
+ */
+export interface ConversationAttachmentFiles {
+    /** The content type of the file */
+    content_type: string;
+    /** The base64 encoded file data. */
+    data: string;
+    /** The name of the file. */
+    name: string;
+}

package/dist/api/types/ConversationAttachmentFiles.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/ConversationContacts.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 contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.
+ */
+export interface ConversationContacts {
+    type: "contact.list";
+    /** The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature. */
+    contacts: Intercom.ContactReference[];
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An object containing information on the first users message. For a contact initiated message this will represent the users original message.
+ */
+export interface ConversationFirstContactReply {
+    /** */
+    created_at: number;
+    /** */
+    type: string;
+    /** */
+    url?: string;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A Conversation Part represents a message in the conversation.
+ */
+export interface ConversationPart {
+    /** Always conversation_part */
+    type: "conversation_part";
+    /** The id representing the conversation part. */
+    id: string;
+    /** The type of conversation part. */
+    part_type: string;
+    /** The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. */
+    body?: string;
+    /** The time the conversation part was created. */
+    created_at: number;
+    /** The last time the conversation part was updated. */
+    updated_at?: number;
+    /** The time the user was notified with the conversation part. */
+    notified_at: number;
+    /** The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.) */
+    assigned_to?: Intercom.Reference;
+    author: Intercom.ConversationPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.PartAttachment[];
+    /** The external id of the conversation part */
+    external_id?: string;
+    /** Whether or not the conversation part has been redacted. */
+    redacted: boolean;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.
+ */
+export interface ConversationPartAuthor {
+    /** The type of the author */
+    type: string;
+    /** The id of the author */
+    id: string;
+    /** The name of the author */
+    name: string;
+    /** The email of the author */
+    email: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.
+ */
+export interface ConversationParts {
+    /** */
+    type: "conversation_part.list";
+    /** A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts. */
+    conversation_parts: Intercom.ConversationPart[];
+    /** */
+    total_count: number;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.
+ */
+export interface ConversationRating {
+    /** The rating, between 1 and 5, for the conversation. */
+    rating: number;
+    /** An optional field to add a remark to correspond to the number rating */
+    remark: string;
+    /** The time the rating was requested in the conversation being rated. */
+    created_at: number;
+    contact: Intercom.ContactReference;
+    teammate: Intercom.Reference;
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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: ConversationSource.Type;
+    /** 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;
+}
+export declare namespace ConversationSource {
+    /**
+     * This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.
+     */
+    type Type = "conversation" | "email" | "facebook" | "instagram" | "phone_call" | "phone_switch" | "push" | "sms" | "twitter" | "whatsapp";
+    const Type: {
+        readonly Conversation: "conversation";
+        readonly Email: "email";
+        readonly Facebook: "facebook";
+        readonly Instagram: "instagram";
+        readonly PhoneCall: "phone_call";
+        readonly PhoneSwitch: "phone_switch";
+        readonly Push: "push";
+        readonly Sms: "sms";
+        readonly Twitter: "twitter";
+        readonly Whatsapp: "whatsapp";
+    };
+}

package/dist/api/types/ConversationSource.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationSource = void 0;
+var ConversationSource;
+(function (ConversationSource) {
+    ConversationSource.Type = {
+        Conversation: "conversation",
+        Email: "email",
+        Facebook: "facebook",
+        Instagram: "instagram",
+        PhoneCall: "phone_call",
+        PhoneSwitch: "phone_switch",
+        Push: "push",
+        Sms: "sms",
+        Twitter: "twitter",
+        Whatsapp: "whatsapp",
+    };
+})(ConversationSource = exports.ConversationSource || (exports.ConversationSource = {}));

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: "admin.list";
+    /** The list of teammates who participated in the conversation (wrote at least one conversation part). */
+    admins: 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 });