@trii/types 2.10.677 → 2.10.678

package/dist/src/Contacts/contacts.d.ts

@@ -0,0 +1,269 @@
+import { Common } from "../index";
+export interface IContactInfo {
+    id: string;
+    name: string;
+    imageUrl?: string;
+    isBusiness: boolean | false;
+    contactAddresses: IContactAddress[];
+    businessName?: string;
+    businessId?: string;
+}
+export interface IBusiness {
+    id: string;
+    spaceId: string;
+    counters?: ICounters;
+    name: string;
+    imageUrl: string;
+    owner?: string;
+    membersId: string[];
+    members: IContactInfo[];
+    phones: IContactAddress[];
+    emails: IContactAddress[];
+    ims_instagram: IContactAddress[];
+    ims_facebook: IContactAddress[];
+    ims_webchat: IContactAddress[];
+    ims_whatsapp: IContactAddress[];
+    ims_mercadolibre: IContactAddress[];
+    ims_rcs: IContactAddress[];
+    address1: IContactPostalAddress;
+    address2: IContactPostalAddress;
+    tags: IContactTag[];
+    properties: Property[];
+    hasDuplicates: boolean | false;
+    duplicateIds: string[];
+    origin: ContactOrigin;
+    createdAt?: Date | null;
+    createdBy?: string | null;
+    updatedAt?: Date | null;
+    updatedBy?: string | null;
+    deletedAt?: Date | null;
+    deletedBy?: string | null;
+}
+export interface ICounters {
+    conversations: number;
+    documents: number;
+    events: number;
+    notes: number;
+}
+export interface IContact {
+    id: string;
+    spaceId: string;
+    counters?: ICounters;
+    name: string;
+    firstName: string;
+    lastName: string;
+    imageUrl: string;
+    birthDate?: Date | null;
+    owner?: string;
+    businessId?: string;
+    businessName?: string;
+    phones: IContactAddress[];
+    emails: IContactAddress[];
+    ims_instagram: IContactAddress[];
+    ims_facebook: IContactAddress[];
+    ims_webchat: IContactAddress[];
+    ims_whatsapp: IContactAddress[];
+    ims_mercadolibre: IContactAddress[];
+    ims_rcs: IContactAddress[];
+    address1: IContactPostalAddress;
+    address2: IContactPostalAddress;
+    tags: IContactTag[];
+    properties: Property[];
+    hasDuplicates: boolean | false;
+    duplicateIds: string[];
+    isSpam: boolean;
+    fechaUltMsg?: Date;
+    origin: ContactOrigin;
+    createdAt?: Date | null;
+    createdBy?: string | null;
+    updatedAt?: Date | null;
+    updatedBy?: string | null;
+    deletedAt?: Date | null;
+    deletedBy?: string | null;
+}
+export interface Property {
+    nameKey: string;
+    type: ContactField_type;
+    value: any;
+}
+export declare enum ContactOrigin {
+    MANUAL = 0,
+    IMPORT = 1,
+    CALL = 2,
+    TICKET = 3,
+    FORM = 4
+}
+export interface IContactPostalAddress {
+    street: string;
+    city: string;
+    state: string;
+    zipcode: string;
+    country: string;
+}
+export interface IContactField {
+    id: string;
+    name: string;
+    nameKey: string;
+    description: string | '';
+    placeholder: string | '';
+    type: ContactField_type;
+    typeNumberDecimalsCount: number | 0;
+    typeOptions: string[];
+    typeOptionsMultiple: boolean;
+    listItemSchema?: IContactFieldListItemSchema[];
+    order: number;
+    requiredField: boolean;
+    forContact: boolean;
+    forBusiness: boolean;
+    isDefault: boolean;
+    isSearchKey: boolean;
+    isImportKey: boolean;
+    isMultiSelect: boolean;
+    readOnly: boolean;
+    hide: boolean;
+    useMask: boolean;
+    min?: number;
+    max?: number;
+    createdAt?: string | null;
+    createdBy?: string | null;
+    deleted: boolean;
+    deletedAt?: string | null;
+}
+export interface IContactFieldListItemSchema {
+    key: string;
+    label: string;
+    type: ContactField_Item_Type;
+    required: boolean;
+    options?: string[];
+}
+export declare enum ContactField_Item_Type {
+    TEXT = 0,
+    OPTIONS = 4,
+    DATE = 6,
+    NUMBER_INTEGER = 21,
+    NUMBER_CURRENCY = 23
+}
+export declare enum ContactField_type {
+    TEXT = 0,
+    LONGTEXT = 1,
+    CURRENCY = 3,
+    OPTIONS = 4,
+    TIME = 5,
+    DATE = 6,
+    TIMERANGE = 7,
+    DATERANGE = 8,
+    ADDRESS = 11,
+    NUMBER_INTEGER = 21,
+    NUMBER_DECIMAL = 22,
+    NUMBER_CURRENCY = 23,
+    NUMBER_ACCOUNTING = 24,
+    LIST_SINGLE = 31,
+    LIST_OBJECT = 32
+}
+export interface IContactAddress {
+    id: string;
+    channelType: Common.Channels.ChannelType;
+    /**
+     * No es un id del canal de Trii.
+     * Facebook: fbPageId
+     * Instagram: igAccountId
+     * WhatsApp: cloudApiBusinessId
+     */
+    channelId?: string;
+    whatsappUserId?: string;
+    whatsappParentUserId?: string;
+    address: string;
+    profileName: string;
+    profileUrl: string;
+    profileUrlDate?: Date;
+    telInfo?: IContactTelInfo;
+    note: string;
+    isVerified: boolean;
+    isFavorite: boolean;
+    dateLastMsgIn?: Date;
+    dateLastMsgOut?: Date;
+    subscriptionsAllowed: string[];
+    subscriptionsRejected: string[];
+    createdAt: Date;
+    verifiedAt?: Date;
+    verifiedBy?: string;
+}
+export interface IContactTelInfo {
+    isMobile: boolean;
+    country: string;
+    countryName: string;
+    state: string;
+    stateName: string;
+}
+export interface IContactTag {
+    id: string;
+    name: string;
+}
+export interface ISubscription {
+    id: string;
+    spaceId: string;
+    name: string;
+    description: string;
+    createdAt: Date;
+    updatedAt?: Date;
+    deletedAt?: Date;
+}
+export interface IIntegrationButton {
+    id: number;
+    name: string;
+    enabled: boolean;
+    icon_class: string;
+    icon_color: string;
+    api_method: IntegrationButton_method;
+    api_url: string;
+    api_AuthType: string;
+    api_Auth_username: string;
+    api_Auth_password: string;
+    api_Auth_token: string;
+    api_Auth_token_url: string;
+    api_Auth_token_body: string;
+    api_Auth_APIkey_Key: string;
+    api_Auth_APIkey_Value: string;
+    api_Auth_APIkey_Addto: string;
+    api_contenttype: string;
+    api_body: string;
+    api_formatosalida: IntegrationButton_format;
+    api_Template: string;
+}
+export declare enum IntegrationButton_method {
+    GET = 1,
+    POST = 2
+}
+export declare enum IntegrationButton_format {
+    JSON = 1,
+    HTML = 2,
+    HTML_newtab = 3
+}
+export declare class GooglePeopleIntegration {
+    googleAccount: GoogleAccountInfo;
+    autoUpdate: boolean;
+    updateBy: string;
+    updateAt: Date;
+}
+export declare class GoogleAccountInfo {
+    name: string;
+    email: string;
+    imageUrl: string;
+}
+export interface IList {
+    id: string;
+    name: string;
+    description: string;
+    count: number;
+    createdAt: Date;
+}
+export interface IContactChangeLog {
+    timeStamp: Date;
+    action: ContactLogAction;
+    details: string;
+    userId: string;
+    json?: string;
+    jsonBefore?: string;
+    importTag?: string;
+}
+export type ContactLogAction = 'created' | 'updated' | 'merged' | 'deleted' | 'restored';

