intercom-client 6.0.0-beta.3 → 6.1.0

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface StartingAfterPaging {
+    /** The number of results to fetch per page. */
+    per_page: number;
+    /** The cursor to use in the next request to get the next page of results. */
+    starting_after?: string;
+}

package/api/types/StartingAfterPaging.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/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/SubscriptionTypeList.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 subscription type objects.
+ */
+export interface SubscriptionTypeList {
+    /** The type of the object */
+    type: "list";
+    /** A list of subscription type objects associated with the workspace . */
+    data: Intercom.SubscriptionType[];
+}

package/api/types/SubscriptionTypeList.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/TagCompanyRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * You can tag a single company or a list of companies.
+ */
+export interface TagCompanyRequest {
+    /** The name of the tag, which will be created if not found. */
+    name: string;
+    /** The id or company_id of the company can be passed as input parameters. */
+    companies: TagCompanyRequest.Companies.Item[];
+}
+export declare namespace TagCompanyRequest {
+    type Companies = Companies.Item[];
+    namespace Companies {
+        interface Item {
+            /** The Intercom defined id representing the company. */
+            id?: string;
+            /** The company id you have defined for the company. */
+            company_id?: string;
+        }
+    }
+}

package/api/types/TagCompanyRequest.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/TagList.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 tags objects in the workspace.
+ */
+export interface TagList {
+    /** The type of the object */
+    type: "list";
+    /** A list of tags objects associated with the workspace . */
+    data: Intercom.Tag[];
+}

package/api/types/TagList.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/TagMultipleUsersRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * You can tag a list of users.
+ */
+export interface TagMultipleUsersRequest {
+    /** The name of the tag, which will be created if not found. */
+    name: string;
+    users: TagMultipleUsersRequest.Users.Item[];
+}
+export declare namespace TagMultipleUsersRequest {
+    type Users = Users.Item[];
+    namespace Users {
+        interface Item {
+            /** The Intercom defined id representing the user. */
+            id?: string;
+        }
+    }
+}

package/api/types/TagMultipleUsersRequest.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/Tags.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 tags objects associated with a conversation
+ */
+export interface Tags {
+    /** The type of the object */
+    type: "tag.list";
+    /** A list of tags objects associated with the conversation. */
+    tags: Intercom.Tag[];
+}

package/api/types/Tags.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/TeamList.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * This will return a list of team objects for the App.
+ */
+export interface TeamList {
+    /** The type of the object */
+    type: "team.list";
+    /** A list of team objects */
+    teams: Intercom.Team[];
+}

package/api/types/TeamList.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/TeamPriorityLevel.d.ts

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

package/api/types/TeamPriorityLevel.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";
+    };
+}

package/api/types/TextComponent.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextComponent = void 0;
+var TextComponent;
+(function (TextComponent) {
+    TextComponent.Align = {
+        Left: "left",
+        Center: "center",
+        Right: "right",
+    };
+    TextComponent.Style = {
+        Header: "header",
+        Paragraph: "paragraph",
+        Muted: "muted",
+        Error: "error",
+    };
+})(TextComponent = exports.TextComponent || (exports.TextComponent = {}));

package/api/types/TicketCustomAttributes.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.
+ */
+export declare type TicketCustomAttributes = Record<string, TicketCustomAttributes.Value>;
+export declare namespace TicketCustomAttributes {
+    type Value = string | undefined | number | boolean | unknown[] | Intercom.FileAttribute;
+}

package/api/types/TicketCustomAttributes.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/TicketList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Tickets are how you track requests from your users.
+ */
+export interface TicketList {
+    /** Always ticket.list */
+    type: "ticket.list";
+    /** The list of ticket objects */
+    tickets: Intercom.Ticket[];
+    /** A count of the total number of objects. */
+    total_count: number;
+    pages?: Intercom.CursorPages;
+}

package/api/types/TicketList.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/TicketPartAuthor.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The author that wrote or triggered the part. Can be a bot, admin, team or user.
+ */
+export interface TicketPartAuthor {
+    /** The type of the author */
+    type: TicketPartAuthor.Type;
+    /** The id of the author */
+    id: string;
+    /** The name of the author */
+    name?: string;
+    /** The email of the author */
+    email: string;
+}
+export declare namespace TicketPartAuthor {
+    /**
+     * The type of the author
+     */
+    type Type = "admin" | "bot" | "team" | "user";
+    const Type: {
+        readonly Admin: "admin";
+        readonly Bot: "bot";
+        readonly Team: "team";
+        readonly User: "user";
+    };
+}

