intercom-client 6.3.0 → 7.0.1

package/dist/cjs/api/types/EventDetails.js

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

package/dist/cjs/api/types/FileAttribute.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The value describing a file upload set for a custom attribute
+ */
+export interface FileAttribute {
+    type?: string;
+    /** The name of the file */
+    name?: string;
+    /** The url of the file. This is a temporary URL and will expire after 30 minutes. */
+    url?: string;
+    /** The type of file */
+    content_type?: string;
+    /** The size of the file in bytes */
+    filesize?: number;
+    /** The width of the file in pixels, if applicable */
+    width?: number;
+    /** The height of the file in pixels, if applicable */
+    height?: number;
+}

package/dist/cjs/api/types/FileAttribute.js

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

package/dist/cjs/api/types/GroupContent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Content of a Group.
+ */
+export interface GroupContent {
+    /** The type of object - `group_content` . */
+    type?: "group_content";
+    /** The name of the collection or section. */
+    name?: string;
+    /** The description of the collection. Only available for collections. */
+    description?: string;
+}

package/dist/cjs/api/types/GroupContent.js

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

package/dist/cjs/api/types/GroupTranslatedContent.d.ts

@@ -0,0 +1,82 @@
+import type * as Intercom from "../index.js";
+/**
+ * The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
+ */
+export interface GroupTranslatedContent {
+    /** The type of object - group_translated_content. */
+    type?: "group_translated_content";
+    /** The content of the group in Arabic */
+    ar?: Intercom.GroupContent;
+    /** The content of the group in Bulgarian */
+    bg?: Intercom.GroupContent;
+    /** The content of the group in Bosnian */
+    bs?: Intercom.GroupContent;
+    /** The content of the group in Catalan */
+    ca?: Intercom.GroupContent;
+    /** The content of the group in Czech */
+    cs?: Intercom.GroupContent;
+    /** The content of the group in Danish */
+    da?: Intercom.GroupContent;
+    /** The content of the group in German */
+    de?: Intercom.GroupContent;
+    /** The content of the group in Greek */
+    el?: Intercom.GroupContent;
+    /** The content of the group in English */
+    en?: Intercom.GroupContent;
+    /** The content of the group in Spanish */
+    es?: Intercom.GroupContent;
+    /** The content of the group in Estonian */
+    et?: Intercom.GroupContent;
+    /** The content of the group in Finnish */
+    fi?: Intercom.GroupContent;
+    /** The content of the group in French */
+    fr?: Intercom.GroupContent;
+    /** The content of the group in Hebrew */
+    he?: Intercom.GroupContent;
+    /** The content of the group in Croatian */
+    hr?: Intercom.GroupContent;
+    /** The content of the group in Hungarian */
+    hu?: Intercom.GroupContent;
+    /** The content of the group in Indonesian */
+    id?: Intercom.GroupContent;
+    /** The content of the group in Italian */
+    it?: Intercom.GroupContent;
+    /** The content of the group in Japanese */
+    ja?: Intercom.GroupContent;
+    /** The content of the group in Korean */
+    ko?: Intercom.GroupContent;
+    /** The content of the group in Lithuanian */
+    lt?: Intercom.GroupContent;
+    /** The content of the group in Latvian */
+    lv?: Intercom.GroupContent;
+    /** The content of the group in Mongolian */
+    mn?: Intercom.GroupContent;
+    /** The content of the group in Norwegian */
+    nb?: Intercom.GroupContent;
+    /** The content of the group in Dutch */
+    nl?: Intercom.GroupContent;
+    /** The content of the group in Polish */
+    pl?: Intercom.GroupContent;
+    /** The content of the group in Portuguese (Portugal) */
+    pt?: Intercom.GroupContent;
+    /** The content of the group in Romanian */
+    ro?: Intercom.GroupContent;
+    /** The content of the group in Russian */
+    ru?: Intercom.GroupContent;
+    /** The content of the group in Slovenian */
+    sl?: Intercom.GroupContent;
+    /** The content of the group in Serbian */
+    sr?: Intercom.GroupContent;
+    /** The content of the group in Swedish */
+    sv?: Intercom.GroupContent;
+    /** The content of the group in Turkish */
+    tr?: Intercom.GroupContent;
+    /** The content of the group in Vietnamese */
+    vi?: Intercom.GroupContent;
+    /** The content of the group in Portuguese (Brazil) */
+    "pt-BR"?: Intercom.GroupContent;
+    /** The content of the group in Chinese (China) */
+    "zh-CN"?: Intercom.GroupContent;
+    /** The content of the group in Chinese (Taiwan) */
+    "zh-TW"?: Intercom.GroupContent;
+}