package/dist/src/Contacts/contacts.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoogleAccountInfo = exports.GooglePeopleIntegration = exports.IntegrationButton_format = exports.IntegrationButton_method = exports.ContactField_type = exports.ContactField_Item_Type = exports.ContactOrigin = void 0;
+var ContactOrigin;
+(function (ContactOrigin) {
+    ContactOrigin[ContactOrigin["MANUAL"] = 0] = "MANUAL";
+    ContactOrigin[ContactOrigin["IMPORT"] = 1] = "IMPORT";
+    ContactOrigin[ContactOrigin["CALL"] = 2] = "CALL";
+    ContactOrigin[ContactOrigin["TICKET"] = 3] = "TICKET";
+    ContactOrigin[ContactOrigin["FORM"] = 4] = "FORM";
+})(ContactOrigin || (exports.ContactOrigin = ContactOrigin = {}));
+var ContactField_Item_Type;
+(function (ContactField_Item_Type) {
+    ContactField_Item_Type[ContactField_Item_Type["TEXT"] = 0] = "TEXT";
+    ContactField_Item_Type[ContactField_Item_Type["OPTIONS"] = 4] = "OPTIONS";
+    ContactField_Item_Type[ContactField_Item_Type["DATE"] = 6] = "DATE";
+    ContactField_Item_Type[ContactField_Item_Type["NUMBER_INTEGER"] = 21] = "NUMBER_INTEGER";
+    ContactField_Item_Type[ContactField_Item_Type["NUMBER_CURRENCY"] = 23] = "NUMBER_CURRENCY";
+})(ContactField_Item_Type || (exports.ContactField_Item_Type = ContactField_Item_Type = {}));
+var ContactField_type;
+(function (ContactField_type) {
+    ContactField_type[ContactField_type["TEXT"] = 0] = "TEXT";
+    ContactField_type[ContactField_type["LONGTEXT"] = 1] = "LONGTEXT";
+    ContactField_type[ContactField_type["CURRENCY"] = 3] = "CURRENCY";
+    ContactField_type[ContactField_type["OPTIONS"] = 4] = "OPTIONS";
+    ContactField_type[ContactField_type["TIME"] = 5] = "TIME";
+    ContactField_type[ContactField_type["DATE"] = 6] = "DATE";
+    ContactField_type[ContactField_type["TIMERANGE"] = 7] = "TIMERANGE";
+    ContactField_type[ContactField_type["DATERANGE"] = 8] = "DATERANGE";
+    ContactField_type[ContactField_type["ADDRESS"] = 11] = "ADDRESS";
+    ContactField_type[ContactField_type["NUMBER_INTEGER"] = 21] = "NUMBER_INTEGER";
+    ContactField_type[ContactField_type["NUMBER_DECIMAL"] = 22] = "NUMBER_DECIMAL";
+    ContactField_type[ContactField_type["NUMBER_CURRENCY"] = 23] = "NUMBER_CURRENCY";
+    ContactField_type[ContactField_type["NUMBER_ACCOUNTING"] = 24] = "NUMBER_ACCOUNTING";
+    ContactField_type[ContactField_type["LIST_SINGLE"] = 31] = "LIST_SINGLE";
+    ContactField_type[ContactField_type["LIST_OBJECT"] = 32] = "LIST_OBJECT";
+})(ContactField_type || (exports.ContactField_type = ContactField_type = {}));
+var IntegrationButton_method;
+(function (IntegrationButton_method) {
+    IntegrationButton_method[IntegrationButton_method["GET"] = 1] = "GET";
+    IntegrationButton_method[IntegrationButton_method["POST"] = 2] = "POST";
+})(IntegrationButton_method || (exports.IntegrationButton_method = IntegrationButton_method = {}));
+var IntegrationButton_format;
+(function (IntegrationButton_format) {
+    IntegrationButton_format[IntegrationButton_format["JSON"] = 1] = "JSON";
+    IntegrationButton_format[IntegrationButton_format["HTML"] = 2] = "HTML";
+    IntegrationButton_format[IntegrationButton_format["HTML_newtab"] = 3] = "HTML_newtab";
+})(IntegrationButton_format || (exports.IntegrationButton_format = IntegrationButton_format = {}));
+class GooglePeopleIntegration {
+}
+exports.GooglePeopleIntegration = GooglePeopleIntegration;
+class GoogleAccountInfo {
+}
+exports.GoogleAccountInfo = GoogleAccountInfo;

