intercom-client 5.0.0 → 6.0.0-alpha1

package/api/types/PaginatedResponseDataItem.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/PaginatedResponseType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of object
+ */
+export declare type PaginatedResponseType = "list" | "conversation.list";
+export declare const PaginatedResponseType: {
+    readonly List: "list";
+    readonly ConversationList: "conversation.list";
+};

package/api/types/PaginatedResponseType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedResponseType = void 0;
+exports.PaginatedResponseType = {
+    List: "list",
+    ConversationList: "conversation.list",
+};

package/api/types/PartAttachment.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The file attached to a part
+ */
+export interface PartAttachment {
+    /** The type of attachment */
+    type?: string;
+    /** The name of the attachment */
+    name?: string;
+    /** The URL of the attachment */
+    url?: string;
+    /** The content type of the attachment */
+    content_type?: string;
+    /** The size of the attachment */
+    filesize?: number;
+    /** The width of the attachment */
+    width?: number;
+    /** The height of the attachment */
+    height?: number;
+}

package/api/types/PartAttachment.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/PhoneSwitch.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Phone Switch Response
+ */
+export interface PhoneSwitch {
+    /** */
+    type?: "phone_call_redirect";
+    /** Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger. */
+    phone?: string;
+}

package/api/types/PhoneSwitch.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/RedactConversationRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+export declare type RedactConversationRequest = 
+/**
+ * Payload of the request to redact a conversation part */
+Intercom.RedactConversationRequest.ConversationPart
+/**
+ * Payload of the request to redact a conversation source */
+ | Intercom.RedactConversationRequest.Source;
+export declare namespace RedactConversationRequest {
+    interface ConversationPart extends Intercom.RedactConversationRequestConversationPart {
+        type: "conversation_part";
+    }
+    interface Source extends Intercom.RedactConversationRequestSource {
+        type: "source";
+    }
+}

package/api/types/RedactConversationRequest.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/RedactConversationRequestConversationPart.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to redact a conversation part
+ */
+export interface RedactConversationRequestConversationPart {
+    /** The id of the conversation. */
+    conversation_id: string;
+    /** The id of the conversation_part. */
+    conversation_part_id: string;
+}

package/api/types/RedactConversationRequestConversationPart.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/RedactConversationRequestSource.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to redact a conversation source
+ */
+export interface RedactConversationRequestSource {
+    /** The id of the conversation. */
+    conversation_id: string;
+    /** The id of the source. */
+    source_id: string;
+}

package/api/types/RedactConversationRequestSource.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/Reference.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * reference to another object
+ */
+export interface Reference {
+    /** */
+    type?: string;
+    /** */
+    id?: string;
+}

package/api/types/Reference.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/ReplyConversationRequest.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 ReplyConversationRequest = Intercom.ContactReplyConversationRequest | Intercom.AdminReplyConversationRequest;

package/api/types/ReplyConversationRequest.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/SearchRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Search using Intercoms Search APIs.
+ */
+export interface SearchRequest {
+    query: Intercom.SearchRequestQuery;
+    pagination?: Intercom.StartingAfterPaging;
+}

package/api/types/SearchRequest.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/SearchRequestQuery.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 SearchRequestQuery = Intercom.SingleFilterSearchRequest | Intercom.MultipleFilterSearchRequest;

package/api/types/SearchRequestQuery.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/SegmentList.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.
+ */
+export interface SegmentList {
+    /** The type of the object */
+    type?: "segment.list";
+    /** A list of Segment objects */
+    segments?: Intercom.Segment[];
+    /** A pagination object, which may be empty, indicating no further pages to fetch. */
+    pages?: Record<string, unknown>;
+}

package/api/types/SegmentList.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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * Search using Intercoms Search APIs with a single filter.
+ */
+export interface SingleFilterSearchRequest {
+    /** The accepted field that you want to search on. */
+    field?: string;
+    /** The accepted operators you can use to define how you want to search for the value. */
+    operator?: Intercom.SingleFilterSearchRequestOperator;
+    /** The value that you want to search on. */
+    value?: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The accepted operators you can use to define how you want to search for the value.
+ */
+export declare type SingleFilterSearchRequestOperator = "=" | "!=" | "IN" | "NIN" | "<" | ">" | "~" | "!~" | "^" | "$";
+export declare const SingleFilterSearchRequestOperator: {
+    readonly Equals: "=";
+    readonly NotEquals: "!=";
+    readonly In: "IN";
+    readonly NotIn: "NIN";
+    readonly LessThan: "<";
+    readonly GreaterThan: ">";
+    readonly Contains: "~";
+    readonly DoesNotContain: "!~";
+    readonly StartsWith: "^";
+    readonly EndsWith: "$";
+};

package/api/types/SingleFilterSearchRequestOperator.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SingleFilterSearchRequestOperator = void 0;
+exports.SingleFilterSearchRequestOperator = {
+    Equals: "=",
+    NotEquals: "!=",
+    In: "IN",
+    NotIn: "NIN",
+    LessThan: "<",
+    GreaterThan: ">",
+    Contains: "~",
+    DoesNotContain: "!~",
+    StartsWith: "^",
+    EndsWith: "$",
+};

package/api/types/SlaApplied.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * The SLA Applied object contains the details for which SLA has been applied to this conversation.
+ * Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.
+ */
+export interface SlaApplied {
+    /** object type */
+    type?: string;
+    /** The name of the SLA as given by the teammate when it was created. */
+    sla_name?: string;
+    /** SLA statuses: - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. */
+    sla_status?: Intercom.SlaAppliedSlaStatus;
+}

package/api/types/SlaApplied.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/SlaAppliedSlaStatus.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * SLA statuses: - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
+ */
+export declare type SlaAppliedSlaStatus = "hit" | "missed" | "cancelled" | "active";
+export declare const SlaAppliedSlaStatus: {
+    readonly Hit: "hit";
+    readonly Missed: "missed";
+    readonly Cancelled: "cancelled";
+    readonly Active: "active";
+};

package/api/types/SlaAppliedSlaStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlaAppliedSlaStatus = void 0;
+exports.SlaAppliedSlaStatus = {
+    Hit: "hit",
+    Missed: "missed",
+    Cancelled: "cancelled",
+    Active: "active",
+};

package/api/types/SnoozeConversationRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to snooze a conversation
+ */
+export interface SnoozeConversationRequest {
+    /** The id of the admin who is performing the action. */
+    admin_id: string;
+    /** The time you want the conversation to reopen. */
+    snoozed_until: number;
+}

package/api/types/SnoozeConversationRequest.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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.
+ */
+export interface SocialProfile {
+    /** value is "social_profile" */
+    type?: string;
+    /** The name of the Social media profile */
+    name?: string;
+    /** The name of the Social media profile */
+    url?: string;
+}

package/api/types/SocialProfile.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/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/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,13 @@
+/**
+ * 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 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: Intercom.TagCompanyRequestCompaniesItem[];
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TagCompanyRequestCompaniesItem {
+    /** The Intercom defined id representing the company. */
+    id?: string;
+    /** The company id you have defined for the company. */
+    company_id?: string;
+}

package/api/types/TagCompanyRequestCompaniesItem.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,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../index";
+/**
+ * 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: Intercom.TagMultipleUsersRequestUsersItem[];
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TagMultipleUsersRequestUsersItem {
+    /** The Intercom defined id representing the user. */
+    id?: string;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * 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, Intercom.TicketCustomAttributesValue>;

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/TicketCustomAttributesValue.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 TicketCustomAttributesValue = string | undefined | number | boolean | unknown[] | Intercom.FileAttribute;

package/api/types/TicketCustomAttributesValue.js

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