@trii/types 2.10.685 → 2.10.687

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

@@ -0,0 +1,227 @@
+import type { ISchedule } from '../Common/Schedules/Schedules';
+import type { ConversationEventType, ConversationStatus, ID } from './Conversation';
+import type { OutboxEvent } from './Outbox';
+export declare const CONVERSATION_SLA_POLICIES_COLLECTION = "conversation_sla_policies";
+export declare const CONVERSATION_SLA_CYCLES_COLLECTION = "conversation_sla_cycles";
+export declare const CONVERSATION_SLA_EVENTS_COLLECTION = "conversation_sla_events";
+export type ConversationSlaMetric = 'first_response' | 'next_response' | 'assignment' | 'acceptance' | 'resolution';
+/**
+ * continuous counts natural elapsed time, including nights and holidays.
+ * schedule counts only ranges allowed by the referenced customer ISchedule.
+ */
+export type ConversationSlaTimeCalculation = {
+    mode: 'continuous';
+    scheduleId?: never;
+} | {
+    mode: 'schedule';
+    scheduleId: Exclude<ISchedule['id'], null>;
+};
+export interface ConversationSlaWarningThreshold {
+    id: ID;
+    percentage: number;
+}
+export interface ConversationSlaTarget {
+    metric: ConversationSlaMetric;
+    durationSeconds: number;
+    warningThresholds: ConversationSlaWarningThreshold[];
+}
+/**
+ * Threshold received by the SLA policy write API.
+ *
+ * Existing thresholds keep their id. New thresholds may omit it so the
+ * backend can assign the canonical identifier returned in
+ * ConversationSlaPolicy.
+ */
+export interface ConversationSlaWarningThresholdInput {
+    id?: ID;
+    percentage: number;
+}
+/**
+ * Target received by the SLA policy write API.
+ * durationSeconds is stored as seconds regardless of the unit used by the UI.
+ */
+export interface ConversationSlaTargetInput {
+    metric: ConversationSlaMetric;
+    durationSeconds: number;
+    warningThresholds: ConversationSlaWarningThresholdInput[];
+}
+export type ConversationSlaResumeBehavior = 'continue' | 'restart' | 'recalculate';
+export type ConversationSlaReopenBehavior = 'preserve' | 'restart' | 'recalculate' | 'do_not_start';
+export interface ConversationSlaClockBehavior {
+    /**
+     * Conversation statuses that pause every running SLA cycle.
+     *
+     * Entering one of these statuses pauses the clock. Leaving all of them
+     * resumes it according to onResume. An empty array means that conversation
+     * status changes never pause the SLA clock.
+     */
+    pauseOnStatuses: ConversationStatus[];
+    /**
+     * Behavior applied when the conversation leaves the last status included
+     * in pauseOnStatuses.
+     *
+     * continue: keeps the current cycle and its consumed/remaining time.
+     * restart: resets the current cycle from the resume timestamp.
+     * recalculate: keeps the applied policy snapshot and recalculates the
+     * schedule-derived warnings/deadline. It does not select another policy
+     * version.
+     */
+    onResume: ConversationSlaResumeBehavior;
+    /**
+     * Behavior applied when a resolved/finalized conversation is reopened.
+     * Reopening is independent from resuming a status-paused clock.
+     *
+     * preserve: preserves the previous cycle state.
+     * restart: starts a new cycle from the reopen timestamp.
+     * recalculate: recalculates the cycle using the applied policy snapshot.
+     * do_not_start: does not start an SLA cycle because of the reopen action.
+     */
+    onReopen: ConversationSlaReopenBehavior;
+}
+/**
+ * Immutable, versioned policy referenced by ConversationQueue.sla.
+ * Editing a published policy creates a new version.
+ */
+export interface ConversationSlaPolicy {
+    id: ID;
+    spaceId: ID;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    version: number;
+    timeCalculation: ConversationSlaTimeCalculation;
+    targets: ConversationSlaTarget[];
+    clockBehavior: ConversationSlaClockBehavior;
+    createdAt: Date;
+    createdByUserId?: ID;
+    updatedAt: Date;
+    updatedByUserId?: ID;
+}
+/**
+ * Editable definition sent by clients.
+ *
+ * It intentionally excludes policy id/version and audit fields controlled by
+ * the backend. targets is full-replacement: omitted metrics are disabled in
+ * the newly published policy version.
+ */
+export interface ConversationSlaPolicyDefinitionInput {
+    name: string;
+    description?: string;
+    enabled: boolean;
+    timeCalculation: ConversationSlaTimeCalculation;
+    targets: ConversationSlaTargetInput[];
+    clockBehavior: ConversationSlaClockBehavior;
+}
+/**
+ * Creates the first immutable version of an SLA policy.
+ *
+ * commandId provides idempotency for retries. The authenticated backend
+ * context supplies createdByUserId and the audit timestamps.
+ */
+export interface CreateConversationSlaPolicyRequest {
+    commandId: ID;
+    spaceId: ID;
+    definition: ConversationSlaPolicyDefinitionInput;
+}
+/**
+ * Publishes a new immutable version of an existing SLA policy.
+ *
+ * expectedVersion implements optimistic concurrency. The backend rejects the
+ * request when another version was published after the client loaded it.
+ * version, updatedAt and updatedByUserId are always assigned by the backend.
+ */
+export interface PublishConversationSlaPolicyVersionRequest {
+    commandId: ID;
+    spaceId: ID;
+    policyId: ID;
+    expectedVersion: number;
+    definition: ConversationSlaPolicyDefinitionInput;
+}
+export type ConversationSlaClockAction = 'start' | 'evaluate' | 'pause' | 'resume' | 'complete' | 'recalculate' | 'cancel';
+export type ConversationSlaClockReason = 'conversation_created' | 'conversation_enqueued' | 'customer_message' | 'agent_response' | 'assignment_changed' | 'status_changed' | 'queue_transfer' | 'conversation_reopened' | 'deadline_due' | 'policy_override';
+/**
+ * Idempotent input for the conversation-sla-worker.
+ * policyId/policyVersion identify the immutable policy snapshot to apply.
+ */
+export interface SlaClockCommand {
+    commandId: ID;
+    sourceEventId: ID;
+    spaceId: ID;
+    conversationId: ID;
+    expectedConversationVersion: number;
+    action: ConversationSlaClockAction;
+    reason: ConversationSlaClockReason;
+    metric?: ConversationSlaMetric;
+    policyId: ID;
+    policyVersion: number;
+    queueId?: ID;
+    occurredAt: Date;
+    requestedAt: Date;
+}
+export type ConversationSlaCycleStatus = 'running' | 'paused' | 'met' | 'breached' | 'cancelled';
+export interface ConversationSlaPausePeriod {
+    startedAt: Date;
+    endedAt?: Date;
+    reason: ConversationSlaClockReason;
+    sourceEventId: ID;
+}
+/**
+ * Durable metric cycle. The target and time calculation are copied from the
+ * selected policy version so later policy edits cannot alter active history.
+ */
+export interface ConversationSlaCycle {
+    id: ID;
+    spaceId: ID;
+    conversationId: ID;
+    metric: ConversationSlaMetric;
+    sequence: number;
+    status: ConversationSlaCycleStatus;
+    policyId: ID;
+    policyVersion: number;
+    timeCalculation: ConversationSlaTimeCalculation;
+    target: ConversationSlaTarget;
+    startedAt: Date;
+    deadlineAt?: Date;
+    nextWarningAt?: Date;
+    pausedAt?: Date;
+    completedAt?: Date;
+    breachedAt?: Date;
+    cancelledAt?: Date;
+    elapsedSeconds: number;
+    pausedSeconds: number;
+    pausePeriods: ConversationSlaPausePeriod[];
+    startedByEventId: ID;
+    completedByEventId?: ID;
+    version: number;
+    updatedAt: Date;
+}
+export type ConversationSlaEventType = Extract<ConversationEventType, 'sla_started' | 'sla_paused' | 'sla_resumed' | 'sla_warning' | 'sla_breached' | 'sla_met' | 'sla_overridden'>;
+/**
+ * Immutable SLA event. Corrections are represented by a later event.
+ */
+export interface ConversationSlaEvent {
+    eventId: ID;
+    sourceEventId: ID;
+    type: ConversationSlaEventType;
+    schemaVersion: 1;
+    spaceId: ID;
+    conversationId: ID;
+    conversationVersion: number;
+    cycleId: ID;
+    metric: ConversationSlaMetric;
+    policyId: ID;
+    policyVersion: number;
+    status: ConversationSlaCycleStatus;
+    deadlineAt?: Date;
+    warningThresholdId?: ID;
+    reason: ConversationSlaClockReason;
+    correlationId: ID;
+    causationId: ID;
+    occurredAt: Date;
+    recordedAt: Date;
+}
+export type ConversationSlaOutboxEvent = OutboxEvent<ConversationSlaEvent> & {
+    aggregateType: 'conversation';
+    eventType: `conversation.${ConversationSlaEventType}`;
+    schemaVersion: 1;
+};