package/dist/cjs/api/types/GroupTranslatedContent.js

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

package/dist/cjs/api/types/InternalArticleList.d.ts

@@ -0,0 +1,13 @@
+import type * as Intercom from "../index.js";
+/**
+ * This will return a list of internal articles for the App.
+ */
+export interface InternalArticleList {
+    /** The type of the object - `list`. */
+    type?: "list";
+    pages?: Intercom.CursorPages;
+    /** A count of the total number of internal articles. */
+    total_count?: number;
+    /** An array of Internal Article objects */
+    data?: Intercom.InternalArticleListItem[];
+}

package/dist/cjs/api/types/InternalArticleList.js

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

package/dist/cjs/api/types/LinkedObject.d.ts

@@ -0,0 +1,26 @@
+/**
+ * A linked conversation or ticket.
+ */
+export interface LinkedObject {
+    /** ticket or conversation */
+    type?: LinkedObject.Type;
+    /** The ID of the linked object */
+    id?: string;
+    /** Category of the Linked Ticket Object. */
+    category?: LinkedObject.Category;
+}
+export declare namespace LinkedObject {
+    /** ticket or conversation */
+    const Type: {
+        readonly Ticket: "ticket";
+        readonly Conversation: "conversation";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+    /** Category of the Linked Ticket Object. */
+    const Category: {
+        readonly Customer: "Customer";
+        readonly BackOffice: "Back-office";
+        readonly Tracker: "Tracker";
+    };
+    type Category = (typeof Category)[keyof typeof Category];
+}

package/dist/cjs/api/types/LinkedObject.js

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkedObject = void 0;
+var LinkedObject;
+(function (LinkedObject) {
+    /** ticket or conversation */
+    LinkedObject.Type = {
+        Ticket: "ticket",
+        Conversation: "conversation",
+    };
+    /** Category of the Linked Ticket Object. */
+    LinkedObject.Category = {
+        Customer: "Customer",
+        BackOffice: "Back-office",
+        Tracker: "Tracker",
+    };
+})(LinkedObject || (exports.LinkedObject = LinkedObject = {}));

package/dist/cjs/api/types/LinkedObjectList.d.ts

@@ -0,0 +1,14 @@
+import type * as Intercom from "../index.js";
+/**
+ * An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.
+ */
+export interface LinkedObjectList {
+    /** Always list. */
+    type?: "list";
+    /** The total number of linked objects. */
+    total_count?: number;
+    /** Whether or not there are more linked objects than returned. */
+    has_more?: boolean;
+    /** An array containing the linked conversations and linked tickets. */
+    data?: Intercom.LinkedObject[];
+}

package/dist/cjs/api/types/LinkedObjectList.js

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

package/dist/cjs/api/types/Metadata.d.ts

@@ -0,0 +1,2 @@
+import type * as Intercom from "../index.js";
+export type Metadata = Intercom.unstable.ConversationPartMetadata;

package/dist/cjs/api/types/Metadata.js

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

package/dist/cjs/api/types/MultipleFilterSearchRequest.d.ts

@@ -0,0 +1,24 @@
+import type * as Intercom from "../index.js";
+/**
+ * Search using Intercoms Search APIs with more than one filter.
+ */
+export interface MultipleFilterSearchRequest {
+    /** An operator to allow boolean inspection between multiple fields. */
+    operator?: MultipleFilterSearchRequest.Operator;
+    value?: MultipleFilterSearchRequest.Value;
+}
+export declare namespace MultipleFilterSearchRequest {
+    /** An operator to allow boolean inspection between multiple fields. */
+    const Operator: {
+        readonly And: "AND";
+        readonly Or: "OR";
+    };
+    type Operator = (typeof Operator)[keyof typeof Operator];
+    type Value = 
+    /**
+     * Add mutiple filters. */
+    Intercom.MultipleFilterSearchRequest[]
+    /**
+     * Add a single filter field. */
+     | Intercom.SingleFilterSearchRequest[];
+}

package/dist/cjs/api/types/MultipleFilterSearchRequest.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultipleFilterSearchRequest = void 0;
+var MultipleFilterSearchRequest;
+(function (MultipleFilterSearchRequest) {
+    /** An operator to allow boolean inspection between multiple fields. */
+    MultipleFilterSearchRequest.Operator = {
+        And: "AND",
+        Or: "OR",
+    };
+})(MultipleFilterSearchRequest || (exports.MultipleFilterSearchRequest = MultipleFilterSearchRequest = {}));

package/dist/cjs/api/types/NewsItemRequest.d.ts

@@ -0,0 +1,30 @@
+import type * as Intercom from "../index.js";
+/**
+ * A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.
+ */
+export interface NewsItemRequest {
+    /** The title of the news item. */
+    title: string;
+    /** The news item body, which may contain HTML. */
+    body?: string;
+    /** The id of the sender of the news item. Must be a teammate on the workspace. */
+    sender_id: number;
+    /** News items will not be visible to your users in the assigned newsfeeds until they are set live. */
+    state?: NewsItemRequest.State;
+    /** When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge. */
+    deliver_silently?: boolean;
+    /** Label names displayed to users to categorize the news item. */
+    labels?: string[];
+    /** Ordered list of emoji reactions to the news item. When empty, reactions are disabled. */
+    reactions?: (string | undefined)[];
+    /** A list of newsfeed_assignments to assign to the specified newsfeed. */
+    newsfeed_assignments?: Intercom.NewsfeedAssignment[];
+}
+export declare namespace NewsItemRequest {
+    /** News items will not be visible to your users in the assigned newsfeeds until they are set live. */
+    const State: {
+        readonly Draft: "draft";
+        readonly Live: "live";
+    };
+    type State = (typeof State)[keyof typeof State];
+}

package/dist/cjs/api/types/NewsItemRequest.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewsItemRequest = void 0;
+var NewsItemRequest;
+(function (NewsItemRequest) {
+    /** News items will not be visible to your users in the assigned newsfeeds until they are set live. */
+    NewsItemRequest.State = {
+        Draft: "draft",
+        Live: "live",
+    };
+})(NewsItemRequest || (exports.NewsItemRequest = NewsItemRequest = {}));

package/dist/cjs/api/types/NotFoundErrorBody.d.ts

@@ -0,0 +1,19 @@
+export interface NotFoundErrorBody {
+    /** The type is error.list */
+    type: string;
+    /** */
+    request_id?: string;
+    /** An array of one or more error objects */
+    errors: NotFoundErrorBody.Errors.Item[];
+}
+export declare namespace NotFoundErrorBody {
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            /** ticket_not_found */
+            code: string;
+            /** Ticket not found */
+            message?: string;
+        }
+    }
+}

package/dist/cjs/api/types/NotFoundErrorBody.js

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

package/dist/cjs/api/types/NoteList.d.ts

@@ -0,0 +1,12 @@
+import type * as Intercom from "../index.js";
+/**
+ * A paginated list of notes associated with a contact.
+ */
+export interface NoteList {
+    /** String representing the object's type. Always has the value `list`. */
+    type?: string;
+    /** An array of notes. */
+    data?: Intercom.Note[];
+    /** A count of the total number of notes. */
+    total_count?: number;
+}

package/dist/cjs/api/types/NoteList.js

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

package/dist/cjs/api/types/OffsetPages.d.ts

@@ -0,0 +1,11 @@
+export interface OffsetPages {
+    /** the type of object `offset_pages` */
+    type: "offset_pages";
+    /** The current offset */
+    page?: number;
+    next?: string;
+    /** Number of results per page */
+    per_page?: number;
+    /** Total number of pages */
+    total_pages?: number;
+}

package/dist/cjs/api/types/OffsetPages.js

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

package/dist/cjs/api/types/OpenConversationRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Payload of the request to open a conversation
+ */
+export interface OpenConversationRequest {
+    /** The id of the admin who is performing the action. */
+    admin_id: string;
+}

package/dist/cjs/api/types/OpenConversationRequest.js

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

