@ray-js/api 1.4.61 → 1.4.63

package/lib/cloud/doorlock/temp-pwd.js

@@ -0,0 +1,193 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 5.1. 获取动态密码参数类型定义
+
+// 5.1. 获取动态密码响应类型定义
+
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export const getDynamicPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.dynapwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 5.2. 临时密码参数有效性校验参数类型定义
+
+// 5.2. 临时密码参数有效性校验响应类型定义
+
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '3.0',
+    data: params
+  });
+};
+
+//#region 5.3. 校验临时密码参数
+
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateAndUpdateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '2.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.4.  临时密码页创建临时密码
+
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export const createTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.create"),
+    version: '8.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.5.  更新临时密码
+
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+
+// 请求结果：是否成功更新临时密码
+
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export const updateTempPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.update"),
+    version: '4.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 更新临时密码名称
+
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+
+// 请求结果：是否成功更新临时密码名称
+
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export const updateTempPasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.name"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  删除临时密码
+
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+
+// 请求结果：是否成功删除临时密码
+
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export const deleteTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.remove"),
+    version: '5.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  检查分享可用性
+
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export const checkShareAvailability = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.share.available"),
+    version: '1.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/unlock-method.d.ts

@@ -0,0 +1,62 @@
+/**
+ * CheckUnlockMethodParams - 查询解锁方式参数
+ */
+type CheckUnlockMethodParams = {
+    devId: string;
+};
+/**
+ * CheckUnlockMethodResult - 查询解锁方式结果
+ */
+type CheckUnlockMethodResult = boolean;
+/**
+ * 查询是否有解锁方式需要分配
+ * @param {CheckUnlockMethodParams} params - 查询解锁方式参数
+ * @returns {Promise<CheckUnlockMethodResult>} - 查询结果的 Promise
+ */
+export declare const checkUnlockMethod: (params: CheckUnlockMethodParams) => Promise<CheckUnlockMethodResult>;
+/**
+ * GetUnlockMethodListParams - 查询开锁方式列表参数
+ */
+type GetUnlockMethodListParams = {
+    devId: string;
+};
+/**
+ * UnlockInfo - 解锁方式信息
+ */
+type UnlockInfo = {
+    unlockId: string;
+    unlockName: string;
+    opmodeId?: number;
+};
+/**
+ * GetUnlockMethodListResult - 查询开锁方式列表结果
+ */
+type GetUnlockMethodListResult = {
+    opmode: boolean;
+    unlockInfo: UnlockInfo[];
+};
+/**
+ * 查询需要分配的开锁方式列表
+ * @param {GetUnlockMethodListParams} params - 查询开锁方式列表参数
+ * @returns {Promise<GetUnlockMethodListResult[]>} - 查询结果的 Promise
+ */
+export declare const getUnlockMethodList: (params: GetUnlockMethodListParams) => Promise<GetUnlockMethodListResult[]>;
+/**
+ * BindUnlockMethodToUserParams - 绑定解锁方式参数
+ */
+type BindUnlockMethodToUserParams = {
+    devId: string;
+    userId: string;
+    unlockIds: string[];
+};
+/**
+ * BindUnlockMethodToUserResponse - 绑定解锁方式响应
+ */
+type BindUnlockMethodToUserResponse = boolean;
+/**
+ * 绑定解锁方式到人
+ * @param {BindUnlockMethodToUserParams} params - 绑定解锁方式参数
+ * @returns {Promise<BindUnlockMethodToUserResponse>} - 绑定结果的 Promise
+ */
+export declare const bindUnlockMethodToUser: (params: BindUnlockMethodToUserParams) => Promise<BindUnlockMethodToUserResponse>;
+export {};

package/lib/cloud/doorlock/unlock-method.js

