@d19n/youfibre-odin-sdk 2.0.52 → 2.0.53

package/dist/entities-v2/Case.d.ts

@@ -0,0 +1,2026 @@
+/**
+ * Case Entity Definition
+ *
+ * Case entity for Customer Service operations. Part of SupportModule. Contains business data for customer service workflows.
+ *
+ * @module SupportModule
+ * @entity Case
+ * @schemaId be8173eb-269b-4a67-be0c-11ce6af5d561
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { ActivityLogProperties } from './ActivityLog';
+import { UserProperties } from './User';
+import { OutageProperties } from './Outage';
+import { SmsMessageProperties } from './SmsMessage';
+import { EmailProperties } from './Email';
+import { CallProperties } from './Call';
+import { ContractBuyOutProperties } from './ContractBuyOut';
+import { TeamProperties } from './Team';
+import { NoteProperties } from './Note';
+import { AccountProperties } from './Account';
+import { WorkOrderProperties } from './WorkOrder';
+import { QueueProperties } from './Queue';
+import { ConversationProperties } from './Conversation';
+import { FileProperties } from './File';
+import { CaseActionProperties } from './CaseAction';
+import { OrderProperties } from './Order';
+import { QueueChangeProperties } from './QueueChange';
+import { ContactProperties } from './Contact';
+import { AddressProperties } from './Address';
+import { PushNotificationProperties } from './PushNotification';
+/**
+ * Available types for Case records
+ */
+export declare enum CaseEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT",
+    /** Outage */
+    OUTAGE = "OUTAGE"
+}
+/**
+ * Pipeline stage names for DEFAULT Case
+ * Pipeline: Case Default
+ * case management pipeline
+ */
+export declare enum DefaultCaseStageNames {
+    /** The case is open and needs to be processed (default) */
+    Open = "Open",
+    Blocked = "Blocked",
+    /** Pending Reply */
+    PendingReply = "Pending Reply",
+    /** Pending Agent */
+    PendingAgent = "Pending Agent",
+    /** Pending Review */
+    PendingReview = "Pending Review",
+    /** The case is resolved (success) */
+    Solved = "Solved",
+    /** The case is closed (fail) */
+    Closed = "Closed",
+    /** Escalated */
+    Escalated = "Escalated"
+}
+/**
+ * Pipeline stage keys for DEFAULT Case
+ * Use these keys when transitioning between stages
+ */
+export declare enum DefaultCaseStageKeys {
+    /** The case is open and needs to be processed */
+    CaseDefaultStageOpen = "CaseDefaultStageOpen",
+    CaseDefaultStageBlocked = "CaseDefaultStageBlocked",
+    /** Pending Reply */
+    CaseDefaultStagePendingReply = "CaseDefaultStagePendingReply",
+    /** Pending Agent */
+    CaseDefaultStagePendingAgent = "CaseDefaultStagePendingAgent",
+    /** Pending Review */
+    CaseDefaultStagePendingReview = "CaseDefaultStagePendingReview",
+    /** The case is resolved */
+    CaseDefaultStageSolved = "CaseDefaultStageSolved",
+    /** The case is closed */
+    CaseDefaultStageClosed = "CaseDefaultStageClosed",
+    /** Escalated */
+    CaseDefaultStageEscalated = "CaseDefaultStageEscalated"
+}
+/**
+ * Pipeline stage names for OUTAGE Case
+ * Pipeline: Outage pipeline
+ * Case management for outages
+ */
+export declare enum OutageCaseStageNames {
+    /** new outage planned or unplanned (default) */
+    New = "New",
+    /** Team has confirmed the outage exists or the maintenance is approved. */
+    Acknowledged = "Acknowledged",
+    /** Restoration work (unplanned) or maintenance tasks (planned) are actively happening. */
+    InProgress = "In Progress",
+    /** Outage or maintenance work is complete. (success) */
+    Solved = "Solved",
+    /** Verification done. Final notifications sent. Post-mortem or documentation completed (if required). */
+    Closed = "Closed"
+}
+/**
+ * Pipeline stage keys for OUTAGE Case
+ * Use these keys when transitioning between stages
+ */
+export declare enum OutageCaseStageKeys {
+    /** new outage planned or unplanned */
+    OutagePipelineStageNew = "OutagePipelineStageNew",
+    /** Team has confirmed the outage exists or the maintenance is approved. */
+    OutagePipelineStageAcknowledged = "OutagePipelineStageAcknowledged",
+    /** Restoration work (unplanned) or maintenance tasks (planned) are actively happening. */
+    OutagePipelineStageInProgress = "OutagePipelineStageInProgress",
+    /** Outage or maintenance work is complete. */
+    OutagePipelineStageSolved = "OutagePipelineStageSolved",
+    /** Verification done. Final notifications sent. Post-mortem or documentation completed (if required). */
+    OutagePipelineStageClosed = "OutagePipelineStageClosed"
+}
+/**
+ * Valid values for Case.BusinessArea
+ *
+ * business area (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `BILLING` - Billing
+ * - `CUSTOMER_EXPERIENCE` - Customer experience
+ * - `INSTALLATION` - Installation
+ * - `NETWORK` - Network team
+ * - `SALES` - Sales
+ * - `SERVICE_DELIVERY` - Service delivery
+ * - `SUPPORT` - Support
+ */
+export declare enum CaseBusinessArea {
+    BILLING = "BILLING",
+    CUSTOMER_EXPERIENCE = "CUSTOMER_EXPERIENCE",
+    INSTALLATION = "INSTALLATION",
+    NETWORK_TEAM = "NETWORK",
+    SALES = "SALES",
+    SERVICE_DELIVERY = "SERVICE_DELIVERY",
+    SUPPORT = "SUPPORT"
+}
+/**
+ * Valid values for Case.Deprecated
+ *
+ * Data field for Case records. Used by Customer Service team.
+ *
+ * @remarks Available options:
+ * - `HIGH` - High
+ * - `LOW` - Low
+ * - `MEDIUM` - Medium
+ * - `URGENT` - Urgent
+ */
+export declare enum CaseDeprecated {
+    HIGH = "HIGH",
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    URGENT = "URGENT"
+}
+/**
+ * Valid values for Case.Origin
+ *
+ * origin of case (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `CUSTOMER_PORTAL_MOBILE` - Customer portal mobile
+ * - `ODIN_AUTOMATION` - Odin Automation
+ * - `OMNI` - Omni
+ * - `WEBSITE` - Website
+ * - `YOUFIBRE` - YouFibre
+ */
+export declare enum CaseOrigin {
+    CUSTOMER_PORTAL_MOBILE = "CUSTOMER_PORTAL_MOBILE",
+    ODIN_AUTOMATION = "ODIN_AUTOMATION",
+    OMNI = "OMNI",
+    WEBSITE = "WEBSITE",
+    YOU_FIBRE = "YOUFIBRE"
+}
+/**
+ * Valid values for Case.Sla
+ *
+ * Data field for Case records. Used by Customer Service team.
+ *
+ * @remarks Available options:
+ * - `HIGH` - High
+ * - `LOW` - Low
+ * - `MEDIUM` - Medium
+ * - `URGENT` - Urgent
+ */
+export declare enum CaseSla {
+    HIGH = "HIGH",
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    URGENT = "URGENT"
+}
+/**
+ * Valid values for Case.Channel
+ *
+ * the channel from the source (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `CALL` - Call
+ * - `CUSTOMER_APP` - Customer App
+ * - `CUSTOMER_PORTAL` - Customer Portal
+ * - `EMAIL` - Email
+ * - `FACEBOOK_MESSENGER` - Facebook Messenger
+ * - `IN_APP_CHAT` - In-App Chat
+ * - `INSTAGRAM_DM` - Instagram DM
+ * - `SMS`
+ * - `TLOS_APP` - TLOS App
+ * - `TLOS_PORTAL` - TLOS Portal
+ * - `TRUSTPILOT_SERVICE_REVIEW` - Trustpilot review
+ * - `TWITTER_X_MENTION` - Twitter/X Mention
+ * - `WEB_CHAT` - Web chat
+ * - `WEB_FORM_BUSINESS` - Web form - Business
+ * - `WHATSAPP` - Whatsapp
+ */
+export declare enum CaseChannel {
+    CALL = "CALL",
+    CUSTOMER_APP = "CUSTOMER_APP",
+    CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
+    EMAIL = "EMAIL",
+    FACEBOOK_MESSENGER = "FACEBOOK_MESSENGER",
+    IN_APP_CHAT = "IN_APP_CHAT",
+    INSTAGRAM_DM = "INSTAGRAM_DM",
+    SMS = "SMS",
+    TLOS_APP = "TLOS_APP",
+    TLOS_PORTAL = "TLOS_PORTAL",
+    TRUSTPILOT_REVIEW = "TRUSTPILOT_SERVICE_REVIEW",
+    TWITTER_X_MENTION = "TWITTER_X_MENTION",
+    WEB_CHAT = "WEB_CHAT",
+    WEB_FORM_BUSINESS = "WEB_FORM_BUSINESS",
+    WHATSAPP = "WHATSAPP"
+}
+/**
+ * Valid values for Case.BlockedReason
+ *
+ * Blocked Reason (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `AWAITING_CHURN` - Awaiting Churn
+ * - `AWAITING_NETOMNIA_ACTION` - Awaiting Netomnia Action
+ * - `PAYMENT_PLAN` - Payment Plan
+ * - `WAITING_TO_PROCESS_REFUND` - Waiting to process Refund
+ */
+export declare enum CaseBlockedReason {
+    AWAITING_CHURN = "AWAITING_CHURN",
+    AWAITING_NETOMNIA_ACTION = "AWAITING_NETOMNIA_ACTION",
+    PAYMENT_PLAN = "PAYMENT_PLAN",
+    WAITING_TO_PROCESS_REFUND = "WAITING_TO_PROCESS_REFUND"
+}
+/**
+ * Valid values for Case.DpaCustomerCategory
+ *
+ * Selection of Category done by the customer over the web chat (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `BILLING` - Billing
+ * - `CANCELLATION` - Cancellation
+ * - `COMPLAINT` - Complaint
+ * - `INSTALLS_AND_SERVICE_VISITS` - Installs & Service Visits
+ * - `MANAGE_MY_ACCOUNT` - Manage My Account
+ * - `SALES` - Sales
+ * - `TECH_SUPPORT` - Tech Support
+ */
+export declare enum CaseDpaCustomerCategory {
+    BILLING = "BILLING",
+    CANCELLATION = "CANCELLATION",
+    COMPLAINT = "COMPLAINT",
+    INSTALLS_SERVICE_VISITS = "INSTALLS_AND_SERVICE_VISITS",
+    MANAGE_MY_ACCOUNT = "MANAGE_MY_ACCOUNT",
+    SALES = "SALES",
+    TECH_SUPPORT = "TECH_SUPPORT"
+}
+/**
+ * Valid values for Case.ReasonForReview
+ *
+ * Reason for Review (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `I_DO_NOT_HAVE_THE_PERMISSIONS` - I do not have the permissions
+ * - `I_DO_NOT_KNOW_HOW_TO_ACTION` - I do not know how to action this
+ * - `I_NEED_SUPPORT_FROM_BILLING` - I need support from Billing
+ * - `I_NEED_SUPPORT_FROM_CUSTOMER_SERVICE` - I need support from Customer Service
+ * - `I_NEED_SUPPORT_FROM_NETWORK_OPERATIONS` - I need support from Network Operations (Tier 3)
+ * - `I_NEED_SUPPORT_FROM_OPERATIONS` - I need support from Operations
+ * - `I_NEED_SUPPORT_FROM_SALES` - I need support from Sales
+ */
+export declare enum CaseReasonForReview {
+    I_DO_NOT_HAVE_THE_PERMISSIONS = "I_DO_NOT_HAVE_THE_PERMISSIONS",
+    I_DO_NOT_KNOW_HOW_TO_ACTION_THIS = "I_DO_NOT_KNOW_HOW_TO_ACTION",
+    I_NEED_SUPPORT_FROM_BILLING = "I_NEED_SUPPORT_FROM_BILLING",
+    I_NEED_SUPPORT_FROM_CUSTOMER_SERVICE = "I_NEED_SUPPORT_FROM_CUSTOMER_SERVICE",
+    I_NEED_SUPPORT_FROM_NETWORK_OPERATIONS_TIER_3 = "I_NEED_SUPPORT_FROM_NETWORK_OPERATIONS",
+    I_NEED_SUPPORT_FROM_OPERATIONS = "I_NEED_SUPPORT_FROM_OPERATIONS",
+    I_NEED_SUPPORT_FROM_SALES = "I_NEED_SUPPORT_FROM_SALES"
+}
+/**
+ * Valid values for Case.SubCategory
+ *
+ * SubCategory (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `AMEND_BILLING_DATE` - Amend Billing Date
+ * - `AMEND_MY_ORDER` - Amend my Order
+ * - `AREA_AVAILABILITY_QUERY` - Area Availability Query
+ * - `BAD_CSAT` - Bad CSAT
+ * - `CANCEL_APPOINTMENT` - Cancel Appointment
+ * - `CHANGE_CONTACT_DETAILS` - Change contact details
+ * - `CHURN_REQUEST` - Churn Request
+ * - `CLAIM_MISSELLING` - Claim Misselling
+ * - `COGENT_ABUSE_NOTIFICATIONS` - Cogent (Abuse Notifications)
+ * - `COMPENSATION_REQUEST` - Compensation Request
+ * - `COMPLAINT` - Complaint
+ * - `CONTRACT_BUYOUT` - Contract Buyout
+ * - `COPY_OF_INVOICE` - Copy of Invoice
+ * - `CUSTOMER_DEVICE_ISSUE` - Customer Device Issue
+ * - `DATA_SUBJECT_ACCESS_REQUEST` - Data Subject Access Request
+ * - ... and 40 more
+ */
+export declare enum CaseSubCategory {
+    AMEND_BILLING_DATE = "AMEND_BILLING_DATE",
+    AMEND_MY_ORDER = "AMEND_MY_ORDER",
+    AREA_AVAILABILITY_QUERY = "AREA_AVAILABILITY_QUERY",
+    BAD_CSAT = "BAD_CSAT",
+    CANCEL_APPOINTMENT = "CANCEL_APPOINTMENT",
+    CHANGE_CONTACT_DETAILS = "CHANGE_CONTACT_DETAILS",
+    CHURN_REQUEST = "CHURN_REQUEST",
+    CLAIM_MISSELLING = "CLAIM_MISSELLING",
+    COGENT_ABUSE_NOTIFICATIONS = "COGENT_ABUSE_NOTIFICATIONS",
+    COMPENSATION_REQUEST = "COMPENSATION_REQUEST",
+    COMPLAINT = "COMPLAINT",
+    CONTRACT_BUYOUT = "CONTRACT_BUYOUT",
+    COPY_OF_INVOICE = "COPY_OF_INVOICE",
+    CUSTOMER_DEVICE_ISSUE = "CUSTOMER_DEVICE_ISSUE",
+    DATA_SUBJECT_ACCESS_REQUEST = "DATA_SUBJECT_ACCESS_REQUEST",
+    DIRECT_DEBIT = "DIRECT_DEBIT",
+    DUPLICATE_REVIEW = "DUPLICATE_REVIEW",
+    EQUIPMENT_RETURN_REFUND = "EQUIPMENT_RETURN_REFUND",
+    ESCALATED_COMPLAINT = "ESCALATED_COMPLAINT",
+    ETF_CUSTOMER_LEAVING_YF = "ETF_CUSTOMER_LEAVING",
+    GDPR_DATA_BREACH = "GDPR_DATA_BREACH",
+    INACTIVE_CHAT_NO_CUSTOMER_RESPONSE = "INACTIVE_CHAT_NO_CUSTOMER_RESPONSE",
+    INSTALL_APPOINTMENT = "INSTALL_APPOINTMENT",
+    INSTALL_REMEDIATION_QUERY = "INSTALL_REMEDIATION_QUERY",
+    INTERMITTENT_CONNECTIVITY = "INTERMITTENT_CONNECTIVITY",
+    INVOICE_DISPUTE = "INVOICE_DISPUTE",
+    MAGRATHEA_PROCESS = "MAGRATHEA_PROCESS",
+    MISSED_APPOINTMENT = "MISSED_APPOINTMENT",
+    NEGATIVE_REVIEWS = "NEGATIVE_REVIEWS",
+    NEW_ORDER = "NEW_ORDER",
+    NEW_TICKET = "NEW_TICKET",
+    ODIN_SUPPORT_REQUEST = "ODIN_SUPPORT_REQUEST",
+    OFFER_QUERY_SUPPORT = "OFFER_QUERY_AND_SUPPORT",
+    OMBUDSMAN_CASE = "OMBUDSMAN_CASE",
+    ONE_TOUCH_SWITCH = "ONE_TOUCH_SWITCH",
+    ONT_RELOCATION = "ONT_RELOCATION",
+    OVERDUE_INVOICE = "OVERDUE_INVOICE",
+    PAYMENT_LINK = "PAYMENT_LINK",
+    PAYMENT_PLAN = "PAYMENT_PLAN",
+    PHONE_ISSUES = "PHONE_ISSUES",
+    PHONE_PORTING = "PHONE_PORTING",
+    PIC_REQUEST = "PIC_REQUEST",
+    POSITIVE_REVIEWS = "POSITIVE_REVIEWS",
+    PRE_LIVE_ORDER_QUERY = "PRE_LIVE_ORDER_QUERY",
+    PRICE_MATCH = "PRICE_MATCH",
+    RECONTRACT_UPGRADE = "RECONTRACT_UPGRADE",
+    REFERRAL = "REFERRAL",
+    SERVICE_VISIT = "SERVICE_VISIT",
+    SPAM = "SPAM",
+    SPEED_HARD_WIRED = "SPEED_HARD_WIRED",
+    SPEED_WI_FI = "SPEED_WIFI",
+    TLOS_OUTAGE = "TLOS_OUTAGE",
+    TRANSFER_OF_OWNERSHIP = "TRANSFER_OF_OWNERSHIP",
+    WEBSITE_APP_ISSUE = "WEBSITE_APP_ISSUE",
+    WI_FI_COVERAGE = "WIFI_COVERAGE"
+}
+/**
+ * Valid values for Case.DpaCustomerType
+ *
+ * dpa customer type (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `ACCOUNT_HOLDER` - Account holder
+ * - `BUSINESS_CUSTOMER` - Business Customer
+ * - `NEW_CUSTOMER` - New Customer
+ * - `NOT_ACCOUNT_HOLDER` - Not account holder
+ */
+export declare enum CaseDpaCustomerType {
+    ACCOUNT_HOLDER = "ACCOUNT_HOLDER",
+    BUSINESS_CUSTOMER = "BUSINESS_CUSTOMER",
+    NEW_CUSTOMER = "NEW_CUSTOMER",
+    NOT_ACCOUNT_HOLDER = "NOT_ACCOUNT_HOLDER"
+}
+/**
+ * Valid values for Case.CsatReason
+ *
+ * CSAT Dissatisfaction Reason (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `AGENT_COMMUNICATION` - I was not happy with the Agent communication
+ * - `OUTCOME` - I was not happy with the outcome
+ * - `PRODUCT_SERVICE` - I was not happy with the product or service
+ * - `OTHER` - Other
+ */
+export declare enum CaseCsatReason {
+    I_WAS_NOT_HAPPY_WITH_THE_AGENT_COMMUNICATION = "AGENT_COMMUNICATION",
+    I_WAS_NOT_HAPPY_WITH_THE_OUTCOME = "OUTCOME",
+    I_WAS_NOT_HAPPY_WITH_THE_PRODUCT_OR_SERVICE = "PRODUCT_SERVICE",
+    OTHER = "OTHER"
+}
+/**
+ * Valid values for Case.Impact
+ *
+ * level of impact to the business (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `HIGH` - High
+ * - `LOW` - Low
+ * - `MEDIUM` - Medium
+ */
+export declare enum CaseImpact {
+    HIGH = "HIGH",
+    LOW = "LOW",
+    MEDIUM = "MEDIUM"
+}
+/**
+ * Valid values for Case.Source
+ *
+ * source of the case (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `AIRCALL` - Aircall
+ * - `CUSTOMER_APP` - Customer App
+ * - `CUSTOMER_PORTAL` - Customer Portal
+ * - `EMAIL` - Email
+ * - `FACEBOOK` - Facebook
+ * - `INSTAGRAM` - Instagram
+ * - `TRUSTPILOT` - Trustpilot
+ * - `TWILIO` - Twilio
+ * - `TWITTER_X` - Twitter/X
+ * - `USERESPONSE` - Useresponse
+ * - `WEBSITE` - Website
+ */
+export declare enum CaseSource {
+    AIRCALL = "AIRCALL",
+    CUSTOMER_APP = "CUSTOMER_APP",
+    CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
+    EMAIL = "EMAIL",
+    FACEBOOK = "FACEBOOK",
+    INSTAGRAM = "INSTAGRAM",
+    TRUSTPILOT = "TRUSTPILOT",
+    TWILIO = "TWILIO",
+    TWITTER_X = "TWITTER_X",
+    USERESPONSE = "USERESPONSE",
+    WEBSITE = "WEBSITE"
+}
+/**
+ * Valid values for Case.Problem
+ *
+ * Data field for Case records. Used by Customer Service team.
+ *
+ * @remarks Available options:
+ * - `Billing Related`
+ * - `Delayed Installation`
+ * - `Engineer Behaviour`
+ * - `Engineer Damage`
+ * - `Loss of Service after Installation`
+ * - `Package Related`
+ * - `Provisioning Issues – Delayed Connection`
+ * - `Router – Delayed Connection`
+ * - `Switching to email`
+ * - `Unable to Contact Customer`
+ * - `Unhappy with Installation Method`
+ * - `Unhappy with Router`
+ * - `WiFi Coverage`
+ */
+export declare enum CaseProblem {
+    BILLING_RELATED = "Billing Related",
+    DELAYED_INSTALLATION = "Delayed Installation",
+    ENGINEER_BEHAVIOUR = "Engineer Behaviour",
+    ENGINEER_DAMAGE = "Engineer Damage",
+    LOSS_OF_SERVICE_AFTER_INSTALLATION = "Loss of Service after Installation",
+    PACKAGE_RELATED = "Package Related",
+    PROVISIONING_ISSUES_DELAYED_CONNECTION = "Provisioning Issues \u2013 Delayed Connection",
+    ROUTER_DELAYED_CONNECTION = "Router \u2013 Delayed Connection",
+    SWITCHING_TO_EMAIL = "Switching to email",
+    UNABLE_TO_CONTACT_CUSTOMER = "Unable to Contact Customer",
+    UNHAPPY_WITH_INSTALLATION_METHOD = "Unhappy with Installation Method",
+    UNHAPPY_WITH_ROUTER = "Unhappy with Router",
+    WI_FI_COVERAGE = "WiFi Coverage"
+}
+/**
+ * Valid values for Case.Category
+ *
+ * Data field for Case records. Used by Customer Service team.
+ *
+ * @remarks Available options:
+ * - `BILLING` - Billing
+ * - `CANCELLATION` - Cancellation
+ * - `COMPLAINT` - Complaint
+ * - `INSTALLS_AND_SERVICE_VISITS` - Installs & Service Visits
+ * - `MANAGE_MY_ACCOUNT` - Manage My Account
+ * - `NEW` - New
+ * - `ODIN_SUPPORT` - Odin Support
+ * - `OUTAGE` - Outage
+ * - `SALES` - Sales
+ * - `SALES_BUSINESS` - Sales - Business
+ * - `SPAM` - Spam
+ * - `TECH_SUPPORT` - Tech Support
+ */
+export declare enum CaseCategory {
+    BILLING = "BILLING",
+    CANCELLATION = "CANCELLATION",
+    COMPLAINT = "COMPLAINT",
+    INSTALLS_SERVICE_VISITS = "INSTALLS_AND_SERVICE_VISITS",
+    MANAGE_MY_ACCOUNT = "MANAGE_MY_ACCOUNT",
+    NEW = "NEW",
+    ODIN_SUPPORT = "ODIN_SUPPORT",
+    OUTAGE = "OUTAGE",
+    SALES = "SALES",
+    SALES_BUSINESS = "SALES_BUSINESS",
+    SPAM = "SPAM",
+    TECH_SUPPORT = "TECH_SUPPORT"
+}
+/**
+ * Valid values for Case.ConversationStatus
+ *
+ * the status of the linked Conversation entity (Customer Service - Case)
+ *
+ * @remarks Available options:
+ * - `CLOSED` - Closed
+ * - `CREATED` - Created
+ * - `INACTIVE` - Inactive
+ */
+export declare enum CaseConversationStatus {
+    CLOSED = "CLOSED",
+    CREATED = "CREATED",
+    INACTIVE = "INACTIVE"
+}
+/**
+ * Valid values for Case.FormalComplaint
+ *
+ * Formal Complaint - Boolean
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum CaseFormalComplaint {
+    NO = "NO",
+    YES = "YES"
+}
+/**
+ * Valid values for Case.Complaint
+ *
+ * Complaint
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum CaseComplaint {
+    NO = "NO",
+    YES = "YES"
+}
+/**
+ * Valid values for Case.Providers
+ *
+ * Providers
+ *
+ * @remarks Available options:
+ * - `Brsk`
+ * - `Cityfibre`
+ * - `CITYFIBRE`
+ * - `Netomnia`
+ * - `Youfibre`
+ */
+export declare enum CaseProviders {
+    BRSK = "Brsk",
+    CITYFIBRE = "Cityfibre",
+    NETOMNIA = "Netomnia",
+    YOUFIBRE = "Youfibre"
+}
+/**
+ * Valid values for Case.PrimaryException
+ *
+ * Primary Exception
+ *
+ * @remarks Available options:
+ * - `INSTALLATIONS_CIVIL_WORKS_&_CONSTRUCTION` - Installations - Civil Works & Construction
+ * - `INSTALLATIONS_ENGINEER_QUALITY` - Installations - Engineer Quality
+ * - `INSTALLATIONS_SCHEDULING_&_COORDINATION` - Installations - Scheduling & Coordination
+ * - `INSTALLATIONS_TECHNICAL_INSTALLATION_ISSUES` - Installations - Technical Installation Issues
+ * - `SALES_MISREPRESENTATION_&_ACCURACY_FAILURES` - Sales - Misrepresentation & Accuracy Failures
+ * - `SALES_PRESSURE_&_ETHICS` - Sales - Pressure & Ethics
+ * - `SALES_PRICING_&_COMMERCIAL` - Sales - Pricing & Commercial
+ * - `SERVICE_AGENT_CONDUCT` - Service - Agent Conduct
+ * - `SERVICE_ESCALATION_PROCESS` - Service - Escalation process
+ * - `SERVICE_ISSUE_RECOGNITION` - Service - Issue recognition
+ * - `SERVICE_MISINFORMATION` - Service - Mis-Information
+ * - `SERVICE_RESPONSE_TIMES` - Service - Response Times
+ * - `SERVICE_VERBAL_COMMUNICATION` - Service - Verbal communication
+ */
+export declare enum CasePrimaryException {
+    INSTALLATIONS_CIVIL_WORKS_CONSTRUCTION = "INSTALLATIONS_CIVIL_WORKS_&_CONSTRUCTION",
+    INSTALLATIONS_ENGINEER_QUALITY = "INSTALLATIONS_ENGINEER_QUALITY",
+    INSTALLATIONS_SCHEDULING_COORDINATION = "INSTALLATIONS_SCHEDULING_&_COORDINATION",
+    INSTALLATIONS_TECHNICAL_INSTALLATION_ISSUES = "INSTALLATIONS_TECHNICAL_INSTALLATION_ISSUES",
+    SALES_MISREPRESENTATION_ACCURACY_FAILURES = "SALES_MISREPRESENTATION_&_ACCURACY_FAILURES",
+    SALES_PRESSURE_ETHICS = "SALES_PRESSURE_&_ETHICS",
+    SALES_PRICING_COMMERCIAL = "SALES_PRICING_&_COMMERCIAL",
+    SERVICE_AGENT_CONDUCT = "SERVICE_AGENT_CONDUCT",
+    SERVICE_ESCALATION_PROCESS = "SERVICE_ESCALATION_PROCESS",
+    SERVICE_ISSUE_RECOGNITION = "SERVICE_ISSUE_RECOGNITION",
+    SERVICE_MIS_INFORMATION = "SERVICE_MISINFORMATION",
+    SERVICE_RESPONSE_TIMES = "SERVICE_RESPONSE_TIMES",
+    SERVICE_VERBAL_COMMUNICATION = "SERVICE_VERBAL_COMMUNICATION"
+}
+/**
+ * Valid values for Case.PrimaryExceptionReason
+ *
+ * Primary Exception reason
+ *
+ * @remarks Available options:
+ * - `AGENT_AUDIBILITY` - Agent audibility
+ * - `ARTIFICIAL_URGENCY` - Artificial urgency
+ * - `CALL_HOLD_TIMES` - Call hold times
+ * - `CAPABILITY_OVERSTATEMENT` - Capability Overstatement
+ * - `CHAT_UNAVAILABLE_OR_SLOW` - Chat unavailable or slow
+ * - `COMPLAINT_NOT_ACKNOWLEDGED` - Complaint not acknowledged
+ * - `CONFLICTING_INFORMATION` - Conflicting information
+ * - `CONFLICTING_INFORMATION_PROVIDED` - Conflicting information provided
+ * - `CREW_AVAILABILITY_ISSUES` - Crew availability issues
+ * - `DISCOUNT_MISALIGNMENT` - Discount misalignment
+ * - `DISMISSED_THEIR_COMPLAINT` - Dismissed their complaint
+ * - `DISMISSIVE` - Dismissive
+ * - `DUCT_BLOCKAGE_ISSUES` - Duct blockage issues
+ * - `EMAIL_RESPONSE_TIMES` - Email response times
+ * - `ENGINEER_CONDUCT` - Engineer conduct
+ * - ... and 38 more
+ */
+export declare enum CasePrimaryExceptionReason {
+    AGENT_AUDIBILITY = "AGENT_AUDIBILITY",
+    ARTIFICIAL_URGENCY = "ARTIFICIAL_URGENCY",
+    CALL_HOLD_TIMES = "CALL_HOLD_TIMES",
+    CAPABILITY_OVERSTATEMENT = "CAPABILITY_OVERSTATEMENT",
+    CHAT_UNAVAILABLE_OR_SLOW = "CHAT_UNAVAILABLE_OR_SLOW",
+    COMPLAINT_NOT_ACKNOWLEDGED = "COMPLAINT_NOT_ACKNOWLEDGED",
+    CONFLICTING_INFORMATION = "CONFLICTING_INFORMATION",
+    CONFLICTING_INFORMATION_PROVIDED = "CONFLICTING_INFORMATION_PROVIDED",
+    CREW_AVAILABILITY_ISSUES = "CREW_AVAILABILITY_ISSUES",
+    DISCOUNT_MISALIGNMENT = "DISCOUNT_MISALIGNMENT",
+    DISMISSED_THEIR_COMPLAINT = "DISMISSED_THEIR_COMPLAINT",
+    DISMISSIVE = "DISMISSIVE",
+    DUCT_BLOCKAGE_ISSUES = "DUCT_BLOCKAGE_ISSUES",
+    EMAIL_RESPONSE_TIMES = "EMAIL_RESPONSE_TIMES",
+    ENGINEER_CONDUCT = "ENGINEER_CONDUCT",
+    ENGINEER_TIMES_INCORRECT = "ENGINEER_TIMES_INCORRECT",
+    ESCALATION_PROCESS_NOT_FOLLOWED = "ESCALATION_PROCESS_NOT_FOLLOWED",
+    FEATURE_MISREPRESENTATION = "FEATURE_MISREPRESENTATION",
+    FORCED_UPSELL = "FORCED_UPSELL",
+    HIDDEN_FEES = "HIDDEN_FEES",
+    HIGH_PRESSURE_TACTICS = "HIGH-PRESSURE_TACTICS",
+    INACCURATE_COMPARISONS = "INACCURATE_COMPARISONS",
+    IN_A_RUSH_TO_FINISH = "IN_A_RUSH_TO_FINISH",
+    INCOMPLETE_NETWORK_TESTING = "INCOMPLETE_NETWORK_TESTING",
+    INCOMPLETE_RESOLUTION = "INCOMPLETE_RESOLUTION",
+    INCORRECT_PRICING = "INCORRECT_PRICING",
+    INFORMATION_WITHHELD = "INFORMATION_WITHHELD",
+    LACK_OF_EMPATHY = "LACK_OF_EMPATHY",
+    LEFT_A_MESS = "LEFT_A_MESS",
+    MIS_ADVISED_THE_CUSTOMER = "MISADVISED_THE_CUSTOMER",
+    MISSED_CALLBACKS = "MISSED_CALLBACKS",
+    MISSED_INSTALL_APPOINTMENT = "MISSED_INSTALL_APPOINTMENT",
+    NO_ID = "NO_ID",
+    NO_SHOW_TECHNICIAN = "NO_SHOW_TECHNICIAN",
+    NO_UPDATE_AFTER_INITIAL_CONTACT = "NO_UPDATE_AFTER_INITIAL_CONTACT",
+    PERMIT_APPROVAL_DELAYS = "PERMIT_APPROVAL_DELAYS",
+    POOR_CUSTOMER_COORDINATION = "POOR_CUSTOMER_COORDINATION",
+    POOR_INSTALLATION_QUALITY = "POOR_INSTALLATION_QUALITY",
+    POOR_OR_NO_OBJECTION_HANDLING = "POOR_OR_NO_OBJECTION_HANDLING",
+    QUOTE_ERRORS = "QUOTE_ERRORS",
+    REPEATED_RESCHEDULES = "REPEATED_RESCHEDULES",
+    RUDE_OR_UNHELPFUL_BEHAVIOR = "RUDE_OR_UNHELPFUL_BEHAVIOR",
+    SURFACE_REINSTATEMENT_ISSUES = "SURFACE_REINSTATEMENT_ISSUES",
+    SURVEY_INCOMPLETE = "SURVEY_INCOMPLETE",
+    THIRD_PARTY_DAMAGE = "THIRD-PARTY_DAMAGE",
+    TRENCHING_DELAYS = "TRENCHING_DELAYS",
+    UNDISCLOSED_LIMITATIONS = "UNDISCLOSED_LIMITATIONS",
+    UNWANTED_BUNDLING = "UNWANTED_BUNDLING",
+    VENDOR_SCHEDULING_FAILURE = "VENDOR_SCHEDULING_FAILURE",
+    VERBAL_VS_WRITTEN_MISMATCH = "VERBAL_VS_WRITTEN_MISMATCH",
+    VULNERABILITY_MISSED = "VULNERABILITY_MISSED",
+    WAYLEAVE_DISPUTES = "WAYLEAVE_DISPUTES",
+    WRONG_ADVICE = "WRONG_ADVICE"
+}
+/**
+ * Valid values for Case.CsatAgentReason
+ *
+ * Main reason for the agent CSAT score.
+ *
+ * @remarks Available options:
+ * - `INTERACTION_TOOK_TOO_LONG` - Interaction took too long
+ * - `OTHER` - Other
+ * - `POOR_COMMUNICATION_OR_TONE` - Poor communication
+ * - `PROVIDED_INFORMATION_UNCLEAR` - Provided information unclear
+ */
+export declare enum CaseCsatAgentReason {
+    INTERACTION_TOOK_TOO_LONG = "INTERACTION_TOOK_TOO_LONG",
+    OTHER = "OTHER",
+    POOR_COMMUNICATION = "POOR_COMMUNICATION_OR_TONE",
+    PROVIDED_INFORMATION_UNCLEAR = "PROVIDED_INFORMATION_UNCLEAR"
+}
+/**
+ * Valid values for Case.CsatResolutionReason
+ *
+ * Main reason for the resolution CSAT score.
+ *
+ * @remarks Available options:
+ * - `ADDITIONAL_STEPS_REQUIRED` - Additional steps required
+ * - `ISSUE_NOT_FULLY_RESOLVED` - Issue not fully resolved
+ * - `OTHER` - Other
+ * - `RESOLUTION_DID_NOT_WORK` - Resolution did not work
+ */
+export declare enum CaseCsatResolutionReason {
+    ADDITIONAL_STEPS_REQUIRED = "ADDITIONAL_STEPS_REQUIRED",
+    ISSUE_NOT_FULLY_RESOLVED = "ISSUE_NOT_FULLY_RESOLVED",
+    OTHER = "OTHER",
+    RESOLUTION_DID_NOT_WORK = "RESOLUTION_DID_NOT_WORK"
+}
+/**
+ * Property keys for Case
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum CasePropertyKeys {
+    /** Timestamp */
+    Timestamp = "Timestamp",
+    /** Indicates when the CSAT has been sent */
+    CsatSentAt = "CsatSentAt",
+    /** Attributed To */
+    AttributedTo = "AttributedTo",
+    /** Timestamp of the CSAT response */
+    CsatResponseAt = "CsatResponseAt",
+    /** The address related to the case (Customer Service - Case) */
+    RAddressId = "R_AddressId",
+    /** R_AddressTitle (Customer Service - Case) */
+    RAddressTitle = "R_AddressTitle",
+    /** R_QueueTitle (Customer Service - Case) */
+    RQueueTitle = "R_QueueTitle",
+    /** R_AddressExchangeName (Customer Service - Case) */
+    RAddressExchangeName = "R_AddressExchangeName",
+    /** The order related to the case (Customer Service - Case) */
+    ROrderId = "R_OrderId",
+    /** R_AssignedOrgUserId (Customer Service - Case) */
+    RAssignedOrgUserId = "R_AssignedOrgUserId",
+    /** R_SmsMessageId (Customer Service - Case) */
+    RSmsMessageId = "R_SmsMessageId",
+    /** business area (Customer Service - Case) */
+    BusinessArea = "BusinessArea",
+    /** R_AssignedUserId (Customer Service - Case) */
+    RAssignedUserId = "R_AssignedUserId",
+    /** The contact related to the case (Customer Service - Case) */
+    RContactId = "R_ContactId",
+    /** The work order related to the case (Customer Service - Case) */
+    RWorkOrderId = "R_WorkOrderId",
+    /** R_AssignedUserTitle (Customer Service - Case) */
+    RAssignedUserTitle = "R_AssignedUserTitle",
+    /** Files to assist with understanding the issue. (Customer Service - Case) */
+    Files = "Files",
+    /** Data field for Case records. Used by Customer Service team. */
+    Deprecated = "Deprecated",
+    /** Data field for Case records. Used by Customer Service team. */
+    Subject = "Subject",
+    /** Sentiment from voyager. (Customer Service - Case) */
+    AiSentiment = "AiSentiment",
+    /** messages/calls/emails tags generated  from voyager (Customer Service - Case) */
+    AiTags = "AiTags",
+    /** Contact information field for Case. Used by Customer Service team for communication. */
+    DpaCustomerPhone = "DpaCustomerPhone",
+    /** Customer name (Customer Service - Case) */
+    DpaCustomerName = "DpaCustomerName",
+    /** When the case was updated (Customer Service - Case) */
+    UpdatedAt = "UpdatedAt",
+    /** origin of case (Customer Service - Case) */
+    Origin = "Origin",
+    /** The sla end date (Customer Service - Case) */
+    SlaEndDate = "SlaEndDate",
+    /** SLA score 1 - 5 (Customer Service - Case) */
+    SlaScore = "SlaScore",
+    /** The time an outage was confirmed (Customer Service - Case) */
+    OutageConfirmedTime = "OutageConfirmedTime",
+    /** The time an outage was resolved (Customer Service - Case) */
+    OutageResolvedTime = "OutageResolvedTime",
+    /** Date to re-open the case (Customer Service - Case) */
+    MoveToOpenOn = "MoveToOpenOn",
+    /** When the Case was created (Customer Service - Case) */
+    CCreatedAt = "C_CreatedAt",
+    /** Data field for Case records. Used by Customer Service team. */
+    Sla = "Sla",
+    /** Additional Notes (Customer Service - Case) */
+    AdditionalNotes = "AdditionalNotes",
+    /** the channel from the source (Customer Service - Case) */
+    Channel = "Channel",
+    /** An external reference to this case (Customer Service - Case) */
+    ExternalRef = "ExternalRef",
+    /** Blocked Reason (Customer Service - Case) */
+    BlockedReason = "BlockedReason",
+    /** Customer last bill (Customer Service - Case) */
+    DpaCustomerLastBill = "DpaCustomerLastBill",
+    /** Satisfaction Survey Score (Customer Service - Case) */
+    CsatScore = "CsatScore",
+    /** Selection of Category done by the customer over the web chat (Customer Service - Case) */
+    DpaCustomerCategory = "DpaCustomerCategory",
+    /** Reason for Review (Customer Service - Case) */
+    ReasonForReview = "ReasonForReview",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    OwnerId = "OwnerId",
+    /** SubCategory (Customer Service - Case) */
+    SubCategory = "SubCategory",
+    /** Customer address (Customer Service - Case) */
+    DpaCustomerAddress = "DpaCustomerAddress",
+    /** dpa customer type (Customer Service - Case) */
+    DpaCustomerType = "DpaCustomerType",
+    /** Data field for Case records. Used by Customer Service team. */
+    Queue = "Queue",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    ContactId = "ContactId",
+    /** CSAT Dissatisfaction Reason (Customer Service - Case) */
+    CsatReason = "CsatReason",
+    /** Satisfaction Survey Comment (Customer Service - Case) */
+    CsatComment = "CsatComment",
+    /** level of impact to the business (Customer Service - Case) */
+    Impact = "Impact",
+    /** boolean to confirm if DPA checks have passed (Customer Service - Case) */
+    DpaChecksPassed = "DpaChecksPassed",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    TeamId = "TeamId",
+    /** source of the case (Customer Service - Case) */
+    Source = "Source",
+    /** Data field for Case records. Used by Customer Service team. */
+    Problem = "Problem",
+    /** Data field for Case records. Used by Customer Service team. */
+    Category = "Category",
+    /** Data field for Case records. Used by Customer Service team. */
+    Priority = "Priority",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    OutageId = "OutageId",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    AccountId = "AccountId",
+    /** Boolean value that is true if in SLA and false if out of SLA (Customer Service - Case) */
+    InSla = "InSla",
+    /** Describe why the case is being moved to closed (Customer Service - Case) */
+    CloseReason = "CloseReason",
+    /** Reference identifier for Case relationships. Used for data integrity. */
+    RQueueId = "R_QueueId",
+    /** Describe the issue being experienced (Customer Service - Case) */
+    Description = "Description",
+    /** Customer email (Customer Service - Case) */
+    DpaCustomerEmail = "DpaCustomerEmail",
+    /** Parent case (Customer Service - Case) */
+    CaseId = "CaseId",
+    /** explain the solution implemented (Customer Service - Case) */
+    Solution = "Solution",
+    /** QueueChangeReason (Customer Service - Case) */
+    QueueChangeReason = "QueueChangeReason",
+    /** The date used to generate the SLA date (defaults to case created and then is updated when the case goes to Pending Agent" (Customer Service - Case) */
+    SlaStartDate = "SlaStartDate",
+    /** The time an outage started (Customer Service - Case) */
+    OutageStartTime = "OutageStartTime",
+    /** the status of the linked Conversation entity (Customer Service - Case) */
+    ConversationStatus = "ConversationStatus",
+    /** Formal Complaint - Boolean */
+    FormalComplaint = "FormalComplaint",
+    /** Complaint */
+    Complaint = "Complaint",
+    /** Providers */
+    Providers = "Providers",
+    /** Accuracy of the AI tags */
+    AiTagsAccuracy = "AiTagsAccuracy",
+    /** Previous AI Tags */
+    AiTagsPrevious = "AiTagsPrevious",
+    /** Previous AI Tags Accuracy */
+    AiTagsPreviousAccuracy = "AiTagsPreviousAccuracy",
+    /** Primary Exception */
+    PrimaryException = "PrimaryException",
+    /** Primary Exception reason */
+    PrimaryExceptionReason = "PrimaryExceptionReason",
+    /** Customer satisfaction score for the agent who handled the case. */
+    CsatAgentScore = "CsatAgentScore",
+    /** Main reason for the agent CSAT score. */
+    CsatAgentReason = "CsatAgentReason",
+    /** Reason when Agent CSAT Reason is OTHER. */
+    CsatAgentOtherReason = "CsatAgentOtherReason",
+    /** Optional customer comment about the agent. */
+    CsatAgentComment = "CsatAgentComment",
+    /** Customer satisfaction score for the resolution of the case. */
+    CsatResolutionScore = "CsatResolutionScore",
+    /** Main reason for the resolution CSAT score. */
+    CsatResolutionReason = "CsatResolutionReason",
+    /** Reason when Resolution CSAT Reason is OTHER. */
+    CsatResolutionOtherReason = "CsatResolutionOtherReason",
+    /** Optional customer comment about the resolution. */
+    CsatResolutionComment = "CsatResolutionComment",
+    /** Allow CSAT communications */
+    CsatAllowed = "CsatAllowed"
+}
+/**
+ * Properties for Case records
+ *
+ * @see SupportModule:Case
+ */
+export interface CaseProperties {
+    /** Timestamp
+     *
+     * @type {DATE_TIME}
+     */
+    Timestamp: string;
+    /** Indicates when the CSAT has been sent
+     *
+     * @type {DATE_TIME}
+     */
+    CsatSentAt: string;
+    /** Attributed To
+     *
+     * @type {TEXT}
+     */
+    AttributedTo: string;
+    /** Timestamp of the CSAT response
+     *
+     * @type {DATE_TIME}
+     */
+    CsatResponseAt: string;
+    /** The address related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressId: string;
+    /** R_AddressTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressTitle: string;
+    /** R_QueueTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RQueueTitle: string;
+    /** R_AddressExchangeName (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressExchangeName: string;
+    /** The order related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    ROrderId: string;
+    /** R_AssignedOrgUserId (Customer Service - Case)
+     *
+     * @type {UUID}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedOrgUserId: string;
+    /** R_SmsMessageId (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RSmsMessageId: string;
+    /** business area (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseBusinessArea}
+     */
+    BusinessArea: CaseBusinessArea;
+    /** R_AssignedUserId (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedUserId: string;
+    /** The contact related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RContactId: string;
+    /** The work order related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RWorkOrderId: string;
+    /** R_AssignedUserTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedUserTitle: string;
+    /** Files to assist with understanding the issue. (Customer Service - Case)
+     *
+     * @type {FILE_MULTIPLE}
+     * @hidden This field is hidden in the UI
+     */
+    Files: string;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseDeprecated}
+     */
+    Deprecated: CaseDeprecated;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {TEXT}
+     */
+    Subject: string;
+    /** Sentiment from voyager. (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    AiSentiment: string;
+    /** messages/calls/emails tags generated  from voyager (Customer Service - Case)
+     *
+     * @type {TAG}
+     */
+    AiTags: string;
+    /** Contact information field for Case. Used by Customer Service team for communication.
+     *
+     * @type {PHONE_NUMBER}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerPhone: string;
+    /** Customer name (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerName: string;
+    /** When the case was updated (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    UpdatedAt: string;
+    /** origin of case (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseOrigin}
+     */
+    Origin: CaseOrigin;
+    /** The sla end date (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    SlaEndDate: string;
+    /** SLA score 1 - 5 (Customer Service - Case)
+     *
+     * @type {NUMBER}
+     */
+    SlaScore: number;
+    /** The time an outage was confirmed (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageConfirmedTime: string;
+    /** The time an outage was resolved (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageResolvedTime: string;
+    /** Date to re-open the case (Customer Service - Case)
+     *
+     * @type {DATE}
+     */
+    MoveToOpenOn: string;
+    /** When the Case was created (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    CCreatedAt: string;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseSla}
+     */
+    Sla: CaseSla;
+    /** Additional Notes (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    AdditionalNotes: string;
+    /** the channel from the source (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseChannel}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    Channel: CaseChannel;
+    /** An external reference to this case (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    ExternalRef: string;
+    /** Blocked Reason (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseBlockedReason}
+     */
+    BlockedReason: CaseBlockedReason;
+    /** Customer last bill (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    DpaCustomerLastBill: string;
+    /** Satisfaction Survey Score (Customer Service - Case)
+     *
+     * @type {NUMBER}
+     */
+    CsatScore: number;
+    /** Selection of Category done by the customer over the web chat (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseDpaCustomerCategory}
+     */
+    DpaCustomerCategory: CaseDpaCustomerCategory;
+    /** Reason for Review (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseReasonForReview}
+     */
+    ReasonForReview: CaseReasonForReview;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    OwnerId: string;
+    /** SubCategory (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseSubCategory}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    SubCategory: CaseSubCategory;
+    /** Customer address (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerAddress: string;
+    /** dpa customer type (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseDpaCustomerType}
+     */
+    DpaCustomerType: CaseDpaCustomerType;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {LOOKUP}
+     */
+    Queue: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    ContactId: string;
+    /** CSAT Dissatisfaction Reason (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatReason}
+     */
+    CsatReason: CaseCsatReason;
+    /** Satisfaction Survey Comment (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatComment: string;
+    /** level of impact to the business (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseImpact}
+     */
+    Impact: CaseImpact;
+    /** boolean to confirm if DPA checks have passed (Customer Service - Case)
+     *
+     * @type {BOOLEAN}
+     */
+    DpaChecksPassed: boolean;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @placeholder The assigned team
+     * @tracked Changes to this field are tracked in audit history
+     */
+    TeamId: string;
+    /** source of the case (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseSource}
+     */
+    Source: CaseSource;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseProblem}
+     * @hidden This field is hidden in the UI
+     */
+    Problem: CaseProblem;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseCategory}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    Category: CaseCategory;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {NUMBER}
+     */
+    Priority: number;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    OutageId: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    AccountId: string;
+    /** Boolean value that is true if in SLA and false if out of SLA (Customer Service - Case)
+     *
+     * @type {BOOLEAN}
+     * @default true
+     */
+    InSla: boolean;
+    /** Describe why the case is being moved to closed (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    CloseReason: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RQueueId: string;
+    /** Describe the issue being experienced (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    Description: string;
+    /** Customer email (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerEmail: string;
+    /** Parent case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     */
+    CaseId: string;
+    /** explain the solution implemented (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    Solution: string;
+    /** QueueChangeReason (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    QueueChangeReason: string;
+    /** The date used to generate the SLA date (defaults to case created and then is updated when the case goes to Pending Agent" (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    SlaStartDate: string;
+    /** The time an outage started (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageStartTime: string;
+    /** the status of the linked Conversation entity (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseConversationStatus}
+     */
+    ConversationStatus: CaseConversationStatus;
+    /** Formal Complaint - Boolean
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {CaseFormalComplaint}
+     */
+    FormalComplaint: CaseFormalComplaint;
+    /** Complaint
+     *
+     * @type {ENUM}
+     * @enum {CaseComplaint}
+     */
+    Complaint: CaseComplaint;
+    /** Providers
+     *
+     * @type {ENUM}
+     * @enum {CaseProviders}
+     */
+    Providers: CaseProviders;
+    /** Accuracy of the AI tags
+     *
+     * @type {TEXT}
+     */
+    AiTagsAccuracy: string;
+    /** Previous AI Tags
+     *
+     * @type {TEXT}
+     */
+    AiTagsPrevious: string;
+    /** Previous AI Tags Accuracy
+     *
+     * @type {TEXT}
+     */
+    AiTagsPreviousAccuracy: string;
+    /** Primary Exception
+     *
+     * @type {ENUM}
+     * @enum {CasePrimaryException}
+     */
+    PrimaryException: CasePrimaryException;
+    /** Primary Exception reason
+     *
+     * @type {ENUM}
+     * @enum {CasePrimaryExceptionReason}
+     */
+    PrimaryExceptionReason: CasePrimaryExceptionReason;
+    /** Customer satisfaction score for the agent who handled the case.
+     *
+     * @type {NUMBER}
+     */
+    CsatAgentScore: number;
+    /** Main reason for the agent CSAT score.
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatAgentReason}
+     */
+    CsatAgentReason: CaseCsatAgentReason;
+    /** Reason when Agent CSAT Reason is OTHER.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatAgentOtherReason: string;
+    /** Optional customer comment about the agent.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatAgentComment: string;
+    /** Customer satisfaction score for the resolution of the case.
+     *
+     * @type {NUMBER}
+     */
+    CsatResolutionScore: number;
+    /** Main reason for the resolution CSAT score.
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatResolutionReason}
+     */
+    CsatResolutionReason: CaseCsatResolutionReason;
+    /** Reason when Resolution CSAT Reason is OTHER.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionOtherReason: string;
+    /** Optional customer comment about the resolution.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionComment: string;
+    /** Allow CSAT communications
+     *
+     * @type {BOOLEAN}
+     * @default true
+     */
+    CsatAllowed: boolean;
+}
+/**
+ * Properties for OUTAGE Case records
+ *
+ * @see SupportModule:Case
+ */
+export interface OutageCaseProperties {
+    /** Timestamp
+     *
+     * @type {DATE_TIME}
+     */
+    Timestamp: string;
+    /** Indicates when the CSAT has been sent
+     *
+     * @type {DATE_TIME}
+     */
+    CsatSentAt: string;
+    /** Attributed To
+     *
+     * @type {TEXT}
+     */
+    AttributedTo: string;
+    /** Timestamp of the CSAT response
+     *
+     * @type {DATE_TIME}
+     */
+    CsatResponseAt: string;
+    /** The address related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressId: string;
+    /** R_AddressTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressTitle: string;
+    /** R_QueueTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RQueueTitle: string;
+    /** R_AddressExchangeName (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAddressExchangeName: string;
+    /** The order related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    ROrderId: string;
+    /** R_AssignedOrgUserId (Customer Service - Case)
+     *
+     * @type {UUID}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedOrgUserId: string;
+    /** R_SmsMessageId (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RSmsMessageId: string;
+    /** business area (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseBusinessArea}
+     */
+    BusinessArea: CaseBusinessArea;
+    /** R_AssignedUserId (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedUserId: string;
+    /** The contact related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RContactId: string;
+    /** The work order related to the case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RWorkOrderId: string;
+    /** R_AssignedUserTitle (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RAssignedUserTitle: string;
+    /** Files to assist with understanding the issue. (Customer Service - Case)
+     *
+     * @type {FILE_MULTIPLE}
+     * @hidden This field is hidden in the UI
+     */
+    Files: string;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseDeprecated}
+     */
+    Deprecated: CaseDeprecated;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {TEXT}
+     */
+    Subject: string;
+    /** Sentiment from voyager. (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    AiSentiment: string;
+    /** messages/calls/emails tags generated  from voyager (Customer Service - Case)
+     *
+     * @type {TAG}
+     */
+    AiTags: string;
+    /** Contact information field for Case. Used by Customer Service team for communication.
+     *
+     * @type {PHONE_NUMBER}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerPhone: string;
+    /** Customer name (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerName: string;
+    /** When the case was updated (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    UpdatedAt: string;
+    /** origin of case (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseOrigin}
+     */
+    Origin: CaseOrigin;
+    /** The sla end date (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    SlaEndDate: string;
+    /** SLA score 1 - 5 (Customer Service - Case)
+     *
+     * @type {NUMBER}
+     */
+    SlaScore: number;
+    /** The time an outage was confirmed (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageConfirmedTime: string;
+    /** The time an outage was resolved (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageResolvedTime: string;
+    /** Date to re-open the case (Customer Service - Case)
+     *
+     * @type {DATE}
+     */
+    MoveToOpenOn: string;
+    /** When the Case was created (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    CCreatedAt: string;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseSla}
+     */
+    Sla: CaseSla;
+    /** Additional Notes (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    AdditionalNotes: string;
+    /** the channel from the source (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseChannel}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    Channel: CaseChannel;
+    /** An external reference to this case (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    ExternalRef: string;
+    /** Blocked Reason (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseBlockedReason}
+     */
+    BlockedReason: CaseBlockedReason;
+    /** Customer last bill (Customer Service - Case)
+     *
+     * @type {TEXT}
+     */
+    DpaCustomerLastBill: string;
+    /** Satisfaction Survey Score (Customer Service - Case)
+     *
+     * @type {NUMBER}
+     */
+    CsatScore: number;
+    /** Selection of Category done by the customer over the web chat (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseDpaCustomerCategory}
+     */
+    DpaCustomerCategory: CaseDpaCustomerCategory;
+    /** Reason for Review (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseReasonForReview}
+     */
+    ReasonForReview: CaseReasonForReview;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    OwnerId: string;
+    /** SubCategory (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseSubCategory}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    SubCategory: CaseSubCategory;
+    /** Customer address (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerAddress: string;
+    /** dpa customer type (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseDpaCustomerType}
+     */
+    DpaCustomerType: CaseDpaCustomerType;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {LOOKUP}
+     */
+    Queue: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    ContactId: string;
+    /** CSAT Dissatisfaction Reason (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatReason}
+     */
+    CsatReason: CaseCsatReason;
+    /** Satisfaction Survey Comment (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatComment: string;
+    /** level of impact to the business (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseImpact}
+     */
+    Impact: CaseImpact;
+    /** boolean to confirm if DPA checks have passed (Customer Service - Case)
+     *
+     * @type {BOOLEAN}
+     */
+    DpaChecksPassed: boolean;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @placeholder The assigned team
+     * @tracked Changes to this field are tracked in audit history
+     */
+    TeamId: string;
+    /** source of the case (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseSource}
+     */
+    Source: CaseSource;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseProblem}
+     * @hidden This field is hidden in the UI
+     */
+    Problem: CaseProblem;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {ENUM}
+     * @enum {CaseCategory}
+     * @tracked Changes to this field are tracked in audit history
+     */
+    Category: CaseCategory;
+    /** Data field for Case records. Used by Customer Service team.
+     *
+     * @type {NUMBER}
+     */
+    Priority: number;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    OutageId: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     */
+    AccountId: string;
+    /** Boolean value that is true if in SLA and false if out of SLA (Customer Service - Case)
+     *
+     * @type {BOOLEAN}
+     * @default true
+     */
+    InSla: boolean;
+    /** Describe why the case is being moved to closed (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    CloseReason: string;
+    /** Reference identifier for Case relationships. Used for data integrity.
+     *
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
+     */
+    RQueueId: string;
+    /** Describe the issue being experienced (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     */
+    Description: string;
+    /** Customer email (Customer Service - Case)
+     *
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
+     */
+    DpaCustomerEmail: string;
+    /** Parent case (Customer Service - Case)
+     *
+     * @type {LOOKUP}
+     */
+    CaseId: string;
+    /** explain the solution implemented (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    Solution: string;
+    /** QueueChangeReason (Customer Service - Case)
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    QueueChangeReason: string;
+    /** The date used to generate the SLA date (defaults to case created and then is updated when the case goes to Pending Agent" (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    SlaStartDate: string;
+    /** The time an outage started (Customer Service - Case)
+     *
+     * @type {DATE_TIME}
+     */
+    OutageStartTime: string;
+    /** the status of the linked Conversation entity (Customer Service - Case)
+     *
+     * @type {ENUM}
+     * @enum {CaseConversationStatus}
+     */
+    ConversationStatus: CaseConversationStatus;
+    /** Formal Complaint - Boolean
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {CaseFormalComplaint}
+     */
+    FormalComplaint: CaseFormalComplaint;
+    /** Complaint
+     *
+     * @type {ENUM}
+     * @enum {CaseComplaint}
+     */
+    Complaint: CaseComplaint;
+    /** Providers
+     *
+     * @type {ENUM}
+     * @enum {CaseProviders}
+     */
+    Providers: CaseProviders;
+    /** Accuracy of the AI tags
+     *
+     * @type {TEXT}
+     */
+    AiTagsAccuracy: string;
+    /** Previous AI Tags
+     *
+     * @type {TEXT}
+     */
+    AiTagsPrevious: string;
+    /** Previous AI Tags Accuracy
+     *
+     * @type {TEXT}
+     */
+    AiTagsPreviousAccuracy: string;
+    /** Primary Exception
+     *
+     * @type {ENUM}
+     * @enum {CasePrimaryException}
+     */
+    PrimaryException: CasePrimaryException;
+    /** Primary Exception reason
+     *
+     * @type {ENUM}
+     * @enum {CasePrimaryExceptionReason}
+     */
+    PrimaryExceptionReason: CasePrimaryExceptionReason;
+    /** Customer satisfaction score for the agent who handled the case.
+     *
+     * @type {NUMBER}
+     */
+    CsatAgentScore: number;
+    /** Main reason for the agent CSAT score.
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatAgentReason}
+     */
+    CsatAgentReason: CaseCsatAgentReason;
+    /** Reason when Agent CSAT Reason is OTHER.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatAgentOtherReason: string;
+    /** Optional customer comment about the agent.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatAgentComment: string;
+    /** Customer satisfaction score for the resolution of the case.
+     *
+     * @type {NUMBER}
+     */
+    CsatResolutionScore: number;
+    /** Main reason for the resolution CSAT score.
+     *
+     * @type {ENUM}
+     * @enum {CaseCsatResolutionReason}
+     */
+    CsatResolutionReason: CaseCsatResolutionReason;
+    /** Reason when Resolution CSAT Reason is OTHER.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionOtherReason: string;
+    /** Optional customer comment about the resolution.
+     *
+     * @type {TEXT_LONG}
+     */
+    CsatResolutionComment: string;
+    /** Allow CSAT communications
+     *
+     * @type {BOOLEAN}
+     * @default true
+     */
+    CsatAllowed: boolean;
+}
+/**
+ * Case entity from SupportModule
+ *
+ * Case entity for Customer Service operations. Part of SupportModule. Contains business data for customer service workflows.
+ *
+ * @module SupportModule
+ * @entity Case
+ * @schemaId be8173eb-269b-4a67-be0c-11ce6af5d561
+ * @recordPrefix SC
+ * @menuLabel Cases
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class Case extends OdinRecord<CaseProperties> {
+    entity: 'SupportModule:Case';
+    type: CaseEntityTypes;
+    schemaId: 'be8173eb-269b-4a67-be0c-11ce6af5d561';
+    properties: CaseProperties;
+    /** Linked ActivityLog records (Case__ActivityLog) */
+    ActivityLog: OdinLink<LinkedOdinRecord<ActivityLogProperties>>;
+    /** Linked User records (CaseOwner) */
+    User: OdinLink<LinkedOdinRecord<UserProperties>>;
+    /** Linked Outage records (Outage__Case) */
+    Outage: OdinLink<LinkedOdinRecord<OutageProperties>>;
+    /** Linked SmsMessage records (Case__SmsMessage) */
+    SmsMessage: OdinLink<LinkedOdinRecord<SmsMessageProperties>>;
+    /** Linked Email records (Case__Email) */
+    Email: OdinLink<LinkedOdinRecord<EmailProperties>>;
+    /** Linked Call records (Call__Case) */
+    Call: OdinLink<LinkedOdinRecord<CallProperties>>;
+    /** Linked ContractBuyOut records (Case__ContractBuyOut) */
+    ContractBuyOut: OdinLink<LinkedOdinRecord<ContractBuyOutProperties>>;
+    /** Linked Team records (Case_Team) */
+    Team: OdinLink<LinkedOdinRecord<TeamProperties>>;
+    /** Linked Note records (Case__Note) */
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
+    /** Linked Account records (Account__Case) */
+    Account: OdinLink<LinkedOdinRecord<AccountProperties>>;
+    /** Linked WorkOrder records (Case__WorkOrder) */
+    WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
+    /** Linked Queue records (Queue__Case) */
+    Queue: OdinLink<LinkedOdinRecord<QueueProperties>>;
+    /** Linked Conversation records (Case_Conversation) */
+    Conversation: OdinLink<LinkedOdinRecord<ConversationProperties>>;
+    /** Linked Case records (Case__Case) */
+    Case: OdinLink<LinkedOdinRecord<CaseProperties>>;
+    /** Linked File records (Case__File) */
+    File: OdinLink<LinkedOdinRecord<FileProperties>>;
+    /** Linked CaseAction records (Case__CaseAction) */
+    CaseAction: OdinLink<LinkedOdinRecord<CaseActionProperties>>;
+    /** Linked Order records (Case__Order) */
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+    /** Linked QueueChange records (Case__QueueChange) */
+    QueueChange: OdinLink<LinkedOdinRecord<QueueChangeProperties>>;
+    /** Linked Contact records (Case__Contact) */
+    Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    /** Linked Address records (Case__Address) */
+    Address: OdinLink<LinkedOdinRecord<AddressProperties>>;
+    /** Linked PushNotification records (Case__PushNotification) */
+    PushNotification: OdinLink<LinkedOdinRecord<PushNotificationProperties>>;
+}
+/**
+ * RabbitMQ routing keys for Case events
+ */
+export declare const ROUTING_KEY_CASE_CREATED = "SupportModule.Case.SubDbRecordCreated";
+export declare const ROUTING_KEY_CASE_UPDATED = "SupportModule.Case.SubDbRecordUpdated";
+export declare const ROUTING_KEY_CASE_DELETED = "SupportModule.Case.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for Case events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_CASE_DEFAULT_CREATED = "SupportModule.Case.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_CASE_DEFAULT_UPDATED = "SupportModule.Case.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_CASE_DEFAULT_DELETED = "SupportModule.Case.DEFAULT.SubDbRecordDeleted";
+/** Outage created */
+export declare const ROUTING_KEY_CASE_OUTAGE_CREATED = "SupportModule.Case.OUTAGE.SubDbRecordCreated";
+/** Outage updated */
+export declare const ROUTING_KEY_CASE_OUTAGE_UPDATED = "SupportModule.Case.OUTAGE.SubDbRecordUpdated";
+/** Outage deleted */
+export declare const ROUTING_KEY_CASE_OUTAGE_DELETED = "SupportModule.Case.OUTAGE.SubDbRecordDeleted";
+/** Event: Case__ActivityLog link created */
+export declare const ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_CREATED = "SupportModule.Case.ActivityLog.SubDbRecordAssociationCreated";
+/** Event: Case__ActivityLog link deleted */
+export declare const ROUTING_KEY_LINK_CASE_ACTIVITY_LOG_DELETED = "SupportModule.Case.ActivityLog.SubDbRecordAssociationDeleted";
+/** Event: CaseOwner link created */
+export declare const ROUTING_KEY_LINK_CASE_OWNER_CREATED = "SupportModule.Case.User.SubDbRecordAssociationCreated";
+/** Event: CaseOwner link deleted */
+export declare const ROUTING_KEY_LINK_CASE_OWNER_DELETED = "SupportModule.Case.User.SubDbRecordAssociationDeleted";
+/** Event: Case__SmsMessage link created */
+export declare const ROUTING_KEY_LINK_CASE_SMS_MESSAGE_CREATED = "SupportModule.Case.SmsMessage.SubDbRecordAssociationCreated";
+/** Event: Case__SmsMessage link deleted */
+export declare const ROUTING_KEY_LINK_CASE_SMS_MESSAGE_DELETED = "SupportModule.Case.SmsMessage.SubDbRecordAssociationDeleted";
+/** Event: Case__Email link created */
+export declare const ROUTING_KEY_LINK_CASE_EMAIL_CREATED = "SupportModule.Case.Email.SubDbRecordAssociationCreated";
+/** Event: Case__Email link deleted */
+export declare const ROUTING_KEY_LINK_CASE_EMAIL_DELETED = "SupportModule.Case.Email.SubDbRecordAssociationDeleted";
+/** Event: Case__ContractBuyOut link created */
+export declare const ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_CREATED = "SupportModule.Case.ContractBuyOut.SubDbRecordAssociationCreated";
+/** Event: Case__ContractBuyOut link deleted */
+export declare const ROUTING_KEY_LINK_CASE_CONTRACT_BUY_OUT_DELETED = "SupportModule.Case.ContractBuyOut.SubDbRecordAssociationDeleted";
+/** Event: Case_Team link created */
+export declare const ROUTING_KEY_LINK_CASE_TEAM_CREATED = "SupportModule.Case.Team.SubDbRecordAssociationCreated";
+/** Event: Case_Team link deleted */
+export declare const ROUTING_KEY_LINK_CASE_TEAM_DELETED = "SupportModule.Case.Team.SubDbRecordAssociationDeleted";
+/** Event: Case__Note link created */
+export declare const ROUTING_KEY_LINK_CASE_NOTE_CREATED = "SupportModule.Case.Note.SubDbRecordAssociationCreated";
+/** Event: Case__Note link deleted */
+export declare const ROUTING_KEY_LINK_CASE_NOTE_DELETED = "SupportModule.Case.Note.SubDbRecordAssociationDeleted";
+/** Event: Case__WorkOrder link created */
+export declare const ROUTING_KEY_LINK_CASE_WORK_ORDER_CREATED = "SupportModule.Case.WorkOrder.SubDbRecordAssociationCreated";
+/** Event: Case__WorkOrder link deleted */
+export declare const ROUTING_KEY_LINK_CASE_WORK_ORDER_DELETED = "SupportModule.Case.WorkOrder.SubDbRecordAssociationDeleted";
+/** Event: Case_Conversation link created */
+export declare const ROUTING_KEY_LINK_CASE_CONVERSATION_CREATED = "SupportModule.Case.Conversation.SubDbRecordAssociationCreated";
+/** Event: Case_Conversation link deleted */
+export declare const ROUTING_KEY_LINK_CASE_CONVERSATION_DELETED = "SupportModule.Case.Conversation.SubDbRecordAssociationDeleted";
+/** Event: Case__Case link created */
+export declare const ROUTING_KEY_LINK_CASE_CASE_CREATED = "SupportModule.Case.Case.SubDbRecordAssociationCreated";
+/** Event: Case__Case link deleted */
+export declare const ROUTING_KEY_LINK_CASE_CASE_DELETED = "SupportModule.Case.Case.SubDbRecordAssociationDeleted";
+/** Event: Case__File link created */
+export declare const ROUTING_KEY_LINK_CASE_FILE_CREATED = "SupportModule.Case.File.SubDbRecordAssociationCreated";
+/** Event: Case__File link deleted */
+export declare const ROUTING_KEY_LINK_CASE_FILE_DELETED = "SupportModule.Case.File.SubDbRecordAssociationDeleted";
+/** Event: Case__CaseAction link created */
+export declare const ROUTING_KEY_LINK_CASE_CASE_ACTION_CREATED = "SupportModule.Case.CaseAction.SubDbRecordAssociationCreated";
+/** Event: Case__CaseAction link deleted */
+export declare const ROUTING_KEY_LINK_CASE_CASE_ACTION_DELETED = "SupportModule.Case.CaseAction.SubDbRecordAssociationDeleted";
+/** Event: Case__Order link created */
+export declare const ROUTING_KEY_LINK_CASE_ORDER_CREATED = "SupportModule.Case.Order.SubDbRecordAssociationCreated";
+/** Event: Case__Order link deleted */
+export declare const ROUTING_KEY_LINK_CASE_ORDER_DELETED = "SupportModule.Case.Order.SubDbRecordAssociationDeleted";
+/** Event: Case__QueueChange link created */
+export declare const ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_CREATED = "SupportModule.Case.QueueChange.SubDbRecordAssociationCreated";
+/** Event: Case__QueueChange link deleted */
+export declare const ROUTING_KEY_LINK_CASE_QUEUE_CHANGE_DELETED = "SupportModule.Case.QueueChange.SubDbRecordAssociationDeleted";
+/** Event: Case__Contact link created */
+export declare const ROUTING_KEY_LINK_CASE_CONTACT_CREATED = "SupportModule.Case.Contact.SubDbRecordAssociationCreated";
+/** Event: Case__Contact link deleted */
+export declare const ROUTING_KEY_LINK_CASE_CONTACT_DELETED = "SupportModule.Case.Contact.SubDbRecordAssociationDeleted";
+/** Event: Case__Address link created */
+export declare const ROUTING_KEY_LINK_CASE_ADDRESS_CREATED = "SupportModule.Case.Address.SubDbRecordAssociationCreated";
+/** Event: Case__Address link deleted */
+export declare const ROUTING_KEY_LINK_CASE_ADDRESS_DELETED = "SupportModule.Case.Address.SubDbRecordAssociationDeleted";
+/** Event: Case__PushNotification link created */
+export declare const ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_CREATED = "SupportModule.Case.PushNotification.SubDbRecordAssociationCreated";
+/** Event: Case__PushNotification link deleted */
+export declare const ROUTING_KEY_LINK_CASE_PUSH_NOTIFICATION_DELETED = "SupportModule.Case.PushNotification.SubDbRecordAssociationDeleted";