intercom-client 6.0.0-beta.3 → 6.1.0

package/api/types/ActivityLogMetadata.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/types/AddressableList.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A list used to access other resources from a parent model.
+ */
+export interface AddressableList {
+    /** The addressable object type */
+    type: string;
+    /** The id of the addressable object */
+    id: string;
+    /** Url to get more company resources for this contact */
+    url: string;
+}

package/api/types/AddressableList.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/types/AdminList.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 admins associated with a given workspace.
+ */
+export interface AdminList {
+    /** String representing the object's type. Always has the value `admin.list`. */
+    type: "admin.list";
+    /** A list of admins associated with a given workspace. */
+    admins: Intercom.Admin[];
+}

package/api/types/AdminList.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/types/AdminPriorityLevel.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Admin priority levels for the team
+ */
+export interface AdminPriorityLevel {
+    /** The primary admin ids for the team */
+    primary_admin_ids?: number[];
+    /** The secondary admin ids for the team */
+    secondary_admin_ids?: number[];
+}

package/api/types/AdminPriorityLevel.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/types/AdminReplyConversationRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Payload of the request to reply on behalf of an admin
+ */
+export interface AdminReplyConversationRequest {
+    message_type: AdminReplyConversationRequest.MessageType;
+    type: "admin";
+    /** The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types. */
+    body?: string;
+    /** The id of the admin who is authoring the comment. */
+    admin_id: string;
+    /** The time the reply was created. If not provided, the current time will be used. */
+    created_at?: number;
+    /** A list of image URLs that will be added as attachments. You can include up to 10 URLs. */
+    attachment_urls?: string[];
+    /** A list of files that will be added as attachments. You can include up to 10 files */
+    attachment_files?: Intercom.ConversationAttachmentFiles[];
+}
+export declare namespace AdminReplyConversationRequest {
+    type MessageType = "comment" | "note";
+    const MessageType: {
+        readonly Comment: "comment";
+        readonly Note: "note";
+    };
+}

package/api/types/AdminReplyConversationRequest.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminReplyConversationRequest = void 0;
+var AdminReplyConversationRequest;
+(function (AdminReplyConversationRequest) {
+    AdminReplyConversationRequest.MessageType = {
+        Comment: "comment",
+        Note: "note",
+    };
+})(AdminReplyConversationRequest = exports.AdminReplyConversationRequest || (exports.AdminReplyConversationRequest = {}));

package/api/types/AdminReplyTicketRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to reply on behalf of an admin
+ */
+export interface AdminReplyTicketRequest {
+    message_type: AdminReplyTicketRequest.MessageType;
+    type: "admin";
+    /** The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types. */
+    body?: string;
+    /** The id of the admin who is authoring the comment. */
+    admin_id: string;
+    /** The time the reply was created. If not provided, the current time will be used. */
+    created_at?: number;
+    /** The quick reply options to display. Must be present for quick_reply message types. */
+    reply_options?: AdminReplyTicketRequest.ReplyOptions.Item[];
+    /** A list of image URLs that will be added as attachments. You can include up to 10 URLs. */
+    attachment_urls?: string[];
+}
+export declare namespace AdminReplyTicketRequest {
+    type MessageType = "comment" | "note" | "quick_reply";
+    const MessageType: {
+        readonly Comment: "comment";
+        readonly Note: "note";
+        readonly QuickReply: "quick_reply";
+    };
+    type ReplyOptions = ReplyOptions.Item[];
+    namespace ReplyOptions {
+        interface Item {
+            /** 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 ticket part that is created when a user clicks on this reply option. */
+            uuid: string;
+        }
+    }
+}

package/api/types/AdminReplyTicketRequest.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.AdminReplyTicketRequest = void 0;
+var AdminReplyTicketRequest;
+(function (AdminReplyTicketRequest) {
+    AdminReplyTicketRequest.MessageType = {
+        Comment: "comment",
+        Note: "note",
+        QuickReply: "quick_reply",
+    };
+})(AdminReplyTicketRequest = exports.AdminReplyTicketRequest || (exports.AdminReplyTicketRequest = {}));