@@ -0,0 +1,85 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+//#region 查询是否有解锁方式需要分配
+
+/**
+ * CheckUnlockMethodParams - 查询解锁方式参数
+ */
+
+/**
+ * CheckUnlockMethodResult - 查询解锁方式结果
+ */
+
+// 查询结果
+
+/**
+ * 查询是否有解锁方式需要分配
+ * @param {CheckUnlockMethodParams} params - 查询解锁方式参数
+ * @returns {Promise<CheckUnlockMethodResult>} - 查询结果的 Promise
+ */
+export const checkUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.unlock.waitassign"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 查询需要分配的开锁方式列表
+
+/**
+ * GetUnlockMethodListParams - 查询开锁方式列表参数
+ */
+
+/**
+ * UnlockInfo - 解锁方式信息
+ */
+
+/**
+ * GetUnlockMethodListResult - 查询开锁方式列表结果
+ */
+
+/**
+ * 查询需要分配的开锁方式列表
+ * @param {GetUnlockMethodListParams} params - 查询开锁方式列表参数
+ * @returns {Promise<GetUnlockMethodListResult[]>} - 查询结果的 Promise
+ */
+export const getUnlockMethodList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.unlock.assignlist"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 绑定解锁方式到人
+
+/**
+ * BindUnlockMethodToUserParams - 绑定解锁方式参数
+ */
+
+/**
+ * BindUnlockMethodToUserResponse - 绑定解锁方式响应
+ */
+
+// 返回参数
+
+/**
+ * 绑定解锁方式到人
+ * @param {BindUnlockMethodToUserParams} params - 绑定解锁方式参数
+ * @returns {Promise<BindUnlockMethodToUserResponse>} - 绑定结果的 Promise
+ */
+export const bindUnlockMethodToUser = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.unlock.allocate"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion

package/lib/cloud/doorlock/unlock.d.ts

@@ -0,0 +1,89 @@
+type RemoteOpenParams = {
+    devId: string;
+    open: boolean;
+};
+type RemoteOpenResponse = boolean;
+/**
+ * 远程免密开门
+ * @param {RemoteOpenParams} params - 包含设备Id和开门状态的参数
+ * @returns {Promise<RemoteOpenResponse>} - 包含执行结果和状态的响应
+ */
+export declare const remoteOpenDoor: (params: RemoteOpenParams) => Promise<RemoteOpenResponse>;
+type UnlockParams = {
+    devId: string;
+    open: boolean;
+    confirm: boolean;
+};
+type UnlockResponse = boolean;
+/**
+ * 远程免密解锁
+ * @param {UnlockParams} params - 包含设备Id、开门状态和确认状态的参数
+ * @returns {Promise<UnlockResponse>} - 包含请求结果和状态的响应
+ */
+export declare const remoteUnlockDoor: (params: UnlockParams) => Promise<UnlockResponse>;
+type CanUnlockRemoteParams = {
+    devId: string;
+};
+type CanUnlockRemoteResponse = boolean;
+/**
+ * 判断用户是否可以远程开门
+ * @param {CanUnlockRemoteResponse} params - 包含设备Id的参数
+ * @returns {Promise<CanUnlockRemoteResponse>} - 包含请求结果和状态的响应
+ */
+export declare const checkCanRemoteUnlock: (params: CanUnlockRemoteParams) => Promise<CanUnlockRemoteResponse>;
+type UnlockRecord = {
+    userName: string;
+    opMode: string;
+    unlockName: string;
+};
+type GetLatestRecordInfoParams = {
+    devId: string;
+};
+type GetLatestRecordInfoResponse = {
+    dpId: number;
+    dpValue: string;
+    recordType: number;
+    userName: string;
+    time: number;
+    unionUnlockInfo: UnlockRecord[];
+    unReadCount: number;
+};
+/**
+ * 获取最近一条记录的信息
+ * @param   {GetLatestRecordInfoParams} params  - 包含设备Id的参数
+ * @returns {Promise<GetLatestRecordInfoResponse>} - 包含请求结果和状态的响应
+ */
+export declare const getLatestUnlockRecord: (params: GetLatestRecordInfoParams) => Promise<GetLatestRecordInfoResponse>;
+type QueryUnlockRecord = {
+    userName: string;
+    opMode: string;
+    unlockName: string;
+};
+type QueryRecordInfoParams = {
+    devId: string;
+    dpIds: string[];
+    offset?: number;
+    limit?: number;
+    startTime?: number;
+    endTime?: number;
+    nameless?: boolean;
+};
+type QueryRecordInfoResponse = {
+    id: number;
+    dpId: number;
+    userId: string;
+    unlockName: string;
+    userName: string;
+    avatarUrl: string;
+    time: number;
+    relateDevName: string;
+    relateOpMode?: number;
+    unionUnlockInfo: QueryUnlockRecord[];
+};
+/**
+ * 查询开门记录
+ * @param { QueryRecordInfoParams} params -  包含设备Id的参数
+ * @returns {Promise<QueryRecordInfoResponse[]>} - 包含请求结果和状态的响应
+ */
+export declare const queryUnlockRecord: (params: QueryRecordInfoParams) => Promise<QueryRecordInfoResponse[]>;
+export {};

