intercom-client 6.3.0 → 6.4.0

package/api/resources/unstable/types/CloseConversationRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload of the request to close a conversation
+ */
+export interface CloseConversationRequest {
+    type: "admin";
+    /** The id of the admin who is performing the action. */
+    admin_id: string;
+    /** Optionally you can leave a message in the conversation to provide additional context to the user and other teammates. */
+    body?: string;
+}

package/api/resources/unstable/types/CloseConversationRequest.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/resources/unstable/types/CollectionList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * This will return a list of Collections for the App.
+ */
+export interface CollectionList {
+    /** The type of the object - `list`. */
+    type?: "list";
+    pages?: Intercom.unstable.CursorPages;
+    /** A count of the total number of collections. */
+    total_count?: number;
+    /** An array of collection objects */
+    data?: Intercom.unstable.Collection[];
+}

package/api/resources/unstable/types/CollectionList.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/resources/unstable/types/CompanyAttachedContacts.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * A list of Contact Objects
+ */
+export interface CompanyAttachedContacts {
+    /** The type of object - `list` */
+    type?: "list";
+    /** An array containing Contact Objects */
+    data?: Intercom.unstable.Contact[];
+    /** The total number of contacts */
+    total_count?: number;
+    pages?: Intercom.unstable.CursorPages;
+}

package/api/resources/unstable/types/CompanyAttachedContacts.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/resources/unstable/types/CompanyAttachedSegments.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 Segment Objects
+ */
+export interface CompanyAttachedSegments {
+    /** The type of object - `list` */
+    type?: "list";
+    /** An array containing Segment Objects */
+    data?: Intercom.unstable.Segment[];
+}

package/api/resources/unstable/types/CompanyAttachedSegments.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/resources/unstable/types/CompanyData.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An object containing data about the companies that a contact is associated with.
+ */
+export interface CompanyData {
+    /** The unique identifier for the company which is given by Intercom. */
+    id?: string;
+    /** The type of the object. Always company. */
+    type?: "company";
+    /** The relative URL of the company. */
+    url?: string;
+}

package/api/resources/unstable/types/CompanyData.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/resources/unstable/types/CompanyList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * This will return a list of companies for the App.
+ */
+export interface CompanyList {
+    /** The type of object - `list`. */
+    type?: "list";
+    pages?: Intercom.unstable.CursorPages;
+    /** The total number of companies. */
+    total_count?: number;
+    /** An array containing Company Objects. */
+    data?: Intercom.unstable.Company[];
+}

package/api/resources/unstable/types/CompanyList.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/resources/unstable/types/CompanyScroll.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.
+ */
+export interface CompanyScroll {
+    /** The type of object - `list` */
+    type?: "list";
+    data?: Intercom.unstable.Company[];
+    pages?: Intercom.unstable.CursorPages;
+    /** The total number of companies */
+    total_count?: number;
+    /** The scroll parameter to use in the next request to fetch the next page of results. */
+    scroll_param?: string;
+}

package/api/resources/unstable/types/CompanyScroll.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/resources/unstable/types/ContactArchived.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * archived contact object
+ */
+export interface ContactArchived extends Intercom.unstable.ContactReference {
+    /** Whether the contact is archived or not. */
+    archived?: boolean;
+}

package/api/resources/unstable/types/ContactArchived.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/resources/unstable/types/ContactAttachedCompanies.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * A list of Company Objects
+ */
+export interface ContactAttachedCompanies {
+    /** The type of object */
+    type?: "list";
+    /** An array containing Company Objects */
+    companies?: Intercom.unstable.Company[];
+    /** The total number of companies associated to this contact */
+    total_count?: number;
+    pages?: Intercom.unstable.PagesLink;
+}

package/api/resources/unstable/types/ContactAttachedCompanies.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/resources/unstable/types/ContactBlocked.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * blocked contact object
+ */
+export interface ContactBlocked extends Intercom.unstable.ContactReference {
+    /** Always true. */
+    blocked?: boolean;
+}