package/dist/src/Conversations/Sla.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONVERSATION_SLA_EVENTS_COLLECTION = exports.CONVERSATION_SLA_CYCLES_COLLECTION = exports.CONVERSATION_SLA_POLICIES_COLLECTION = void 0;
+exports.CONVERSATION_SLA_POLICIES_COLLECTION = 'conversation_sla_policies';
+exports.CONVERSATION_SLA_CYCLES_COLLECTION = 'conversation_sla_cycles';
+exports.CONVERSATION_SLA_EVENTS_COLLECTION = 'conversation_sla_events';

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

@@ -17,4 +17,5 @@ export * from './DashBoard/dashboardMessages';
 export * from './Survey';
 export * from './Queue';
 export * from './Routing';
+export * from './Sla';
 export * from './Transfer';

package/dist/src/Conversations/index.js

@@ -56,4 +56,5 @@ __exportStar(require("./DashBoard/dashboardMessages"), exports);
 __exportStar(require("./Survey"), exports);
 __exportStar(require("./Queue"), exports);
 __exportStar(require("./Routing"), exports);
+__exportStar(require("./Sla"), exports);
 __exportStar(require("./Transfer"), exports);

package/dist/src/Tickets/Dashboard.d.ts

@@ -193,6 +193,17 @@ export declare enum TicketMetricCode {
     SECURITY_DENIAL_COUNT = "SECURITY_DENIAL_COUNT",
     PII_ACCESS_COUNT = "PII_ACCESS_COUNT"
 }
