@trii/types 2.10.726 → 2.10.728

package/dist/src/Common/Channels/MercadoLibre.d.ts

@@ -4,6 +4,7 @@ export declare class MercadoLibreConfig {
     reassign?: boolean;
     reassignTime?: number;
     reassignGroupId?: string;
+    reOpenTime?: number;
     autoResponseBusinessHours?: boolean;
     autoResponseOutOfBusinessHours?: boolean;
     autoResponseHoliday?: boolean;

package/dist/src/Common/Channels/WebChat.d.ts

@@ -4,6 +4,7 @@ export declare class WebChatConfig {
     reassign?: boolean;
     reassignTime?: number;
     reassignGroupId?: string;
+    reOpenTime?: number;
     signatureEnabled?: boolean;
     signatureText?: string;
     autoResponseBusinessHours?: boolean;

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

@@ -0,0 +1,107 @@
+export declare enum CommunicationEndpointKind {
+    PHONE = "phone",
+    EMAIL = "email",
+    PROVIDER_IDENTITY = "provider_identity"
+}
+/**
+ * Known provider identity namespaces. Contracts continue to accept strings so
+ * custom providers and namespaces can be introduced without a library update.
+ */
+export declare const providerIdentityNamespaces: {
+    readonly meta: {
+        readonly instagramUser: 'instagram_user';
+        readonly messengerUser: 'messenger_user';
+        readonly whatsappUser: 'whatsapp_user';
+    };
+    readonly telegram: {
+        readonly user: 'user';
+        readonly chat: 'chat';
+    };
+    readonly trii: {
+        readonly webchatVisitor: 'webchat_visitor';
+    };
+    readonly mercadolibre: {
+        readonly buyer: 'buyer';
+    };
+    readonly google: {
+        readonly businessMessagesUser: 'business_messages_user';
+    };
+};
+export type KnownIdentityProvider = keyof typeof providerIdentityNamespaces;
+export type KnownProviderIdentityNamespace = {
+    [TProvider in KnownIdentityProvider]: (typeof providerIdentityNamespaces)[TProvider][keyof (typeof providerIdentityNamespaces)[TProvider]];
+}[KnownIdentityProvider];
+export declare enum CommunicationEndpointStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    ORPHANED = "orphaned"
+}
+export interface ICommunicationEndpointActivity {
+    firstSeenAt?: Date;
+    lastSeenAt?: Date;
+    lastMessageInAt?: Date;
+    lastMessageOutAt?: Date;
+}
+export interface ICommunicationEndpoint {
+    id: string;
+    spaceId: string;
+    kind: CommunicationEndpointKind;
+    status: CommunicationEndpointStatus;
+    normalizedValue: string;
+    normalizationVersion: number;
+    displayValue: string;
+    phoneInfo?: IPhoneEndpointInfo;
+    emailInfo?: IEmailEndpointInfo;
+    providerIdentityInfo?: IProviderIdentityEndpointInfo;
+    activity?: ICommunicationEndpointActivity;
+    createdAt: Date;
+    createdBy?: string;
+    updatedAt?: Date;
+    updatedBy?: string;
+    inactiveAt?: Date;
+    inactiveBy?: string;
+}
+export interface IPhoneEndpointInfo {
+    e164: string;
+    isMobile: boolean;
+    country: string;
+    countryName: string;
+    /**
+     * ISO 3166-2 subdivision code when it can be resolved from the phone
+     * number, for example `AR-C` or `US-CA`. Empty when unknown, not
+     * applicable, or when the number does not identify a subdivision.
+     */
+    state: string;
+    /**
+     * Display name corresponding to `state`, for example `Córdoba` or
+     * `California`. Empty when `state` is not available.
+     */
+    stateName: string;
+}
+export interface IEmailEndpointInfo {
+    localPart: string;
+    domain: string;
+}
+export interface IProviderIdentityProfile {
+    displayName?: string;
+    username?: string;
+    imageUrl?: string;
+    imageObservedAt?: Date;
+}
+export interface IProviderIdentityEndpointInfo {
+    /** System that issues and controls the external identity. */
+    provider: string;
+    /**
+     * Provider-defined namespace in which the identity keys are valid.
+     * This is not a communication channel or a configured channel account.
+     */
+    identityNamespace: string;
+    /** Configured channel account in which the external identity is valid. */
+    channelAccountId: string;
+    profile?: IProviderIdentityProfile;
+}
+export interface ICommunicationEndpointSnapshot {
+    endpointId: string;
+    kind: CommunicationEndpointKind;
+    displayValue: string;
+}

package/dist/src/Contacts/CommunicationEndpoint.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunicationEndpointStatus = exports.providerIdentityNamespaces = exports.CommunicationEndpointKind = void 0;
+var CommunicationEndpointKind;
+(function (CommunicationEndpointKind) {
+    CommunicationEndpointKind["PHONE"] = "phone";
+    CommunicationEndpointKind["EMAIL"] = "email";
+    CommunicationEndpointKind["PROVIDER_IDENTITY"] = "provider_identity";
+})(CommunicationEndpointKind || (exports.CommunicationEndpointKind = CommunicationEndpointKind = {}));
+/**
+ * Known provider identity namespaces. Contracts continue to accept strings so
+ * custom providers and namespaces can be introduced without a library update.
+ */
+exports.providerIdentityNamespaces = {
+    meta: {
+        instagramUser: 'instagram_user',
+        messengerUser: 'messenger_user',
+        whatsappUser: 'whatsapp_user',
+    },
+    telegram: {
+        user: 'user',
+        chat: 'chat',
+    },
+    trii: {
+        webchatVisitor: 'webchat_visitor',
+    },
+    mercadolibre: {
+        buyer: 'buyer',
+    },
+    google: {
+        businessMessagesUser: 'business_messages_user',
+    },
+};
+var CommunicationEndpointStatus;
+(function (CommunicationEndpointStatus) {
+    CommunicationEndpointStatus["ACTIVE"] = "active";
+    CommunicationEndpointStatus["INACTIVE"] = "inactive";
+    CommunicationEndpointStatus["ORPHANED"] = "orphaned";
+})(CommunicationEndpointStatus || (exports.CommunicationEndpointStatus = CommunicationEndpointStatus = {}));

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

@@ -0,0 +1,9 @@
+export interface ICommunicationMethod {
+    endpointId: string;
+    isFavorite: boolean;
+    label: string;
+    note: string;
+    sortOrder: number;
+    linkedAt: Date;
+    linkedBy?: string;
+}

package/dist/src/Contacts/CommunicationMethod.js

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

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

@@ -14,7 +14,7 @@ export interface IBusiness {
     counters?: ICounters;
     name: string;
     imageUrl: string;
-    owner?: string;
+    ownerUserId?: string;
     membersId: string[];
     members: IContactInfo[];
     phones: IContactAddress[];
@@ -54,7 +54,7 @@ export interface IContact {
     lastName: string;
     imageUrl: string;
     birthDate?: Date | null;
-    owner?: string;
+    ownerUserId?: string;
     businessId?: string;
     businessName?: string;
     phones: IContactAddress[];

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

@@ -7,3 +7,5 @@ export * from './Import';
 export * from './Relationship';
 export * from './options';
 export * from './DuplicateContact';
+export * from './CommunicationEndpoint';
+export * from './CommunicationMethod';

package/dist/src/Contacts/index.js

@@ -23,3 +23,5 @@ __exportStar(require("./Import"), exports);
 __exportStar(require("./Relationship"), exports);
 __exportStar(require("./options"), exports);
 __exportStar(require("./DuplicateContact"), exports);
+__exportStar(require("./CommunicationEndpoint"), exports);
+__exportStar(require("./CommunicationMethod"), exports);

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

@@ -0,0 +1,181 @@
+import { ID } from './Conversation';
+export declare const CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = "conversation_assignment_events";
+export type ConversationAssignmentEventType = 'enqueued' | 'routing_started' | 'offered' | 'assigned' | 'accepted' | 'transferred' | 'released' | 'timed_out' | 'requeued';
+export type ConversationAssignmentReason = 'conversation_created' | 'routing_selected' | 'manual_assignment' | 'manual_transfer' | 'flow_routing' | 'offer_timeout' | 'assignment_timeout' | 'agent_accepted' | 'agent_released' | 'supervisor_released' | 'capacity_rebalance' | 'sla_escalation' | 'system_recovery' | 'transfer_cancelled' | 'transfer_declined';
+export type AssignmentOwnerReference = {
+    type: 'none';
+    id?: never;
+    displayName?: string;
+} | {
+    type: 'user' | 'bot' | 'flow';
+    id: ID;
+    displayName?: string;
+};
+export type AssignmentStateReference = {
+    status: 'unrouted';
+    assignmentId?: never;
+    queueId?: never;
+    owner: {
+        type: 'none';
+        id?: never;
+    } | {
+        type: 'bot' | 'flow';
+        id: ID;
+    };
+} | {
+    status: 'queued' | 'routing';
+    assignmentId: ID;
+    queueId: ID;
+    owner: {
+        type: 'none';
+        id?: never;
+    };
+} | {
+    status: 'offered' | 'assigned' | 'accepted';
+    assignmentId: ID;
+    queueId: ID;
+    owner: {
+        type: 'user';
+        id: ID;
+    };
+};
+export type AssignmentActorReference = {
+    type: 'system';
+    id?: never;
+    displayName?: string;
+} | {
+    type: 'user' | 'bot' | 'flow';
+    id: ID;
+    displayName?: string;
+};
+/**
+ * Immutable domain event stored in conversation_assignment_events.
+ *
+ * Events must only be inserted. Corrections are represented by a new event.
+ */
+export interface ConversationAssignmentEvent {
+    id: ID;
+    spaceId: ID;
+    conversationId: ID;
+    /**
+     * Monotonic order within a conversation.
+     */
+    sequence: number;
+    eventType: ConversationAssignmentEventType;
+    reason: ConversationAssignmentReason;
+    /**
+     * Undefined only when no previous assignment state existed.
+     */
+    previous?: AssignmentStateReference;
+    current: AssignmentStateReference;
+    actor: AssignmentActorReference;
+    routingDecisionId?: ID;
+    /**
+     * Version of conversations after applying the transition.
+     */
+    conversationVersion: number;
+    correlationId?: ID;
+    causationId?: ID;
+    idempotencyKey: string;
+    /**
+     * Domain time and persistence time, respectively.
+     */
+    occurredAt: Date;
+    recordedAt: Date;
+}
+export interface AcceptConversationAssignmentCommand {
+    commandId: string;
+    spaceId: ID;
+    conversationId: ID;
+    assignmentId: ID;
+    expectedConversationVersion: number;
+    actor: AssignmentActorReference;
+    requestedAt: Date;
+}
+export type AcceptConversationAssignmentRejectionCode = 'conversation_not_found' | 'assignment_not_current' | 'assignment_not_offered' | 'actor_not_authorized';
+export type AcceptConversationAssignmentResult = {
+    status: 'accepted' | 'already_applied';
+    commandId: string;
+    conversationId: ID;
+    previousVersion: number;
+    conversationVersion: number;
+    previous?: AssignmentStateReference;
+    current: AssignmentStateReference;
+    assignmentEventId: ID;
+    outboxEventId?: ID;
+} | {
+    status: 'version_conflict';
+    commandId: string;
+    conversationId: ID;
+    expectedVersion: number;
+    currentVersion: number;
+} | {
+    status: 'rejected';
+    commandId: string;
+    conversationId: ID;
+    code: AcceptConversationAssignmentRejectionCode;
+};
+export interface DeclineConversationAssignmentCommand {
+    commandId: string;
+    spaceId: ID;
+    conversationId: ID;
+    assignmentId: ID;
+    expectedConversationVersion: number;
+    actor: AssignmentActorReference;
+    requestedAt: Date;
+}
+export type DeclineConversationAssignmentRejectionCode = 'conversation_not_found' | 'assignment_not_current' | 'assignment_not_offered' | 'actor_not_authorized';
+export type DeclineConversationAssignmentResult = {
+    status: 'declined' | 'already_applied';
+    commandId: string;
+    conversationId: ID;
+    previousVersion: number;
+    conversationVersion: number;
+    previous?: AssignmentStateReference;
+    current: AssignmentStateReference;
+    assignmentEventId: ID;
+    outboxEventId?: ID;
+} | {
+    status: 'version_conflict';
+    commandId: string;
+    conversationId: ID;
+    expectedVersion: number;
+    currentVersion: number;
+} | {
+    status: 'rejected';
+    commandId: string;
+    conversationId: ID;
+    code: DeclineConversationAssignmentRejectionCode;
+};
+export interface CancelConversationAssignmentCommand {
+    commandId: string;
+    spaceId: ID;
+    conversationId: ID;
+    assignmentId: ID;
+    expectedConversationVersion: number;
+    actor: AssignmentActorReference;
+    requestedAt: Date;
+}
+export type CancelConversationAssignmentRejectionCode = 'conversation_not_found' | 'assignment_not_current' | 'assignment_not_cancellable' | 'actor_not_authorized';
+export type CancelConversationAssignmentResult = {
+    status: 'cancelled' | 'already_applied';
+    commandId: string;
+    conversationId: ID;
+    previousVersion: number;
+    conversationVersion: number;
+    previous?: AssignmentStateReference;
+    current: AssignmentStateReference;
+    assignmentEventId: ID;
+    outboxEventId?: ID;
+} | {
+    status: 'version_conflict';
+    commandId: string;
+    conversationId: ID;
+    expectedVersion: number;
+    currentVersion: number;
+} | {
+    status: 'rejected';
+    commandId: string;
+    conversationId: ID;
+    code: CancelConversationAssignmentRejectionCode;
+};

package/dist/src/Conversations/Assignment.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = void 0;
+exports.CONVERSATION_ASSIGNMENT_EVENTS_COLLECTION = 'conversation_assignment_events';