intercom-client 6.0.0 → 6.1.1

package/api/types/InitializeResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The response object returned when initializing an app, specifying the UI for the first screen using components.
+ */
+export interface InitializeResponse {
+    /** The canvas object that defines the UI to be shown for the app. */
+    canvas: Intercom.CanvasObject;
+}

package/api/types/InitializeResponse.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/InputComponent.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An input component is used to capture text input from the end user. You can submit the value of the input by:
+ *
+ * - Adding an `action` to the input component (which will render an inline button)
+ * - Using a ButtonComponent (which will submit all interactive components in the canvas)
+ */
+export interface InputComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The text shown above the input. */
+    label?: string;
+    /** An example value shown inside the component when it's empty. */
+    placeholder?: string;
+    /** An entered value which is already inside the component. */
+    value?: string;
+    /** This can be a Submit Action, URL Action, or Sheets Action. */
+    action?: Intercom.ActionComponent;
+    /** Styles the input. Default is `unsaved`. Prevent action with `saved`. */
+    save_state?: InputComponent.SaveState;
+    /** Styles the input and prevents the action. Default is false. Will be overridden if save_state is saved. */
+    disabled?: boolean;
+}
+export declare namespace InputComponent {
+    /**
+     * 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/InputComponent.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.InputComponent = void 0;
+var InputComponent;
+(function (InputComponent) {
+    InputComponent.SaveState = {
+        Unsaved: "unsaved",
+        Saved: "saved",
+        Failed: "failed",
+    };
+})(InputComponent = exports.InputComponent || (exports.InputComponent = {}));

package/api/types/ListComponent.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A list component renders a list of items which you provide in an array. You can make each list item take an action by adding the relevant action object to the item:
+ *
+ * - [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 ListComponent {
+    /** The items that will be rendered in the list. */
+    items: ListComponent.Items.Item[];
+    /** Styles all list items and prevents the action. Default is `false`. */
+    disabled?: boolean;
+}
+export declare namespace ListComponent {
+    type Items = Items.Item[];
+    namespace Items {
+        type Item = Intercom.ListItemWithImage | Intercom.ListItemWithoutImage;
+    }
+}

package/api/types/ListComponent.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/ListItem.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A list item component that can be rendered in a list.
+ */
+export interface ListItem {
+    /** The type of component you are rendering. */
+    type: "item";
+    /** A unique identifier for the item. */
+    id: string;
+    /** The text shown as the title for the item. */
+    title: string;
+    /** The text shown underneath the item's title. */
+    subtitle?: string;
+    /** The text shown next to the subtitle, separates by a bullet. */
+    tertiary_text?: string;
+    /** Rounds the corners of the image. Default is `false`. */
+    rounded_image?: boolean;
+    /** Styles all list items and prevents the action. Default is `false`. */
+    disabled?: boolean;
+    /** This can be a Submit Action, URL Action, or Sheets Action. */
+    action?: Intercom.ActionComponent;
+}

package/api/types/ListItem.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/ListItemWithImage.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export interface ListItemWithImage extends Intercom.ListItem {
+    /** An image that will be displayed to the left of the item. */
+    image: string;
+    /** The exact width of the image in pixels. */
+    image_width: number;
+    /** The exact height of the image in pixels. */
+    image_height: number;
+}

package/api/types/ListItemWithImage.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/ListItemWithoutImage.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export interface ListItemWithoutImage extends Intercom.ListItem {
+    /** An image that will be displayed to the left of the item. */
+    image?: string;
+    /** The exact width of the image in pixels. */
+    image_width?: number;
+    /** The exact height of the image in pixels. */
+    image_height?: number;
+}

package/api/types/ListItemWithoutImage.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/LiveCanvasRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Canvases are static by default and require a new request to come through in order to update them. Live canvases however will make requests every time the card is viewed without any interaction needed, meaning the canvas can be kept up-to-date with no action from the user.
+ *
+ * This works for every Messenger request that you can respond with a canvas object to. Instead of returning the content object within the canvas object, you should provide a `content_url` attribute instead with the value being the URL you want us to send a POST request to when someone views the app.
+ */
+export interface LiveCanvasRequest {
+    /** 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 current_canvas the teammate can see. */
+    canvas: Intercom.CanvasObject;
+    /** The context of where the app is added, where the user last visited, and information on the Messenger settings. */
+    context: Intercom.Context;
+    /** The contact who viewed the card. */
+    contact: Intercom.Contact;
+}

package/api/types/LiveCanvasRequest.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/LiveCanvasResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The response object returned when responding to a Live Canvas request. This contains the components you want to show.
+ */
+export interface LiveCanvasResponse {
+    /** The content object that defines the components to be shown. */
+    content: Intercom.ContentObject;
+}

package/api/types/LiveCanvasResponse.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/MultipleFilterSearchRequest.d.ts