package/lib/cloud/doorlock/unlock.js

@@ -0,0 +1,76 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 1.1. RemoteOpenParams - 远程免密开门的参数类型
+
+// RemoteOpenResponse - 远程免密开门的响应类型
+
+/**
+ * 远程免密开门
+ * @param {RemoteOpenParams} params - 包含设备Id和开门状态的参数
+ * @returns {Promise<RemoteOpenResponse>} - 包含执行结果和状态的响应
+ */
+export const remoteOpenDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.zigbee.lock.remotepwd.execute"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.2. Unlock - 远程免密开门的参数和响应类型
+
+/**
+ * 远程免密解锁
+ * @param {UnlockParams} params - 包含设备Id、开门状态和确认状态的参数
+ * @returns {Promise<UnlockResponse>} - 包含请求结果和状态的响应
+ */
+export const remoteUnlockDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 1.3. 判断用户是否可以远程开门
+
+/**
+ * 判断用户是否可以远程开门
+ * @param {CanUnlockRemoteResponse} params - 包含设备Id的参数
+ * @returns {Promise<CanUnlockRemoteResponse>} - 包含请求结果和状态的响应
+ */
+export const checkCanRemoteUnlock = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock.available"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ * 获取最近一条记录的信息
+ * @param   {GetLatestRecordInfoParams} params  - 包含设备Id的参数
+ * @returns {Promise<GetLatestRecordInfoResponse>} - 包含请求结果和状态的响应
+ */
+export const getLatestUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.latest"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.5. 查询开门记录
+
+/**
+ * 查询开门记录
+ * @param { QueryRecordInfoParams} params -  包含设备Id的参数
+ * @returns {Promise<QueryRecordInfoResponse[]>} - 包含请求结果和状态的响应
+ */
+export const queryUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.list"),
+    version: '2.0',
+    data: params
+  });
+};

package/lib/cloud/index.d.ts

@@ -4,5 +4,7 @@ export * from './alarm';
 export * from './statistic';
 export * from './device';
 export * from './linkage';
-export * from './doorlock';
+export * from './remoteGroup';
 export * from './outdoor';
+export * from './doorlock';
+export * from './recipe';

package/lib/cloud/index.js

@@ -4,9 +4,12 @@ export * from './alarm';
 export * from './statistic';
 export * from './device';
 export * from './linkage';
-
-// 仅用于门锁模版，在门锁未OpenAPI时使用。
-export * from './doorlock';
+export * from './remoteGroup';
 
 // 仅用于出行产品
-export * from './outdoor';
+export * from './outdoor';
+
+// 门锁
+export * from './doorlock';
+// 菜谱
+export * from './recipe';

package/lib/cloud/interface.d.ts

@@ -969,3 +969,29 @@ export interface DeviceProperty {
     value: string;
 }
 export type ISaveDevPropertyResponse = boolean;
+export interface IGetZigbeeLocalGroupRelation {
+    /**
+     * 遥控器设备 ID
+     */
+    devId: string;
+}
+export interface IGetZigbeeLocalGroupDeviceList {
+    /**
+     * 遥控器的设备 ID
+     */
+    devId: string;
+    /**
+     * 遥控器的网关 id
+     */
+    meshId: string;
+    /**
+     * 分组 Code，遥控器可支持多个群组，与 localId 匹配范围为 7001-7008；
+     * localId 为云端分配，步长为 8，因此一个遥控器内部最多支持关联 8 个群组，localId 为初始值依次+1，与之匹配的 categoryCode 从 7001 依次 +1。
+     * 可以通过 getZigbeeLocalGroupRelation 获取
+     */
+    categoryCode: string;
+    /**
+     * 家庭 id，可以通过 getCurrentHomeInfo 获取
+     */
+    homeId: string;
+}