intercom-client 3.2.0 → 4.0.0

package/dist/company.js

@@ -0,0 +1,114 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var scroll_1 = __importDefault(require("./scroll"));
+var url_1 = require("./util/url");
+var Company = /** @class */ (function () {
+    function Company(client) {
+        this.client = client;
+        this.baseUrl = 'companies';
+        this.client = client;
+        this.scroll = new scroll_1.default(this.client, this.baseUrl);
+    }
+    Company.prototype.create = function (_a) {
+        var createdAt = _a.createdAt, companyId = _a.companyId, name = _a.name, monthlySpend = _a.monthlySpend, plan = _a.plan, size = _a.size, website = _a.website, industry = _a.industry, customAttributes = _a.customAttributes;
+        var data = {
+            remote_created_at: createdAt,
+            company_id: companyId,
+            name: name,
+            monthly_spend: monthlySpend,
+            plan: plan,
+            size: size,
+            website: website,
+            industry: industry,
+            custom_attributes: customAttributes,
+        };
+        return this.client.post({
+            url: "/".concat(this.baseUrl),
+            data: data,
+        });
+    };
+    Company.prototype.update = function (_a) {
+        var createdAt = _a.createdAt, companyId = _a.companyId, name = _a.name, monthlySpend = _a.monthlySpend, plan = _a.plan, size = _a.size, website = _a.website, industry = _a.industry, customAttributes = _a.customAttributes;
+        var data = {
+            remote_created_at: createdAt,
+            name: name,
+            monthly_spend: monthlySpend,
+            plan: plan,
+            size: size,
+            website: website,
+            industry: industry,
+            custom_attributes: customAttributes,
+        };
+        return this.client.put({
+            url: "/".concat(this.baseUrl, "/").concat(companyId),
+            data: data,
+        });
+    };
+    Company.prototype.find = function (_a) {
+        var companyId = _a.companyId, name = _a.name;
+        var query = {
+            company_id: companyId,
+            name: name,
+        };
+        return this.client.get({
+            url: "/".concat(this.baseUrl),
+            params: (0, url_1.encodeParamsForURL)(query),
+        });
+    };
+    Company.prototype.delete = function (_a) {
+        var id = _a.id;
+        return this.client.delete({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+        });
+    };
+    Company.prototype.list = function (_a) {
+        var page = _a.page, per_page = _a.perPage, order = _a.order, tag_id = _a.tagId, segment_id = _a.segmentId;
+        var params = {
+            page: page,
+            per_page: per_page,
+            order: order,
+            tag_id: tag_id,
+            segment_id: segment_id,
+        };
+        return this.client.get({
+            url: "/".concat(this.baseUrl),
+            params: params,
+        });
+    };
+    Company.prototype.attachContact = function (_a) {
+        var contactId = _a.contactId, companyId = _a.companyId;
+        var data = {
+            id: companyId,
+        };
+        return this.client.post({
+            url: "/".concat(this.client.contacts.baseUrl, "/").concat(contactId, "/").concat(this.baseUrl),
+            data: data,
+        });
+    };
+    Company.prototype.detachContact = function (_a) {
+        var contactId = _a.contactId, companyId = _a.companyId;
+        return this.client.delete({
+            url: "/".concat(this.client.contacts.baseUrl, "/").concat(contactId, "/").concat(this.baseUrl, "/").concat(companyId),
+        });
+    };
+    Company.prototype.listAttachedContacts = function (_a) {
+        var companyId = _a.companyId, page = _a.page, perPage = _a.perPage;
+        var params = { page: page, perPage: perPage };
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(companyId, "/").concat(this.client.contacts.baseUrl),
+            params: params,
+        });
+    };
+    Company.prototype.listAttachedSegments = function (_a) {
+        var companyId = _a.companyId;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(companyId, "/").concat(this.client.segments.baseUrl),
+        });
+    };
+    return Company;
+}());
+exports.default = Company;
+//# sourceMappingURL=company.js.map

