@trii/types 2.10.744 → 2.10.746

package/dist/Tickets/Category.d.ts

@@ -69,3 +69,21 @@ export interface IUpdateTicketResolutionTypeDto {
     fieldDefinitionIds?: string[] | null;
     layoutIds?: string[] | null;
 }
+/** Body of GET /categories/{id}/usages. */
+export interface ICategoryUsages {
+    subcategoryCount: number;
+    requestTypeCount: number;
+    fieldCount: number;
+    layoutCount: number;
+    activeTicketCount: number;
+}
+/** Body of GET /resolution-types/{id}/usages. */
+export interface IResolutionTypeUsages {
+    ticketCount: number;
+}
+/** One rejected reference in a 422 from the resolution-type write endpoints. */
+export interface IResolutionTypeReferenceProblem {
+    fieldName: 'fieldDefinitionIds' | 'layoutIds';
+    code: 'REFERENCE_NOT_FOUND' | 'REFERENCE_DISABLED';
+    message: string;
+}

package/dist/Tickets/Common.d.ts

@@ -150,3 +150,12 @@ export interface ITicketMetricGroup {
     label: string;
     value: number;
 }
+/** The stored value of a FILE custom field. The blob lives under
+ *  tickets/{ticketId}/files/ and is written through media-api. */
+export interface ITicketFileValue {
+    url: string;
+    storageKey: string;
+    fileName: string;
+    mimeType: string;
+    sizeBytes: number;
+}

package/dist/Tickets/Dashboard.d.ts

@@ -1,6 +1,8 @@
 import { ChannelType } from "../Common/Channels/ChannelType";
-import { ITicketDateRange, ITicketMetricGroup, ITicketMetricPoint, TicketPropertyValue } from "./Common";
+import { ITicketDateRange, ITicketMetricGroup, ITicketMetricPoint, TicketPriority, TicketPropertyValue } from "./Common";
 import { ITicketFilter } from "./Api";