package/api/resources/unstable/types/ContactBlocked.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/resources/unstable/types/ContactCompanies.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more.
+ */
+export interface ContactCompanies {
+    /** An array of company data objects attached to the contact. */
+    data?: Intercom.unstable.CompanyData[];
+    /** Url to get more company resources for this contact */
+    url?: string;
+    /** Integer representing the total number of companies attached to this contact */
+    total_count?: number;
+    /** Whether there's more Addressable Objects to be viewed. If true, use the url to view all */
+    has_more?: boolean;
+}

package/api/resources/unstable/types/ContactCompanies.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/resources/unstable/types/ContactDeleted.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * deleted contact object
+ */
+export interface ContactDeleted extends Intercom.unstable.ContactReference {
+    /** Whether the contact is deleted or not. */
+    deleted?: boolean;
+}

package/api/resources/unstable/types/ContactDeleted.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/resources/unstable/types/ContactList.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Contacts are your users in Intercom.
+ */
+export interface ContactList {
+    /** Always list */
+    type?: "list";
+    /** The list of contact objects */
+    data?: Intercom.unstable.Contact[];
+    /** A count of the total number of objects. */
+    total_count?: number;
+    pages?: Intercom.unstable.CursorPages;
+}

package/api/resources/unstable/types/ContactList.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/resources/unstable/types/ContactLocation.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An object containing location meta data about a Intercom contact.
+ */
+export interface ContactLocation {
+    /** Always location */
+    type?: string;
+    /** The country that the contact is located in */
+    country?: string;
+    /** The overal region that the contact is located in */
+    region?: string;
+    /** The city that the contact is located in */
+    city?: string;
+}

package/api/resources/unstable/types/ContactLocation.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/resources/unstable/types/ContactNotes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.
+ */
+export interface ContactNotes {
+    /** This object represents the notes attached to a contact. */
+    data?: Intercom.unstable.AddressableList[];
+    /** Url to get more company resources for this contact */
+    url?: string;
+    /** Int representing the total number of companyies attached to this contact */
+    total_count?: number;
+    /** Whether there's more Addressable Objects to be viewed. If true, use the url to view all */
+    has_more?: boolean;
+}

package/api/resources/unstable/types/ContactNotes.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/resources/unstable/types/ContactReference.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * reference to contact object
+ */
+export interface ContactReference {
+    /** always contact */
+    type?: "contact";
+    /** The unique identifier for the contact which is given by Intercom. */
+    id?: string;
+    /** The unique identifier for the contact which is provided by the Client. */
+    external_id?: string;
+}

package/api/resources/unstable/types/ContactReference.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/resources/unstable/types/ContactReplyBaseRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ContactReplyBaseRequest {
+    message_type: "comment";
+    type: "user";
+    /** The text body of the comment. */
+    body: string;
+    /** The time the reply was created. If not provided, the current time will be used. */
+    created_at?: number;
+    /** A list of image URLs that will be added as attachments. You can include up to 10 URLs. */
+    attachment_urls?: string[];
+    /** The quick reply selection the contact wishes to respond with. These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API. */
+    reply_options?: ContactReplyBaseRequest.ReplyOptions.Item[];
+}
+export declare namespace ContactReplyBaseRequest {
+    type ReplyOptions = ReplyOptions.Item[];
+    namespace ReplyOptions {
+        interface Item {
+            /** The text of the chosen reply option. */
+            text: string;
+            /** The unique identifier for the quick reply option selected. */
+            uuid: string;
+        }
+    }
+}

package/api/resources/unstable/types/ContactReplyBaseRequest.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/resources/unstable/types/ContactReplyConversationRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+export type ContactReplyConversationRequest = Intercom.unstable.ContactReplyIntercomUserIdRequest | Intercom.unstable.ContactReplyEmailRequest | Intercom.unstable.ContactReplyUserIdRequest;