package/api/types/TicketPartAuthor.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.TicketPartAuthor = void 0;
+var TicketPartAuthor;
+(function (TicketPartAuthor) {
+    TicketPartAuthor.Type = {
+        Admin: "admin",
+        Bot: "bot",
+        Team: "team",
+        User: "user",
+    };
+})(TicketPartAuthor = exports.TicketPartAuthor || (exports.TicketPartAuthor = {}));

package/api/types/TicketParts.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.
+ */
+export interface TicketParts {
+    /** */
+    type: "ticket_part.list";
+    /** A list of Ticket Part objects for each ticket. There is a limit of 500 parts. */
+    ticket_parts: Intercom.TicketPart[];
+    /** */
+    total_count: number;
+}

package/api/types/TicketParts.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/TicketReply.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * A Ticket Part representing a note, comment, or quick_reply on a ticket
+ */
+export interface TicketReply {
+    /** Always ticket_part */
+    type: "ticket_part";
+    /** The id representing the part. */
+    id: string;
+    /** Type of the part */
+    part_type: TicketReply.PartType;
+    /** The message body, which may contain HTML. */
+    body?: string;
+    /** The time the note was created. */
+    created_at: number;
+    /** The last time the note was updated. */
+    updated_at?: number;
+    author?: Intercom.TicketPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.PartAttachment[];
+    /** Whether or not the ticket part has been redacted. */
+    redacted?: boolean;
+}
+export declare namespace TicketReply {
+    /**
+     * Type of the part
+     */
+    type PartType = "note" | "comment" | "quick_reply";
+    const PartType: {
+        readonly Note: "note";
+        readonly Comment: "comment";
+        readonly QuickReply: "quick_reply";
+    };
+}

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

package/api/types/TicketRequestCustomAttributes.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).
+ */
+export declare type TicketRequestCustomAttributes = Record<string, TicketRequestCustomAttributes.Value>;
+export declare namespace TicketRequestCustomAttributes {
+    type Value = string | undefined | number | boolean | unknown[];
+}

package/api/types/TicketRequestCustomAttributes.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/TicketTypeAttribute.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Ticket type attribute, used to define each data field to be captured in a ticket.
+ */
+export interface TicketTypeAttribute {
+    /** String representing the object's type. Always has the value `ticket_type_attribute`. */
+    type: "ticket_type_attribute";
+    /** The id representing the ticket type attribute. */
+    id: string;
+    /** The id of the workspace that the ticket type attribute belongs to. */
+    workspace_id: string;
+    /** The name of the ticket type attribute */
+    name: string;
+    /** The description of the ticket type attribute */
+    description: string;
+    /** The type of the data attribute (allowed values: "string list integer decimal boolean datetime files") */
+    data_type: TicketTypeAttribute.DataType;
+    /** Input options for the attribute */
+    input_options: Record<string, unknown>;
+    /** The order of the attribute against other attributes */
+    order: number;
+    /** Whether the attribute is required or not for teammates. */
+    required_to_create: boolean;
+    /** Whether the attribute is required or not for contacts. */
+    required_to_create_for_contacts: boolean;
+    /** Whether the attribute is visible or not to teammates. */
+    visible_on_create: boolean;
+    /** Whether the attribute is visible or not to contacts. */
+    visible_to_contacts: boolean;
+    /** Whether the attribute is built in or not. */
+    default: boolean;
+    /** The id of the ticket type that the attribute belongs to. */
+    ticket_type_id: number;
+    /** Whether the ticket type attribute is archived or not. */
+    archived: boolean;
+    /** The date and time the ticket type attribute was created. */
+    created_at: number;
+    /** The date and time the ticket type attribute was last updated. */
+    updated_at?: number;
+}
+export declare namespace TicketTypeAttribute {
+    /**
+     * The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
+     */
+    type DataType = "string" | "list" | "integer" | "decimal" | "boolean" | "datetime" | "files";
+    const DataType: {
+        readonly String: "string";
+        readonly List: "list";
+        readonly Integer: "integer";
+        readonly Decimal: "decimal";
+        readonly Boolean: "boolean";
+        readonly Datetime: "datetime";
+        readonly Files: "files";
+    };
+}