intercom-client 6.2.0 → 6.4.0

package/dist/api/resources/unstable/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.unstable.TicketPartAuthor;
+    /** A list of attachments for the part. */
+    attachments?: Intercom.unstable.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/dist/api/resources/unstable/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 = TicketReply = {}));

package/dist/api/resources/unstable/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 type TicketRequestCustomAttributes = Record<string, TicketRequestCustomAttributes.Value>;
+export declare namespace TicketRequestCustomAttributes {
+    type Value = string | undefined | number | boolean | unknown[];
+}

package/dist/api/resources/unstable/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/dist/api/resources/unstable/types/TicketStateList.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 ticket states associated with a given ticket type.
+ */
+export interface TicketStateList {
+    /** String representing the object's type. Always has the value `list`. */
+    type?: string;
+    /** A list of ticket states associated with a given ticket type. */
+    data?: (Intercom.unstable.TicketStateDetailed | undefined)[];
+}

package/dist/api/resources/unstable/types/TicketStateList.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/dist/api/resources/unstable/types/TicketTypeAttribute.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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?: string;
+    /** 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?: string;
+    /** 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;
+}

package/dist/api/resources/unstable/types/TicketTypeAttribute.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/dist/api/resources/unstable/types/TicketTypeAttributeList.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 attributes associated with a given ticket type.
+ */
+export interface TicketTypeAttributeList {
+    /** String representing the object's type. Always has the value `ticket_type_attributes.list`. */
+    type?: string;
+    /** A list of ticket type attributes associated with a given ticket type. */
+    ticket_type_attributes?: (Intercom.unstable.TicketTypeAttribute | undefined)[];
+}

package/dist/api/resources/unstable/types/TicketTypeAttributeList.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/dist/api/resources/unstable/types/TicketTypeList.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 ticket types associated with a given workspace.
+ */
+export interface TicketTypeList {
+    /** String representing the object's type. Always has the value `list`. */
+    type?: string;
+    /** A list of ticket_types associated with a given workspace. */
+    data?: (Intercom.unstable.TicketType | undefined)[];
+}

package/dist/api/resources/unstable/types/TicketTypeList.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/dist/api/resources/unstable/types/Translation.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A translation object contains the localised details of a subscription type.
+ */
+export interface Translation {
+    /** The localised name of the subscription type. */
+    name?: string;
+    /** The localised description of the subscription type. */
+    description?: string;
+    /** The two character identifier for the language of the translation object. */
+    locale?: string;
+}

package/dist/api/resources/unstable/types/Translation.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/dist/api/resources/unstable/types/UntagCompanyRequest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * You can tag a single company or a list of companies.
+ */
+export interface UntagCompanyRequest {
+    /** The name of the tag which will be untagged from the company */
+    name: string;
+    /** The id or company_id of the company can be passed as input parameters. */
+    companies: UntagCompanyRequest.Companies.Item[];
+}
+export declare namespace UntagCompanyRequest {
+    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;
+            /** Always set to true */
+            untag?: boolean;
+        }
+    }
+}

package/dist/api/resources/unstable/types/UntagCompanyRequest.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/dist/api/resources/unstable/types/UpdateArticleRequestBody.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * You can Update an Article
+ */
+export interface UpdateArticleRequestBody {
+    /** The title of the article.For multilingual articles, this will be the title of the default language's content. */
+    title?: string;
+    /** The description of the article. For multilingual articles, this will be the description of the default language's content. */
+    description?: string;
+    /** The content of the article. For multilingual articles, this will be the body of the default language's content. */
+    body?: string;
+    /** The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. */
+    author_id?: number;
+    /** Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. */
+    state?: UpdateArticleRequestBody.State;
+    /** The id of the article's parent collection or section. An article without this field stands alone. */
+    parent_id?: string;
+    /** The type of parent, which can either be a `collection` or `section`. */
+    parent_type?: string;
+    translated_content?: Intercom.unstable.ArticleTranslatedContent;
+}
+export declare namespace UpdateArticleRequestBody {
+    /**
+     * Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.
+     */
+    type State = "published" | "draft";
+    const State: {
+        readonly Published: "published";
+        readonly Draft: "draft";
+    };
+}

package/dist/api/resources/unstable/types/UpdateArticleRequestBody.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.UpdateArticleRequestBody = void 0;
+var UpdateArticleRequestBody;
+(function (UpdateArticleRequestBody) {
+    UpdateArticleRequestBody.State = {
+        Published: "published",
+        Draft: "draft",
+    };
+})(UpdateArticleRequestBody || (exports.UpdateArticleRequestBody = UpdateArticleRequestBody = {}));