package/dist/company.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.js","sourceRoot":"","sources":["../../lib/company.ts"],"names":[],"mappings":";;;;;AAWA,oDAA8B;AAE9B,kCAAgD;AAEhD;IAII,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAH3B,YAAO,GAAG,WAAW,CAAC;QAIlC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAU,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC;IACD,wBAAM,GAAN,UAAO,EAUa;YAThB,SAAS,eAAA,EACT,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,IAAI,UAAA,EACJ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,QAAQ,cAAA,EACR,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,SAAS;YAC5B,UAAU,EAAE,SAAS;YACrB,IAAI,MAAA;YACJ,aAAa,EAAE,YAAY;YAC3B,IAAI,MAAA;YACJ,IAAI,MAAA;YACJ,OAAO,SAAA;YACP,QAAQ,UAAA;YACR,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAUa;YAThB,SAAS,eAAA,EACT,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,IAAI,UAAA,EACJ,IAAI,UAAA,EACJ,OAAO,aAAA,EACP,QAAQ,cAAA,EACR,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAG;YACT,iBAAiB,EAAE,SAAS;YAC5B,IAAI,MAAA;YACJ,aAAa,EAAE,YAAY;YAC3B,IAAI,MAAA;YACJ,IAAI,MAAA;YACJ,OAAO,SAAA;YACP,QAAQ,UAAA;YACR,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,CAAE;YACpC,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAAoC;YAAlC,SAAS,eAAA,EAAE,IAAI,UAAA;QAClB,IAAM,KAAK,GAAG;YACV,UAAU,EAAE,SAAS;YACrB,IAAI,MAAA;SACP,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,EAAE,IAAA,wBAAkB,EACtB,KAAuD,CAC1D;SACJ,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAAyB;YAAvB,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAwB;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAMe;YALhB,IAAI,UAAA,EACK,QAAQ,aAAA,EACjB,KAAK,WAAA,EACE,MAAM,WAAA,EACF,UAAU,eAAA;QAErB,IAAM,MAAM,GAAG;YACX,IAAI,MAAA;YACJ,QAAQ,UAAA;YACR,KAAK,OAAA;YACL,MAAM,QAAA;YACN,UAAU,YAAA;SACb,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAwB;YAC1C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,+BAAa,GAAb,UAAc,EAA2C;YAAzC,SAAS,eAAA,EAAE,SAAS,eAAA;QAChC,IAAM,IAAI,GAAG;YACT,EAAE,EAAE,SAAS;SAChB,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,OAAO,CAAE;YACpE,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,+BAAa,GAAb,UAAc,EAA2C;YAAzC,SAAS,eAAA,EAAE,SAAS,eAAA;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAgB;YACrC,GAAG,EAAE,WAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,OAAO,cAAI,SAAS,CAAE;SACpF,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAIM;YAHvB,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,OAAO,aAAA;QAEP,IAAM,MAAM,GAAG,EAAE,IAAI,MAAA,EAAE,OAAO,SAAA,EAAE,CAAC;QAEjC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA2B;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAE;YACpE,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAAuC;YAArC,SAAS,eAAA;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA+B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,SAAS,cAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAE;SACvE,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AArID,IAqIC"}

package/dist/contact/contact.types.d.ts

@@ -0,0 +1,82 @@
+import { JavascriptObject, Role, Timestamp } from '../common/common.types';
+export interface ContactObject {
+    type: 'contact';
+    id: string;
+    workspace_id: string;
+    external_id: string;
+    role: Role;
+    email: string;
+    phone: string;
+    name: string;
+    avatar: string;
+    owner_id: number;
+    social_profiles: Array<SocialProfileObject>;
+    has_hard_bounced: boolean;
+    marked_email_as_spam: boolean;
+    unsubscribed_from_emails: boolean;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    signed_up_at: Timestamp;
+    last_seen_at: Timestamp;
+    last_replied_at: Timestamp;
+    last_contacted_at: Timestamp;
+    last_email_opened_at: Timestamp;
+    last_email_clicked_at: Timestamp;
+    language_override: string;
+    browser: string;
+    browser_version: string;
+    browser_language: string;
+    os: string;
+    location: LocationObject;
+    android_app_name: string | null;
+    android_app_version: string | null;
+    android_device: string | null;
+    android_os_version: string | null;
+    android_sdk_version: string | null;
+    android_last_seen_at: Timestamp | null;
+    ios_app_name: string | null;
+    ios_app_version: string | null;
+    ios_device: string | null;
+    ios_os_version: string | null;
+    ios_sdk_version: string | null;
+    ios_last_seen_at: Timestamp | null;
+    custom_attributes: JavascriptObject;
+    tags: AddressableList;
+    notes: AddressableList;
+    companies: AddressableList;
+    opted_in_subscription_types: AddressableList;
+    opted_out_subscription_tyes: AddressableList;
+    referrer: string;
+    utm_campaign: string | null;
+    utm_content: string | null;
+    utm_medium: string | null;
+    utm_source: string | null;
+    utm_term: string | null;
+}
+interface LocationObject {
+    type: 'location';
+    country: string;
+    region: string;
+    city: string;
+    country_code: string;
+    continent_code: string;
+}
+interface SocialProfileObject {
+    type: 'social_profile';
+    name: string;
+    url: string;
+}
+interface AddressableList {
+    type: 'list';
+    data: Array<AddressableObject>;
+    url: string;
+    total_count: number;
+    has_more: boolean;
+}
+interface AddressableObject {
+    type: 'company' | 'note' | 'tag';
+    id: string;
+    url: string;
+}
+export {};
+//# sourceMappingURL=contact.types.d.ts.map

