ring-client-api 11.6.0 → 11.7.0-beta.1

package/README.md

@@ -115,7 +115,9 @@ camera.getSnapshot() // returns a Promise<Buffer> of the latest snapshot from th
 
 Camera also includes the following observables:
 
-- `onNewDing`: this will include the sip info and ding information every time a new ding is created
+- `onNewNotification`: this is triggered any time a new push notification is received
+- `onActiveNotifications`: notifications received within the last minute
+- `onDoorbellPressed`: this will include the sip info and ding information every time a new ding is created
 - `onActiveDings`: dings created within the last 65 seconds
 - `onDoorbellPressed`: emits a ding every time the doorbell is pressed
 - `onMotionDetected`: `true` or `false` based on `onActiveDings` containing a motion ding

package/lib/api.d.ts

@@ -33,7 +33,7 @@ export declare class RingApi extends Subscribed {
         beamBridges: BeamBridge[];
         onvifCameras: OnvifCameraData[];
         thirdPartyGarageDoorOpeners: ThirdPartyGarageDoorOpener[];
-        intercomHandsets: IntercomHandsetAudioData[];
+        intercoms: IntercomHandsetAudioData[];
         unknownDevices: UnknownDevice[];
     }>;
     private listenForDeviceUpdates;

package/lib/api.js

@@ -15,6 +15,7 @@ const util_1 = require("./util");
 const ffmpeg_1 = require("./ffmpeg");
 const subscribed_1 = require("./subscribed");
 const push_receiver_1 = __importDefault(require("@eneris/push-receiver"));