package/dist/cjs/api/types/OperatorWorkflowEvent.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Contains details about name of the workflow for conversation part type <code>operator_workflow_event</code>.
+ */
+export interface OperatorWorkflowEvent {
+    workflow?: OperatorWorkflowEvent.Workflow;
+    event?: OperatorWorkflowEvent.Event;
+}
+export declare namespace OperatorWorkflowEvent {
+    interface Workflow {
+        /** The name of the workflow */
+        name?: string;
+    }
+    interface Event {
+        /** Type of the workflow event initiated */
+        type?: string;
+        /** Result of the workflow event */
+        result?: string;
+    }
+}

package/dist/cjs/api/types/OperatorWorkflowEvent.js

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

package/dist/cjs/api/types/PagesLink.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.
+ *
+ * Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.
+ */
+export interface PagesLink {
+    type?: "pages";
+    page?: number;
+    /** A link to the next page of results. A response that does not contain a next link does not have further data to fetch. */
+    next?: string;
+    per_page?: number;
+    total_pages?: number;
+}

package/dist/cjs/api/types/PagesLink.js

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

package/dist/cjs/api/types/PaginatedResponse.d.ts

@@ -0,0 +1,21 @@
+import type * as Intercom from "../index.js";
+/**
+ * Paginated Response
+ */
+export interface PaginatedResponse {
+    /** The type of object */
+    type?: PaginatedResponse.Type;
+    pages?: Intercom.CursorPages;
+    /** A count of the total number of objects. */
+    total_count?: number;
+    /** An array of Objects */
+    data?: Intercom.PaginatedResponseDataItem[];
+}
+export declare namespace PaginatedResponse {
+    /** The type of object */
+    const Type: {
+        readonly List: "list";
+        readonly ConversationList: "conversation.list";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/PaginatedResponse.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedResponse = void 0;
+var PaginatedResponse;
+(function (PaginatedResponse) {
+    /** The type of object */
+    PaginatedResponse.Type = {
+        List: "list",
+        ConversationList: "conversation.list",
+    };
+})(PaginatedResponse || (exports.PaginatedResponse = PaginatedResponse = {}));

package/dist/cjs/api/types/PaginatedResponseDataItem.d.ts

@@ -0,0 +1,10 @@
+import type * as Intercom from "../index.js";
+export type PaginatedResponseDataItem = Intercom.PaginatedResponseDataItem.NewsItem | Intercom.PaginatedResponseDataItem.Newsfeed;
+export declare namespace PaginatedResponseDataItem {
+    interface NewsItem extends Intercom.NewsItem {
+        type: "news-item";
+    }
+    interface Newsfeed extends Intercom.Newsfeed {
+        type: "newsfeed";
+    }
+}

package/dist/cjs/api/types/PaginatedResponseDataItem.js

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

package/dist/cjs/api/types/PartAttachment.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The file attached to a part
+ */
+export interface PartAttachment {
+    /** The type of attachment */
+    type?: string;
+    /** The name of the attachment */
+    name?: string;
+    /** The URL of the attachment */
+    url?: string;
+    /** The content type of the attachment */
+    content_type?: string;
+    /** The size of the attachment */
+    filesize?: number;
+    /** The width of the attachment */
+    width?: number;
+    /** The height of the attachment */
+    height?: number;
+}

package/dist/cjs/api/types/PartAttachment.js

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

package/dist/cjs/api/types/PhoneSwitch.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Phone Switch Response
+ */
+export interface PhoneSwitch {
+    /** */
+    type?: "phone_call_redirect";
+    /** Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger. */
+    phone?: string;
+}

package/dist/cjs/api/types/PhoneSwitch.js

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

package/dist/cjs/api/types/QuickReplyOption.d.ts

@@ -0,0 +1,6 @@
+export interface QuickReplyOption {
+    /** The text to display in this quick reply option. */
+    text: string;
+    /** A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option. */
+    uuid: string;
+}

package/dist/cjs/api/types/QuickReplyOption.js

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

package/dist/cjs/api/types/Recipient.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A recipient of a message
+ */
+export interface Recipient {
+    /** The role associated to the contact - `user` or `lead`. */
+    type: Recipient.Type;
+    /** The identifier for the contact which is given by Intercom. */
+    id: string;
+}
+export declare namespace Recipient {
+    /** The role associated to the contact - `user` or `lead`. */
+    const Type: {
+        readonly User: "user";
+        readonly Lead: "lead";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/Recipient.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Recipient = void 0;
+var Recipient;
+(function (Recipient) {
+    /** The role associated to the contact - `user` or `lead`. */
+    Recipient.Type = {
+        User: "user",
+        Lead: "lead",
+    };
+})(Recipient || (exports.Recipient = Recipient = {}));

package/dist/cjs/api/types/RedactConversationRequest.d.ts

@@ -0,0 +1,24 @@
+import type * as Intercom from "../index.js";
+export type RedactConversationRequest = 
+/**
+ * Payload of the request to redact a conversation part */
+Intercom.RedactConversationRequest.ConversationPart
+/**
+ * Payload of the request to redact a conversation source */
+ | Intercom.RedactConversationRequest.Source;
+export declare namespace RedactConversationRequest {
+    interface ConversationPart {
+        type: "conversation_part";
+        /** The id of the conversation. */
+        conversation_id: string;
+        /** The id of the conversation_part. */
+        conversation_part_id: string;
+    }
+    interface Source {
+        type: "source";
+        /** The id of the conversation. */
+        conversation_id: string;
+        /** The id of the source. */
+        source_id: string;
+    }
+}

package/dist/cjs/api/types/RedactConversationRequest.js

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

package/dist/cjs/api/types/Reference.d.ts

@@ -0,0 +1,9 @@
+/**
+ * reference to another object
+ */
+export interface Reference {
+    /** */
+    type?: string;
+    /** */
+    id?: string;
+}

package/dist/cjs/api/types/Reference.js

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

package/dist/cjs/api/types/ReplyConversationRequest.d.ts

@@ -0,0 +1,2 @@
+import type * as Intercom from "../index.js";
+export type ReplyConversationRequest = Intercom.ContactReplyConversationRequest | Intercom.AdminReplyConversationRequest;

package/dist/cjs/api/types/ReplyConversationRequest.js

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

package/dist/cjs/api/types/SearchRequest.d.ts

@@ -0,0 +1,11 @@
+import type * as Intercom from "../index.js";
+/**
+ * Search using Intercoms Search APIs.
+ */
+export interface SearchRequest {
+    query: SearchRequest.Query;
+    pagination?: Intercom.StartingAfterPaging;
+}
+export declare namespace SearchRequest {
+    type Query = Intercom.SingleFilterSearchRequest | Intercom.MultipleFilterSearchRequest;
+}