intercom-client 5.0.0 → 6.0.0-alpha1

package/dist/api/types/ContactReplyUserIdRequest.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/ContactSegments.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 segments objects attached to a specific contact.
+ */
+export interface ContactSegments {
+    /** The type of the object */
+    type?: "list";
+    /** Segment objects associated with the contact. */
+    data?: Intercom.Segment[];
+}

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/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/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,13 @@
+/**
+ * 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/ConversationList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 ConversationList {
+    /** Always conversation.list */
+    type?: "conversation.list";
+    /** The list of conversation objects */
+    conversations?: Intercom.Conversation[];
+    /** A count of the total number of objects. */
+    total_count?: number;
+    pages?: Intercom.CursorPages;
+}

package/dist/api/types/ConversationList.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?: string;
+    /** 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,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?: string;
+    /** 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/CreateArticleRequest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * You can create an Article
+ */
+export interface CreateArticleRequest {
+    /** The title of the article.For multilingual articles, this will be the title of the default language's content. */
+    title: string;
+    /** The description of the article. For multilingual articles, this will be the description of the default language's content. */
+    description?: string;
+    /** The content of the article. For multilingual articles, this will be the body of the default language's content. */
+    body?: string;
+    /** The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. */
+    author_id: number;
+    /** Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. */
+    state?: Intercom.CreateArticleRequestState;
+    /** The id of the article's parent collection or section. An article without this field stands alone. */
+    parent_id?: number;
+    /** The type of parent, which can either be a `collection` or `section`. */
+    parent_type?: string;
+    translated_content?: Intercom.ArticleTranslatedContent;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
+ */
+export declare type CreateArticleRequestState = "published" | "draft";
+export declare const CreateArticleRequestState: {
+    readonly Published: "published";
+    readonly Draft: "draft";
+};

package/dist/api/types/CreateArticleRequestState.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateArticleRequestState = void 0;
+exports.CreateArticleRequestState = {
+    Published: "published",
+    Draft: "draft",
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Payload to create a contact
+ */
+export declare type CreateContactRequest = Intercom.CreateContactRequestWithEmail | Intercom.CreateContactRequestWithExternalId | Intercom.CreateContactRequestWithRole;

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/CreateContactRequestWithEmail.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateContactRequestWithEmail {
+    /** The contacts email */
+    email: string;
+    /** The contacts phone */
+    phone?: string;
+    /** The contacts name */
+    name?: string;
+    /** An image URL containing the avatar of a contact */
+    avatar?: string;
+    /** The time specified for when a contact signed up */
+    signed_up_at?: number;
+    /** The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) */
+    last_seen_at?: number;
+    /** The id of an admin that has been assigned account ownership of the contact */
+    owner_id?: number;
+    /** Whether the contact is unsubscribed from emails */
+    unsubscribed_from_emails?: boolean;
+    /** The custom attributes which are set for the contact */
+    custom_attributes?: Record<string, unknown>;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateContactRequestWithExternalId {
+    /** A unique identifier for the contact which is given to Intercom */
+    external_id: string;
+    /** The contacts phone */
+    phone?: string;
+    /** The contacts name */
+    name?: string;
+    /** An image URL containing the avatar of a contact */
+    avatar?: string;
+    /** The time specified for when a contact signed up */
+    signed_up_at?: number;
+    /** The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) */
+    last_seen_at?: number;
+    /** The id of an admin that has been assigned account ownership of the contact */
+    owner_id?: number;
+    /** Whether the contact is unsubscribed from emails */
+    unsubscribed_from_emails?: boolean;
+    /** The custom attributes which are set for the contact */
+    custom_attributes?: Record<string, unknown>;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CreateContactRequestWithRole {
+    /** The role of the contact. */
+    role: string;
+    /** The contacts phone */
+    phone?: string;
+    /** The contacts name */
+    name?: string;
+    /** An image URL containing the avatar of a contact */
+    avatar?: string;
+    /** The time specified for when a contact signed up */
+    signed_up_at?: number;
+    /** The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) */
+    last_seen_at?: number;
+    /** The id of an admin that has been assigned account ownership of the contact */
+    owner_id?: number;
+    /** Whether the contact is unsubscribed from emails */
+    unsubscribed_from_emails?: boolean;
+    /** The custom attributes which are set for the contact */
+    custom_attributes?: Record<string, unknown>;
+}

package/dist/api/types/CreateContactRequestWithRole.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,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ *
+ */
+export declare type CreateDataEventRequest = Intercom.CreateDataEventRequestWithId | Intercom.CreateDataEventRequestWithUserId | Intercom.CreateDataEventRequestWithEmail;