package/dist/contact/contact.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.types.d.ts","sourceRoot":"","sources":["../../../lib/contact/contact.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;IAClC,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,oBAAoB,EAAE,SAAS,CAAC;IAChC,qBAAqB,EAAE,SAAS,CAAC;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,cAAc,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,oBAAoB,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,SAAS,GAAG,IAAI,CAAC;IACnC,iBAAiB,EAAE,gBAAgB,CAAC;IACpC,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,eAAe,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,2BAA2B,EAAE,eAAe,CAAC;IAC7C,2BAA2B,EAAE,eAAe,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,UAAU,cAAc;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,mBAAmB;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACf;AAED,UAAU,eAAe;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACf"}

package/dist/contact/contact.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contact.types.js.map

package/dist/contact/contact.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.types.js","sourceRoot":"","sources":["../../../lib/contact/contact.types.ts"],"names":[],"mappings":""}

package/dist/contact.d.ts

@@ -0,0 +1,121 @@
+import { Client } from '.';
+import { ContactObject } from './contact/contact.types';
+import { GenericDeletedResponse, GenericSearchFilters, Paginated } from './common/common.types';
+import { ListCompaniesResponse } from './company/company.types';
+import { SegmentObject } from './segment/segment.types';
+import { TagObject } from './tag/tag.types';
+import { SubscriptionObject } from './subscription/subscription.types';
+export default class Contact {
+    private readonly client;
+    readonly baseUrl = "contacts";
+    constructor(client: Client);
+    createUser({ externalId, email, phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromEmails, customAttributes, }: CreateUserData): Promise<ContactObject>;
+    createLead(data?: CreateLeadData): Promise<ContactObject>;
+    find({ id }: RetrieveContactData): Promise<ContactObject>;
+    update({ id, role, externalId, email, phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromMails, customAttributes, }: UpdateContactData): Promise<ContactObject>;
+    mergeLeadInUser({ leadId, userId }: MergeLeadInUserContactData): Promise<ContactObject>;
+    search({ data }: SearchContactRequest): Promise<SearchContactResponse>;
+    list({ perPage, startingAfter }: ListAllContactsData): Promise<ListContactsResponse>;
+    delete({ id }: DeleteContactData): Promise<DeleteContactResponse>;
+    archive({ id }: ArchiveContactData): Promise<ArchiveContactResponse>;
+    unarchive({ id }: UnarchiveContactData): Promise<ArchiveContactResponse>;
+    listAttachedCompanies({ id, perPage, page }: ListAttachedCompaniesData): Promise<ListCompaniesResponse>;
+    listAttachedTags({ id }: RetrieveContactData): Promise<ListAttachedTagsResponse>;
+    listAttachedSegments({ id }: RetrieveContactData): Promise<ListAttachedSegmentsResponse>;
+    listAttachedEmailSubscriptions({ id }: RetrieveContactData): Promise<ListAttachedEmailSubscriptionsResponse>;
+}
+declare type CreateContactRequest = Pick<ContactObject, 'role'> & Partial<Pick<ContactObject, 'external_id' | 'email' | 'phone' | 'name' | 'avatar' | 'signed_up_at' | 'last_seen_at' | 'owner_id' | 'unsubscribed_from_emails' | 'custom_attributes'>>;
+interface CreateUserDataBase {
+    phone?: CreateContactRequest['phone'];
+    name?: CreateContactRequest['name'];
+    email?: CreateContactRequest['email'];
+    avatar?: CreateContactRequest['avatar'];
+    signedUpAt?: CreateContactRequest['signed_up_at'];
+    lastSeenAt?: CreateContactRequest['last_seen_at'];
+    ownerId?: CreateContactRequest['owner_id'];
+    isUnsubscribedFromEmails?: CreateContactRequest['unsubscribed_from_emails'];
+    customAttributes?: CreateContactRequest['custom_attributes'];
+}
+interface CreateUserData extends CreateUserDataBase {
+    externalId?: string;
+}
+declare type CreateLeadData = CreateUserDataBase;
+interface RetrieveContactData {
+    id: string;
+}
+declare type UpdateContactRequest = Partial<Pick<ContactObject, 'role' | 'external_id' | 'email' | 'phone' | 'name' | 'avatar' | 'signed_up_at' | 'last_seen_at' | 'owner_id' | 'unsubscribed_from_emails' | 'custom_attributes'>>;
+declare type UpdateContactData = {
+    id: string;
+    role?: UpdateContactRequest['role'];
+    externalId?: UpdateContactRequest['external_id'];
+    email?: UpdateContactRequest['email'];
+    phone?: UpdateContactRequest['phone'];
+    name?: UpdateContactRequest['name'];
+    avatar?: UpdateContactRequest['avatar'];
+    signedUpAt?: UpdateContactRequest['signed_up_at'];
+    lastSeenAt?: UpdateContactRequest['last_seen_at'];
+    ownerId?: UpdateContactRequest['owner_id'];
+    isUnsubscribedFromMails?: UpdateContactRequest['unsubscribed_from_emails'];
+    customAttributes?: UpdateContactRequest['custom_attributes'];
+};
+interface DeleteContactData {
+    id: string;
+}
+declare type DeleteContactResponse = GenericDeletedResponse<'contact'>;
+interface ArchiveContactData {
+    id: string;
+}
+interface ArchiveContactResponse {
+    id: string;
+    object: ContactObject;
+    archived: boolean;
+}
+declare type UnarchiveContactData = ArchiveContactData;
+interface MergeLeadInUserContactData {
+    leadId: string;
+    userId: string;
+}
+export declare enum SearchContactOrderBy {
+    ASC = "ascending",
+    DESC = "descending"
+}
+interface SearchContactPagination {
+    pagination: {
+        per_page: number;
+        starting_after?: string;
+    };
+}
+interface SearchContactOrder {
+    sort: {
+        field: string;
+        order: SearchContactOrderBy;
+    };
+}
+interface SearchContactRequest {
+    data: GenericSearchFilters & Partial<SearchContactPagination> & Partial<SearchContactOrder>;
+}
+declare type SearchContactResponse = Paginated<ContactObject>;
+interface ListAllContactsData {
+    perPage?: number;
+    startingAfter?: string;
+}
+declare type ListContactsResponse = Paginated<ContactObject>;
+declare type ListAttachedTagsResponse = {
+    type: string;
+    tags: Array<TagObject>;
+};
+declare type ListAttachedSegmentsResponse = {
+    type: string;
+    data: Array<SegmentObject>;
+};
+declare type ListAttachedEmailSubscriptionsResponse = {
+    type: string;
+    data: Array<SubscriptionObject>;
+};
+declare type ListAttachedCompaniesData = {
+    id: string;
+    perPage?: number;
+    page?: number;
+};
+export {};
+//# sourceMappingURL=contact.d.ts.map