+export declare enum DashboardIcon {
+    DASHBOARD = "DASHBOARD",
+    HOME = "HOME",
+    SUPPORT = "SUPPORT",
+    ANALYTICS = "ANALYTICS",
+    REPORTS = "REPORTS",
+    USERS = "USERS",
+    SETTINGS = "SETTINGS",
+    FAVORITES = "FAVORITES",
+    QUICK_ACTIONS = "QUICK_ACTIONS"
+}
 export interface ITicketAnalyticsFilter extends ITicketFilter {
     range: ITicketDateRange;
     channelTypes?: ChannelType[];
@@ -318,6 +329,8 @@ export interface ITicketDashboard {
     refreshMode: TicketWidgetRefreshMode;
     refreshIntervalSeconds?: number;
     isDefault?: boolean;
+    order: number;
+    icon?: DashboardIcon;
     createdAt: Date;
     createdBy: string;
     updatedAt?: Date;
@@ -334,7 +347,9 @@ export interface ICreateTicketDashboardDto {
     widgets?: ITicketWidgetConfiguration[];
     refreshMode?: TicketWidgetRefreshMode;
     refreshIntervalSeconds?: number;
+    order?: number;
     isDefault?: boolean;
+    icon?: DashboardIcon;
 }
 export interface IUpdateTicketDashboardDto {
     name?: string;
@@ -347,7 +362,9 @@ export interface IUpdateTicketDashboardDto {
     widgets?: ITicketWidgetConfiguration[];
     refreshMode?: TicketWidgetRefreshMode;
     refreshIntervalSeconds?: number;
+    order?: number;
     isDefault?: boolean;
+    icon?: DashboardIcon;
 }
 export interface ITicketDashboardTemplate {
     id: string;

package/dist/src/Tickets/Dashboard.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TicketMetricCode = exports.TicketDrilldownTarget = exports.TicketWidgetRefreshMode = exports.TicketMetricFormat = exports.TicketComparisonMode = exports.TicketTimeGranularity = exports.TicketAnalyticsDimension = exports.TicketMetricAggregation = exports.TicketWidgetType = exports.TicketDashboardVisibility = exports.TicketAnalyticsAudience = void 0;
+exports.DashboardIcon = exports.TicketMetricCode = exports.TicketDrilldownTarget = exports.TicketWidgetRefreshMode = exports.TicketMetricFormat = exports.TicketComparisonMode = exports.TicketTimeGranularity = exports.TicketAnalyticsDimension = exports.TicketMetricAggregation = exports.TicketWidgetType = exports.TicketDashboardVisibility = exports.TicketAnalyticsAudience = void 0;
 var TicketAnalyticsAudience;
 (function (TicketAnalyticsAudience) {
     TicketAnalyticsAudience["AGENT"] = "AGENT";
@@ -204,3 +204,15 @@ var TicketMetricCode;
     TicketMetricCode["SECURITY_DENIAL_COUNT"] = "SECURITY_DENIAL_COUNT";
     TicketMetricCode["PII_ACCESS_COUNT"] = "PII_ACCESS_COUNT";
 })(TicketMetricCode || (exports.TicketMetricCode = TicketMetricCode = {}));
+var DashboardIcon;
+(function (DashboardIcon) {
+    DashboardIcon["DASHBOARD"] = "DASHBOARD";
+    DashboardIcon["HOME"] = "HOME";
+    DashboardIcon["SUPPORT"] = "SUPPORT";
+    DashboardIcon["ANALYTICS"] = "ANALYTICS";
+    DashboardIcon["REPORTS"] = "REPORTS";
+    DashboardIcon["USERS"] = "USERS";
+    DashboardIcon["SETTINGS"] = "SETTINGS";
+    DashboardIcon["FAVORITES"] = "FAVORITES";
+    DashboardIcon["QUICK_ACTIONS"] = "QUICK_ACTIONS";
+})(DashboardIcon || (exports.DashboardIcon = DashboardIcon = {}));

package/dist/src/index.d.ts

@@ -20,3 +20,4 @@ export * as AI from './AI/index';
 export * as Shop from './Shop/index';
 export * as APIResponses from './ApiResponses/index';
 export * as Forms from './Forms/index';
+export * as Automations from './Automations/index';

package/dist/src/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Forms = exports.APIResponses = exports.Shop = exports.AI = exports.APIKeys = exports.EventsQueue = exports.ApiResponses = exports.Presence = exports.Users = exports.Collections = exports.Sales = exports.Tickets = exports.Spaces = exports.Reports = exports.Security = exports.Calls = exports.Conversations = exports.Calendar = exports.Contacts = exports.Common = exports.AuditLogs = exports.Accounts = void 0;
+exports.Automations = exports.Forms = exports.APIResponses = exports.Shop = exports.AI = exports.APIKeys = exports.EventsQueue = exports.ApiResponses = exports.Presence = exports.Users = exports.Collections = exports.Sales = exports.Tickets = exports.Spaces = exports.Reports = exports.Security = exports.Calls = exports.Conversations = exports.Calendar = exports.Contacts = exports.Common = exports.AuditLogs = exports.Accounts = void 0;
 exports.Accounts = __importStar(require("./Accounts/index"));
 exports.AuditLogs = __importStar(require("./AuditLogs/index"));
 exports.Common = __importStar(require("./Common/index"));
@@ -56,3 +56,4 @@ exports.AI = __importStar(require("./AI/index"));
 exports.Shop = __importStar(require("./Shop/index"));
 exports.APIResponses = __importStar(require("./ApiResponses/index"));
 exports.Forms = __importStar(require("./Forms/index"));
+exports.Automations = __importStar(require("./Automations/index"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trii/types",
-  "version": "2.10.685",
+  "version": "2.10.687",
   "description": "Types definitions for Trii projects - ",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",