intercom-client 6.0.0 → 6.1.1

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

@@ -8,7 +8,7 @@ import * as Intercom from "../index";
 export interface CollectionList {
     /** The type of the object - `list`. */
     type: "list";
-    pages?: Intercom.CursorPages;
+    pages?: Intercom.OffsetPages;
     /** A count of the total number of collections. */
     total_count: number;
     /** An array of collection objects */

package/api/types/CompanyList.d.ts

@@ -8,7 +8,7 @@ import * as Intercom from "../index";
 export interface CompanyList {
     /** The type of object - `list`. */
     type: "list";
-    pages?: Intercom.CursorPages;
+    pages?: Intercom.OffsetPages;
     /** The total number of companies. */
     total_count: number;
     /** An array containing Company Objects. */

package/api/types/Component.d.ts

@@ -0,0 +1,43 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export declare type Component = Intercom.Component.Button | Intercom.Component.Checkbox | Intercom.Component.Dropdown | Intercom.Component.Input | Intercom.Component.List | Intercom.Component.SingleSelect | Intercom.Component.Textarea | Intercom.Component.DataTable | Intercom.Component.Divider | Intercom.Component.Image | Intercom.Component.Spacer | Intercom.Component.Text;
+export declare namespace Component {
+    interface Button extends Intercom.ButtonComponent {
+        type: "button";
+    }
+    interface Checkbox extends Intercom.CheckboxComponent {
+        type: "checkbox";
+    }
+    interface Dropdown extends Intercom.DropdownComponent {
+        type: "dropdown";
+    }
+    interface Input extends Intercom.InputComponent {
+        type: "input";
+    }
+    interface List extends Intercom.ListComponent {
+        type: "list";
+    }
+    interface SingleSelect extends Intercom.SingleSelectComponent {
+        type: "single-select";
+    }
+    interface Textarea extends Intercom.TextAreaComponent {
+        type: "textarea";
+    }
+    interface DataTable extends Intercom.DataTableComponent {
+        type: "data-table";
+    }
+    interface Divider extends Intercom.DividerComponent {
+        type: "divider";
+    }
+    interface Image extends Intercom.ImageComponent {
+        type: "image";
+    }
+    interface Spacer extends Intercom.SpacerComponent {
+        type: "spacer";
+    }
+    interface Text extends Intercom.TextComponent {
+        type: "text";
+    }
+}

package/api/types/Component.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/ConfigureRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The first request we send will allow you to know the workspace where this is happening, the admin who will be configuring the app, and additional context such as where this will be added once complete.
+ *
+ * For subsequent requests whereby an admin has interacted with a component with a submit action, the request payload will contain the same details with `current_canvas`, `input_values` and the `component_id` also present. This allows you to understand what component the request came from, see what the value of any input was, action anything in your codebase, and then respond knowing what canvas was previously shown beforehand.
+ */
+export declare type ConfigureRequest = {
+    workspace_id: string;
+    admin: Intercom.Admin;
+    context: Intercom.Context;
+} | {
+    workspace_id: string;
+    workspace_region: string;
+    component_id: string;
+    admin: Intercom.Admin;
+    context: Intercom.Context;
+    current_canvas: Intercom.CanvasObject;
+    input_values: Record<string, unknown>;
+};

package/api/types/ConfigureRequest.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/ConfigureResponse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The response object returned when configuring an app. This will either:
+ * - A canvas object which will replace the previous canvas that was visible until the teammate interacted with your app
+ * - A results object which will end the configuration and trigger the initialize request to be sent. There will be a card_creation_options object in the payload showing your key-value pairs from the results object.
+ */
+export declare type ConfigureResponse = Intercom.ResultsResponse | {
+    canvas: Intercom.CanvasObject;
+};

package/api/types/ConfigureResponse.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/ContactCompanies.d.ts

@@ -1,10 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Intercom from "../index";
 /**
  * An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.
  */
 export interface ContactCompanies {
+    /** The type of object */
+    type?: "list";
+    /** An array containing Company Objects */
+    data?: Intercom.ContactCompany[];
     /** Url to get more company resources for this contact */
     url: string;
     /** Int representing the total number of companyies attached to this contact */

package/api/types/ContactCompany.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A reference to a company associated with a contact
+ */
+export interface ContactCompany {
+    /** The unique identifier for the company */
+    id: string;
+    /** The type of the object */
+    type: "company";
+    /** URL to get the full company resource */
+    url: string;
+}

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

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

package/api/types/ContentObject.js

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

package/api/types/Context.d.ts

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

package/api/types/Context.js

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

package/api/types/ConversationSource.d.ts

@@ -7,7 +7,7 @@ import * as Intercom from "../index";
  */
 export interface ConversationSource {
     /** This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. */
-    type: string;
+    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). */
@@ -24,3 +24,21 @@ export interface ConversationSource {
     /** 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/types/ConversationSource.js

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

package/api/types/ConversationTeammates.d.ts

@@ -7,7 +7,7 @@ import * as Intercom from "../index";
  */
 export interface ConversationTeammates {
     /** The type of the object - `admin.list`. */
-    type: string;
+    type: "admin.list";
     /** The list of teammates who participated in the conversation (wrote at least one conversation part). */
-    teammates: Intercom.Reference[];
+    admins: Intercom.Reference[];
 }

package/api/types/CurrentCanvas.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The current canvas that was most recently showing before the request was sent. This object mirrors the same format as the Canvas Object.
+ */
+export interface CurrentCanvas {
+    /** The canvas object representing the current canvas state. */
+    current_canvas: Intercom.CanvasObject;
+}

package/api/types/CurrentCanvas.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/CustomAttributes.d.ts

@@ -1,11 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Intercom from "../index";
 /**
- * An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.
+ * Custom data set for this data.
  */
-export declare type CustomAttributes = Record<string, CustomAttributes.Value>;
-export declare namespace CustomAttributes {
-    type Value = string | Intercom.CustomObjectInstance;
-}
+export declare type CustomAttributes = Record<string, unknown>;

package/api/types/DataEventSummaryItem.d.ts

@@ -14,5 +14,5 @@ export interface DataEventSummaryItem {
     /** The number of times the event was sent */
     count: number;
     /** The description of the event */
-    description: string;
+    description?: string;
 }

package/api/types/DataTableComponent.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A data-table component is used for rendering a table of key-value pairs. For Messenger, text will wrap around on multiple lines. For Inbox and Frame (ie. Configure) views, we will truncate and use tooltips on hover if the text overflows.
+ */
+export interface DataTableComponent {
+    /** The items that will be rendered in the data-table. */
+    items: Intercom.DataTableItem[];
+}

package/api/types/DataTableComponent.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/DataTableItem.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A field-value pair component for use in a data table.
+ */
+export interface DataTableItem {
+    /** The type of component you are rendering. */
+    type: "field-value";
+    /** The text of the key in your key-value pair. */
+    field: string;
+    /** The text of the value in your key-value pair. */
+    value: string;
+}

package/api/types/DataTableItem.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/DividerComponent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A divider component is used to separate components with a line.
+ */
+export interface DividerComponent {
+    /** A unique identifier for the component. */
+    id?: string;
+    /** Disables a component's margin-bottom of 10px. */
+    bottom_margin?: "none";
+}

package/api/types/DividerComponent.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/DropdownComponent.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A dropdown component is used to capture a choice from the options that you provide.
+ *
+ * When submitted, the dropdown choices are returned in a hash with the id from the dropdown component used as the key and the id from the chosen option as the value.
+ */
+export interface DropdownComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The list of options. Can provide 2 to 10. */
+    options: Intercom.DropdownOption[];
+    /** The text shown above the dropdown. */
+    label?: string;
+    /** The option that is selected by default. */
+    value?: string;
+    /** Styles all options and prevents the action. Default is `unsaved`. Will be overridden if `save_state` is `saved`. */
+    save_state?: DropdownComponent.SaveState;
+    /** Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved. */
+    disabled?: boolean;
+}
+export declare namespace DropdownComponent {
+    /**
+     * Styles all options and prevents the action. Default is `unsaved`. Will be overridden if `save_state` is `saved`.
+     */
+    type SaveState = "unsaved" | "saved" | "failed";
+    const SaveState: {
+        readonly Unsaved: "unsaved";
+        readonly Saved: "saved";
+        readonly Failed: "failed";
+    };
+}

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

package/api/types/DropdownOption.d.ts

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

package/api/types/DropdownOption.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/Error_.d.ts

@@ -6,7 +6,7 @@
  */
 export interface Error_ {
     /** The type is error.list */
-    type: string;
+    type: "error.list";
     /** */
     request_id?: string;
     /** An array of one or more error objects */

package/api/types/Event.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The event object enables Intercom to know more about the actions that took place in your app. Currently, you can only tell us when an app's flow has been completed.
+ */
+export interface Event {
+    /** What action took place. The only value currently accepted is `completed`. */
+    type: "completed";
+}

package/api/types/Event.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/ImageComponent.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An image component is used to display an image.
+ *
+ * HTTPS Images:
+ * If your request URLs (or website URLs) are over HTTPS, you will need to ensure that images are loaded over HTTPS likewise. Otherwise, they will not work.
+ */
+export interface ImageComponent {
+    /** A unique identifier for the component. */
+    id?: string;
+    /** The URL where the image is located. */
+    url: string;
+    /** Aligns the image inside the component. Default is `left`. */
+    align?: ImageComponent.Align;
+    /** The exact width of the image in pixels. */
+    width: number;
+    /** The exact height of the image in pixels. */
+    height: number;
+    /** Rounds the corners of the image. Default is `false`. */
+    rounded?: boolean;
+    /** Disables a component's margin-bottom of 10px. */
+    bottom_margin?: "none";
+    /** This can be a URL Action only. */
+    action?: Intercom.UrlActionComponent;
+}
+export declare namespace ImageComponent {
+    /**
+     * Aligns the image inside the component. Default is `left`.
+     */
+    type Align = "left" | "center" | "right" | "full_width";
+    const Align: {
+        readonly Left: "left";
+        readonly Center: "center";
+        readonly Right: "right";
+        readonly FullWidth: "full_width";
+    };
+}

package/api/types/ImageComponent.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageComponent = void 0;
+var ImageComponent;
+(function (ImageComponent) {
+    ImageComponent.Align = {
+        Left: "left",
+        Center: "center",
+        Right: "right",
+        FullWidth: "full_width",
+    };
+})(ImageComponent = exports.ImageComponent || (exports.ImageComponent = {}));

package/api/types/InitializeRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The request payload will have all the data needed for you to understand who is using your app, where they are using it, and how you should respond. There are different request payloads for Messenger capabilities and Inbox capabilities.
+ */
+export interface InitializeRequest {
+    /** The workspace ID of the teammate. Attribute is `app_id` for V1.2 and below. */
+    workspace_id: string;
+    /** The Intercom hosted region that this app is located in. */
+    workspace_region: string;
+    /** The Intercom teammate viewing the conversation. */
+    admin: Intercom.Admin;
+    /** Key-value pairs which were given as results in response to the Configure request. */
+    card_creation_options: Record<string, unknown>;
+    /** The context of where the app is added, where the user last visited, and information on the Messenger settings. */
+    context: Intercom.Context;
+    /** The conversation your app is being shown for. */
+    conversation: Intercom.Conversation;
+    /** The contact which is currently being viewed by the teammate in the conversation details panel. We send an individual initialize request for each customer when it's a group conversation. */
+    contact: Intercom.Contact;
+}

package/api/types/InitializeRequest.js

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