package/dist/contact.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../../lib/contact.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EACH,sBAAsB,EACtB,oBAAoB,EACpB,SAAS,EAEZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,MAAM,CAAC,OAAO,OAAO,OAAO;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,SAAgB,OAAO,cAAc;gBAER,MAAM,EAAE,MAAM;IAG3C,UAAU,CAAC,EACP,UAAU,EACV,KAAK,EACL,KAAK,EACL,IAAI,EACJ,MAAM,EACN,UAAU,EACV,UAAU,EACV,OAAO,EACP,wBAAwB,EACxB,gBAAgB,GACnB,EAAE,cAAc;IAoBjB,UAAU,CAAC,IAAI,CAAC,EAAE,cAAc;IAkBhC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAKhC,MAAM,CAAC,EACH,EAAE,EACF,IAAI,EACJ,UAAU,EACV,KAAK,EACL,KAAK,EACL,IAAI,EACJ,MAAM,EACN,UAAU,EACV,UAAU,EACV,OAAO,EACP,uBAAuB,EACvB,gBAAgB,GACnB,EAAE,iBAAiB;IAoBpB,eAAe,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,0BAA0B;IAW9D,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,oBAAoB;IAMrC,IAAI,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,mBAAmB;IAUpD,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB;IAKhC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,kBAAkB;IAKlC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,oBAAoB;IAKtC,qBAAqB,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,yBAAyB;IAUtE,gBAAgB,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAK5C,oBAAoB,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;IAKhD,8BAA8B,CAAC,EAAE,EAAE,EAAE,EAAE,mBAAmB;CAK7D;AAED,aAAK,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,GACnD,OAAO,CACH,IAAI,CACA,aAAa,EACX,aAAa,GACb,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,cAAc,GACd,cAAc,GACd,UAAU,GACV,0BAA0B,GAC1B,mBAAmB,CACxB,CACJ,CAAC;AAEN,UAAU,kBAAkB;IACxB,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC3C,wBAAwB,CAAC,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IAC5E,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAChE;AAED,UAAU,cAAe,SAAQ,kBAAkB;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,aAAK,cAAc,GAAG,kBAAkB,CAAC;AAGzC,UAAU,mBAAmB;IACzB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,aAAK,oBAAoB,GAAG,OAAO,CAC/B,IAAI,CACA,aAAa,EACX,MAAM,GACN,aAAa,GACb,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,cAAc,GACd,cAAc,GACd,UAAU,GACV,0BAA0B,GAC1B,mBAAmB,CACxB,CACJ,CAAC;AAEF,aAAK,iBAAiB,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,UAAU,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,UAAU,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAC3C,uBAAuB,CAAC,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IAC3E,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;CAChE,CAAC;AAEF,UAAU,iBAAiB;IACvB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,aAAK,qBAAqB,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAE/D,UAAU,kBAAkB;IACxB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,sBAAsB;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,aAAK,oBAAoB,GAAG,kBAAkB,CAAC;AAS/C,UAAU,0BAA0B;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,oBAAoB;IAC5B,GAAG,cAAc;IACjB,IAAI,eAAe;CACtB;AACD,UAAU,uBAAuB;IAC7B,UAAU,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACL;AAED,UAAU,kBAAkB;IACxB,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,oBAAoB,CAAC;KAC/B,CAAC;CACL;AAED,UAAU,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB,GAC1B,OAAO,CAAC,uBAAuB,CAAC,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/B;AAED,aAAK,qBAAqB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAOtD,UAAU,mBAAmB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,aAAK,oBAAoB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAErD,aAAK,wBAAwB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC1B,CAAC;AAEF,aAAK,4BAA4B,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAC9B,CAAC;AAEF,aAAK,sCAAsC,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACnC,CAAC;AAEF,aAAK,yBAAyB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/contact.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchContactOrderBy = void 0;
+var common_types_1 = require("./common/common.types");
+var Contact = /** @class */ (function () {
+    function Contact(client) {
+        this.client = client;
+        this.baseUrl = 'contacts';
+        this.client = client;
+    }
+    Contact.prototype.createUser = function (_a) {
+        var externalId = _a.externalId, email = _a.email, phone = _a.phone, name = _a.name, avatar = _a.avatar, signedUpAt = _a.signedUpAt, lastSeenAt = _a.lastSeenAt, ownerId = _a.ownerId, isUnsubscribedFromEmails = _a.isUnsubscribedFromEmails, customAttributes = _a.customAttributes;
+        var requestData = {
+            role: common_types_1.Role.USER,
+            external_id: externalId,
+            email: email,
+            phone: phone,
+            name: name,
+            avatar: avatar,
+            signed_up_at: signedUpAt,
+            last_seen_at: lastSeenAt,
+            owner_id: ownerId,
+            unsubscribed_from_emails: isUnsubscribedFromEmails,
+            custom_attributes: customAttributes,
+        };
+        return this.client.post({
+            url: "/".concat(this.baseUrl),
+            data: requestData,
+        });
+    };
+    Contact.prototype.createLead = function (data) {
+        var requestData = {
+            role: common_types_1.Role.LEAD,
+            phone: data === null || data === void 0 ? void 0 : data.phone,
+            email: data === null || data === void 0 ? void 0 : data.email,
+            name: data === null || data === void 0 ? void 0 : data.name,
+            avatar: data === null || data === void 0 ? void 0 : data.avatar,
+            signed_up_at: data === null || data === void 0 ? void 0 : data.signedUpAt,
+            last_seen_at: data === null || data === void 0 ? void 0 : data.lastSeenAt,
+            owner_id: data === null || data === void 0 ? void 0 : data.ownerId,
+            unsubscribed_from_emails: data === null || data === void 0 ? void 0 : data.isUnsubscribedFromEmails,
+            custom_attributes: data === null || data === void 0 ? void 0 : data.customAttributes,
+        };
+        return this.client.post({
+            url: "/".concat(this.baseUrl),
+            data: requestData,
+        });
+    };
+    Contact.prototype.find = function (_a) {
+        var id = _a.id;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+        });
+    };
+    Contact.prototype.update = function (_a) {
+        var id = _a.id, role = _a.role, externalId = _a.externalId, email = _a.email, phone = _a.phone, name = _a.name, avatar = _a.avatar, signedUpAt = _a.signedUpAt, lastSeenAt = _a.lastSeenAt, ownerId = _a.ownerId, isUnsubscribedFromMails = _a.isUnsubscribedFromMails, customAttributes = _a.customAttributes;
+        var data = {
+            role: role,
+            external_id: externalId,
+            email: email,
+            phone: phone,
+            name: name,
+            avatar: avatar,
+            signed_up_at: signedUpAt,
+            last_seen_at: lastSeenAt,
+            owner_id: ownerId,
+            unsubscribed_from_emails: isUnsubscribedFromMails,
+            custom_attributes: customAttributes,
+        };
+        return this.client.put({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+            data: data,
+        });
+    };
+    Contact.prototype.mergeLeadInUser = function (_a) {
+        var leadId = _a.leadId, userId = _a.userId;
+        var data = {
+            from: leadId,
+            into: userId,
+        };
+        return this.client.post({
+            url: "/".concat(this.baseUrl, "/merge"),
+            data: data,
+        });
+    };
+    Contact.prototype.search = function (_a) {
+        var data = _a.data;
+        return this.client.post({
+            url: "/".concat(this.baseUrl, "/search"),
+            data: data,
+        });
+    };
+    Contact.prototype.list = function (_a) {
+        var perPage = _a.perPage, startingAfter = _a.startingAfter;
+        var params = {
+            per_page: perPage,
+            starting_after: startingAfter,
+        };
+        return this.client.get({
+            url: "/".concat(this.baseUrl),
+            params: params,
+        });
+    };
+    Contact.prototype.delete = function (_a) {
+        var id = _a.id;
+        return this.client.delete({
+            url: "/".concat(this.baseUrl, "/").concat(id),
+        });
+    };
+    Contact.prototype.archive = function (_a) {
+        var id = _a.id;
+        return this.client.post({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/archive"),
+        });
+    };
+    Contact.prototype.unarchive = function (_a) {
+        var id = _a.id;
+        return this.client.post({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/unarchive"),
+        });
+    };
+    Contact.prototype.listAttachedCompanies = function (_a) {
+        var id = _a.id, perPage = _a.perPage, page = _a.page;
+        var params = {
+            per_page: perPage,
+            page: page,
+        };
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/companies"),
+            params: params,
+        });
+    };
+    Contact.prototype.listAttachedTags = function (_a) {
+        var id = _a.id;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/tags"),
+        });
+    };
+    Contact.prototype.listAttachedSegments = function (_a) {
+        var id = _a.id;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/segments"),
+        });
+    };
+    Contact.prototype.listAttachedEmailSubscriptions = function (_a) {
+        var id = _a.id;
+        return this.client.get({
+            url: "/".concat(this.baseUrl, "/").concat(id, "/subscriptions"),
+        });
+    };
+    return Contact;
+}());
+exports.default = Contact;
+//
+var SearchContactOrderBy;
+(function (SearchContactOrderBy) {
+    SearchContactOrderBy["ASC"] = "ascending";
+    SearchContactOrderBy["DESC"] = "descending";
+})(SearchContactOrderBy = exports.SearchContactOrderBy || (exports.SearchContactOrderBy = {}));
+//# sourceMappingURL=contact.js.map