package/dist/src/Contacts/index.d.ts

@@ -0,0 +1,9 @@
+export * from './contacts';
+export * from './segments';
+export * from './Label';
+export * from './Note';
+export * from './File';
+export * from './Import';
+export * from './Relationship';
+export * from './options';
+export * from './DuplicateContact';

package/dist/src/Contacts/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./contacts"), exports);
+__exportStar(require("./segments"), exports);
+__exportStar(require("./Label"), exports);
+__exportStar(require("./Note"), exports);
+__exportStar(require("./File"), exports);
+__exportStar(require("./Import"), exports);
+__exportStar(require("./Relationship"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./DuplicateContact"), exports);

package/dist/src/Contacts/options.d.ts

@@ -0,0 +1,5 @@
+import { nameFormat } from '../Spaces/spaces';
+export interface Options {
+    contactNameFormat: nameFormat;
+    allowDuplicateContactChannels: boolean;
+}

package/dist/src/Contacts/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/Contacts/segments.d.ts

@@ -0,0 +1,52 @@
+import { ContactField_type } from "./contacts";
+export interface ISegment {
+    id: string;
+    spaceId?: string | null;
+    name?: string | null;
+    description?: string | null;
+    count: number;
+    lists: ISegmentList[];
+    filter?: ISegmentFilter;
+    countLastUpdate?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    deletedAt?: string | null;
+}
+export interface ISegmentList {
+    id: string;
+    name: string | null;
+}
+export interface ISegmentFilter {
+    operator: string | 'AND';
+    groups: ISegmentFilterGroup[];
+}
+export interface ISegmentFilterGroup {
+    operator: string | 'OR';
+    items: ISegmentFilterGroupItem[];
+}
+export interface ISegmentFilterGroupItem {
+    field: string;
+    condition: string;
+    value: string;
+}
+export declare enum Segment_Filter_Operator {
+    NULL = 0,
+    LESS_THAN = 1,
+    LESS_THAN_EQUAL = 2,
+    EQUAL = 3,
+    GREATER_THAN_EQUAL = 4,
+    GREATER_THAN = 5,
+    START_WITH = 6,
+    END_WITH = 7,
+    CONTAINS = 8,
+    NOT_CONTAINS = 9,
+    ANY_VALUE = 10,
+    NOT_EQUAL = 11
+}
+export interface filter {
+    key: string;
+    type: ContactField_type;
+}
+export declare const Segment_Filter_Details: filter[];
+export declare const Segment_Filter_Geography: filter[];
+export declare const Segment_Filter_Account: filter[];

package/dist/src/Contacts/segments.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Segment_Filter_Account = exports.Segment_Filter_Geography = exports.Segment_Filter_Details = exports.Segment_Filter_Operator = void 0;
+const contacts_1 = require("./contacts");
+var Segment_Filter_Operator;
+(function (Segment_Filter_Operator) {
+    Segment_Filter_Operator[Segment_Filter_Operator["NULL"] = 0] = "NULL";
+    Segment_Filter_Operator[Segment_Filter_Operator["LESS_THAN"] = 1] = "LESS_THAN";
+    Segment_Filter_Operator[Segment_Filter_Operator["LESS_THAN_EQUAL"] = 2] = "LESS_THAN_EQUAL";
+    Segment_Filter_Operator[Segment_Filter_Operator["EQUAL"] = 3] = "EQUAL";
+    Segment_Filter_Operator[Segment_Filter_Operator["GREATER_THAN_EQUAL"] = 4] = "GREATER_THAN_EQUAL";
+    Segment_Filter_Operator[Segment_Filter_Operator["GREATER_THAN"] = 5] = "GREATER_THAN";
+    Segment_Filter_Operator[Segment_Filter_Operator["START_WITH"] = 6] = "START_WITH";
+    Segment_Filter_Operator[Segment_Filter_Operator["END_WITH"] = 7] = "END_WITH";
+    Segment_Filter_Operator[Segment_Filter_Operator["CONTAINS"] = 8] = "CONTAINS";
+    Segment_Filter_Operator[Segment_Filter_Operator["NOT_CONTAINS"] = 9] = "NOT_CONTAINS";
+    Segment_Filter_Operator[Segment_Filter_Operator["ANY_VALUE"] = 10] = "ANY_VALUE";
+    Segment_Filter_Operator[Segment_Filter_Operator["NOT_EQUAL"] = 11] = "NOT_EQUAL";
+})(Segment_Filter_Operator || (exports.Segment_Filter_Operator = Segment_Filter_Operator = {}));
+exports.Segment_Filter_Details = [
+    {
+        key: "details.name",
+        type: contacts_1.ContactField_type.TEXT
+    },
+    {
+        key: "details.email",
+        type: contacts_1.ContactField_type.TEXT
+    },
+];
+exports.Segment_Filter_Geography = [
+    {
+        key: "geography.country",
+        type: contacts_1.ContactField_type.TEXT
+    },
+    {
+        key: "details.city",
+        type: contacts_1.ContactField_type.TEXT
+    }
+];
+exports.Segment_Filter_Account = [
+    {
+        key: "account.name",
+        type: contacts_1.ContactField_type.TEXT
+    },
+    {
+        key: "account.email",
+        type: contacts_1.ContactField_type.TEXT
+    },
+    {
+        key: "account.numberOfEmployees",
+        type: contacts_1.ContactField_type.NUMBER_INTEGER
+    }
+];

package/dist/src/Conversations/Conversation.d.ts

@@ -0,0 +1,167 @@
+import { UserInfo } from "../Users/UserTrii";
+import { ILabel } from "./Label";
+import { GroupInfo } from "./Groups/Group";
+import { Channels } from "../Common/index";
+import { IContactAddress, IContactInfo } from "../Contacts/contacts";
+import { IEnding } from "./Ending";
+export interface IConversation {
+    id: string;
+    /**only for Front-End */
+    idLocal?: number;
+    spaceId: string;
+    type: ChatType;
+    ownerId: string;
+    chatName: string;
+    chatImage: string;
+    chatMembers: IChatMemeber[];
+    chatMembersCount: number;
+    whatsappGroupInfo?: IWhatsAppGroupInfo;
+    contactInfo?: IContactInfo;
+    direction: ConversationDirection;
+    remoteAddress: string;
+    remoteAddressId: string;
+    channelInfo: Channels.IChannelInfo;
+    lastMessage: string;
+    lastMessageId?: string;
+    newMessagesCount: number;
+    newMessagesUnread: boolean;
+    labels: ILabel[];
+    pinned: boolean;
+    transferBy?: string;
+    transferTo?: ConversationAssigned;
+    expired: boolean;
+    expiredAssignedTo: ConversationAssigned;
+    status: ConversationSatus;
+    assignedTo?: ConversationAssigned;
+    participants: UserInfo[];
+    archived: boolean;
+    externalMessagingWindowEndAt?: Date;
+    workflowId?: string;
+    botStatus: ConversationBotStatus;
+    botVars: ConversationBotVar[];
+    metadata: IConversationMetadata;
+    /** Domain objects discussed or served by this conversation. */
+    contextReferences?: IConversationContextReference[];
+    finalizedAt: Date;
+    finalizedBy?: string;
+    finalizedOnWebChat: Date;
+    ending?: IEnding;
+    qualityEvaluation?: IInteractionQualityEvaluation;
+    reOpenAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export declare enum ConversationContextType {
+    TICKET = "TICKET",
+    CONVERSATION = "CONVERSATION",
+    LEAD = "LEAD",
+    DEBT = "DEBT"
+}
+export interface IConversationContextReference {
+    entityType: ConversationContextType;
+    entityId: string;
+    role?: string;
+    linkedAt: Date;
+    linkedBy?: string;
+}
+export interface IWhatsAppGroupInfo {
+    whatsappGroupId: string;
+    groupInviteCode: string;
+    members: IWhatsAppGroupMember[];
+    invitationTemplateId: string;
+    subject: string;
+    description: string;
+}
+export interface IWhatsAppGroupMember {
+    contactAddress: IContactAddress;
+    contactId: string;
+    name: string;
+    contactInfo: IContactInfo;
+    joinedAt?: Date;
+}
+export interface IInteractionQualityEvaluation {
+    courtesy: EvaluationCriterion;
+    clarity: EvaluationCriterion;
+    empathy: EvaluationCriterion;
+    proactivity: EvaluationCriterion;
+    resolution: EvaluationCriterion;
+    responseTime: EvaluationCriterion;
+    overallScore: EvaluationCriterion;
+}
+export interface EvaluationCriterion {
+    value: number;
+    comment: string;
+}
+export interface IConversationMetadata {
+    nickname?: string;
+    email?: string;
+    ip?: string;
+    country?: string;
+    region?: string;
+    city?: string;
+    timezone?: string;
+    latitude?: number;
+    longitude?: number;
+    isp?: string;
+    userAgent?: string;
+    browser?: string;
+    os?: string;
+    deviceType?: 'Desktop' | 'Mobile' | 'Tablet';
+    language?: string;
+    referer?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    sessionId?: string;
+    screenResolution?: string;
+}
+export declare enum ConversationBotStatus {
+    NONE = 0,
+    WAITING = 1,
+    PROCESSING = 2,
+    FINALIZED = 4,
+    CANCELED = 5
+}
+export declare class ConversationBotVar {
+    title: string;
+    value: string;
+}
+export declare enum ChatType {
+    /**Conversation with a external channel/contact */
+    EXTERNAL = 0,
+    /**messages between two users */
+    DIRECT = 1,
+    /**messages between multiple users */
+    GROUP = 2,
+    /**Messages to discuss a conversation */
+    DISCUSS_CONVERSATION = 11,
+    /**Messages to discuss a ticket */
+    DISCUSS_TICKET = 12
+}
+export interface IChatMemeber {
+    joinTimeStamp: Date;
+    isAdmin: boolean;
+    userId: string;
+    user: UserInfo;
+}
+export declare class ConversationAssigned {
+    groupInfo?: GroupInfo;
+    userInfo?: UserInfo;
+    userIds?: string[];
+}
+export declare enum ConversationDirection {
+    INBOUND = 1,
+    OUTBOUND = 2
+}
+export declare enum ConversationSatus {
+    NEW = 1,
+    ACTIVE = 2,
+    FINALIZED = 3,
+    ARCHIVED = 4
+}
+export declare enum AssignMethod {
+    ALL = 0,
+    ROUND_ROBIN = 1,
+    RANDOM = 2,
+    LEAST_BUSY = 3
+}