+const ring_intercom_1 = require("./ring-intercom");
 class RingApi extends subscribed_1.Subscribed {
     constructor(options) {
         super();
@@ -34,14 +35,14 @@ class RingApi extends subscribed_1.Subscribed {
         }
     }
     async fetchRingDevices() {
-        const { doorbots, chimes, authorized_doorbots: authorizedDoorbots, stickup_cams: stickupCams, base_stations: baseStations, beams_bridges: beamBridges, other: otherDevices, } = await this.restClient.request({ url: (0, rest_client_1.clientApi)('ring_devices') }), onvifCameras = [], intercomHandsets = [], thirdPartyGarageDoorOpeners = [], unknownDevices = [];
+        const { doorbots, chimes, authorized_doorbots: authorizedDoorbots, stickup_cams: stickupCams, base_stations: baseStations, beams_bridges: beamBridges, other: otherDevices, } = await this.restClient.request({ url: (0, rest_client_1.clientApi)('ring_devices') }), onvifCameras = [], intercoms = [], thirdPartyGarageDoorOpeners = [], unknownDevices = [];
         otherDevices.forEach((device) => {
             switch (device.kind) {
                 case ring_types_1.RingDeviceType.OnvifCamera:
                     onvifCameras.push(device);
                     break;
                 case ring_types_1.RingDeviceType.IntercomHandsetAudio:
-                    intercomHandsets.push(device);
+                    intercoms.push(device);
                     break;
                 case ring_types_1.RingDeviceType.ThirdPartyGarageDoorOpener:
                     thirdPartyGarageDoorOpeners.push(device);
@@ -66,16 +67,16 @@ class RingApi extends subscribed_1.Subscribed {
             beamBridges,
             onvifCameras,
             thirdPartyGarageDoorOpeners,
-            intercomHandsets,
+            intercoms,
             unknownDevices,
         };
     }
-    listenForDeviceUpdates(cameras, chimes) {
+    listenForDeviceUpdates(cameras, chimes, intercoms) {
         const { cameraStatusPollingSeconds } = this.options;
         if (!cameraStatusPollingSeconds) {
             return;
         }
-        const onCamerasRequestUpdate = (0, rxjs_1.merge)(...cameras.map((camera) => camera.onRequestUpdate)), onChimesRequestUpdate = (0, rxjs_1.merge)(...chimes.map((chime) => chime.onRequestUpdate)), onUpdateReceived = new rxjs_1.Subject(), onPollForStatusUpdate = cameraStatusPollingSeconds
+        const devices = [...cameras, ...chimes, ...intercoms], onDeviceRequestUpdate = (0, rxjs_1.merge)(...devices.map((device) => device.onRequestUpdate)), onUpdateReceived = new rxjs_1.Subject(), onPollForStatusUpdate = cameraStatusPollingSeconds
             ? onUpdateReceived.pipe((0, operators_1.debounceTime)(cameraStatusPollingSeconds * 1000))
             : rxjs_1.EMPTY, camerasById = cameras.reduce((byId, camera) => {
             byId[camera.id] = camera;
@@ -83,11 +84,14 @@ class RingApi extends subscribed_1.Subscribed {
         }, {}), chimesById = chimes.reduce((byId, chime) => {
             byId[chime.id] = chime;
             return byId;
+        }, {}), intercomsById = intercoms.reduce((byId, intercom) => {
+            byId[intercom.id] = intercom;
+            return byId;
         }, {});
         if (!cameras.length && !chimes.length) {
             return;
         }
-        this.addSubscriptions((0, rxjs_1.merge)(onCamerasRequestUpdate, onChimesRequestUpdate, onPollForStatusUpdate)
+        this.addSubscriptions((0, rxjs_1.merge)(onDeviceRequestUpdate, onPollForStatusUpdate)
             .pipe((0, operators_1.throttleTime)(500), (0, operators_1.switchMap)(() => this.fetchRingDevices().catch(() => null)))
             .subscribe((response) => {
             onUpdateReceived.next(null);
@@ -106,6 +110,12 @@ class RingApi extends subscribed_1.Subscribed {
                     chime.updateData(data);
                 }
             });
+            response.intercoms.forEach((data) => {
+                const intercom = intercomsById[data.id];
+                if (intercom) {
+                    intercom.updateData(data);
+                }
+            });
         }));
         if (cameraStatusPollingSeconds) {
             onUpdateReceived.next(null); // kick off polling
@@ -142,6 +152,7 @@ class RingApi extends subscribed_1.Subscribed {
         });
         pushReceiver.onNotification(({ message }) => {
             const dataJson = message.data?.gcmData;
+            (0, util_1.logInfo)(`Received push notification: ${dataJson}`);
             try {
                 const notification = JSON.parse(dataJson);
                 if (!notification.ding) {
@@ -175,19 +186,19 @@ class RingApi extends subscribed_1.Subscribed {
         });
     }
     async fetchAndBuildLocations() {
-        const rawLocations = await this.fetchRawLocations(), { authorizedDoorbots, chimes, doorbots, allCameras, baseStations, beamBridges, } = await this.fetchRingDevices(), locationIdsWithHubs = [...baseStations, ...beamBridges].map((x) => x.location_id), cameras = allCameras.map((data) => new ring_camera_1.RingCamera(data, doorbots.includes(data) ||
+        const rawLocations = await this.fetchRawLocations(), { authorizedDoorbots, chimes, doorbots, allCameras, baseStations, beamBridges, intercoms, } = await this.fetchRingDevices(), locationIdsWithHubs = [...baseStations, ...beamBridges].map((x) => x.location_id), cameras = allCameras.map((data) => new ring_camera_1.RingCamera(data, doorbots.includes(data) ||
             authorizedDoorbots.includes(data) ||
-            data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), locations = rawLocations
+            data.kind.startsWith('doorbell'), this.restClient, this.options.avoidSnapshotBatteryDrain || false)), ringChimes = chimes.map((data) => new ring_chime_1.RingChime(data, this.restClient)), ringIntercoms = intercoms.map((data) => new ring_intercom_1.RingIntercom(data, this.restClient)), locations = rawLocations
             .filter((location) => {
             return (!Array.isArray(this.options.locationIds) ||
                 this.options.locationIds.includes(location.location_id));
         })
-            .map((location) => new location_1.Location(location, cameras.filter((x) => x.data.location_id === location.location_id), ringChimes.filter((x) => x.data.location_id === location.location_id), {
+            .map((location) => new location_1.Location(location, cameras.filter((x) => x.data.location_id === location.location_id), ringChimes.filter((x) => x.data.location_id === location.location_id), ringIntercoms.filter((x) => x.data.location_id === location.location_id), {
             hasHubs: locationIdsWithHubs.includes(location.location_id),
             hasAlarmBaseStation: baseStations.some((station) => station.location_id === location.location_id),
             locationModePollingSeconds: this.options.locationModePollingSeconds,
         }, this.restClient));
-        this.listenForDeviceUpdates(cameras, ringChimes);
+        this.listenForDeviceUpdates(cameras, ringChimes, ringIntercoms);
         this.registerPushReceiver(cameras).catch((e) => {
             (0, util_1.logError)(e);
         });

package/lib/index.d.ts

@@ -3,4 +3,5 @@ export * from './location';
 export * from './ring-camera';
 export * from './ring-chime';
 export * from './ring-device';
+export * from './ring-intercom';
 export * from './ring-types';

package/lib/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./location"), exports);
 __exportStar(require("./ring-camera"), exports);
 __exportStar(require("./ring-chime"), exports);
 __exportStar(require("./ring-device"), exports);
+__exportStar(require("./ring-intercom"), exports);
 __exportStar(require("./ring-types"), exports);

package/lib/location.d.ts

@@ -5,11 +5,13 @@ import { RingRestClient } from './rest-client';
 import { RingCamera } from './ring-camera';
 import { RingChime } from './ring-chime';
 import { RingDevice } from './ring-device';
+import { RingIntercom } from './ring-intercom';
 import { Subscribed } from './subscribed';
 export declare class Location extends Subscribed {
     readonly locationDetails: UserLocation;
     readonly cameras: RingCamera[];
     readonly chimes: RingChime[];
+    readonly intercoms: RingIntercom[];
     readonly options: {
         hasHubs: boolean;
         hasAlarmBaseStation: boolean;
@@ -35,7 +37,7 @@ export declare class Location extends Subscribed {
     offlineAssets: string[];
     hasHubs: boolean;
     hasAlarmBaseStation: boolean;
-    constructor(locationDetails: UserLocation, cameras: RingCamera[], chimes: RingChime[], options: {
+    constructor(locationDetails: UserLocation, cameras: RingCamera[], chimes: RingChime[], intercoms: RingIntercom[], options: {
         hasHubs: boolean;
         hasAlarmBaseStation: boolean;
         locationModePollingSeconds?: number;

package/lib/location.js

@@ -15,11 +15,12 @@ function flattenDeviceData(data) {
     return Object.assign({}, data.general && data.general.v2, data.device && data.device.v1);
 }
 class Location extends subscribed_1.Subscribed {
-    constructor(locationDetails, cameras, chimes, options, restClient) {
+    constructor(locationDetails, cameras, chimes, intercoms, options, restClient) {
         super();
         this.locationDetails = locationDetails;
         this.cameras = cameras;
         this.chimes = chimes;
+        this.intercoms = intercoms;
         this.options = options;
         this.restClient = restClient;
         this.seq = 1;

package/lib/rest-client.d.ts

@@ -3,6 +3,7 @@ import { AuthTokenResponse, SessionResponse } from './ring-types';
 import { ReplaySubject } from 'rxjs';
 export declare function clientApi(path: string): string;
 export declare function deviceApi(path: string): string;
+export declare function commandsApi(path: string): string;
 export declare function appApi(path: string): string;
 export interface ExtendedResponse {
     responseTimestamp: number;

package/lib/rest-client.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RingRestClient = exports.appApi = exports.deviceApi = exports.clientApi = void 0;
+exports.RingRestClient = exports.appApi = exports.commandsApi = exports.deviceApi = exports.clientApi = void 0;
 const got_1 = __importDefault(require("got"));
 const util_1 = require("./util");
 const rxjs_1 = require("rxjs");
@@ -18,7 +18,7 @@ const defaultRequestOptions = {
     7061: 'ASSET_CELL_BACKUP',
     7062: 'UPDATING',
     7063: 'MAINTENANCE',
-}, clientApiBaseUrl = 'https://api.ring.com/clients_api/', deviceApiBaseUrl = 'https://api.ring.com/devices/v1/', appApiBaseUrl = 'https://app.ring.com/api/v1/', apiVersion = 11;
+}, clientApiBaseUrl = 'https://api.ring.com/clients_api/', deviceApiBaseUrl = 'https://api.ring.com/devices/v1/', commandsApiBaseUrl = 'https://api.ring.com/commands/v1/', appApiBaseUrl = 'https://app.ring.com/api/v1/', apiVersion = 11;
 function clientApi(path) {
     return clientApiBaseUrl + path;
 }
@@ -27,6 +27,10 @@ function deviceApi(path) {
     return deviceApiBaseUrl + path;
 }
 exports.deviceApi = deviceApi;
+function commandsApi(path) {
+    return commandsApiBaseUrl + path;
+}
+exports.commandsApi = commandsApi;
 function appApi(path) {
     return appApiBaseUrl + path;
 }

package/lib/ring-intercom.d.ts

@@ -0,0 +1,20 @@
+import { IntercomHandsetAudioData } from './ring-types';
+import { RingRestClient } from './rest-client';
+import { BehaviorSubject, Subject } from 'rxjs';
+export declare class RingIntercom {
+    private initialData;
+    private restClient;
+    id: number;
+    deviceType: import("./ring-types").RingDeviceType.IntercomHandsetAudio;
+    onData: BehaviorSubject<IntercomHandsetAudioData>;
+    onRequestUpdate: Subject<unknown>;
+    onBatteryLevel: import("rxjs").Observable<number | null>;
+    constructor(initialData: IntercomHandsetAudioData, restClient: RingRestClient);
+    updateData(update: IntercomHandsetAudioData): void;
+    requestUpdate(): void;
+    get data(): IntercomHandsetAudioData;
+    get name(): string;
+    get isOffline(): boolean;
+    get batteryLevel(): number | null;
+    unlock(): Promise<import("./rest-client").ExtendedResponse>;
+}

package/lib/ring-intercom.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RingIntercom = void 0;
+const rest_client_1 = require("./rest-client");
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const ring_camera_1 = require("./ring-camera");
+class RingIntercom {
+    constructor(initialData, restClient) {
+        this.initialData = initialData;
+        this.restClient = restClient;
+        this.onRequestUpdate = new rxjs_1.Subject();
+        this.id = this.initialData.id;
+        this.deviceType = this.initialData.kind;
+        this.onData = new rxjs_1.BehaviorSubject(this.initialData);
+        this.onBatteryLevel = this.onData.pipe((0, operators_1.map)((data) => (0, ring_camera_1.getBatteryLevel)(data)), (0, operators_1.distinctUntilChanged)());
+    }
+    updateData(update) {
+        this.onData.next(update);
+    }
+    requestUpdate() {
+        this.onRequestUpdate.next(null);
+    }
+    get data() {
+        return this.onData.getValue();
+    }
+    get name() {
+        return this.data.description;
+    }
+    get isOffline() {
+        return this.data.alerts.connection === 'offline';
+    }
+    get batteryLevel() {
+        return (0, ring_camera_1.getBatteryLevel)(this.data);
+    }
+    unlock() {
+        return this.restClient.request({
+            method: 'PUT',
+            url: (0, rest_client_1.commandsApi)(`devices/${this.id}/device_rpc`),
+            json: {
+                command_name: 'device_rpc',
+                request: {
+                    jsonrpc: '2.0',
+                    method: 'unlock_door',
+                    params: {
+                        door_id: this.id,
+                        user_id: 0,
+                    },
+                },
+            },
+        });
+    }
+}
+exports.RingIntercom = RingIntercom;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.6.0",
+  "version": "11.7.0-beta.1",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {