ring-client-api 14.0.0-beta.0 → 14.0.0-beta.2

package/lib/ring-types.d.ts

@@ -1,106 +1,109 @@
 type Firmware = string | 'Up To Date';
-export declare enum RingDeviceType {
-    BaseStation = "hub.redsky",
-    BaseStationPro = "hub.kili",
-    Keypad = "security-keypad",
-    SecurityPanel = "security-panel",
-    ContactSensor = "sensor.contact",
-    MotionSensor = "sensor.motion",
-    FloodFreezeSensor = "sensor.flood-freeze",
-    FreezeSensor = "sensor.freeze",
-    TemperatureSensor = "sensor.temperature",
-    WaterSensor = "sensor.water",
-    TiltSensor = "sensor.tilt",
-    GlassbreakSensor = "sensor.glassbreak",
-    RangeExtender = "range-extender.zwave",
-    ZigbeeAdapter = "adapter.zigbee",
-    AccessCodeVault = "access-code.vault",
-    AccessCode = "access-code",
-    SmokeAlarm = "alarm.smoke",
-    CoAlarm = "alarm.co",
-    SmokeCoListener = "listener.smoke-co",
-    MultiLevelSwitch = "switch.multilevel",
-    Fan = "switch.multilevel",
-    MultiLevelBulb = "switch.multilevel.bulb",
-    Switch = "switch",
-    BeamsMotionSensor = "motion-sensor.beams",
-    BeamsSwitch = "switch.beams",
-    BeamsMultiLevelSwitch = "switch.multilevel.beams",
-    BeamsLightGroupSwitch = "group.light-group.beams",
-    BeamsTransformerSwitch = "switch.transformer.beams",
-    BeamsDevice = "device.beams",
-    RetrofitBridge = "bridge.flatline",
-    RetrofitZone = "sensor.zone",
-    Thermostat = "temperature-control.thermostat",
-    Sensor = "sensor",
-    RingNetAdapter = "adapter.ringnet",
-    CodeVault = "access-code.vault",
-    SecurityAccessCode = "access-code",
-    ZWaveAdapter = "adapter.zwave",
-    ZWaveExtender = "range-extender.zwave",
-    PanicButton = "security-panic",
-    UnknownZWave = "unknown.zwave",
-    OnvifCamera = "onvif_camera",
-    ThirdPartyGarageDoorOpener = "third_party_gdo",
-    IntercomHandsetAudio = "intercom_handset_audio",
-    WaterValve = "valve.water"
-}
-export declare enum RingDeviceCategory {
-    Outlets = 1,
-    Lights = 2,
-    Sensors = 5,
-    Appliances = 7,
-    Locks = 10,
-    Thermostats = 11,
-    Cameras = 12,
-    Alarms = 15,
-    Fans = 17,
-    Security = 22,
-    Unknown = 29,
-    SensorsMotion = 30,
-    Controller = 31,
-    RangeExtenders = 32,
-    Keypads = 33,
-    Sirens = 34,
-    PanicButtons = 35,
-    WaterValves = 37
-}
-export declare enum RingCameraKind {
-    doorbot = "doorbot",
-    doorbell = "doorbell",
-    doorbell_v3 = "doorbell_v3",
-    doorbell_v4 = "doorbell_v4",
-    doorbell_v5 = "doorbell_v5",
-    doorbell_oyster = "doorbell_oyster",// used for the Ring Video Doorbell 4
-    doorbell_portal = "doorbell_portal",
-    doorbell_scallop = "doorbell_scallop",
-    doorbell_scallop_lite = "doorbell_scallop_lite",
-    doorbell_graham_cracker = "doorbell_graham_cracker",
-    lpd_v1 = "lpd_v1",
-    lpd_v2 = "lpd_v2",
-    lpd_v4 = "lpd_v4",
-    jbox_v1 = "jbox_v1",
-    stickup_cam = "stickup_cam",
-    stickup_cam_v3 = "stickup_cam_v3",
-    stickup_cam_elite = "stickup_cam_elite",
-    stickup_cam_longfin = "stickup_cam_longfin",
-    stickup_cam_lunar = "stickup_cam_lunar",
-    spotlightw_v2 = "spotlightw_v2",
-    hp_cam_v1 = "hp_cam_v1",
-    hp_cam_v2 = "hp_cam_v2",
-    stickup_cam_v4 = "stickup_cam_v4",
-    floodlight_v1 = "floodlight_v1",
-    floodlight_v2 = "floodlight_v2",
-    floodlight_pro = "floodlight_pro",
-    cocoa_camera = "cocoa_camera",// appears to be used for all next gen stickup cams (wired/battery/solar)
-    cocoa_doorbell = "cocoa_doorbell",
-    cocoa_doorbell_v2 = "cocoa_doorbell_v2",
-    cocoa_doorbell_v3 = "cocoa_doorbell_v3",
-    cocoa_floodlight = "cocoa_floodlight",
-    cocoa_spotlight = "cocoa_spotlight",// used for the Spotlight Cam Plus (potentially other Spotlight models)
-    stickup_cam_mini = "stickup_cam_mini",
-    onvif_camera = "onvif_camera"
-}
+export declare const RingDeviceType: {
+    readonly BaseStation: "hub.redsky";
+    readonly BaseStationPro: "hub.kili";
+    readonly Keypad: "security-keypad";
+    readonly SecurityPanel: "security-panel";
+    readonly ContactSensor: "sensor.contact";
+    readonly MotionSensor: "sensor.motion";
+    readonly FloodFreezeSensor: "sensor.flood-freeze";
+    readonly FreezeSensor: "sensor.freeze";
+    readonly TemperatureSensor: "sensor.temperature";
+    readonly WaterSensor: "sensor.water";
+    readonly TiltSensor: "sensor.tilt";
+    readonly GlassbreakSensor: "sensor.glassbreak";
+    readonly RangeExtender: "range-extender.zwave";
+    readonly ZigbeeAdapter: "adapter.zigbee";
+    readonly AccessCodeVault: "access-code.vault";
+    readonly AccessCode: "access-code";
+    readonly SmokeAlarm: "alarm.smoke";
+    readonly CoAlarm: "alarm.co";
+    readonly SmokeCoListener: "listener.smoke-co";
+    readonly MultiLevelSwitch: "switch.multilevel";
+    readonly Fan: "switch.multilevel";
+    readonly MultiLevelBulb: "switch.multilevel.bulb";
+    readonly Switch: "switch";
+    readonly BeamsMotionSensor: "motion-sensor.beams";
+    readonly BeamsSwitch: "switch.beams";
+    readonly BeamsMultiLevelSwitch: "switch.multilevel.beams";
+    readonly BeamsLightGroupSwitch: "group.light-group.beams";
+    readonly BeamsTransformerSwitch: "switch.transformer.beams";
+    readonly BeamsDevice: "device.beams";
+    readonly RetrofitBridge: "bridge.flatline";
+    readonly RetrofitZone: "sensor.zone";
+    readonly Thermostat: "temperature-control.thermostat";
+    readonly Sensor: "sensor";
+    readonly RingNetAdapter: "adapter.ringnet";
+    readonly CodeVault: "access-code.vault";
+    readonly SecurityAccessCode: "access-code";
+    readonly ZWaveAdapter: "adapter.zwave";
+    readonly ZWaveExtender: "range-extender.zwave";
+    readonly PanicButton: "security-panic";
+    readonly UnknownZWave: "unknown.zwave";
+    readonly OnvifCamera: "onvif_camera";
+    readonly ThirdPartyGarageDoorOpener: "third_party_gdo";
+    readonly IntercomHandsetAudio: "intercom_handset_audio";
+    readonly WaterValve: "valve.water";
+};
+export type RingDeviceType = (typeof RingDeviceType)[keyof typeof RingDeviceType];
+export declare const RingDeviceCategory: {
+    readonly Outlets: 1;
+    readonly Lights: 2;
+    readonly Sensors: 5;
+    readonly Appliances: 7;
+    readonly Locks: 10;
+    readonly Thermostats: 11;
+    readonly Cameras: 12;
+    readonly Alarms: 15;
+    readonly Fans: 17;
+    readonly Security: 22;
+    readonly Unknown: 29;
+    readonly SensorsMotion: 30;
+    readonly Controller: 31;
+    readonly RangeExtenders: 32;
+    readonly Keypads: 33;
+    readonly Sirens: 34;
+    readonly PanicButtons: 35;
+    readonly WaterValves: 37;
+};
+export type RingDeviceCategory = (typeof RingDeviceCategory)[keyof typeof RingDeviceCategory];
+export declare const RingCameraKind: {
+    readonly doorbot: "doorbot";
+    readonly doorbell: "doorbell";
+    readonly doorbell_v3: "doorbell_v3";
+    readonly doorbell_v4: "doorbell_v4";
+    readonly doorbell_v5: "doorbell_v5";
+    readonly doorbell_oyster: "doorbell_oyster";
+    readonly doorbell_portal: "doorbell_portal";
+    readonly doorbell_scallop: "doorbell_scallop";
+    readonly doorbell_scallop_lite: "doorbell_scallop_lite";
+    readonly doorbell_graham_cracker: "doorbell_graham_cracker";
+    readonly lpd_v1: "lpd_v1";
+    readonly lpd_v2: "lpd_v2";
+    readonly lpd_v4: "lpd_v4";
+    readonly jbox_v1: "jbox_v1";
+    readonly stickup_cam: "stickup_cam";
+    readonly stickup_cam_v3: "stickup_cam_v3";
+    readonly stickup_cam_elite: "stickup_cam_elite";
+    readonly stickup_cam_longfin: "stickup_cam_longfin";
+    readonly stickup_cam_lunar: "stickup_cam_lunar";
+    readonly spotlightw_v2: "spotlightw_v2";
+    readonly hp_cam_v1: "hp_cam_v1";
+    readonly hp_cam_v2: "hp_cam_v2";
+    readonly stickup_cam_v4: "stickup_cam_v4";
+    readonly floodlight_v1: "floodlight_v1";
+    readonly floodlight_v2: "floodlight_v2";
+    readonly floodlight_pro: "floodlight_pro";
+    readonly cocoa_camera: "cocoa_camera";
+    readonly cocoa_doorbell: "cocoa_doorbell";
+    readonly cocoa_doorbell_v2: "cocoa_doorbell_v2";
+    readonly cocoa_doorbell_v3: "cocoa_doorbell_v3";
+    readonly cocoa_floodlight: "cocoa_floodlight";
+    readonly cocoa_spotlight: "cocoa_spotlight";
+    readonly stickup_cam_mini: "stickup_cam_mini";
+    readonly onvif_camera: "onvif_camera";
+};
+export type RingCameraKind = (typeof RingCameraKind)[keyof typeof RingCameraKind];
 export declare const RingCameraModel: {
     readonly [P in RingCameraKind]: string;
 };