package/dist/api/resources/unstable/types/UpdateTicketTypeRequestBody.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The request payload for updating a ticket type.
+ * You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)
+ */
+export interface UpdateTicketTypeRequestBody {
+    /** The name of the ticket type. */
+    name?: string;
+    /** The description of the ticket type. */
+    description?: string;
+    /** Category of the Ticket Type. */
+    category?: UpdateTicketTypeRequestBody.Category;
+    /** The icon of the ticket type. */
+    icon?: string;
+    /** The archived status of the ticket type. */
+    archived?: boolean;
+    /** Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. */
+    is_internal?: boolean;
+}
+export declare namespace UpdateTicketTypeRequestBody {
+    /**
+     * Category of the Ticket Type.
+     */
+    type Category = "Customer" | "Back-office" | "Tracker";
+    const Category: {
+        readonly Customer: "Customer";
+        readonly BackOffice: "Back-office";
+        readonly Tracker: "Tracker";
+    };
+}

package/dist/api/resources/unstable/types/UpdateTicketTypeRequestBody.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.UpdateTicketTypeRequestBody = void 0;
+var UpdateTicketTypeRequestBody;
+(function (UpdateTicketTypeRequestBody) {
+    UpdateTicketTypeRequestBody.Category = {
+        Customer: "Customer",
+        BackOffice: "Back-office",
+        Tracker: "Tracker",
+    };
+})(UpdateTicketTypeRequestBody || (exports.UpdateTicketTypeRequestBody = UpdateTicketTypeRequestBody = {}));

package/dist/api/resources/unstable/types/Visitor.d.ts

@@ -0,0 +1,128 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.
+ */
+export interface Visitor {
+    /** Value is 'visitor' */
+    type?: string;
+    /** The Intercom defined id representing the Visitor. */
+    id?: string;
+    /** Automatically generated identifier for the Visitor. */
+    user_id?: string;
+    /** Identifies if this visitor is anonymous. */
+    anonymous?: boolean;
+    /** The email of the visitor. */
+    email?: string;
+    /** The phone number of the visitor. */
+    phone?: string;
+    /** The name of the visitor. */
+    name?: string;
+    /** The pseudonym of the visitor. */
+    pseudonym?: string;
+    avatar?: Visitor.Avatar;
+    /** The id of the app the visitor is associated with. */
+    app_id?: string;
+    companies?: Visitor.Companies;
+    location_data?: Visitor.LocationData;
+    /** The time the Lead last recorded making a request. */
+    las_request_at?: number;
+    /** The time the Visitor was added to Intercom. */
+    created_at?: number;
+    /** The time the Visitor was added to Intercom. */
+    remote_created_at?: number;
+    /** The time the Visitor signed up for your product. */
+    signed_up_at?: number;
+    /** The last time the Visitor was updated. */
+    updated_at?: number;
+    /** The number of sessions the Visitor has had. */
+    session_count?: number;
+    social_profiles?: Visitor.SocialProfiles;
+    /** The id of the admin that owns the Visitor. */
+    owner_id?: string;
+    /** Whether the Visitor is unsubscribed from emails. */
+    unsubscribed_from_emails?: boolean;
+    /** Identifies if this visitor has marked an email as spam. */
+    marked_email_as_spam?: boolean;
+    /** Identifies if this visitor has had a hard bounce. */
+    has_hard_bounced?: boolean;
+    tags?: Visitor.Tags;
+    segments?: Visitor.Segments;
+    /** The custom attributes you have set on the Visitor. */
+    custom_attributes?: Record<string, string>;
+    /** The referer of the visitor. */
+    referrer?: string;
+    /** The utm_campaign of the visitor. */
+    utm_campaign?: string;
+    /** The utm_content of the visitor. */
+    utm_content?: string;
+    /** The utm_medium of the visitor. */
+    utm_medium?: string;
+    /** The utm_source of the visitor. */
+    utm_source?: string;
+    /** The utm_term of the visitor. */
+    utm_term?: string;
+    /** Identifies if this visitor has do not track enabled. */
+    do_not_track?: boolean;
+}
+export declare namespace Visitor {
+    interface Avatar {
+        /** */
+        type?: string;
+        /** This object represents the avatar associated with the visitor. */
+        image_url?: string;
+    }
+    interface Companies {
+        /** The type of the object */
+        type?: "company.list";
+        companies?: Intercom.unstable.Company[];
+    }
+    interface LocationData {
+        /** */
+        type?: string;
+        /** The city name of the visitor. */
+        city_name?: string;
+        /** The continent code of the visitor. */
+        continent_code?: string;
+        /** The country code of the visitor. */
+        country_code?: string;
+        /** The country name of the visitor. */
+        country_name?: string;
+        /** The postal code of the visitor. */
+        postal_code?: string;
+        /** The region name of the visitor. */
+        region_name?: string;
+        /** The timezone of the visitor. */
+        timezone?: string;
+    }
+    interface SocialProfiles {
+        /** The type of the object */
+        type?: "social_profile.list";
+        social_profiles?: string[];
+    }
+    interface Tags {
+        /** The type of the object */
+        type?: "tag.list";
+        tags?: Tags.Tags.Item[];
+    }
+    namespace Tags {
+        type Tags = Tags.Item[];
+        namespace Tags {
+            interface Item {
+                /** The type of the object */
+                type?: "tag";
+                /** The id of the tag. */
+                id?: string;
+                /** The name of the tag. */
+                name?: string;
+            }
+        }
+    }
+    interface Segments {
+        /** The type of the object */
+        type?: "segment.list";
+        segments?: string[];
+    }
+}