@@ -8,7 +8,7 @@ import * as Intercom from "../index";
 export interface MultipleFilterSearchRequest {
     /** An operator to allow boolean inspection between multiple fields. */
     operator?: MultipleFilterSearchRequest.Operator;
-    value?: MultipleFilterSearchRequest.Value;
+    value?: Intercom.MultipleOrSingleFilterSearchRequest[];
 }
 export declare namespace MultipleFilterSearchRequest {
     /**
@@ -19,11 +19,4 @@ export declare namespace MultipleFilterSearchRequest {
         readonly And: "AND";
         readonly Or: "OR";
     };
-    type Value = 
-    /**
-     * Add mutiple filters. */
-    Intercom.MultipleFilterSearchRequest[]
-    /**
-     * Add a single filter field. */
-     | Intercom.SingleFilterSearchRequest[];
 }

package/api/types/MultipleOrSingleFilterSearchRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export declare type MultipleOrSingleFilterSearchRequest = Intercom.MultipleFilterSearchRequest | Intercom.SingleFilterSearchRequest;

package/api/types/MultipleOrSingleFilterSearchRequest.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/NoteList.d.ts

@@ -12,5 +12,5 @@ export interface NoteList {
     data: Intercom.Note[];
     /** A count of the total number of notes. */
     total_count: number;
-    pages?: Intercom.CursorPages;
+    pages?: Intercom.OffsetPages;
 }

