clarion-shared-types 1.0.89 → 1.0.91

package/dist/types/modules/partner/interfaces/partner-membership.dto.d.ts

@@ -0,0 +1,176 @@
+import { PartnerMemberDocumentType, PartnerMemberGender, PartnerMemberProfileField, PartnerMemberState, PartnerMembershipStatus, PartnerMembershipSubjectType, PartnerProviderCode } from '../enums/partner-enums';
+/**
+ * A person, as a partner membership records them.
+ *
+ * Deliberately NOT a Clarion user, a billing client or a beneficiary: those are
+ * three rows in three services, and a partner cares about none of that
+ * distinction. It wants a name, a number and enough identity to tell two people
+ * apart.
+ */
+export interface PartnerMemberProfileDto {
+    fullName: string;
+    /** E.164, e.g. `+254712345678`. */
+    phoneNumber?: string | null;
+    email?: string | null;
+    /** `YYYY-MM-DD`. A calendar date, never a timestamp. */
+    dateOfBirth?: string | null;
+    gender?: PartnerMemberGender | null;
+    documentType?: PartnerMemberDocumentType | null;
+    /**
+     * ALWAYS masked by the API - `***67`, never the whole number.
+     *
+     * An identity document cannot be rotated and outlives any credential, and
+     * an operator does not need it in order to act. Treat this as display-only.
+     */
+    documentNumber?: string | null;
+    documentCountryCode?: string | null;
+    /** Partner-declared extras, keyed by that partner's descriptor field keys. */
+    attributes?: Record<string, string> | null;
+}
+/**
+ * Why a partner cannot yet be told about somebody.
+ *
+ * MISSING and MALFORMED are not the same problem and do not have the same
+ * remedy: one needs the fact collected, the other needs it corrected. An
+ * operator staring at a filled-in date of birth the platform calls "missing"
+ * has nothing to do.
+ */
+export interface UnsatisfiedMemberProfileFieldDto {
+    field: string;
+    reason: 'MISSING' | 'MALFORMED';
+    detail?: string;
+}
+/** One dependent carried on somebody else's membership. */
+export interface PartnerMembershipDependentDto {
+    dependentReference: string;
+    userId?: number | null;
+    /** The partner's own id. Absent means the partner has NOT accepted them. */
+    partnerDependentId?: string | null;
+    name: string;
+    /** The name the partner accepted, which many partners will not let change. */
+    partnerName?: string | null;
+    synced: boolean;
+    /**
+     * True when Clarion has stopped covering them but the partner will only
+     * drop them at the end of the term - a real, dated divergence rather than
+     * something to hide.
+     */
+    pendingRemovalAtTermEnd?: boolean;
+    lastErrorMessage?: string | null;
+    syncedAt?: string | null;
+}
+/** One subscriber's registration with one partner, as the API returns it. */
+export interface PartnerMembershipDto {
+    id: number;
+    membershipReference: string;
+    organizationId: number;
+    integrationId: number;
+    providerCode: PartnerProviderCode;
+    subjectType: PartnerMembershipSubjectType;
+    subjectReference: string;
+    userId?: number | null;
+    subscriptionId?: number | null;
+    packageId?: number | null;
+    membershipLabel?: string | null;
+    status: PartnerMembershipStatus;
+    /** Present only once the partner has issued one. */
+    partnerMemberId?: string | null;
+    /** The partner's own status word, verbatim, e.g. `waitingPeriod`. */
+    partnerStatus?: string | null;
+    memberState?: PartnerMemberState | null;
+    /**
+     * When the partner's cover actually begins and ends.
+     *
+     * Distinct from the membership being ACTIVE. A member can be registered,
+     * hold a real member id, and not be covered yet.
+     */
+    coverageStartsAt?: string | null;
+    coverageEndsAt?: string | null;
+    /** True when the partner has confirmed cover is in force right now. */
+    coverActive?: boolean;
+    partnerSeats?: number | null;
+    /** The member's name. The LIST carries this and nothing else personal. */
+    memberName?: string | null;
+    /** Present on the detail endpoint only, with the document number masked. */
+    profile?: PartnerMemberProfileDto | null;
+    unsatisfiedFields: UnsatisfiedMemberProfileFieldDto[];
+    dependents: PartnerMembershipDependentDto[];
+    attemptCount: number;
+    maxAttempts: number;
+    nextAttemptAt?: string | null;
+    failureReason?: string | null;
+    lastErrorCode?: string | null;
+    lastErrorMessage?: string | null;
+    countryCode: string;
+    provisionedAt?: string | null;
+    lastSyncedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Filters for the membership list. */
+export interface PartnerMembershipQueryDto {
+    integrationId?: number;
+    status?: PartnerMembershipStatus;
+    subjectType?: PartnerMembershipSubjectType;
+    userId?: number;
+    subscriptionId?: number;
+    search?: string;
+    /** Narrow to the memberships an operator can actually unblock. */
+    needsAttention?: boolean;
+    page?: number;
+    limit?: number;
+}
+/** An operator filling in or correcting what a partner is waiting for. */
+export interface UpdatePartnerMembershipDto {
+    profile?: Partial<PartnerMemberProfileDto>;
+    /** Queue another attempt straight away, rather than waiting for the worker. */
+    retryNow?: boolean;
+}
+/**
+ * One thing a partner needs to know about a person, described so the admin can
+ * render a form for it without knowing which partner it is.
+ *
+ * The same shape as a partnership's `configFields`, and for the same reason: a
+ * partner that starts wanting a policy number costs a descriptor change and
+ * nothing else.
+ */
+export interface PartnerMemberProfileFieldDescriptorDto {
+    key: string;
+    label: string;
+    description?: string;
+    required: boolean;
+    type: 'string' | 'number' | 'boolean' | 'enum' | 'date';
+    allowedValues?: string[];
+    pattern?: string;
+    maxLength?: number;
+    /** Where an operator is likely to find this, shown as help text. */
+    sourceHint?: string;
+}
+/** What one partner needs before it will register a member. */
+export interface PartnerMembershipDescriptorDto {
+    profileFields: PartnerMemberProfileFieldDescriptorDto[];
+    requiredProfileFields: PartnerMemberProfileField[];
+    optionalProfileFields: PartnerMemberProfileField[];
+    supportsDependents: boolean;
+    maxDependents: number | null;
+    quotesMemberOnDispatch: boolean;
+    quotableStates?: PartnerMemberState[];
+    identityDocumentOptional: boolean;
+    /**
+     * Shown beside the membership settings - e.g. that a new member serves a
+     * waiting period before cover begins. Operators need to know that, and it
+     * is not inferable from anything else on screen.
+     */
+    notes?: string;
+}
+/** The demographic details captured against a person, for a partner to use. */
+export interface UpsertMemberProfileDto {
+    userId?: number;
+    corporateClientMemberId?: number;
+    dateOfBirth?: string;
+    gender?: PartnerMemberGender;
+    documentType?: PartnerMemberDocumentType;
+    documentNumber?: string;
+    documentCountryCode?: string;
+    attributes?: Record<string, string>;
+}

package/dist/types/modules/partner/interfaces/partner-provider.dto.d.ts

@@ -1,4 +1,5 @@
 import { PartnerIntegrationEnvironment, PartnerProviderCode, PartnerServiceCapability } from '../enums/partner-enums';
+import { PartnerMembershipDescriptorDto } from './partner-membership.dto';
 /** A credential a partnership must supply, described by the backend adapter. */
 export interface PartnerProviderCredentialFieldDto {
     key: string;
@@ -53,6 +54,15 @@ export interface PartnerProviderDescriptorDto {
     supportsAmendment: boolean;
     /** True when the partner can be asked whether a request already exists. */
     supportsDuplicateDetection: boolean;
+    /**
+     * True when this partner registers people as MEMBERS ahead of an emergency.
+     *
+     * When false the admin must not offer membership settings at all: a toggle
+     * that provisions nothing is worse than no toggle.
+     */
+    supportsMembership: boolean;
+    /** What this partner needs to register a member. Present when the flag is true. */
+    membership?: PartnerMembershipDescriptorDto;
     available: boolean;
 }
 /** Result of the admin's "test connection" button. Never creates an emergency. */

package/dist/types/modules/partner/utils/partner-display.util.d.ts

@@ -1,4 +1,5 @@
-import { IncidentPartnerRoutingStatus, PartnerEngagementState, PartnerCoverageMatchType, PartnerDispatchStatus, PartnerIntegrationStatus, PartnerRoutingMode, PartnerServiceCapability } from '../enums/partner-enums';
+import { IncidentPartnerRoutingStatus, PartnerEngagementState, PartnerCoverageMatchType, PartnerDispatchStatus, PartnerIntegrationStatus, PartnerMemberDocumentType, PartnerMemberGender, PartnerMemberProfileField, PartnerMemberState, PartnerMembershipPackageScope, PartnerMembershipStatus, PartnerMembershipSubjectType, PartnerRoutingMode, PartnerServiceCapability } from '../enums/partner-enums';
+import { UnsatisfiedMemberProfileFieldDto } from '../interfaces/partner-membership.dto';
 /**
  * Human labels for the partner enums.
  *
@@ -48,3 +49,52 @@ export interface PartnerActionCapabilities {
     supportsWithdrawal?: boolean;
     supportsAmendment?: boolean;
 }
+/**
+ * How a membership's own lifecycle reads on screen.
+ *
+ * Worded as what an operator should DO, not as an internal state name. Nobody
+ * has to know what PROVISIONING means; they have to know whether somebody is
+ * waiting on them.
+ */
+export declare const PARTNER_MEMBERSHIP_STATUS_LABELS: Readonly<Record<PartnerMembershipStatus, string>>;
+/**
+ * How the PARTNER's own view of a member reads.
+ *
+ * Kept apart from the status above because the two answer different questions,
+ * and collapsing them is how somebody gets told they are covered on the day
+ * they paid: "Registered" means the partner has issued a member id, and
+ * "Waiting period" means their cover has not started.
+ */
+export declare const PARTNER_MEMBER_STATE_LABELS: Readonly<Record<PartnerMemberState, string>>;
+export declare const PARTNER_MEMBERSHIP_SUBJECT_TYPE_LABELS: Readonly<Record<PartnerMembershipSubjectType, string>>;
+export declare const PARTNER_MEMBERSHIP_PACKAGE_SCOPE_LABELS: Readonly<Record<PartnerMembershipPackageScope, string>>;
+export declare const PARTNER_MEMBER_GENDER_LABELS: Readonly<Record<PartnerMemberGender, string>>;
+export declare const PARTNER_MEMBER_DOCUMENT_TYPE_LABELS: Readonly<Record<PartnerMemberDocumentType, string>>;
+/** The provider-neutral profile fields, named for a person to read. */
+export declare const PARTNER_MEMBER_PROFILE_FIELD_LABELS: Readonly<Record<PartnerMemberProfileField, string>>;
+export declare function partnerMembershipStatusTone(status: PartnerMembershipStatus): 'success' | 'warn' | 'danger' | 'neutral';
+/**
+ * One line saying what a membership is waiting on, or null when nothing is.
+ *
+ * The whole point of the membership screen. An operator should never have to
+ * open a record to find out whether it needs them, and should never be shown a
+ * partner's raw error where a plain sentence would do.
+ */
+export declare function describeMembershipAttention(membership: {
+    status: PartnerMembershipStatus;
+    unsatisfiedFields?: UnsatisfiedMemberProfileFieldDto[];
+    lastErrorMessage?: string | null;
+}): string | null;
+/**
+ * What the partner's cover actually says, in a sentence.
+ *
+ * Separate from the status chip because "registered" and "covered" are
+ * different facts, and a partner that starts a member on a waiting period would
+ * otherwise be reported as though cover began the day they paid.
+ */
+export declare function describeMembershipCover(membership: {
+    status: PartnerMembershipStatus;
+    memberState?: PartnerMemberState | null;
+    coverActive?: boolean;
+    coverageStartsAt?: string | null;
+}): string | null;

package/dist/types/modules/permission/enums/permission-actions.enum.d.ts

@@ -7,6 +7,13 @@ export declare enum PermissionActions {
     READ_PARTNER = "read:partner",
     UPDATE_PARTNER = "update:partner",
     DELETE_PARTNER = "delete:partner",
+    READ_PARTNER_DISPATCH = "read:partner-dispatch",
+    APPROVE_PARTNER_DISPATCH = "approve:partner-dispatch",
+    UPDATE_PARTNER_DISPATCH = "update:partner-dispatch",
+    CANCEL_PARTNER_DISPATCH = "cancel:partner-dispatch",
+    RESEND_PARTNER_DISPATCH = "resend:partner-dispatch",
+    READ_PARTNER_MEMBERSHIP = "read:partner-membership",
+    MANAGE_PARTNER_MEMBERSHIP = "manage:partner-membership",
     CREATE_CONTROL_CENTRE = "create:control-centre",
     READ_CONTROL_CENTRE = "read:control-centre",
     UPDATE_CONTROL_CENTRE = "update:control-centre",
@@ -30,5 +37,26 @@ export declare enum PermissionActions {
     CREATE_RESPONSE_UNIT = "create:response-unit",
     READ_RESPONSE_UNIT = "read:response-unit",
     UPDATE_RESPONSE_UNIT = "update:response-unit",
-    DELETE_RESPONSE_UNIT = "delete:response-unit"
+    DELETE_RESPONSE_UNIT = "delete:response-unit",
+    CREATE_SUPPORT_TICKET = "create:support-ticket",
+    READ_SUPPORT_TICKET = "read:support-ticket",
+    UPDATE_SUPPORT_TICKET = "update:support-ticket",
+    ASSIGN_SUPPORT_TICKET = "assign:support-ticket",
+    REPLY_SUPPORT_TICKET = "reply:support-ticket",
+    NOTE_SUPPORT_TICKET = "note:support-ticket",
+    CHANGE_STATUS_SUPPORT_TICKET = "change-status:support-ticket",
+    CHANGE_PRIORITY_SUPPORT_TICKET = "change-priority:support-ticket",
+    CLOSE_SUPPORT_TICKET = "close:support-ticket",
+    REOPEN_SUPPORT_TICKET = "reopen:support-ticket",
+    READ_SUPPORT_FEEDBACK = "read:support-feedback",
+    REVIEW_SUPPORT_FEEDBACK = "review:support-feedback",
+    RESPOND_SUPPORT_FEEDBACK = "respond:support-feedback",
+    CONVERT_SUPPORT_FEEDBACK = "convert:support-feedback",
+    MANAGE_SUPPORT_QUEUE = "manage:support-queue",
+    MANAGE_SUPPORT_TEAM = "manage:support-team",
+    MANAGE_SUPPORT_SLA = "manage:support-sla",
+    MANAGE_SUPPORT_CONFIGURATION = "manage:support-configuration",
+    READ_SUPPORT_REPORT = "read:support-report",
+    READ_SUPPORT_SYNC = "read:support-sync",
+    MANAGE_SUPPORT_SYNC = "manage:support-sync"
 }

package/dist/types/modules/permission/enums/permissions-moudule.enum.d.ts

@@ -5,5 +5,6 @@ export declare enum PermissionsModule {
     USER = "User",
     ROLE = "Role",
     INCIDENT = "Grievance",
-    RESPONSE_UNIT = "Response Unit"
+    RESPONSE_UNIT = "Response Unit",
+    SUPPORT = "Support"
 }

package/dist/types/modules/support/enums/support-enums.d.ts

@@ -0,0 +1,341 @@
+/**
+ * Frontend mirrors of the support enums in grm-shared-library.
+ *
+ * Kept in ONE file rather than one per enum: the admin's support console
+ * imports most of them together and the set only means anything as a whole. The
+ * values are byte-identical to the backend's, because they travel over the wire
+ * as strings and any drift would show up as a silently unstyled chip rather
+ * than a compile error.
+ */
+/** The helpdesk a deployment mirrors tickets to, if any. */
+export declare enum SupportProviderCode {
+    ZAMMAD = "ZAMMAD",
+    FRESHDESK = "FRESHDESK",
+    /** No external helpdesk. Clarion is the whole system of record. */
+    NONE = "NONE"
+}
+/** What a helpdesk adapter is able to do. The admin builds its buttons from this. */
+export declare enum SupportProviderCapability {
+    CREATE_TICKET = "CREATE_TICKET",
+    UPDATE_TICKET = "UPDATE_TICKET",
+    PUBLIC_REPLY = "PUBLIC_REPLY",
+    INTERNAL_NOTE = "INTERNAL_NOTE",
+    ASSIGN_TICKET = "ASSIGN_TICKET",
+    CHANGE_STATUS = "CHANGE_STATUS",
+    CLOSE_REOPEN = "CLOSE_REOPEN",
+    ATTACHMENTS = "ATTACHMENTS",
+    CONTACTS = "CONTACTS",
+    SEARCH = "SEARCH",
+    WEBHOOKS = "WEBHOOKS",
+    FETCH_TICKET = "FETCH_TICKET"
+}
+/** Lifecycle of a support ticket. */
+export declare enum SupportTicketStatus {
+    NEW = "NEW",
+    OPEN = "OPEN",
+    ASSIGNED = "ASSIGNED",
+    IN_PROGRESS = "IN_PROGRESS",
+    WAITING_ON_CUSTOMER = "WAITING_ON_CUSTOMER",
+    WAITING_ON_INTERNAL_TEAM = "WAITING_ON_INTERNAL_TEAM",
+    RESOLVED = "RESOLVED",
+    CLOSED = "CLOSED",
+    REOPENED = "REOPENED",
+    CANCELLED = "CANCELLED"
+}
+/** How urgently a ticket needs answering. */
+export declare enum SupportTicketPriority {
+    CRITICAL = "CRITICAL",
+    URGENT = "URGENT",
+    HIGH = "HIGH",
+    NORMAL = "NORMAL",
+    LOW = "LOW"
+}
+/** How a ticket reached Clarion. */
+export declare enum SupportTicketChannel {
+    MOBILE_APP = "MOBILE_APP",
+    WEB_APP = "WEB_APP",
+    AGENT_PORTAL = "AGENT_PORTAL",
+    PROVIDER = "PROVIDER",
+    EMAIL = "EMAIL",
+    PHONE = "PHONE",
+    SMS = "SMS",
+    CHAT = "CHAT",
+    SYSTEM = "SYSTEM",
+    API = "API"
+}
+/** Who or what caused the ticket to exist. */
+export declare enum SupportTicketSource {
+    CUSTOMER = "CUSTOMER",
+    AGENT = "AGENT",
+    SYSTEM = "SYSTEM",
+    FEEDBACK_CONVERSION = "FEEDBACK_CONVERSION",
+    PROVIDER_SYNC = "PROVIDER_SYNC",
+    CHAT_ESCALATION = "CHAT_ESCALATION"
+}
+/**
+ * What kind of entry a conversation item is.
+ *
+ * INTERNAL_NOTE is the one the UI must never render on a customer-facing
+ * surface. The admin styles it distinctly for the same reason - an agent who
+ * cannot tell at a glance which entries the customer can see will eventually
+ * write the wrong thing in the wrong box.
+ */
+export declare enum SupportTicketMessageType {
+    CUSTOMER_MESSAGE = "CUSTOMER_MESSAGE",
+    AGENT_REPLY = "AGENT_REPLY",
+    INTERNAL_NOTE = "INTERNAL_NOTE",
+    SYSTEM_MESSAGE = "SYSTEM_MESSAGE",
+    STATUS_MESSAGE = "STATUS_MESSAGE"
+}
+/** Who wrote a conversation entry. */
+export declare enum SupportMessageAuthorType {
+    CUSTOMER = "CUSTOMER",
+    AGENT = "AGENT",
+    SYSTEM = "SYSTEM",
+    PROVIDER_AGENT = "PROVIDER_AGENT"
+}
+/** Whether an entry was written here or arrived from the helpdesk. */
+export declare enum SupportMessageOrigin {
+    CLARION = "CLARION",
+    PROVIDER = "PROVIDER"
+}
+/** Where a ticket stands against one SLA target. */
+export declare enum SupportSlaState {
+    ON_TRACK = "ON_TRACK",
+    WARNING = "WARNING",
+    BREACHED = "BREACHED",
+    PAUSED = "PAUSED",
+    MET = "MET",
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}
+/** Which clock a state describes. */
+export declare enum SupportSlaTarget {
+    FIRST_RESPONSE = "FIRST_RESPONSE",
+    RESOLUTION = "RESOLUTION"
+}
+/** How a policy measures elapsed time. */
+export declare enum SupportSlaClock {
+    CALENDAR = "CALENDAR",
+    BUSINESS = "BUSINESS"
+}
+/** What a customer is telling us. */
+export declare enum CustomerFeedbackType {
+    BUG_REPORT = "BUG_REPORT",
+    FEATURE_REQUEST = "FEATURE_REQUEST",
+    COMPLAINT = "COMPLAINT",
+    COMPLIMENT = "COMPLIMENT",
+    GENERAL = "GENERAL",
+    SERVICE_RATING = "SERVICE_RATING",
+    SUPPORT_RATING = "SUPPORT_RATING"
+}
+/** Where a piece of feedback is in its review workflow. */
+export declare enum CustomerFeedbackStatus {
+    NEW = "NEW",
+    UNDER_REVIEW = "UNDER_REVIEW",
+    ACKNOWLEDGED = "ACKNOWLEDGED",
+    RESPONDED = "RESPONDED",
+    CONVERTED_TO_TICKET = "CONVERTED_TO_TICKET",
+    CLOSED = "CLOSED",
+    DISMISSED = "DISMISSED"
+}
+/** Where the feedback was submitted from. */
+export declare enum CustomerFeedbackChannel {
+    MOBILE_APP = "MOBILE_APP",
+    WEB_APP = "WEB_APP",
+    AGENT_PORTAL = "AGENT_PORTAL",
+    API = "API"
+}
+/** Coarse sentiment, derived from type and rating - never from the message text. */
+export declare enum CustomerFeedbackSentiment {
+    POSITIVE = "POSITIVE",
+    NEUTRAL = "NEUTRAL",
+    NEGATIVE = "NEGATIVE",
+    UNKNOWN = "UNKNOWN"
+}
+/** Who wrote an entry in a feedback thread. */
+export declare enum CustomerFeedbackMessageAuthorType {
+    CUSTOMER = "CUSTOMER",
+    REVIEWER = "REVIEWER",
+    SYSTEM = "SYSTEM"
+}
+/** The kind of Clarion record a ticket or a piece of feedback is about. */
+export declare enum SupportRelatedEntityType {
+    INCIDENT = "INCIDENT",
+    BILLING_SUBSCRIPTION = "BILLING_SUBSCRIPTION",
+    BILLING_INVOICE = "BILLING_INVOICE",
+    BILLING_PAYMENT = "BILLING_PAYMENT",
+    BILLING_PACKAGE = "BILLING_PACKAGE",
+    CHAT_CONVERSATION = "CHAT_CONVERSATION",
+    NEWSFEED_POST = "NEWSFEED_POST",
+    NEWSFEED_COMMENT = "NEWSFEED_COMMENT",
+    PARTNER_DISPATCH = "PARTNER_DISPATCH",
+    RESPONSE_UNIT = "RESPONSE_UNIT",
+    ORGANIZATION = "ORGANIZATION",
+    USER = "USER",
+    APP_SCREEN = "APP_SCREEN",
+    SUPPORT_TICKET = "SUPPORT_TICKET",
+    CUSTOMER_FEEDBACK = "CUSTOMER_FEEDBACK",
+    OTHER = "OTHER"
+}
+/** Which Clarion record a synchronization row is mirroring. */
+export declare enum SupportSyncEntityType {
+    TICKET = "TICKET",
+    MESSAGE = "MESSAGE",
+    ATTACHMENT = "ATTACHMENT",
+    CONTACT = "CONTACT"
+}
+/** What a synchronization row is trying to do at the provider. */
+export declare enum SupportSyncOperation {
+    UPSERT_CONTACT = "UPSERT_CONTACT",
+    CREATE_TICKET = "CREATE_TICKET",
+    UPDATE_TICKET = "UPDATE_TICKET",
+    ADD_PUBLIC_REPLY = "ADD_PUBLIC_REPLY",
+    ADD_INTERNAL_NOTE = "ADD_INTERNAL_NOTE",
+    ASSIGN_TICKET = "ASSIGN_TICKET",
+    CHANGE_STATUS = "CHANGE_STATUS",
+    ADD_ATTACHMENT = "ADD_ATTACHMENT",
+    CLOSE_TICKET = "CLOSE_TICKET",
+    REOPEN_TICKET = "REOPEN_TICKET",
+    FETCH_TICKET = "FETCH_TICKET"
+}
+/** Where a synchronization row has got to. */
+export declare enum SupportSyncStatus {
+    PENDING = "PENDING",
+    IN_PROGRESS = "IN_PROGRESS",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    DEAD_LETTER = "DEAD_LETTER",
+    SKIPPED = "SKIPPED",
+    SUPERSEDED = "SUPERSEDED"
+}
+/** Why a synchronization attempt failed. */
+export declare enum SupportSyncFailureReason {
+    AUTHENTICATION_FAILED = "AUTHENTICATION_FAILED",
+    AUTHORIZATION_FAILED = "AUTHORIZATION_FAILED",
+    INVALID_PAYLOAD = "INVALID_PAYLOAD",
+    NOT_FOUND = "NOT_FOUND",
+    PROVIDER_REJECTED = "PROVIDER_REJECTED",
+    RATE_LIMITED = "RATE_LIMITED",
+    PROVIDER_UNAVAILABLE = "PROVIDER_UNAVAILABLE",
+    TIMEOUT = "TIMEOUT",
+    CIRCUIT_OPEN = "CIRCUIT_OPEN",
+    PROVIDER_NOT_CONFIGURED = "PROVIDER_NOT_CONFIGURED",
+    UNREADABLE_SUCCESS = "UNREADABLE_SUCCESS",
+    UNKNOWN = "UNKNOWN"
+}
+/** How a provider webhook delivery was handled. */
+export declare enum SupportWebhookStatus {
+    RECEIVED = "RECEIVED",
+    PROCESSED = "PROCESSED",
+    DUPLICATE = "DUPLICATE",
+    IGNORED = "IGNORED",
+    REJECTED = "REJECTED",
+    FAILED = "FAILED"
+}
+/** How a queue hands a ticket to an agent. Only MANUAL is honoured today. */
+export declare enum SupportQueueAssignmentStrategy {
+    MANUAL = "MANUAL",
+    ROUND_ROBIN = "ROUND_ROBIN",
+    LEAST_BUSY = "LEAST_BUSY"
+}
+/** What a routing rule matches on. */
+export declare enum SupportRoutingMatchType {
+    ANY = "ANY",
+    CATEGORY = "CATEGORY",
+    PRIORITY = "PRIORITY",
+    CHANNEL = "CHANNEL",
+    COUNTRY = "COUNTRY",
+    CONTROL_CENTRE = "CONTROL_CENTRE",
+    APP_ID = "APP_ID",
+    RELATED_ENTITY_TYPE = "RELATED_ENTITY_TYPE"
+}
+/** A support person's standing inside a team. */
+export declare enum SupportTeamMemberRole {
+    AGENT = "AGENT",
+    SUPERVISOR = "SUPERVISOR",
+    MANAGER = "MANAGER"
+}
+/** Every audited support action, as a closed vocabulary the admin can filter on. */
+export declare enum SupportAuditAction {
+    TICKET_CREATED = "TICKET_CREATED",
+    TICKET_UPDATED = "TICKET_UPDATED",
+    TICKET_ASSIGNED = "TICKET_ASSIGNED",
+    TICKET_REASSIGNED = "TICKET_REASSIGNED",
+    TICKET_UNASSIGNED = "TICKET_UNASSIGNED",
+    TICKET_STATUS_CHANGED = "TICKET_STATUS_CHANGED",
+    TICKET_PRIORITY_CHANGED = "TICKET_PRIORITY_CHANGED",
+    TICKET_CATEGORY_CHANGED = "TICKET_CATEGORY_CHANGED",
+    TICKET_QUEUE_CHANGED = "TICKET_QUEUE_CHANGED",
+    TICKET_CLOSED = "TICKET_CLOSED",
+    TICKET_REOPENED = "TICKET_REOPENED",
+    TICKET_CANCELLED = "TICKET_CANCELLED",
+    TICKET_TAGGED = "TICKET_TAGGED",
+    TICKET_UNTAGGED = "TICKET_UNTAGGED",
+    TICKET_WATCHER_ADDED = "TICKET_WATCHER_ADDED",
+    TICKET_WATCHER_REMOVED = "TICKET_WATCHER_REMOVED",
+    MESSAGE_ADDED = "MESSAGE_ADDED",
+    INTERNAL_NOTE_ADDED = "INTERNAL_NOTE_ADDED",
+    ATTACHMENT_ADDED = "ATTACHMENT_ADDED",
+    ATTACHMENT_ACCESSED = "ATTACHMENT_ACCESSED",
+    ATTACHMENT_REMOVED = "ATTACHMENT_REMOVED",
+    FEEDBACK_CREATED = "FEEDBACK_CREATED",
+    FEEDBACK_REVIEWED = "FEEDBACK_REVIEWED",
+    FEEDBACK_RESPONDED = "FEEDBACK_RESPONDED",
+    FEEDBACK_STATUS_CHANGED = "FEEDBACK_STATUS_CHANGED",
+    FEEDBACK_CONVERTED_TO_TICKET = "FEEDBACK_CONVERTED_TO_TICKET",
+    SLA_WARNING_RAISED = "SLA_WARNING_RAISED",
+    SLA_BREACHED = "SLA_BREACHED",
+    SLA_POLICY_CREATED = "SLA_POLICY_CREATED",
+    SLA_POLICY_UPDATED = "SLA_POLICY_UPDATED",
+    SLA_POLICY_DELETED = "SLA_POLICY_DELETED",
+    QUEUE_CREATED = "QUEUE_CREATED",
+    QUEUE_UPDATED = "QUEUE_UPDATED",
+    QUEUE_DELETED = "QUEUE_DELETED",
+    TEAM_CREATED = "TEAM_CREATED",
+    TEAM_UPDATED = "TEAM_UPDATED",
+    TEAM_DELETED = "TEAM_DELETED",
+    TEAM_MEMBER_ADDED = "TEAM_MEMBER_ADDED",
+    TEAM_MEMBER_REMOVED = "TEAM_MEMBER_REMOVED",
+    CATEGORY_CREATED = "CATEGORY_CREATED",
+    CATEGORY_UPDATED = "CATEGORY_UPDATED",
+    CATEGORY_DELETED = "CATEGORY_DELETED",
+    PROVIDER_SYNC_QUEUED = "PROVIDER_SYNC_QUEUED",
+    PROVIDER_SYNC_SUCCEEDED = "PROVIDER_SYNC_SUCCEEDED",
+    PROVIDER_SYNC_FAILED = "PROVIDER_SYNC_FAILED",
+    PROVIDER_SYNC_RETRIED = "PROVIDER_SYNC_RETRIED",
+    PROVIDER_SYNC_DEAD_LETTERED = "PROVIDER_SYNC_DEAD_LETTERED",
+    PROVIDER_RECONCILED = "PROVIDER_RECONCILED",
+    PROVIDER_WEBHOOK_RECEIVED = "PROVIDER_WEBHOOK_RECEIVED",
+    PROVIDER_WEBHOOK_REJECTED = "PROVIDER_WEBHOOK_REJECTED"
+}
+/** What an audit entry was about. */
+export declare enum SupportAuditEntityType {
+    TICKET = "TICKET",
+    TICKET_MESSAGE = "TICKET_MESSAGE",
+    TICKET_ATTACHMENT = "TICKET_ATTACHMENT",
+    FEEDBACK = "FEEDBACK",
+    QUEUE = "QUEUE",
+    TEAM = "TEAM",
+    CATEGORY = "CATEGORY",
+    SLA_POLICY = "SLA_POLICY",
+    PROVIDER_SYNC = "PROVIDER_SYNC"
+}
+/** Who performed an audited action. */
+export declare enum SupportActorType {
+    USER = "USER",
+    SYSTEM = "SYSTEM",
+    PROVIDER = "PROVIDER"
+}
+/** Live support update types delivered over the socket. */
+export declare enum SupportRealtimeEventType {
+    TICKET_CREATED = "support.ticket.created",
+    TICKET_UPDATED = "support.ticket.updated",
+    TICKET_STATUS_CHANGED = "support.ticket.status.changed",
+    TICKET_PRIORITY_CHANGED = "support.ticket.priority.changed",
+    TICKET_ASSIGNED = "support.ticket.assigned",
+    TICKET_MESSAGE_CREATED = "support.ticket.message.created",
+    TICKET_SLA_CHANGED = "support.ticket.sla.changed",
+    TICKET_SYNC_CHANGED = "support.ticket.sync.changed",
+    FEEDBACK_CREATED = "support.feedback.created",
+    FEEDBACK_RESPONDED = "support.feedback.responded"
+}

package/dist/types/modules/support/index.d.ts

@@ -0,0 +1,7 @@
+export * from './enums/support-enums';
+export * from './interfaces/support-ticket.dto';
+export * from './interfaces/customer-feedback.dto';
+export * from './interfaces/support-configuration.dto';
+export * from './interfaces/support-sync.dto';
+export * from './interfaces/support-reports.dto';
+export * from './utils/support-display.util';