package/api/types/AdminWithApp.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Admins are the teammate accounts that have access to a workspace
+ */
+export interface AdminWithApp {
+    /** String representing the object's type. Always has the value `admin`. */
+    type: "admin";
+    /** The id representing the admin. */
+    id: string;
+    /** The name of the admin. */
+    name: string;
+    /** The email of the admin. */
+    email: string;
+    /** The job title of the admin. */
+    job_title: string;
+    /** Identifies if this admin is currently set in away mode. */
+    away_mode_enabled: boolean;
+    /** Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. */
+    away_mode_reassign: boolean;
+    /** Identifies if this admin has a paid inbox seat to restrict/allow features that require them. */
+    has_inbox_seat: boolean;
+    /** This is a list of ids of the teams that this admin is part of. */
+    team_ids: number[];
+    /** This object represents the avatar associated with the admin. */
+    avatar?: AdminWithApp.Avatar;
+    /** Identifies if this admin's email is verified. */
+    email_verified?: boolean;
+    /** App that the admin belongs to. */
+    app?: Intercom.App;
+}
+export declare namespace AdminWithApp {
+    /**
+     * This object represents the avatar associated with the admin.
+     */
+    interface Avatar {
+        /** This is a string that identifies the type of the object. It will always have the value `avatar`. */
+        type?: "avatar";
+        /** This object represents the avatar associated with the admin. */
+        image_url?: string;
+    }
+}

package/api/types/AdminWithApp.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/types/App.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * App is a workspace on Intercom
+ */
+export interface App {
+    /** */
+    type: string;
+    /** The id of the app. */
+    id_code: string;
+    /** The name of the app. */
+    name: string;
+    /** The Intercom region the app is located in. */
+    region: string;
+    /** The timezone of the region where the app is located. */
+    timezone: string;
+    /** When the app was created. */
+    created_at: number;
+    /** Whether or not the app uses identity verification. */
+    identity_verification: boolean;
+}

package/api/types/App.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/types/ArticleContent.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The Content of an Article.
+ */
+export interface ArticleContent {
+    /** The type of object - `article_content` . */
+    type: "article_content";
+    /** The title of the article. */
+    title: string;
+    /** The description of the article. */
+    description: string;
+    /** The body of the article. */
+    body: string;
+    /** The ID of the author of the article. */
+    author_id: number;
+    /** Whether the article is `published` or is a `draft` . */
+    state: ArticleContent.State;
+    /** The time when the article was created (seconds). */
+    created_at?: number;
+    /** The time when the article was last updated (seconds). */
+    updated_at?: number;
+    /** The URL of the article. */
+    url?: string;
+}
+export declare namespace ArticleContent {
+    /**
+     * Whether the article is `published` or is a `draft` .
+     */
+    type State = "published" | "draft";
+    const State: {
+        readonly Published: "published";
+        readonly Draft: "draft";
+    };
+}

package/api/types/ArticleContent.js

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

package/api/types/ArticleList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * This will return a list of articles for the App.
+ */
+export interface ArticleList {
+    /** The type of the object - `list`. */
+    type: "list";
+    pages?: Intercom.CursorPages;
+    /** A count of the total number of articles. */
+    total_count: number;
+    /** An array of Article objects */
+    data: Intercom.ArticleListItem[];
+}

package/api/types/ArticleList.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/types/ArticleStatistics.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The statistics of an article.
+ */
+export interface ArticleStatistics {
+    /** The type of object - `article_statistics`. */
+    type: "article_statistics";
+    /** The number of total views the article has received. */
+    views: number;
+    /** The number of conversations started from the article. */
+    conversions: number;
+    /** The number of total reactions the article has received. */
+    reactions: number;
+    /** The percentage of happy reactions the article has received against other types of reaction. */
+    happy_reaction_percentage: number;
+    /** The percentage of neutral reactions the article has received against other types of reaction. */
+    neutral_reaction_percentage: number;
+    /** The percentage of sad reactions the article has received against other types of reaction. */
+    sad_reaction_percentage: number;
+}

package/api/types/ArticleStatistics.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/types/ArticleTranslatedContent.d.ts

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

package/api/types/ArticleTranslatedContent.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/types/AssignConversationRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to assign a conversation
+ */
+export interface AssignConversationRequest {
+    type: AssignConversationRequest.Type;
+    /** The id of the admin who is performing the action. */
+    admin_id: string;
+    /** The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin or team (ie. Unassigned). */
+    assignee_id: string;
+    /** Optionally you can send a response in the conversation when it is assigned. */
+    body?: string;
+}
+export declare namespace AssignConversationRequest {
+    type Type = "admin" | "team";
+    const Type: {
+        readonly Admin: "admin";
+        readonly Team: "team";
+    };
+}

package/api/types/AssignConversationRequest.js

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