@@ -336,11 +339,12 @@ export interface TicketAsset {
     status: 'online' | 'offline';
     uuid: string;
 }
-export declare enum DoorbellType {
-    Mechanical = 0,
-    Digital = 1,
-    None = 2
-}
+export declare const DoorbellType: {
+    readonly Mechanical: 0;
+    readonly Digital: 1;
+    readonly None: 2;
+};
+export type DoorbellType = (typeof DoorbellType)[keyof typeof DoorbellType];
 export interface BaseCameraData {
     alerts: {
         connection: 'online' | 'offline' | string;
@@ -483,7 +487,7 @@ export interface BaseCameraData {
     };
 }
 export interface CameraData extends BaseCameraData {
-    kind: Omit<RingCameraKind, RingCameraKind.onvif_camera>;
+    kind: Omit<RingCameraKind, typeof RingCameraKind.onvif_camera>;
     address: string;
     battery_life: number | string | null;
     battery_life_2?: number | string | null;
@@ -497,7 +501,7 @@ export interface CameraData extends BaseCameraData {
     stolen: boolean;
 }
 export interface OnvifCameraData extends BaseCameraData {
-    kind: RingCameraKind.onvif_camera;
+    kind: typeof RingCameraKind.onvif_camera;
     metadata: {
         legacy_fw_migrated: boolean;
         imported_from_amazon: boolean;
@@ -515,7 +519,7 @@ export interface OnvifCameraData extends BaseCameraData {
 }
 export interface ThirdPartyGarageDoorOpener {
     id: number;
-    kind: RingDeviceType.ThirdPartyGarageDoorOpener;
+    kind: typeof RingDeviceType.ThirdPartyGarageDoorOpener;
     description: string;
     location_id: string;
     owner_id: number;
@@ -539,7 +543,7 @@ export interface IntercomHandsetAudioData {
     id: number;
     description: string;
     device_id: string;
-    kind: RingDeviceType.IntercomHandsetAudio;
+    kind: typeof RingDeviceType.IntercomHandsetAudio;
     function: {
         name: null;
     };
@@ -862,24 +866,26 @@ export interface RingDeviceHistoryEvent {
     body: any;
 }
 export type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
-export declare enum NotificationDetectionType {
-    Human = "human",
-    Loitering = "loitering",
-    Motion = "motion",
-    OtherMotion = "other_motion",
-    NotAvailable = "null",
-    StreamBroken = "stream_broken"
-}
-export declare enum PushNotificationAction {
-    Ding = "com.ring.pn.live-event.ding",
-    Motion = "com.ring.pn.live-event.motion",
-    IntercomDing = "com.ring.pn.live-event.intercom",
-    IntercomUnlock = "com.ring.push.INTERCOM_UNLOCK_FROM_APP",
-    AlarmModeNone = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE",
-    AlarmModeSome = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE",
-    AlarmSoundSiren = "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN",
-    AlarmSilenceSiren = "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED"
-}
+export declare const NotificationDetectionType: {
+    readonly Human: "human";
+    readonly Loitering: "loitering";
+    readonly Motion: "motion";
+    readonly OtherMotion: "other_motion";
+    readonly NotAvailable: "null";
+    readonly StreamBroken: "stream_broken";
+};
+export type NotificationDetectionType = (typeof NotificationDetectionType)[keyof typeof NotificationDetectionType];
+export declare const PushNotificationAction: {
+    readonly Ding: "com.ring.pn.live-event.ding";
+    readonly Motion: "com.ring.pn.live-event.motion";
+    readonly IntercomDing: "com.ring.pn.live-event.intercom";
+    readonly IntercomUnlock: "com.ring.push.INTERCOM_UNLOCK_FROM_APP";
+    readonly AlarmModeNone: "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE";
+    readonly AlarmModeSome: "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE";
+    readonly AlarmSoundSiren: "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN";
+    readonly AlarmSilenceSiren: "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED";
+};
+export type PushNotificationAction = (typeof PushNotificationAction)[keyof typeof PushNotificationAction];
 export interface PushNotificationDingV2 {
     version: '2.0.0' | string;
     android_config: {
@@ -899,7 +905,7 @@ export interface PushNotificationDingV2 {
         device: {
             e2ee_enabled: boolean;
             id: number;
-            kind: RingCameraKind | RingDeviceType.IntercomHandsetAudio;
+            kind: RingCameraKind | typeof RingDeviceType.IntercomHandsetAudio;
             name: string;
         };
         event: {
@@ -949,7 +955,7 @@ interface PushNotificationIntercomUnlock {
     aps: {
         alert: string;
     };
-    action: PushNotificationAction.IntercomUnlock;
+    action: typeof PushNotificationAction.IntercomUnlock;
     alarm_meta: {
         device_zid: number;
         location_id: string;
@@ -1027,10 +1033,11 @@ export interface AccountMonitoringStatus {
     cmsMonitoringType: 'full' | string;
     dispatchSetupComplete: boolean;
 }
-export declare enum DispatchSignalType {
-    Burglar = "user-verified-burglar-xa",
-    Fire = "user-verified-fire-xa"
-}
+export declare const DispatchSignalType: {
+    readonly Burglar: "user-verified-burglar-xa";
+    readonly Fire: "user-verified-fire-xa";
+};
+export type DispatchSignalType = (typeof DispatchSignalType)[keyof typeof DispatchSignalType];
 export type LocationModeInput = 'home' | 'away' | 'disarmed';
 export type LocationMode = LocationModeInput | 'disabled' | 'unset';
 export declare const disabledLocationModes: LocationMode[];