intercom-client 6.3.0 → 6.4.0

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * unarchived contact object
+ */
+export interface ContactUnarchived extends Intercom.unstable.ContactReference {
+    /** Whether the contact is archived or not. */
+    archived?: boolean;
+}

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

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type <code>conversation_attribute_updated_by_admin</code>.
+ */
+export interface ConversationAttributeUpdatedByAdmin {
+    attribute?: ConversationAttributeUpdatedByAdmin.Attribute;
+    value?: ConversationAttributeUpdatedByAdmin.Value;
+}
+export declare namespace ConversationAttributeUpdatedByAdmin {
+    interface Attribute {
+        /** Name of the CDA updated */
+        name?: string;
+    }
+    interface Value {
+        /** Value of the CDA updated */
+        name?: string;
+    }
+}

package/api/resources/unstable/types/ConversationAttributeUpdatedByAdmin.js

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

package/api/resources/unstable/types/ConversationAttributeUpdatedByWorkflow.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type <code>conversation_attribute_updated_by_workflow</code>.
+ */
+export interface ConversationAttributeUpdatedByWorkflow {
+    workflow?: ConversationAttributeUpdatedByWorkflow.Workflow;
+    attribute?: ConversationAttributeUpdatedByWorkflow.Attribute;
+    value?: ConversationAttributeUpdatedByWorkflow.Value;
+}
+export declare namespace ConversationAttributeUpdatedByWorkflow {
+    interface Workflow {
+        /** Name of the workflow */
+        name?: string;
+    }
+    interface Attribute {
+        /** Name of the CDA updated */
+        name?: string;
+    }
+    interface Value {
+        /** Value of the CDA updated */
+        name?: string;
+    }
+}

package/api/resources/unstable/types/ConversationAttributeUpdatedByWorkflow.js

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * deleted conversation object
+ */
+export interface ConversationDeleted {
+    /** The unique identifier for the conversation. */
+    id?: string;
+    /** always conversation */
+    object?: "conversation";
+    /** Whether the conversation is deleted or not. */
+    deleted?: boolean;
+}

package/api/resources/unstable/types/ConversationDeleted.js

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

package/api/resources/unstable/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/api/resources/unstable/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/api/resources/unstable/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.unstable.Conversation[];
+    /** A count of the total number of objects. */
+    total_count?: number;
+    pages?: Intercom.unstable.CursorPages;
+}

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

@@ -0,0 +1,52 @@
+/**
+ * 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.unstable.Reference;
+    author?: Intercom.unstable.ConversationPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.unstable.PartAttachment[];
+    /** The external id of the conversation part */
+    external_id?: string;
+    /** Whether or not the conversation part has been redacted. */
+    redacted?: boolean;
+    email_message_metadata?: Intercom.unstable.EmailMessageMetadata;
+    metadata?: Intercom.unstable.ConversationPartMetadata;
+    /** Indicates the current state of conversation when the conversation part was created. */
+    state?: ConversationPart.State;
+    /** A list of tags objects associated with the conversation part. */
+    tags?: Intercom.unstable.TagBasic[];
+    event_details?: Intercom.unstable.EventDetails;
+    /** The app package code if this part was created via API. null if the part was not created via API. */
+    app_package_code?: string;
+}
+export declare namespace ConversationPart {
+    /**
+     * Indicates the current state of conversation when the conversation part was created.
+     */
+    type State = "open" | "closed" | "snoozed";
+    const State: {
+        readonly Open: "open";
+        readonly Closed: "closed";
+        readonly Snoozed: "snoozed";
+    };
+}

package/api/resources/unstable/types/ConversationPart.js

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

package/api/resources/unstable/types/ConversationPartAuthor.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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;
+    /** If this conversation part was sent by the AI Agent */
+    from_ai_agent?: boolean;
+    /** If this conversation part body was generated by the AI Agent */
+    is_ai_answer?: boolean;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Metadata for a conversation part
+ */
+export interface ConversationPartMetadata {
+    /** The quick reply options sent by the Admin or bot, presented in this conversation part. */
+    quick_reply_options?: ConversationPartMetadata.QuickReplyOptions.Item[];
+    /** The unique identifier for the quick reply option that was clicked by the end user. */
+    quick_reply_uuid?: string;
+}
+export declare namespace ConversationPartMetadata {
+    type QuickReplyOptions = QuickReplyOptions.Item[];
+    namespace QuickReplyOptions {
+        interface Item extends Intercom.unstable.QuickReplyOption {
+            /** The translations for the quick reply option. */
+            translations?: Record<string, unknown>;
+        }
+    }
+}

package/api/resources/unstable/types/ConversationPartMetadata.js

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

package/api/resources/unstable/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.unstable.ConversationPart[];
+    /** */
+    total_count?: number;
+}

package/api/resources/unstable/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/api/resources/unstable/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.unstable.ContactReference;
+    teammate?: Intercom.unstable.Reference;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Details of first response time of assigned team in seconds.
+ */
+export interface ConversationResponseTime {
+    /** Id of the assigned team. */
+    team_id?: number;
+    /** Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned. */
+    team_name?: string;
+    /** First response time of assigned team in seconds. */
+    response_time?: number;
+}

package/api/resources/unstable/types/ConversationResponseTime.js

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

package/api/resources/unstable/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 type of the conversation part that started this conversation. 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.unstable.ConversationPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.unstable.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/api/resources/unstable/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 = ConversationSource = {}));

package/api/resources/unstable/types/ConversationStatistics.d.ts

@@ -0,0 +1,53 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * 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;
+    /** An array of conversation response time objects */
+    assigned_team_first_response_time_by_team?: Intercom.unstable.ConversationResponseTime[];
+    /** An array of conversation response time objects within office hours */
+    assigned_team_first_response_time_in_office_hours?: Intercom.unstable.ConversationResponseTime[];
+    /** Time from conversation assignment to conversation close in seconds. */
+    handling_time?: number;
+}

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

package/api/resources/unstable/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/api/resources/unstable/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/api/resources/unstable/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/api/resources/unstable/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 type CreateTicketReplyWithCommentRequest = Intercom.unstable.ContactReplyTicketRequest | Intercom.unstable.AdminReplyTicketRequest;

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