yale-user-access/packages/backend/Models/YaleModels.cs
Liam Pietralla f577617b4d
All checks were successful
Build and Publish / Build Yale Access Backend (push) Successful in 28s
Build and Publish / Build Yale Access Frontend (push) Successful in 47s
Build and Publish / Push Yale Access Backend Docker Image (push) Successful in 9s
Build and Publish / Push Yale Access Frontend Docker Image (push) Successful in 10s
initial commit
2025-01-10 08:37:18 +11:00

46 lines
1.3 KiB
C#

namespace YaleAccess.Models
{
public class YaleUserCode
{
/// <summary>
/// The ID of the user code. When making requets to ZWave.JS API, this is the value to use.
/// </summary>
public int Id { get; set; }
/// <summary>
/// The code / pin number for the user code. This may be null if the user code is not set or is not in use.
/// Even though its a string, it is a number and appropriate validation is required.
/// </summary>
public string Code { get; set; } = string.Empty;
/// <summary>
/// The current status of the user code.
/// </summary>
public UserCodeStatus Status { get; set; }
/// <summary>
/// Is true is this is the 'home' or normal user code for daily use.
/// </summary>
public bool IsHome { get; set; }
}
public enum UserCodeStatus
{
/// <summary>
/// This means the code is not being used, and can be assigned
/// </summary>
AVAILABLE = 0,
/// <summary>
/// This means that the code is in used, and cannot be assigned
/// </summary>
ENABLED = 1,
/// <summary>
/// Not sure what this means yet, perhaps it is related to schedules?
/// </summary>
DISABLED = 2
}
}