package/api/types/ButtonComponent.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A button component is used to take an action by clicking a button. This can either:
+ * - [Trigger a submit request to be sent](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/submit-action) Inbox Messenger
+ * - [Open a link in a new page](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/url-action) Inbox Messenger
+ * - [Open a sheet](https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/sheets-action) Messenger
+ */
+export interface ButtonComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The text that will be rendered inside the button. */
+    label: string;
+    /** This can be a Submit Action, URL Action, or Sheets Action. */
+    action: Intercom.ActionComponent;
+    /** Styles the button. Default is 'primary'. */
+    style?: ButtonComponent.Style;
+    /** Styles the button and prevents the action. Default is false. */
+    disabled?: boolean;
+}
+export declare namespace ButtonComponent {
+    /**
+     * Styles the button. Default is 'primary'.
+     */
+    type Style = "primary" | "secondary" | "link";
+    const Style: {
+        readonly Primary: "primary";
+        readonly Secondary: "secondary";
+        readonly Link: "link";
+    };
+}

package/api/types/ButtonComponent.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.ButtonComponent = void 0;
+var ButtonComponent;
+(function (ButtonComponent) {
+    ButtonComponent.Style = {
+        Primary: "primary",
+        Secondary: "secondary",
+        Link: "link",
+    };
+})(ButtonComponent = exports.ButtonComponent || (exports.ButtonComponent = {}));

package/api/types/CanvasObject.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * You have to respond to the majority of requests with a canvas object. This will tell us what UI to show for your app.
+ *
+ * A canvas can either be static (meaning we send you the next request only when an action takes place) or live (meaning we send you the next request when someone views the app).
+ *
+ * - A static canvas needs a ContentObject which will contain the components to show.
+ * - A live canvas needs a `content_url` which we we will make the Live Canvas requests to when the app is viewed. This is only possible for apps viewed or used in the Messenger.
+ */
+export interface CanvasObject {
+    /** The content object that will be shown as the UI of the app. Max Size is 64KB. */
+    content: Intercom.ContentObject;
+    /** The URL which we make Live Canvas requests to. You must respond to these with a content object. Max size is 64KB. */
+    content_url?: string;
+    /** Optional Stored Data that you want to be returned in the next sent request. Max Size is 64KB. */
+    stored_data?: Record<string, unknown>;
+}

package/api/types/CanvasObject.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/types/CheckboxComponent.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A checkbox component is used to capture multiple choices from as many options as you want to provide. You can submit the options by:
+ *
+ * - Using a ButtonComponent (which will submit all interactive components in the canvas)
+ *
+ * When a submit action takes place, the results are given in a hash with the `id` from the checkbox component used as the key and an array containing the `id` of each chosen option as the value.
+ */
+export interface CheckboxComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The list of options. Minimum of 1. */
+    option: Intercom.CheckboxOption[];
+    /** The text shown above the options. */
+    label: string;
+    /** The option's that are selected by default. */
+    value?: string[];
+    /** Styles the input. Default is `unsaved`. Prevent action with `saved`. */
+    save_state?: CheckboxComponent.SaveState;
+    /** Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved. */
+    disabled?: boolean;
+}
+export declare namespace CheckboxComponent {
+    /**
+     * Styles the input. Default is `unsaved`. Prevent action with `saved`.
+     */
+    type SaveState = "unsaved" | "saved" | "failed";
+    const SaveState: {
+        readonly Unsaved: "unsaved";
+        readonly Saved: "saved";
+        readonly Failed: "failed";
+    };
+}

package/api/types/CheckboxComponent.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.CheckboxComponent = void 0;
+var CheckboxComponent;
+(function (CheckboxComponent) {
+    CheckboxComponent.SaveState = {
+        Unsaved: "unsaved",
+        Saved: "saved",
+        Failed: "failed",
+    };
+})(CheckboxComponent = exports.CheckboxComponent || (exports.CheckboxComponent = {}));

package/api/types/CheckboxOption.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A checkbox option component that can be selected.
+ */
+export interface CheckboxOption {
+    /** The type of component you are rendering. */
+    type: "option";
+    /** A unique identifier for the option. */
+    id: string;
+    /** The text shown next to the checkbox. */
+    text: string;
+    /** Styles the option and prevents the action. Default is false. */
+    disabled?: boolean;
+}

package/api/types/CheckboxOption.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/types/CloseConversationRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to close a conversation
+ */
+export interface CloseConversationRequest {
+    type: "admin";
+    /** The id of the admin who is performing the action. */
+    admin_id: string;
+    /** Optionally you can leave a message in the conversation to provide additional context to the user and other teammates. */
+    body?: string;
+}