intercom-client 6.0.0-alpha → 6.0.0-beta.2

package/api/types/TicketList.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 | undefined)[];
-    /** A count of the total number of objects. */
-    total_count?: number;
-    pages?: Intercom.CursorPages;
-}

package/api/types/TicketList.js

@@ -1,5 +0,0 @@
-"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

@@ -1,17 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * 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?: Intercom.TicketPartAuthorType;
-    /** The id of the author */
-    id?: string;
-    /** The name of the author */
-    name?: string;
-    /** The email of the author */
-    email?: string;
-}

package/api/types/TicketPartAuthor.js

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

package/api/types/TicketPartAuthorType.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The type of the author
- */
-export declare type TicketPartAuthorType = "admin" | "bot" | "team" | "user";
-export declare const TicketPartAuthorType: {
-    readonly Admin: "admin";
-    readonly Bot: "bot";
-    readonly Team: "team";
-    readonly User: "user";
-};

package/api/types/TicketPartAuthorType.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TicketPartAuthorType = void 0;
-exports.TicketPartAuthorType = {
-    Admin: "admin",
-    Bot: "bot",
-    Team: "team",
-    User: "user",
-};

package/api/types/TicketParts.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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

@@ -1,5 +0,0 @@
-"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

@@ -1,26 +0,0 @@
-/**
- * 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?: Intercom.TicketReplyPartType;
-    /** 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;
-}

package/api/types/TicketReply.js

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

package/api/types/TicketReplyPartType.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Type of the part
- */
-export declare type TicketReplyPartType = "note" | "comment" | "quick_reply";
-export declare const TicketReplyPartType: {
-    readonly Note: "note";
-    readonly Comment: "comment";
-    readonly QuickReply: "quick_reply";
-};

package/api/types/TicketReplyPartType.js

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

package/api/types/TicketRequestCustomAttributes.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * 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, Intercom.TicketRequestCustomAttributesValue>;

package/api/types/TicketRequestCustomAttributes.js

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

package/api/types/TicketRequestCustomAttributesValue.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export declare type TicketRequestCustomAttributesValue = string | undefined | number | boolean | unknown[];

package/api/types/TicketRequestCustomAttributesValue.js

@@ -1,5 +0,0 @@
-"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

@@ -1,42 +0,0 @@
-/**
- * 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/api/types/TicketTypeAttribute.js

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

package/api/types/TicketTypeAttributeList.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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.TicketTypeAttribute | undefined)[];
-}

package/api/types/TicketTypeAttributeList.js

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

package/api/types/TicketTypeList.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 `ticket_type.list`. */
-    type?: string;
-    /** A list of ticket_types associated with a given workspace. */
-    ticket_types?: (Intercom.TicketType | undefined)[];
-}

package/api/types/TicketTypeList.js

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

package/api/types/Translation.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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/api/types/Translation.js

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

package/api/types/UntagCompanyRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * 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: Intercom.UntagCompanyRequestCompaniesItem[];
-}

package/api/types/UntagCompanyRequest.js

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

package/api/types/UntagCompanyRequestCompaniesItem.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface UntagCompanyRequestCompaniesItem {
-    /** 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/api/types/UntagCompanyRequestCompaniesItem.js

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

package/api/types/UpdateArticleRequest.d.ts

@@ -1,24 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * You can Update an Article
- */
-export interface UpdateArticleRequest {
-    /** 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?: Intercom.UpdateArticleRequestState;
-    /** 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.ArticleTranslatedContent;
-}

package/api/types/UpdateArticleRequest.js

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

package/api/types/UpdateArticleRequestState.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * 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.
- */
-export declare type UpdateArticleRequestState = "published" | "draft";
-export declare const UpdateArticleRequestState: {
-    readonly Published: "published";
-    readonly Draft: "draft";
-};

package/api/types/UpdateArticleRequestState.js

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

package/api/types/UpdateTicketTypeRequest.d.ts

@@ -1,22 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * 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 UpdateTicketTypeRequest {
-    /** The name of the ticket type. */
-    name?: string;
-    /** The description of the ticket type. */
-    description?: string;
-    /** Category of the Ticket Type. */
-    category?: Intercom.UpdateTicketTypeRequestCategory;
-    /** 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;
-}

package/api/types/UpdateTicketTypeRequest.js

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

package/api/types/UpdateTicketTypeRequestCategory.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Category of the Ticket Type.
- */
-export declare type UpdateTicketTypeRequestCategory = "Customer" | "Back-office" | "Tracker";
-export declare const UpdateTicketTypeRequestCategory: {
-    readonly Customer: "Customer";
-    readonly BackOffice: "Back-office";
-    readonly Tracker: "Tracker";
-};

package/api/types/UpdateTicketTypeRequestCategory.js

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateTicketTypeRequestCategory = void 0;
-exports.UpdateTicketTypeRequestCategory = {
-    Customer: "Customer",
-    BackOffice: "Back-office",
-    Tracker: "Tracker",
-};

package/api/types/UpdateVisitorRequest.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-/**
- * Update an existing visitor.
- */
-export declare type UpdateVisitorRequest = Intercom.UpdateVisitorRequestWithId | Intercom.UpdateVisitorRequestWithUserId;

package/api/types/UpdateVisitorRequest.js

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

package/api/types/UpdateVisitorRequestWithId.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface UpdateVisitorRequestWithId {
-    /** A unique identified for the visitor which is given by Intercom. */
-    id: string;
-    /** The custom attributes which are set for the visitor. */
-    custom_attributes?: Record<string, string>;
-}

package/api/types/UpdateVisitorRequestWithId.js

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

package/api/types/UpdateVisitorRequestWithUserId.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface UpdateVisitorRequestWithUserId {
-    /** A unique identified for the visitor which is given by you. */
-    user_id: string;
-    /** The custom attributes which are set for the visitor. */
-    custom_attributes?: Record<string, string>;
-}

package/api/types/UpdateVisitorRequestWithUserId.js

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

package/api/types/Visitor.d.ts

@@ -1,69 +0,0 @@
-/**
- * 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?: Intercom.VisitorAvatar;
-    /** The id of the app the visitor is associated with. */
-    app_id?: string;
-    companies?: Intercom.VisitorCompanies;
-    location_data?: Intercom.VisitorLocationData;
-    /** 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?: Intercom.VisitorSocialProfiles;
-    /** 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?: Intercom.VisitorTags;
-    segments?: Intercom.VisitorSegments;
-    /** 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;
-}

package/api/types/Visitor.js

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

package/api/types/VisitorAvatar.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface VisitorAvatar {
-    /** */
-    type?: string;
-    /** This object represents the avatar associated with the visitor. */
-    image_url?: string;
-}

package/api/types/VisitorAvatar.js

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

package/api/types/VisitorCompanies.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Intercom from "../index";
-export interface VisitorCompanies {
-    /** The type of the object */
-    type?: "company.list";
-    companies?: Intercom.Company[];
-}

package/api/types/VisitorCompanies.js

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

package/api/types/VisitorDeletedObject.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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;
-}