@trii/types 2.10.726 → 2.10.728

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

@@ -1,4 +1,6 @@
+import { ITicketCursorResponse } from "./Api";
 import { ITicketAuditedEntity, TicketPropertyValue } from "./Common";
+import { TicketFieldType } from "./Fields";
 import { TicketConditionOperator } from "./Workflow";
 export declare enum TicketSecurityResourceType {
     TICKET = "TICKET",
@@ -92,6 +94,14 @@ export declare enum TicketDelegatedAccessStatus {
     EXPIRED = "EXPIRED",
     REJECTED = "REJECTED"
 }
+export declare enum TicketLegalHoldReleaseReason {
+    MATTER_CLOSED = "MATTER_CLOSED",
+    NO_LONGER_RELEVANT = "NO_LONGER_RELEVANT",
+    APPLIED_IN_ERROR = "APPLIED_IN_ERROR",
+    SUPERSEDED = "SUPERSEDED",
+    OBLIGATION_EXPIRED = "OBLIGATION_EXPIRED",
+    OTHER = "OTHER"
+}
 export interface ITicketSecuritySubject {
     /** When every selector is false or empty, the subject matches nobody. */
     allAuthenticated?: boolean;
@@ -145,15 +155,71 @@ export interface ITicketSecurityPolicy extends ITicketAuditedEntity {
     fieldPermissions?: ITicketFieldPermission[];
     validFrom?: Date;
     validUntil?: Date;
+    version: number;
+}
+export interface ICreateTicketSecurityPolicyDto {
+    name: string;
+    description?: string;
+    enabled?: boolean;
+    priority?: number;
+    effect: TicketPolicyEffect;
+    resourceTypes: TicketSecurityResourceType[];
+    operations: TicketSecurityOperation[];
+    subjects: ITicketSecuritySubject;
+    scope?: ITicketSecurityScope;
+    conditions?: ITicketSecurityConditionGroup;
+    fieldPermissions?: ITicketFieldPermission[];
+    validFrom?: Date;
+    validUntil?: Date;
+}
+export interface IUpdateTicketSecurityPolicyDto {
+    expectedVersion: number;
+    name?: string;
+    description?: string;
+    enabled?: boolean;
+    priority?: number;
+    effect?: TicketPolicyEffect;
+    resourceTypes?: TicketSecurityResourceType[];
+    operations?: TicketSecurityOperation[];
+    subjects?: ITicketSecuritySubject;
+    scope?: ITicketSecurityScope;
+    conditions?: ITicketSecurityConditionGroup;
+    fieldPermissions?: ITicketFieldPermission[];
+    validFrom?: Date;
+    validUntil?: Date;
 }
 export interface ITicketFieldSecurityDefinition extends ITicketAuditedEntity {
     fieldNameKey: string;
-    classification: TicketDataClassification;
+    label: string;
+    type: TicketFieldType;
+    isSystem: boolean;
+    enabled: boolean;
+    classification?: TicketDataClassification;
     containsPii: boolean;
     maskingStrategy: TicketMaskingStrategy;
-    searchableWhenMasked?: boolean;
+    searchableWhenMasked: boolean;
     exportable: boolean;
     retentionPolicyId?: string;
+    readRoleIds?: string[];
+    writeRoleIds?: string[];
+    searchable: boolean;
+    filterable: boolean;
+    sortable: boolean;
+    version: number;
+}
+export interface IUpdateTicketFieldSecurityDefinitionDto {
+    expectedVersion: number;
+    classification?: TicketDataClassification;
+    containsPii?: boolean;
+    maskingStrategy?: TicketMaskingStrategy;
+    searchableWhenMasked?: boolean;
+    exportable?: boolean;
+    retentionPolicyId?: string;
+    readRoleIds?: string[];
+    writeRoleIds?: string[];
+    searchable?: boolean;
+    filterable?: boolean;
+    sortable?: boolean;
 }
 export interface ITicketSecurityState {
     sensitivity: TicketSensitivityLevel;
@@ -189,6 +255,102 @@ export interface ITicketRetentionPolicy extends ITicketAuditedEntity {
     dataClassifications?: TicketDataClassification[];
     preserveAuditLog: boolean;
     enabled: boolean;
+    version: number;
+}
+export interface ICreateTicketRetentionPolicyDto {
+    name: string;
+    description?: string;
+    retentionDays: number;
+    action: TicketRetentionAction;
+    categoryIds?: string[];
+    dataClassifications?: TicketDataClassification[];
+    preserveAuditLog?: boolean;
+    enabled?: boolean;
+}
+export interface IUpdateTicketRetentionPolicyDto {
+    expectedVersion: number;
+    name?: string;
+    description?: string;
+    retentionDays?: number;
+    action?: TicketRetentionAction;
+    categoryIds?: string[];
+    dataClassifications?: TicketDataClassification[];
+    preserveAuditLog?: boolean;
+    enabled?: boolean;
+}
+export interface ITicketRetentionUpcomingBucket {
+    withinDays: number;
+    count: number;
+}
+export interface ITicketRetentionAffectedCategory {
+    categoryId: string;
+    name: string;
+    count: number;
+}
+export interface ITicketRetentionSampleTicket {
+    ticketId: string;
+    number: number;
+    title: string;
+    categoryId: string;
+    resolvedAt: Date;
+}
+export interface ITicketRetentionImpactPreview {
+    policyId?: string;
+    action: TicketRetentionAction;
+    retentionDays: number;
+    preserveAuditLog: boolean;
+    irreversible: boolean;
+    anonymizedFieldNameKeys?: string[];
+    evaluatedAt: Date;
+    alreadyReachedCount: number;
+    onLegalHoldCount: number;
+    upcoming: ITicketRetentionUpcomingBucket[];
+    affectedCategories: ITicketRetentionAffectedCategory[];
+    affectedClassifications: TicketDataClassification[];
+    samples: ITicketRetentionSampleTicket[];
+}
+export interface ITicketRetentionValidationIssue {
+    code: string;
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    path?: string;
+}
+export interface ITicketRetentionValidationEntry {
+    policyId: string;
+    issues: ITicketRetentionValidationIssue[];
+}
+export interface IValidateTicketRetentionResponse {
+    policies: ITicketRetentionValidationEntry[];
+}
+export interface ITicketFieldSecurityValidationIssue {
+    code: string;
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    path?: string;
+}
+export interface ITicketFieldSecurityValidationEntry {
+    fieldNameKey: string;
+    issues: ITicketFieldSecurityValidationIssue[];
+}
+export interface IValidateTicketFieldSecurityResponse {
+    fields: ITicketFieldSecurityValidationEntry[];
+}
+export interface ITicketFieldSecurityPreviewRequest {
+    roleIds: string[];
+}
+export interface ITicketFieldSecurityPreviewEntry {
+    fieldNameKey: string;
+    label: string;
+    visible: boolean;
+    editable: boolean;
+    masked: boolean;
+    maskingStrategy?: TicketMaskingStrategy;
+    searchable: boolean;
+    exportable: boolean;
+}
+export interface ITicketFieldSecurityPreviewResponse {
+    roleIds: string[];
+    fields: ITicketFieldSecurityPreviewEntry[];
 }
 export interface ITicketLegalHold {
     id: string;
@@ -202,6 +364,8 @@ export interface ITicketLegalHold {
     releasedAt?: Date;
     releasedBy?: string;
     externalMatterId?: string;
+    releaseReason?: TicketLegalHoldReleaseReason;
+    releaseNotes?: string;
 }
 export interface ITicketAccessAuditEvent {
     id: string;
@@ -221,6 +385,57 @@ export interface ITicketAccessAuditEvent {
     allowed: boolean;
     policyIds?: string[];
     denialReason?: string;
+    technicalContextWithheld: boolean;
+}
+export interface ICreateTicketAccessAuditEventDto {
+    actorId: string;
+    /** Con qué identidad se actuó. Si no hay impersonación, es el propio actor. */
+    effectiveUserId?: string;
+    action: TicketAccessAuditAction;
+    resourceType: TicketSecurityResourceType;
+    resourceId?: string;
+    ticketId?: string;
+    /** Qué campos se tocaron. NUNCA sus valores. */
+    fieldNameKeys?: string[];
+    purpose?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    correlationId?: string;
+    allowed: boolean;
+    policyIds?: string[];
+    denialReason?: string;
+}
+export interface ITicketAccessAuditFilters {
+    from?: Date;
+    to?: Date;
+    userId?: string;
+    actorId?: string;
+    effectiveUserId?: string;
+    actions?: TicketAccessAuditAction[];
+    resourceTypes?: TicketSecurityResourceType[];
+    ticketId?: string;
+    fieldNameKey?: string;
+    allowed?: boolean;
+    policyId?: string;
+    ipAddress?: string;
+    correlationId?: string;
+}
+export interface ITicketAccessAuditSearchRequest extends ITicketAccessAuditFilters {
+    cursor?: string;
+    limit?: number;
+}
+export interface ITicketAccessAuditEventDetail {
+    event: ITicketAccessAuditEvent;
+    correlated: ITicketAccessAuditEvent[];
+}
+export interface ITicketAccessAuditExportPreview {
+    filters: ITicketAccessAuditFilters;
+    from?: Date;
+    to?: Date;
+    estimatedEventCount: number;
+    includesSensitiveData: boolean;
+    includedActions: TicketAccessAuditAction[];
+    wideRangeWarning?: string;
 }
 export interface ITicketImpersonationSession {
     id: string;
@@ -260,15 +475,51 @@ export interface ITicketAuthorizationRequest {
     context?: {
         [key: string]: TicketPropertyValue;
     };
+    evaluatedAt?: Date;
+    subjectContext?: ITicketAuthorizationSubjectContext;
+    ticketContext?: ITicketAuthorizationTicketContext;
+    record?: boolean;
+    purpose?: string;
+}
+export interface ITicketAuthorizationSubjectContext {
+    isAgent?: boolean;
+    isCustomer?: boolean;
+    roleIds?: string[];
+    groupIds?: string[];
+    organizationIds?: string[];
+    contactSegmentIds?: string[];
+}
+export interface ITicketAuthorizationTicketContext {
+    requesterId?: string;
+    assigneeId?: string;
+    assignedGroupId?: string;
+    categoryId?: string;
+    channelId?: string;
+    brandId?: string;
+    organizationId?: string;
+    sensitivityLevel?: TicketSensitivityLevel;
+    fields?: {
+        [nameKey: string]: TicketPropertyValue;
+    };
 }
 export interface ITicketAuthorizationDecision {
     allowed: boolean;
     policyIds: string[];
+    decisivePolicyId?: string;
     deniedFieldNameKeys?: string[];
     maskedFieldNameKeys?: string[];
     reason?: string;
     evaluatedAt: Date;
 }
+export interface ITicketSecurityPolicyValidationIssue {
+    code: string;
+    severity: 'ERROR' | 'WARNING';
+    message: string;
+    path?: string;
+}
+export interface IValidateTicketSecurityPolicyResponse {
+    issues: ITicketSecurityPolicyValidationIssue[];
+}
 export interface ICreateTicketRedactionRequestDto {
     expectedVersion: number;
     fieldNameKeys?: string[];
@@ -284,8 +535,23 @@ export interface ICreateTicketLegalHoldDto {
 }
 export interface IReleaseTicketLegalHoldDto {
     expectedVersion: number;
-    legalHoldId: string;
-    reason: string;
+    releaseReason: TicketLegalHoldReleaseReason;
+    releaseNotes?: string;
+}
+export interface ITicketSuspendedRetentionPolicy {
+    id: string;
+    name: string;
+    action: TicketRetentionAction;
+    retentionDays: number;
+}
+export interface ITicketLegalHoldsResponse {
+    onHold: boolean;
+    holds: ITicketLegalHold[];
+    suspendedPolicies: ITicketSuspendedRetentionPolicy[];
+}
+export interface ITicketLegalHoldListEntry extends ITicketLegalHold {
+    ticketNumber: number;
+    ticketTitle: string;
 }
 export interface ICreateTicketDelegatedAccessDto {
     delegateId: string;
@@ -300,3 +566,4 @@ export interface IStartTicketImpersonationDto {
     reason: string;
     expiresAt: Date;
 }
+export type TicketAccessAuditPage = ITicketCursorResponse<ITicketAccessAuditEvent>;

package/dist/src/Tickets/Security.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TicketDelegatedAccessStatus = exports.TicketAccessAuditAction = exports.TicketLegalHoldStatus = exports.TicketRetentionAction = exports.TicketRedactionStatus = exports.TicketMaskingStrategy = exports.TicketDataClassification = exports.TicketSensitivityLevel = exports.TicketPolicyConditionGroupOperator = exports.TicketPolicyEffect = exports.TicketSecurityOperation = exports.TicketSecurityResourceType = void 0;
+exports.TicketLegalHoldReleaseReason = exports.TicketDelegatedAccessStatus = exports.TicketAccessAuditAction = exports.TicketLegalHoldStatus = exports.TicketRetentionAction = exports.TicketRedactionStatus = exports.TicketMaskingStrategy = exports.TicketDataClassification = exports.TicketSensitivityLevel = exports.TicketPolicyConditionGroupOperator = exports.TicketPolicyEffect = exports.TicketSecurityOperation = exports.TicketSecurityResourceType = void 0;
 var TicketSecurityResourceType;
 (function (TicketSecurityResourceType) {
     TicketSecurityResourceType["TICKET"] = "TICKET";
@@ -105,3 +105,12 @@ var TicketDelegatedAccessStatus;
     TicketDelegatedAccessStatus["EXPIRED"] = "EXPIRED";
     TicketDelegatedAccessStatus["REJECTED"] = "REJECTED";
 })(TicketDelegatedAccessStatus || (exports.TicketDelegatedAccessStatus = TicketDelegatedAccessStatus = {}));
+var TicketLegalHoldReleaseReason;
+(function (TicketLegalHoldReleaseReason) {
+    TicketLegalHoldReleaseReason["MATTER_CLOSED"] = "MATTER_CLOSED";
+    TicketLegalHoldReleaseReason["NO_LONGER_RELEVANT"] = "NO_LONGER_RELEVANT";
+    TicketLegalHoldReleaseReason["APPLIED_IN_ERROR"] = "APPLIED_IN_ERROR";
+    TicketLegalHoldReleaseReason["SUPERSEDED"] = "SUPERSEDED";
+    TicketLegalHoldReleaseReason["OBLIGATION_EXPIRED"] = "OBLIGATION_EXPIRED";
+    TicketLegalHoldReleaseReason["OTHER"] = "OTHER";
+})(TicketLegalHoldReleaseReason || (exports.TicketLegalHoldReleaseReason = TicketLegalHoldReleaseReason = {}));

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

@@ -67,6 +67,46 @@ export interface ITicketPortal extends ITicketAuditedEntity {
     privacyDocumentId?: string;
     enabled: boolean;
 }
+export interface ICreateTicketPortalDto {
+    name: string;
+    slug: string;
+    title: string;
+    description?: string;
+    logoUrl?: string;
+    faviconUrl?: string;
+    primaryColor?: string;
+    defaultLocale: string;
+    supportedLocales?: string[];
+    authenticationMode: TicketPortalAuthenticationMode;
+    allowTicketCreation?: boolean;
+    allowTicketTracking?: boolean;
+    allowComments?: boolean;
+    allowReopen?: boolean;
+    allowCancellation?: boolean;
+    termsDocumentId?: string;
+    privacyDocumentId?: string;
+    enabled?: boolean;
+}
+export interface IUpdateTicketPortalDto {
+    name?: string;
+    slug?: string;
+    title?: string;
+    description?: string | null;
+    logoUrl?: string | null;
+    faviconUrl?: string | null;
+    primaryColor?: string | null;
+    defaultLocale?: string;
+    supportedLocales?: string[] | null;
+    authenticationMode?: TicketPortalAuthenticationMode;
+    allowTicketCreation?: boolean;
+    allowTicketTracking?: boolean;
+    allowComments?: boolean;
+    allowReopen?: boolean;
+    allowCancellation?: boolean;
+    termsDocumentId?: string | null;
+    privacyDocumentId?: string | null;
+    enabled?: boolean;
+}
 export interface ITicketRequestType extends ITicketAuditedEntity {
     name: string;
     description?: string;
@@ -84,6 +124,40 @@ export interface ITicketRequestType extends ITicketAuditedEntity {
     audiencePolicyId?: string;
     enabled: boolean;
 }
+export interface ICreateTicketRequestTypeDto {
+    name: string;
+    description?: string;
+    categoryId: string;
+    icon?: string;
+    formId: string;
+    formVersion?: number;
+    workflowId?: string;
+    defaultPriority?: TicketPriority;
+    defaultAssignedGroupId?: string;
+    slaPolicyId?: string;
+    publicStatusSchemeId?: string;
+    fieldDefinitionIds?: string[];
+    layoutIds?: string[];
+    audiencePolicyId?: string;
+    enabled?: boolean;
+}
+export interface IUpdateTicketRequestTypeDto {
+    name?: string;
+    description?: string | null;
+    categoryId?: string;
+    icon?: string | null;
+    formId?: string;
+    formVersion?: number | null;
+    workflowId?: string | null;
+    defaultPriority?: TicketPriority | null;
+    defaultAssignedGroupId?: string | null;
+    slaPolicyId?: string | null;
+    publicStatusSchemeId?: string | null;
+    fieldDefinitionIds?: string[] | null;
+    layoutIds?: string[] | null;
+    audiencePolicyId?: string | null;
+    enabled?: boolean;
+}
 export interface IServiceCatalog extends ITicketAuditedEntity {
     portalId: string;
     name: string;
@@ -91,6 +165,20 @@ export interface IServiceCatalog extends ITicketAuditedEntity {
     order?: number;
     enabled: boolean;
 }
+export interface ICreateServiceCatalogDto {
+    portalId: string;
+    name: string;
+    description?: string;
+    order?: number;
+    enabled?: boolean;
+}
+export interface IUpdateServiceCatalogDto {
+    portalId?: string;
+    name?: string;
+    description?: string | null;
+    order?: number | null;
+    enabled?: boolean;
+}
 export interface IServiceCatalogSection extends ITicketAuditedEntity {
     catalogId: string;
     parentSectionId?: string;
@@ -100,6 +188,24 @@ export interface IServiceCatalogSection extends ITicketAuditedEntity {
     order: number;
     enabled: boolean;
 }
+export interface ICreateServiceCatalogSectionDto {
+    catalogId: string;
+    parentSectionId?: string;
+    name: string;
+    description?: string;
+    icon?: string;
+    order?: number;
+    enabled?: boolean;
+}
+export interface IUpdateServiceCatalogSectionDto {
+    catalogId?: string;
+    parentSectionId?: string | null;
+    name?: string;
+    description?: string | null;
+    icon?: string | null;
+    order?: number;
+    enabled?: boolean;
+}
 export interface IServiceCatalogItem extends ITicketAuditedEntity {
     catalogId: string;
     sectionId?: string;
@@ -112,6 +218,30 @@ export interface IServiceCatalogItem extends ITicketAuditedEntity {
     audiencePolicyId?: string;
     enabled: boolean;
 }
+export interface ICreateServiceCatalogItemDto {
+    catalogId: string;
+    sectionId?: string;
+    requestTypeId: string;
+    name: string;
+    shortDescription?: string;
+    imageUrl?: string;
+    order?: number;
+    estimatedDeliveryMinutes?: number;
+    audiencePolicyId?: string;
+    enabled?: boolean;
+}
+export interface IUpdateServiceCatalogItemDto {
+    catalogId?: string;
+    sectionId?: string | null;
+    requestTypeId?: string;
+    name?: string;
+    shortDescription?: string | null;
+    imageUrl?: string | null;
+    order?: number;
+    estimatedDeliveryMinutes?: number | null;
+    audiencePolicyId?: string | null;
+    enabled?: boolean;
+}
 export interface ITicketAudienceRule {
     id: string;
     effect: TicketAudienceRuleEffect;
@@ -129,6 +259,20 @@ export interface ITicketAudiencePolicy extends ITicketAuditedEntity {
     rules: ITicketAudienceRule[];
     enabled: boolean;
 }
+export interface ICreateTicketAudiencePolicyDto {
+    name: string;
+    description?: string;
+    defaultEffect: TicketAudienceRuleEffect;
+    rules?: ITicketAudienceRule[];
+    enabled?: boolean;
+}
+export interface IUpdateTicketAudiencePolicyDto {
+    name?: string;
+    description?: string | null;
+    defaultEffect?: TicketAudienceRuleEffect;
+    rules?: ITicketAudienceRule[];
+    enabled?: boolean;
+}
 export interface ITicketRequestDraft {
     id: string;
     spaceId: string;
@@ -191,6 +335,28 @@ export interface ITicketKnowledgeReference extends ITicketAuditedEntity {
     order?: number;
     enabled: boolean;
 }
+export interface ICreateTicketKnowledgeReferenceDto {
+    referenceType: TicketKnowledgeReferenceType;
+    documentId: string;
+    portalIds?: string[];
+    requestTypeIds?: string[];
+    categoryIds?: string[];
+    locales?: string[];
+    audiencePolicyId?: string;
+    order?: number;
+    enabled?: boolean;
+}
+export interface IUpdateTicketKnowledgeReferenceDto {
+    referenceType?: TicketKnowledgeReferenceType;
+    documentId?: string;
+    portalIds?: string[] | null;
+    requestTypeIds?: string[] | null;
+    categoryIds?: string[] | null;
+    locales?: string[] | null;
+    audiencePolicyId?: string | null;
+    order?: number | null;
+    enabled?: boolean;
+}
 /** Rules may work globally at portal level and become more specific by request type/category. */
 export interface ITicketDeflectionRule extends ITicketAuditedEntity {
     name: string;
@@ -204,6 +370,30 @@ export interface ITicketDeflectionRule extends ITicketAuditedEntity {
     audiencePolicyId?: string;
     enabled: boolean;
 }
+export interface ICreateTicketDeflectionRuleDto {
+    name: string;
+    portalId: string;
+    requestTypeIds?: string[];
+    categoryIds?: string[];
+    knowledgeReferenceIds?: string[];
+    includeKnownIssues?: boolean;
+    minimumScore?: number;
+    maximumSuggestions?: number;
+    audiencePolicyId?: string;
+    enabled?: boolean;
+}
+export interface IUpdateTicketDeflectionRuleDto {
+    name?: string;
+    portalId?: string;
+    requestTypeIds?: string[] | null;
+    categoryIds?: string[] | null;
+    knowledgeReferenceIds?: string[] | null;
+    includeKnownIssues?: boolean;
+    minimumScore?: number | null;
+    maximumSuggestions?: number | null;
+    audiencePolicyId?: string | null;
+    enabled?: boolean;
+}
 export interface ITicketDeflectionSuggestion {
     knowledgeReferenceId?: string;
     knownIssueTicketId?: string;