package/api/types/OffsetPages.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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/api/types/OffsetPages.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/ResultsResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The results object should be sent when you want to end configuration of the app and trigger the [Initialize request](https://developers.intercom.com/docs/canvas-kit/#initialize) to be sent. You provide the key-value pairs of data you want access to and we will send these in the Initialize request within a [card_creation_options object](https://developers.intercom.com/docs/references/canvas-kit/requestobjects/card-creation-options/#card-creation-options).
+ */
+export interface ResultsResponse {
+    /** Key-value pairs of data you want access to in the Initialize request */
+    results: Record<string, unknown>;
+}

package/api/types/ResultsResponse.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/SheetActionComponent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A sheet action opens the link you give within the Messenger as an embedded iframe.
+ *
+ * [More on how Sheets work is in our Canvas Kit documentation.](https://developers.intercom.com/docs/canvas-kit#sheets-optional)
+ */
+export interface SheetActionComponent {
+    /** The link which hosts your sheet. */
+    url: string;
+}

package/api/types/SheetActionComponent.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/SingleFilterSearchRequest.d.ts

@@ -10,7 +10,7 @@ export interface SingleFilterSearchRequest {
     /** The accepted operators you can use to define how you want to search for the value. */
     operator?: SingleFilterSearchRequest.Operator;
     /** The value that you want to search on. */
-    value?: string;
+    value?: SingleFilterSearchRequest.Value;
 }
 export declare namespace SingleFilterSearchRequest {
     /**
@@ -29,4 +29,8 @@ export declare namespace SingleFilterSearchRequest {
         readonly StartsWith: "^";
         readonly EndsWith: "$";
     };
+    /**
+     * The value that you want to search on.
+     */
+    type Value = string | number | string[] | number[];
 }

package/api/types/SingleSelectComponent.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A single-select component is used to capture a choice from up to 10 options that you provide. You can submit the value of the select option by:
+ *
+ * - Adding an `action` to the single-select component
+ * - 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 single-select component used as the key and the `id` from the chosen option as the value.
+ */
+export interface SingleSelectComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The list of options. Can provide 2 to 10. */
+    options: Intercom.SingleSelectOption[];
+    /** The text shown above the options. */
+    label?: string;
+    /** The option that is selected by default. */
+    value?: string;
+    /** Styles the input. Default is `unsaved`. Prevent action with `saved`. */
+    save_state?: SingleSelectComponent.SaveState;
+    /** Styles all options and prevents the action. Default is false. Will be overridden if save_state is saved. */
+    disabled?: boolean;
+    /** This can be a Submit Action, URL Action, or Sheets Action. */
+    action?: Intercom.ActionComponent;
+}
+export declare namespace SingleSelectComponent {
+    /**
+     * 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/SingleSelectComponent.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.SingleSelectComponent = void 0;
+var SingleSelectComponent;
+(function (SingleSelectComponent) {
+    SingleSelectComponent.SaveState = {
+        Unsaved: "unsaved",
+        Saved: "saved",
+        Failed: "failed",
+    };
+})(SingleSelectComponent = exports.SingleSelectComponent || (exports.SingleSelectComponent = {}));

package/api/types/SingleSelectOption.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A single select option component that can be selected.
+ */
+export interface SingleSelectOption {
+    /** 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/SingleSelectOption.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/SocialProfile.d.ts

@@ -6,7 +6,7 @@
  */
 export interface SocialProfile {
     /** value is "social_profile" */
-    type: string;
+    type: "social_profile";
     /** The name of the Social media profile */
     name: string;
     /** The name of the Social media profile */

package/api/types/SpacerComponent.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A spacer component is used to create empty space between components.
+ */
+export interface SpacerComponent {
+    /** A unique identifier for the component. */
+    id?: string;
+    /** The amount of space between components. Default is `s`. */
+    size?: SpacerComponent.Size;
+}
+export declare namespace SpacerComponent {
+    /**
+     * The amount of space between components. Default is `s`.
+     */
+    type Size = "xs" | "s" | "m" | "l" | "xl";
+    const Size: {
+        readonly Xs: "xs";
+        readonly S: "s";
+        readonly M: "m";
+        readonly L: "l";
+        readonly Xl: "xl";
+    };
+}

package/api/types/SpacerComponent.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpacerComponent = void 0;
+var SpacerComponent;
+(function (SpacerComponent) {
+    SpacerComponent.Size = {
+        Xs: "xs",
+        S: "s",
+        M: "m",
+        L: "l",
+        Xl: "xl",
+    };
+})(SpacerComponent = exports.SpacerComponent || (exports.SpacerComponent = {}));

package/api/types/SubmitActionComponent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A submit action triggers a [Submit Request](https://developers.intercom.com/docs/canvas-kit#submit-request) to be sent. This request will include all values which have been entered into all the interactive components on the current canvas.
+ */
+export interface SubmitActionComponent {
+}

package/api/types/SubmitActionComponent.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/SubmitRequest.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The Submit request is triggered when a component with a submit action is interacted with in Messenger Inbox.
+ */
+export interface SubmitRequest {
+    /** 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;
+    /** The id of the component clicked by the teammate to trigger the request. */
+    component_id: string;
+    /** The context of where the app is added, where the user last visited, and information on the Messenger settings. */
+    context: Intercom.Context;
+    /** The conversation where your app is being shown. */
+    conversation: Intercom.Conversation;
+    /** The current canvas the teammate can see. */
+    current_canvas: Intercom.CurrentCanvas;
+    /** The contact which is currently being viewed by the teammate in the conversation details panel. */
+    contact: Intercom.Contact;
+    /** A list of key/value pairs of data, inputted by the teammate on the current canvas. */
+    input_values: Record<string, unknown>;
+    /** The user who took the action. */
+    user: Intercom.Contact;
+}

package/api/types/SubmitRequest.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/SubmitResponse.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The response object returned when submitting an app interaction. This will replace the previous canvas that was visible until the app was interacted with.
+ *
+ * You can optionally provide an event object with the attribute `type` given as `completed` to tell us if the app has completed its purpose. For example, an email collector app would be complete when the end-user submits their email address.
+ *
+ * Apps in conversation details can also optionally insert an app into the conversation reply:
+ *
+ * 1. You respond with a card_creation_options object (https://developers.intercom.com/canvas-kit-reference/reference/card-creation-options)
+ * 2. We send a request to the initialize URL for Messenger capabilities (https://developers.intercom.com/docs/build-an-integration/getting-started/build-an-app-for-your-messenger/request-flows) with the card_creation_options object present
+ * 3. You respond with a canvas object with the components you want to insert into the conversation reply
+ */
+export interface SubmitResponse {
+    /** The canvas object that defines the new UI to be shown. */
+    canvas: Intercom.CanvasObject;
+    /** Optional. Key-value pairs that will be sent in the initialize request to insert an app into the conversation reply. */
+    card_creation_options?: Record<string, unknown>;
+    /** Optional. Indicates if the app has completed its purpose. */
+    event?: Intercom.Event;
+}

package/api/types/SubmitResponse.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/TextAreaComponent.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A text area component is used to capture a large amount of text as input with a multi-line text box. You can submit the value of the text area by:
+ *
+ * - Using a ButtonComponent (which will submit all interactive components in the canvas)
+ */
+export interface TextAreaComponent {
+    /** A unique identifier for the component. */
+    id: string;
+    /** The text shown above the text area. */
+    label?: string;
+    /** An example value shown inside the component when it's empty. */
+    placeholder?: string;
+    /** An entered value which is already inside the component. */
+    value?: string;
+    /** Styles the input as failed. Default is false. */
+    error?: boolean;
+    /** Styles the input and prevents the action. Default is false. */
+    disabled?: boolean;
+}

package/api/types/TextAreaComponent.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/TextComponent.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A text component is used for rendering blocks of text. Links and bold font can be rendered through Markdown. There are different styles provided which edit the color, weight, and font size. These cannot be edited through Markdown.
+ */
+export interface TextComponent {
+    /** A unique identifier for the component. */
+    id?: string;
+    /** The text that will be rendered. */
+    text: string;
+    /** Aligns the text. Default is `left`. */
+    align?: TextComponent.Align;
+    /** Styles the text. Default is `paragraph`. */
+    style?: TextComponent.Style;
+    /** Disables a component's margin-bottom of 10px. */
+    bottom_margin?: "none";
+}
+export declare namespace TextComponent {
+    /**
+     * Aligns the text. Default is `left`.
+     */
+    type Align = "left" | "center" | "right";
+    const Align: {
+        readonly Left: "left";
+        readonly Center: "center";
+        readonly Right: "right";
+    };
+    /**
+     * Styles the text. Default is `paragraph`.
+     */
+    type Style = "header" | "paragraph" | "muted" | "error";
+    const Style: {
+        readonly Header: "header";
+        readonly Paragraph: "paragraph";
+        readonly Muted: "muted";
+        readonly Error: "error";
+    };
+}