package/dist/contact.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.js","sourceRoot":"","sources":["../../lib/contact.ts"],"names":[],"mappings":";;;AAEA,sDAK+B;AAM/B;IAGI,iBAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF3B,YAAO,GAAG,UAAU,CAAC;QAGjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,4BAAU,GAAV,UAAW,EAWM;YAVb,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,KAAK,WAAA,EACL,IAAI,UAAA,EACJ,MAAM,YAAA,EACN,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,OAAO,aAAA,EACP,wBAAwB,8BAAA,EACxB,gBAAgB,sBAAA;QAEhB,IAAM,WAAW,GAAyB;YACtC,IAAI,EAAE,mBAAI,CAAC,IAAI;YACf,WAAW,EAAE,UAAU;YACvB,KAAK,OAAA;YACL,KAAK,OAAA;YACL,IAAI,MAAA;YACJ,MAAM,QAAA;YACN,YAAY,EAAE,UAAU;YACxB,YAAY,EAAE,UAAU;YACxB,QAAQ,EAAE,OAAO;YACjB,wBAAwB,EAAE,wBAAwB;YAClD,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;IACP,CAAC;IACD,4BAAU,GAAV,UAAW,IAAqB;QAC5B,IAAM,WAAW,GAAyB;YACtC,IAAI,EAAE,mBAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAClB,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;YAChB,MAAM,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM;YACpB,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC9B,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU;YAC9B,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO;YACvB,wBAAwB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,wBAAwB;YACxD,iBAAiB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA2B;YAAzB,EAAE,QAAA;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAaa;YAZhB,EAAE,QAAA,EACF,IAAI,UAAA,EACJ,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,KAAK,WAAA,EACL,IAAI,UAAA,EACJ,MAAM,YAAA,EACN,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,OAAO,aAAA,EACP,uBAAuB,6BAAA,EACvB,gBAAgB,sBAAA;QAEhB,IAAM,IAAI,GAAyB;YAC/B,IAAI,MAAA;YACJ,WAAW,EAAE,UAAU;YACvB,KAAK,OAAA;YACL,KAAK,OAAA;YACL,IAAI,MAAA;YACJ,MAAM,QAAA;YACN,YAAY,EAAE,UAAU;YACxB,YAAY,EAAE,UAAU;YACxB,QAAQ,EAAE,OAAO;YACjB,wBAAwB,EAAE,uBAAuB;YACjD,iBAAiB,EAAE,gBAAgB;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAgB;YAClC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;YAC7B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,iCAAe,GAAf,UAAgB,EAA8C;YAA5C,MAAM,YAAA,EAAE,MAAM,YAAA;QAC5B,IAAM,IAAI,GAAkC;YACxC,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;SACf,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB;YACnC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,WAAQ;YAC7B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAA8B;YAA5B,IAAI,UAAA;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB;YAC3C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,YAAS;YAC9B,IAAI,MAAA;SACP,CAAC,CAAC;IACP,CAAC;IACD,sBAAI,GAAJ,UAAK,EAA+C;YAA7C,OAAO,aAAA,EAAE,aAAa,mBAAA;QACzB,IAAM,MAAM,GAA2B;YACnC,QAAQ,EAAE,OAAO;YACjB,cAAc,EAAE,aAAa;SAChC,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAuB;YACzC,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,CAAE;YACvB,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,wBAAM,GAAN,UAAO,EAAyB;YAAvB,EAAE,QAAA;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAwB;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,CAAE;SAChC,CAAC,CAAC;IACP,CAAC;IACD,yBAAO,GAAP,UAAQ,EAA0B;YAAxB,EAAE,QAAA;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAyB;YAC5C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,aAAU;SACxC,CAAC,CAAC;IACP,CAAC;IACD,2BAAS,GAAT,UAAU,EAA4B;YAA1B,EAAE,QAAA;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAA2B;YAC9C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,eAAY;SAC1C,CAAC,CAAC;IACP,CAAC;IACD,uCAAqB,GAArB,UAAsB,EAAgD;YAA9C,EAAE,QAAA,EAAE,OAAO,aAAA,EAAE,IAAI,UAAA;QACrC,IAAM,MAAM,GAAG;YACX,QAAQ,EAAE,OAAO;YACjB,IAAI,MAAA;SACP,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAwB;YAC1C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,eAAY;YACvC,MAAM,QAAA;SACT,CAAC,CAAC;IACP,CAAC;IACD,kCAAgB,GAAhB,UAAiB,EAA2B;YAAzB,EAAE,QAAA;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA2B;YAC7C,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,UAAO;SACrC,CAAC,CAAC;IACP,CAAC;IACD,sCAAoB,GAApB,UAAqB,EAA2B;YAAzB,EAAE,QAAA;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA+B;YACjD,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,cAAW;SACzC,CAAC,CAAC;IACP,CAAC;IACD,gDAA8B,GAA9B,UAA+B,EAA2B;YAAzB,EAAE,QAAA;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAyC;YAC3D,GAAG,EAAE,WAAI,IAAI,CAAC,OAAO,cAAI,EAAE,mBAAgB;SAC9C,CAAC,CAAC;IACP,CAAC;IACL,cAAC;AAAD,CAAC,AAhKD,IAgKC;;AAuGD,EAAE;AACF,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC5B,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;AACvB,CAAC,EAHW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAG/B"}