package/api/resources/unstable/types/ContactReplyConversationRequest.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/resources/unstable/types/ContactReplyEmailRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `email`
+ */
+export interface ContactReplyEmailRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The email you have defined for the user. */
+    email: string;
+    /** A list of files that will be added as attachments. */
+    attachment_files?: Intercom.unstable.ConversationAttachmentFiles[];
+}

package/api/resources/unstable/types/ContactReplyEmailRequest.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/resources/unstable/types/ContactReplyIntercomUserIdRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `intercom_user_id`
+ */
+export interface ContactReplyIntercomUserIdRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The identifier for the contact as given by Intercom. */
+    intercom_user_id: string;
+    /** A list of files that will be added as attachments. */
+    attachment_files?: Intercom.unstable.ConversationAttachmentFiles[];
+}

package/api/resources/unstable/types/ContactReplyIntercomUserIdRequest.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/resources/unstable/types/ContactReplyTicketEmailRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `email`
+ */
+export interface ContactReplyTicketEmailRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The email you have defined for the user. */
+    email: string;
+}

package/api/resources/unstable/types/ContactReplyTicketEmailRequest.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/resources/unstable/types/ContactReplyTicketIntercomUserIdRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `intercom_user_id`
+ */
+export interface ContactReplyTicketIntercomUserIdRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The identifier for the contact as given by Intercom. */
+    intercom_user_id: string;
+}

package/api/resources/unstable/types/ContactReplyTicketIntercomUserIdRequest.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/resources/unstable/types/ContactReplyTicketRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+export type ContactReplyTicketRequest = Intercom.unstable.ContactReplyTicketIntercomUserIdRequest | Intercom.unstable.ContactReplyTicketUserIdRequest | Intercom.unstable.ContactReplyTicketEmailRequest;

package/api/resources/unstable/types/ContactReplyTicketRequest.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/resources/unstable/types/ContactReplyTicketUserIdRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `user_id`
+ */
+export interface ContactReplyTicketUserIdRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The external_id you have defined for the contact. */
+    user_id: string;
+}

package/api/resources/unstable/types/ContactReplyTicketUserIdRequest.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/resources/unstable/types/ContactReplyUserIdRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * Payload of the request to reply on behalf of a contact using their `user_id`
+ */
+export interface ContactReplyUserIdRequest extends Intercom.unstable.ContactReplyBaseRequest {
+    /** The external_id you have defined for the contact. */
+    user_id: string;
+    /** A list of files that will be added as attachments. You can include up to 10 files. */
+    attachment_files?: Intercom.unstable.ConversationAttachmentFiles[];
+}

package/api/resources/unstable/types/ContactReplyUserIdRequest.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/resources/unstable/types/ContactSegments.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 segments objects attached to a specific contact.
+ */
+export interface ContactSegments {
+    /** The type of the object */
+    type?: "list";
+    /** Segment objects associated with the contact. */
+    data?: Intercom.unstable.Segment[];
+}

package/api/resources/unstable/types/ContactSegments.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/resources/unstable/types/ContactSocialProfiles.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 social profiles that a contact has.
+ */
+export interface ContactSocialProfiles {
+    /** A list of social profiles objects associated with the contact. */
+    data?: Intercom.unstable.SocialProfile[];
+}

package/api/resources/unstable/types/ContactSocialProfiles.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/resources/unstable/types/ContactSubscriptionTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.
+ */
+export interface ContactSubscriptionTypes {
+    /** This object represents the subscriptions attached to a contact. */
+    data?: Intercom.unstable.AddressableList[];
+    /** Url to get more subscription type resources for this contact */
+    url?: string;
+    /** Int representing the total number of subscription types attached to this contact */
+    total_count?: number;
+    /** Whether there's more Addressable Objects to be viewed. If true, use the url to view all */
+    has_more?: boolean;
+}

package/api/resources/unstable/types/ContactSubscriptionTypes.js

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