package/dist/api/resources/unstable/types/Visitor.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/dist/api/resources/unstable/types/VisitorDeletedObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when an object is deleted
+ */
+export interface VisitorDeletedObject {
+    /** The unique identifier for the visitor which is given by Intercom. */
+    id?: string;
+    /** The type of object which was deleted */
+    type?: "visitor";
+    /** Automatically generated identifier for the Visitor. */
+    user_id?: string;
+}

package/dist/api/resources/unstable/types/VisitorDeletedObject.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/dist/api/resources/unstable/types/WhatsappMessageStatusList.d.ts

@@ -0,0 +1,65 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WhatsappMessageStatusList {
+    type: "list";
+    /** The provided ruleset ID */
+    ruleset_id: string;
+    pages: WhatsappMessageStatusList.Pages;
+    /** Total number of events */
+    total_count: number;
+    events: WhatsappMessageStatusList.Events.Item[];
+}
+export declare namespace WhatsappMessageStatusList {
+    interface Pages {
+        type: "pages";
+        /** Number of results per page */
+        per_page: number;
+        /** Total number of pages */
+        total_pages: number;
+        /** Information for fetching next page (null if no more pages) */
+        next?: Pages.Next;
+    }
+    namespace Pages {
+        /**
+         * Information for fetching next page (null if no more pages)
+         */
+        interface Next {
+            /** Cursor for the next page */
+            starting_after?: string;
+        }
+    }
+    type Events = Events.Item[];
+    namespace Events {
+        interface Item {
+            /** Event ID */
+            id: string;
+            /** ID of the conversation */
+            conversation_id: string;
+            /** Current status of the message */
+            status: Item.Status;
+            /** Event type */
+            type: "broadcast_outbound";
+            /** Creation timestamp */
+            created_at: number;
+            /** Last update timestamp */
+            updated_at: number;
+            /** WhatsApp's message identifier */
+            whatsapp_message_id: string;
+            /** Name of the WhatsApp template used */
+            template_name?: string;
+        }
+        namespace Item {
+            /**
+             * Current status of the message
+             */
+            type Status = "sent" | "delivered" | "read" | "failed";
+            const Status: {
+                readonly Sent: "sent";
+                readonly Delivered: "delivered";
+                readonly Read: "read";
+                readonly Failed: "failed";
+            };
+        }
+    }
+}

package/dist/api/resources/unstable/types/WhatsappMessageStatusList.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhatsappMessageStatusList = void 0;
+var WhatsappMessageStatusList;
+(function (WhatsappMessageStatusList) {
+    let Events;
+    (function (Events) {
+        let Item;
+        (function (Item) {
+            Item.Status = {
+                Sent: "sent",
+                Delivered: "delivered",
+                Read: "read",
+                Failed: "failed",
+            };
+        })(Item = Events.Item || (Events.Item = {}));
+    })(Events = WhatsappMessageStatusList.Events || (WhatsappMessageStatusList.Events = {}));
+})(WhatsappMessageStatusList || (exports.WhatsappMessageStatusList = WhatsappMessageStatusList = {}));