package/dist/conversation/conversation.types.d.ts

@@ -0,0 +1,144 @@
+import { AdminObject } from '../admin/admin.types';
+import { JavascriptObject, Seconds, Timestamp } from '../common/common.types';
+export interface ConversationObject {
+    type: 'conversation';
+    id: string;
+    created_at: Timestamp;
+    updated_at: Timestamp;
+    source: SourceObject;
+    contacts: Array<ContactObject>;
+    teammates: Array<TeammateObject>;
+    title: string;
+    admin_assignee_id: number;
+    team_assignee_id: number;
+    custom_attributes: JavascriptObject;
+    topics: JavascriptObject;
+    open: boolean;
+    state: ConversationState;
+    read: boolean;
+    waiting_since: Timestamp;
+    snoozed_until: Timestamp;
+    tags: JavascriptObject[];
+    first_contact_reply: FirstContactReplyObject;
+    priority: ConversationPriority;
+    sla_applied: SLAObject;
+    conversation_rating: ConversationRatingObject;
+    statistics: StatisticsObject;
+    conversation_parts: ConversationPartObject;
+}
+export declare type ConversationObjectWithoutParts = Exclude<ConversationObject, 'conversation_parts'>;
+interface SourceObject {
+    type: ConversationSourceType;
+    id: string;
+    delivered_as: string;
+    subject?: string;
+    body: string;
+    author: Author;
+    attachments: JavascriptObject[];
+    url: string;
+    redacted: boolean;
+}
+interface ContactObject {
+    type: ContactType;
+    id: string;
+}
+interface TeammateObject {
+    type: 'admin';
+    id: string;
+}
+interface FirstContactReplyObject {
+    type: ConversationSourceType;
+    url: string;
+    created_at: Timestamp;
+}
+interface ConversationRatingObject {
+    rating: FromOneToFiveRating;
+    remark?: string;
+    created_at: Timestamp;
+    contact: ContactObject;
+    teammate: TeammateObject;
+}
+interface SLAObject {
+    sla_name: string;
+    sla_status: SLAStatus;
+}
+interface StatisticsObject {
+    time_to_assignment: Seconds;
+    time_to_admin_reply: Seconds;
+    time_to_first_close: Seconds;
+    time_to_last_close: Seconds;
+    median_time_to_reply: Seconds;
+    first_contact_reply_at: Seconds;
+    first_assignment_at: Seconds;
+    first_admin_reply_at: Seconds;
+    first_close_at: Seconds;
+    last_assignment_at: Seconds;
+    last_assignment_admin_reply_at: Seconds;
+    last_contact_reply_at: Seconds;
+    last_admin_reply_at: Seconds;
+    last_close_at: Seconds;
+    last_closed_by: AdminObject;
+    count_reopens: number;
+    count_assignments: number;
+    count_conversations_parts: number;
+}
+interface ConversationPartObject {
+    type: 'conversation_part.list';
+    conversation_parts: {
+        id: string;
+        part_type: string;
+        body: string;
+        created_at: Timestamp;
+        updated_at: Timestamp;
+        notified_at: Timestamp;
+        assigned_to: string | null;
+        author: Author;
+        attachments: JavascriptObject[];
+        redacted: boolean;
+    }[];
+}
+declare enum ConversationState {
+    OPEN = "open",
+    CLOSED = "closed",
+    SNOOZED = "snoozed"
+}
+declare enum ConversationPriority {
+    PRIORITY = "priority",
+    NOT_PRIORITY = "not_priority"
+}
+declare enum ConversationSourceType {
+    CONVERSATION = "conversation",
+    PUSH = "push",
+    FACEBOOK = "facebook",
+    TWITTER = "twitter",
+    EMAIL = "email"
+}
+export declare enum ContactType {
+    USER = "user",
+    LEAD = "lead"
+}
+declare enum FromOneToFiveRating {
+    ONE = 1,
+    TWO = 2,
+    THREE = 3,
+    FOUR = 4,
+    FIVE = 5
+}
+declare enum SLAStatus {
+    HIT = "hit",
+    MISSED = "missed",
+    CANCELLED = "cancelled",
+    ACTIVE = "active"
+}
+interface Author {
+    id: string;
+    type: AuthorType;
+}
+declare enum AuthorType {
+    USER = "user",
+    ADMIN = "admin",
+    BOT = "bot",
+    TEAM = "team"
+}
+export {};
+//# sourceMappingURL=conversation.types.d.ts.map