+import type { SlaStatus } from "./Sla";
+import type { AgentAvailabilityStatus } from "./Routing";
 export declare enum TicketAnalyticsAudience {
     AGENT = "AGENT",
     SUPERVISOR = "SUPERVISOR",
@@ -484,3 +486,98 @@ export interface ITicketDashboardMetrics {
     byCategory: ITicketMetricGroup[];
     byAssignee: ITicketMetricGroup[];
 }
+export interface IAgentDashboardQueueItem {
+    ticketId: string;
+    number: number;
+    title: string;
+    priority: TicketPriority;
+    statusId: string;
+    statusLabel: string;
+    dueAt?: Date;
+    /**
+     * PENDING / BREACHED / NOT_APPLICABLE are the only values this backend can
+     * derive from dueAt — MET and PAUSED need real SLA cycles, which are not
+     * persisted yet. "At risk" is NOT a SlaStatus value: the domain models it as a
+     * separate warning threshold, which is why it is a boolean of its own.
+     */
+    slaStatus: SlaStatus;
+    slaAtRisk: boolean;
+    createdAt: Date;
+    updatedAt?: Date;
+}
+export interface IAgentDashboardCapacity {
+    maximum: number;
+    occupied: number;
+    freePercentage: number;
+    inProgress: number;
+    waitingCustomer: number;
+    new: number;
+}
+export interface IAgentDashboardQualityGoal {
+    actual: number;
+    target: number;
+}
+/**
+ * The agent's PERSONAL dashboard. Not to be confused with
+ * ITicketDashboardMetrics, which is the space-wide aggregate: everything here is
+ * filtered by the acting agent.
+ */
+export interface IAgentDashboardMetrics {
+    range: {
+        from: Date;
+        to: Date;
+    };
+    activeLoad: number;
+    resolvedCount: number;
+    resolvedChangePercentage?: number;
+    receivedCount: number;
+    awaitingResponseCount: number;
+    averageFirstResponseMinutes: number;
+    averageResolutionMinutes: number;
+    slaAttentionCount: number;
+    slaBreachedCount: number;
+    slaAtRiskCount: number;
+    priorityQueue: IAgentDashboardQueueItem[];
+    capacity: IAgentDashboardCapacity;
+    loadByPriority: {
+        priority: TicketPriority;
+        count: number;
+    }[];
+    availabilityStatus: AgentAvailabilityStatus;
+    resolutionRhythm: {
+        series: ITicketMetricPoint[];
+        changePercentage?: number;
+    };
+    qualityGoals: {
+        firstResponseSla: IAgentDashboardQualityGoal;
+        resolutionSla: IAgentDashboardQualityGoal;
+        assignmentAcceptanceRate: IAgentDashboardQualityGoal;
+    };
+    csatScore: IAgentDashboardQualityGoal;
+    warnings: string[];
+}
+/** A metric of the catalog, plus the dimensions a query MUST supply for it. */
+export interface IMetricCatalogEntry extends ITicketMetricDefinition {
+    requiredDimensions?: TicketAnalyticsDimension[];
+}
+export type IWidgetPresetQuery = Omit<ITicketMetricQuery, 'filter'>;
+export type WidgetPresetCategory = 'kpi' | 'trend' | 'breakdown' | 'sla';
+/**
+ * A ready-made widget the user can drop on a dashboard. `queries` drops `filter`
+ * on purpose: the preset defines WHAT is measured, the dashboard defines over
+ * which slice.
+ */
+export interface IWidgetPreset {
+    key: string;
+    label: string;
+    description: string;
+    category: WidgetPresetCategory;
+    audiences: TicketAnalyticsAudience[];
+    defaultSize: {
+        width: number;
+        height: number;
+    };
+    widget: Omit<ITicketWidgetConfiguration, 'id' | 'position' | 'queries'> & {
+        queries: IWidgetPresetQuery[];
+    };
+}

package/dist/Tickets/Fields.d.ts

@@ -1,6 +1,7 @@
 import { ITicketAuditedEntity, TicketPropertyValue } from './Common';
 import { TicketConditionOperator } from './Workflow';
 import { TicketDataClassification, TicketMaskingStrategy } from './Security';
+import type { TicketLayoutVisibility } from './Layouts';
 export declare enum TicketFieldType {
     SHORT_TEXT = "SHORT_TEXT",
     LONG_TEXT = "LONG_TEXT",
@@ -135,3 +136,100 @@ export interface IUpdateTicketFieldDefinitionDto extends Partial<Omit<ICreateTic
     sortable?: boolean;
     exportable?: boolean;
 }
+export interface ITicketFormField {
+    fieldNameKey: string;
+    order: number;
+    column: number;
+    width: number;
+    visible: boolean;
+    /**
+     * One EDIT layout serves both the read and the edit screen, so `visible` is
+     * not enough to tell them apart: `visibility` is what says whether the field
+     * shows only on create, only on edit, or only on read.
+     */
+    visibility?: TicketLayoutVisibility;
+    labelOverride?: string;
+    placeholderOverride?: string;
+    /** Resolved by the field scope, not by the layout: the very same values
+     *  validation will apply on save. */
+    required: boolean;
+    readOnly: boolean;
+    hidden: boolean;
+    /** The full definition travels with the field so the client does not have to
+     *  fetch /fields separately and rebuild the form from two sources. */
+    definition: ITicketFieldDefinition;
+}
+export interface ITicketFormSection {
+    id: string;
+    title?: string;
+    description?: string;
+    order: number;
+    columns?: number;
+    collapsible?: boolean;
+    collapsedByDefault?: boolean;
+    fields: ITicketFormField[];
+}
+/**
+ * A resolved ticket form: which fields apply, and how they are arranged.
+ *
+ * The split is the point: the field SCOPE decides membership, the layout decides
+ * presentation. A field in scope that the layout does not mention is appended
+ * anyway; one the layout still lists but that no longer applies is not rendered.
+ * That is why a space with no layouts still has a working form.
+ */
+export interface ITicketFormSchema {
+    viewType: string;
+    /** Absent when no layout applies: the form is served anyway, in default order. */
+    layoutId?: string;
+    sections: ITicketFormSection[];
+    /** In scope but missing from the layout; appended at the end. Diagnostic:
+     *  reveals layouts that fell behind the field configuration. */
+    appendedFieldNameKeys: string[];
+    /** Present in the layout but out of scope. Not rendered; same diagnostic value. */
+    ignoredLayoutFieldNameKeys: string[];
+}
+/** Body of GET /fields/{id}/usages. */
+export interface IFieldUsages {
+    requestTypes: {
+        id: string;
+        name: string;
+    }[];
+    referencedByFields: {
+        id: string;
+        nameKey: string;
+        label: string;
+    }[];
+    /** Real usage in tickets: an indexed total plus a bounded sample of the
+     *  most-recently-touched ones, so a small set gives concrete references and a
+     *  large one just shows a few plus the count. */
+    tickets: {
+        count: number;
+        sample: {
+            id: string;
+            number: number;
+            title: string;
+        }[];
+    };
+    layouts: {
+        supported: false;
+    };
+}
+/** Body of GET /layouts/{id}/usages. */
+export interface ITicketLayoutUsages {
+    categories: {
+        id: string;
+        name: string;
+    }[];
+    requestTypes: {
+        id: string;
+        name: string;
+    }[];
+    resolutionTypes: {
+        id: string;
+        name: string;
+    }[];
+    views: {
+        id: string;
+        name: string;
+    }[];
+}

package/dist/Tickets/Routing.d.ts

@@ -390,3 +390,46 @@ export interface ICreateAgentChannelCapacityDto {
     reservedCapacity?: number;
 }
 export type IUpdateAgentChannelCapacityDto = Partial<Omit<ICreateAgentChannelCapacityDto, "userId" | "channelType">>;
+export interface IEscalationPolicyUsageRef {
+    id: string;
+    name: string;
+    enabled: boolean;
+}
+/** Body of GET /routing/escalation-policies/{id}/usages. */
+export interface IEscalationPolicyUsage {
+    queues: IEscalationPolicyUsageRef[];
+}
+export interface IEscalationPolicyUsageSummary {
+    queuesCount: number;
+}
+/** Mirror of TicketSkillWarningCode; only one member is needed today. */
+export declare enum EscalationPolicyWarningCode {
+    DISABLED_BUT_REFERENCED = "DISABLED_BUT_REFERENCED"
+}
+/** List/get view: the base DTO plus a usage summary and warnings. */
+export interface ITicketEscalationPolicyWithUsage extends ITicketEscalationPolicy {
+    usage: IEscalationPolicyUsageSummary;
+    warnings: EscalationPolicyWarningCode[];
+}
+export interface ICreateAgentSkillDto {
+    userId: string;
+    skillId: string;
+    proficiency?: number;
+    priority?: number;
+    enabled?: boolean;
+    validFrom?: string;
+    validUntil?: string;
+}
+/** `channelType` null means "the agent's global capacity", not "unknown". */
+export interface ICreateAgentCapacityDto {
+    userId: string;
+    channelType?: number | null;
+    maximumConcurrent: number;
+    reservedCapacity?: number;
+    enabled?: boolean;
+}
+export interface IListAgentSkillsFilters {
+    userId?: string;
+    skillId?: string;
+    enabled?: boolean;
+}

package/dist/Tickets/Routing.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TicketSkillWarningCode = exports.TicketAssignmentEndReason = exports.TicketEscalationActionType = exports.TicketEscalationTrigger = exports.TicketSkillRelaxationMode = exports.TicketQueueOrderDirection = exports.TicketQueueOrderCriterion = exports.TicketRoutingConditionGroupOperator = exports.AgentAvailabilityStatus = exports.TicketRoutingStatus = exports.TicketRoutingStrategy = void 0;
+exports.EscalationPolicyWarningCode = exports.TicketSkillWarningCode = exports.TicketAssignmentEndReason = exports.TicketEscalationActionType = exports.TicketEscalationTrigger = exports.TicketSkillRelaxationMode = exports.TicketQueueOrderDirection = exports.TicketQueueOrderCriterion = exports.TicketRoutingConditionGroupOperator = exports.AgentAvailabilityStatus = exports.TicketRoutingStatus = exports.TicketRoutingStrategy = void 0;
 var TicketRoutingStrategy;
 (function (TicketRoutingStrategy) {
     TicketRoutingStrategy["ROUND_ROBIN"] = "ROUND_ROBIN";
@@ -91,3 +91,8 @@ var TicketSkillWarningCode;
     TicketSkillWarningCode["DISABLED_BUT_REFERENCED"] = "DISABLED_BUT_REFERENCED";
     TicketSkillWarningCode["REQUIRED_BY_QUEUE_BUT_UNMET"] = "REQUIRED_BY_QUEUE_BUT_UNMET";
 })(TicketSkillWarningCode || (exports.TicketSkillWarningCode = TicketSkillWarningCode = {}));
+/** Mirror of TicketSkillWarningCode; only one member is needed today. */
+var EscalationPolicyWarningCode;
+(function (EscalationPolicyWarningCode) {
+    EscalationPolicyWarningCode["DISABLED_BUT_REFERENCED"] = "DISABLED_BUT_REFERENCED";
+})(EscalationPolicyWarningCode || (exports.EscalationPolicyWarningCode = EscalationPolicyWarningCode = {}));

package/dist/Tickets/SelfService.d.ts

@@ -140,7 +140,7 @@ export interface ICreateTicketRequestTypeDto {
     description?: string;
     categoryId: string;
     icon?: string;
-    formId: string;
+    formId?: string;
     formVersion?: number;
     workflowId?: string;
     defaultPriority?: TicketPriority;
@@ -536,7 +536,7 @@ export interface ICustomerRequestTypeView {
     name: string;
     description?: string;
     icon?: string;
-    formId: string;
+    formId?: string;
     formVersion?: number;
     defaultPriority?: TicketPriority;
     category: ICustomerRequestTypeCategoryView;
@@ -644,3 +644,27 @@ export interface ICustomerTicketActionDto {
     attachmentIds?: string[];
     formSubmissionId?: string;
 }
+/**
+ * Confirmation that an uploaded file became an attachment of the ticket.
+ *
+ * An allowlist over ITicketAttachment, and note the two absences:
+ *
+ * - `storageKey` is the blob layout tickets-api and media-api agree on. It is
+ *   internal plumbing, and a client that learned to build one could address
+ *   blobs of tickets it never saw.
+ * - `downloadUrl` is omitted because there is NO customer read path for
+ *   attachments yet: ICustomerTicketView has no attachments field, and the url
+ *   the agent surface hands out is an unsigned blob url that only resolves with
+ *   a container SAS this surface has never discussed. Returning one would be
+ *   offering a link that 403s.
+ *
+ * `createdBy` is absent too, for a duller reason: on this path it is the nil
+ * uuid marker, which says nothing to anyone.
+ */
+export interface ICustomerTicketAttachmentView {
+    id: string;
+    fileName: string;
+    mimeType: string;
+    sizeBytes: number;
+    createdAt: Date;
+}

package/dist/Tickets/Sla.d.ts

@@ -391,3 +391,38 @@ export interface ISlaWarningEvent {
     escalationPolicyId?: string;
     notificationTemplateId?: string;
 }
+/** Body of GET /business-calendars/{id}/usages. */
+export interface IBusinessCalendarUsages {
+    slaPolicies: {
+        id: string;
+        name: string;
+    }[];
+}
+/** One row of the bulk usage count for a list of calendars. */
+export interface IBusinessCalendarUsageCount {
+    businessCalendarId: string;
+    count: number;
+}
+/** Body of GET /sla/metric-definitions/{id}/usages. */
+export interface IMetricDefinitionUsages {
+    slaPolicies: {
+        id: string;
+        name: string;
+    }[];
+}
+/** List item of GET /sla/metric-definitions: the published definition plus how
+ *  many policies reference it, so the list can warn before a delete. */
+export interface ISlaMetricDefinitionListItem extends ISlaMetricDefinition {
+    usageCount: number;
+}
+export interface ISlaPolicyValidationIssue {
+    code: string;
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    path?: string;
+}
+/** Body of POST /sla/policies/validate. Issues with severity WARNING do not
+ *  block the save; ERROR ones do. */
+export interface IValidateSlaPolicyResponse {
+    issues: ISlaPolicyValidationIssue[];
+}

package/dist/Tickets/Ticket.d.ts

@@ -134,3 +134,8 @@ export interface ITicketInboundEvent {
         [key: string]: string | number | boolean | null;
     };
 }
+/** Body of GET /tickets/{id}/collaboration. `chatId` is an opaque reference to a
+ *  chat group of another service, not a tickets uuid. */
+export interface ITicketCollaboration {
+    chatId: string | null;
+}

package/dist/Tickets/Workflow.d.ts

@@ -145,3 +145,35 @@ export interface ITicketFormSubmissionReference {
     submittedAt: Date;
     submittedBy: string;
 }
+/** Body of GET /approval-definitions/{id}/usages. */
+export interface IApprovalDefinitionUsages {
+    categories: {
+        id: string;
+        name: string;
+    }[];
+    /**
+     * `transitions` and `macros` ARE resolvable: an APPROVAL_COMPLETED transition
+     * condition stores the approvalProcessDefinitionId it gates on, and a
+     * START_APPROVAL macro action stores its definitionId.
+     *
+     * `workflows` stays unsupported because a "workflow" is the status+transition
+     * graph, not a stored entity that references a definition on its own — the
+     * relationship materializes as the transitions above. `automations` stays
+     * unsupported because no automation entity references an approval definition
+     * in this schema.
+     */
+    workflows: {
+        supported: false;
+    };
+    transitions: {
+        id: string;
+        name: string;
+    }[];
+    automations: {
+        supported: false;
+    };
+    macros: {
+        id: string;
+        name: string;
+    }[];
+}

package/package.json

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