package/dist/conversation/conversation.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.types.d.ts","sourceRoot":"","sources":["../../../lib/conversation/conversation.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,gBAAgB,CAAC;IACpC,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,iBAAiB,CAAC;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,aAAa,EAAE,SAAS,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;IACzB,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,WAAW,EAAE,SAAS,CAAC;IACvB,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C,UAAU,EAAE,gBAAgB,CAAC;IAC7B,kBAAkB,EAAE,sBAAsB,CAAC;CAC9C;AAED,oBAAY,8BAA8B,GAAG,OAAO,CAChD,kBAAkB,EAClB,oBAAoB,CACvB,CAAC;AAEF,UAAU,YAAY;IAClB,IAAI,EAAE,sBAAsB,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,aAAa;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,cAAc;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;CACd;AAED,UAAU,uBAAuB;IAC7B,IAAI,EAAE,sBAAsB,CAAC;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,wBAAwB;IAC9B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED,UAAU,SAAS;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,gBAAgB;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,sBAAsB,EAAE,OAAO,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,8BAA8B,EAAE,OAAO,CAAC;IACxC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,WAAW,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yBAAyB,EAAE,MAAM,CAAC;CACrC;AAED,UAAU,sBAAsB;IAC5B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,kBAAkB,EAAE;QAChB,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,SAAS,CAAC;QACtB,UAAU,EAAE,SAAS,CAAC;QACtB,WAAW,EAAE,SAAS,CAAC;QACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,gBAAgB,EAAE,CAAC;QAChC,QAAQ,EAAE,OAAO,CAAC;KACrB,EAAE,CAAC;CACP;AAED,aAAK,iBAAiB;IAClB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,OAAO,YAAY;CACtB;AAED,aAAK,oBAAoB;IACrB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,aAAK,sBAAsB;IACvB,YAAY,iBAAiB;IAC7B,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED,oBAAY,WAAW;IACnB,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED,aAAK,mBAAmB;IACpB,GAAG,IAAI;IACP,GAAG,IAAI;IACP,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;CACX;AAED,aAAK,SAAS;IACV,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,MAAM,WAAW;CACpB;AAED,UAAU,MAAM;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,aAAK,UAAU;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB"}