@ray-js/api 1.4.62 → 1.4.63

package/lib/cloud/doorlock/device.js

@@ -0,0 +1,187 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+//#region 设置设备属性
+
+/**
+ * SetDevicePropertiesParams - 设置设备属性参数
+ */
+
+/**
+ * SetDevicePropertiesResponse - 设置设备属性响应
+ */
+
+/**
+ * 设置设备属性
+ * @param {SetDevicePropertiesParams} params - 设置设备属性参数
+ * @returns {Promise<SetDevicePropertiesResponse>} - 设置结果的 Promise
+ */
+export const setDeviceProperties = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.props.save"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 查看设置的设备属性
+
+/**
+ * GetDevicePropertiesParams - 查看设置的设备属性参数
+ */
+
+/**
+ * GetDevicePropertiesResponse - 查看设置的设备属性响应
+ */
+
+// 返回参数，一个键值对，key为LOST_ALERTER_HELPER，值为对应状态字符串
+
+/**
+ * 查看设置的设备属性
+ * @param {GetDevicePropertiesParams} params - 查看设备属性参数
+ * @returns {Promise<GetDevicePropertiesResponse>} - 查看结果的 Promise
+ */
+export const getDeviceProperties = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.props.fetch"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 获取家庭成员基础信息列表
+
+/**
+ * MemberListParams - 获取家庭成员基础信息列表参数
+ */
+
+/**
+ * MemberListResponseItem - 家庭成员基础信息列表项
+ */
+
+/**
+ * MemberListResponse - 获取家庭成员基础信息列表响应
+ */
+
+/**
+ * 获取家庭成员基础信息列表
+ * @param {MemberListParams} params - 获取成员列表参数
+ * @returns {Promise<MemberListResponse>} - 成员列表的 Promise
+ */
+export const getMemberList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.list"),
+    version: '5.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 解锁方式同步
+
+/**
+ * UnlockSyncParams - 解锁方式同步参数
+ */
+
+/**
+ * UnlockSyncResponse - 解锁方式同步响应
+ */
+
+/**
+ * 解锁方式同步
+ * @param {UnlockSyncParams} params - 解锁方式同步参数
+ * @returns {Promise<UnlockSyncResponse>} - 同步结果的 Promise
+ */
+export const syncUnlockMode = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.opmode.sync.rise"),
+    version: '2.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 查询时间对应的格式
+
+/**
+ * QueryDateFormatParams - 查询时间对应的格式参数
+ */
+
+/**
+ * QueryDateFormatResponse - 查询时间对应的格式响应
+ */
+
+// 日期格式化格式
+
+/**
+ * 查询时间对应的格式
+ * @param {QueryDateFormatParams} params - 查询时间对应的格式参数
+ * @returns {Promise<QueryDateFormatResponse>} - 查询结果的 Promise
+ */
+export const queryDateFormat = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.i18n.date.template.get"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 用户获取设备自身的激活时间(配网时间)
+
+/**
+ * QueryActiveDateParams - 用户获取设备自身的激活时间参数
+ */
+
+/**
+ * QueryActiveDateResponse - 用户获取设备自身的激活时间响应
+ */
+
+// 64 dp password_offline_time  最新数据
+
+/**
+ * 用户获取设备自身的激活时间(配网时间)
+ * @param {QueryActiveDateParams} params - 查询激活时间参数
+ * @returns {Promise<QueryActiveDateResponse>} - 查询结果的 Promise
+ */
+export const queryDeviceActiveDate = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.active.date"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 获取设备位置
+
+/**
+ * QueryTrackDetailsParams - 获取设备位置参数
+ */
+
+/**
+ * QueryTrackDetailsResponse - 获取设备位置响应
+ */
+
+/**
+ * 获取设备位置
+ * @param {QueryTrackDetailsParams} params - 获取设备位置参数
+ * @returns {Promise<QueryTrackDetailsResponse>} - 查询结果的 Promise
+ */
+export const queryDeviceTrackDetails = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.track.details"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion

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

@@ -0,0 +1,10 @@
+export * from './old';
+export * from './auth';
+export * from './device';
+export * from './log';
+export * from './member-opmode';
+export * from './member';
+export * from './offline-pwd';
+export * from './temp-pwd';
+export * from './unlock';
+export * from './unlock-method';

package/lib/cloud/doorlock/index.js

@@ -0,0 +1,20 @@
+export * from './old';
+
+// 授权相关
+export * from './auth';
+// 设备相关
+export * from './device';
+// 日志相关
+export * from './log';
+// 成员解锁相关
+export * from './member-opmode';
+// 用户相关
+export * from './member';
+// 离线临时密码相关
+export * from './offline-pwd';
+// 临时开锁相关
+export * from './temp-pwd';
+// 解锁相关
+export * from './unlock';
+// 解锁方式分配相关
+export * from './unlock-method';

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

@@ -0,0 +1,113 @@
+type LatestLogParams = {
+    devId: string;
+};
+type UnionUnlockInfo = {
+    userName?: string;
+    opMode?: string;
+    unlockName?: string;
+    currentUser?: boolean;
+    sn?: number;
+};
+type LatestLogResponse = {
+    exist: boolean;
+    logId: number;
+    logCategory: string;
+    logType: string;
+    recordType?: number;
+    unlockNameRosettaKey?: string;
+    currentUser?: boolean;
+    userId?: string;
+    userName?: string;
+    unlockName?: string;
+    time: number;
+    relateDevName?: string;
+    relateOpMode?: string;
+    unionUnlockInfo?: UnionUnlockInfo;
+    data?: string;
+    unReadCount?: number;
+};
+/**
+ * 查询最近一条日志记录
+ * @param   {LatestLogParams} params  - 包含设备Id的参数
+ * @returns {Promise<LatestLogResponse>} - 包含请求结果和状态的响应
+ */
+export declare const getLatestLog: (params: LatestLogParams) => Promise<LatestLogResponse>;
+type UserAction = {
+    userType: number;
+    userId: number;
+    operClassify: number;
+    operType: number;
+    operDetail: string;
+    toUserType: number;
+    toUserId: number;
+};
+type MediaInfo = {
+    fileUrl: string;
+    fileKey: string;
+    mediaPath: string;
+    mediaBucket: string;
+    mediaKey: string;
+};
+type LogRecord = {
+    logId: number;
+    logCategory: number;
+    logType: string;
+    recordType?: number;
+    unlockNameRosettaKey?: string;
+    currentUser?: boolean;
+    userId?: string;
+    userName?: string;
+    memberBindableFlag: boolean;
+    unlockName?: string;
+    time: number;
+    relateDevName?: string;
+    relateOpMode?: string;
+    unionUnlockInfo?: string;
+    mediaInfoList?: MediaInfo[];
+    localOperateRecordInfo?: UserAction;
+};
+type QueryLogRecordParams = {
+    devId: string;
+    logCategories?: string[];
+    userIds?: string[];
+    onlyShowMediaRecord: boolean;
+    startTime?: number;
+    endTime?: number;
+    lastRowKey?: string;
+    limit: number;
+};
+type QueryLogRecordResponse = LogRecord[];
+/**
+ *  查询日志记录
+ * @param  {QueryLogRecordParams} params
+ * @returns  {Promise<QueryLogRecordResponse>} - 包含请求结果和状态的响应
+ */
+export declare const queryLogRecord: (params: QueryLogRecordParams) => Promise<QueryLogRecordResponse>;
+type UploadLogRecordResult = boolean;
+type UploadLogRecordParams = {
+    devId: string;
+    logType: string;
+    data: string[];
+};
+/**
+ *  上报操作日志记录
+ * @param  {UploadLogRecordParams} params
+ * @returns  {Promise<UploadLogRecordResult>}
+ */
+export declare const uploadLogRecord: (params: UploadLogRecordParams) => Promise<UploadLogRecordResult>;
+type QueryAlbumRecordParams = {
+    devId: string;
+    offset: number;
+    limit: number;
+};
+type QueryAlbumRecordResponse = {
+    eventTypes: string;
+    albumList: any[];
+};
+/**
+ * 分页获取获取可以查看的相册列表
+ * @param  {QueryAlbumRecordParams} params
+ * @returns  {Promise<QueryAlbumRecordResponse>}
+ */
+export declare const queryAlbumRecord: (params: QueryAlbumRecordParams) => Promise<QueryAlbumRecordResponse>;
+export {};

package/lib/cloud/doorlock/log.js

@@ -0,0 +1,53 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+/**
+ * 查询最近一条日志记录
+ * @param   {LatestLogParams} params  - 包含设备Id的参数
+ * @returns {Promise<LatestLogResponse>} - 包含请求结果和状态的响应
+ */
+export const getLatestLog = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.latest"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ *  查询日志记录
+ * @param  {QueryLogRecordParams} params
+ * @returns  {Promise<QueryLogRecordResponse>} - 包含请求结果和状态的响应
+ */
+export const queryLogRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.list"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ *  上报操作日志记录
+ * @param  {UploadLogRecordParams} params
+ * @returns  {Promise<UploadLogRecordResult>}
+ */
+export const uploadLogRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.log.upload"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 2.4. m.lock.album.media.list
+
+/**
+ * 分页获取获取可以查看的相册列表
+ * @param  {QueryAlbumRecordParams} params
+ * @returns  {Promise<QueryAlbumRecordResponse>}
+ */
+export const queryAlbumRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.lock.album.media.list"),
+    version: '2.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/member-opmode.d.ts

@@ -0,0 +1,121 @@
+type ValidatePwdMemberResult = {
+    valid: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+type ValidatePwdMemberParams = {
+    devId: string;
+    opModeId?: number;
+    password: string;
+};
+/**
+ *  校验成员密码是否存在(包括临时密码)
+ * @param {ValidatePwdMemberParams} params
+ * @returns {Promise<ValidatePwdMemberResult>}
+ */
+export declare const validatePasswordForMember: (params: ValidatePwdMemberParams) => Promise<ValidatePwdMemberResult>;
+type AddMemberUnlockMethodResult = {
+    opModeId: string;
+    unlockName: string;
+};
+type NotifyInfo = {
+    appSend?: boolean;
+    msgPhone?: string;
+    countryCode?: string;
+    msgPhoneVerifyCode?: string;
+};
+type AddMemberUnlockMethodParams = {
+    devId: string;
+    userId: string;
+    unlockId: number;
+    unlockName?: string;
+    unlockAttr: number;
+    notifyInfo?: NotifyInfo;
+    unlockDetail?: string;
+};
+/**
+ * 添加解锁方式
+ * @param  {AddMemberUnlockMethodParams} params
+ * @returns  {Promise<AddMemberUnlockMethodResult>}
+ */
+export declare const addMemberUnlockMethod: (params: AddMemberUnlockMethodParams) => Promise<AddMemberUnlockMethodResult>;
+type RemoveMemberUnlockMethodResult = boolean;
+type RemoveMemberUnlockMethodParams = {
+    devId: string;
+    opmodeId: number;
+};
+/**
+ *  删除解锁方式
+ * @param  {RemoveMemberUnlockMethodParams} params
+ * @returns  {Promise<RemoveMemberUnlockMethodResult>}
+ */
+export declare const removeMemberUnlockMethod: (params: RemoveMemberUnlockMethodParams) => Promise<RemoveMemberUnlockMethodResult>;
+type SendSpecialUnlockVerifyCodeResult = boolean;
+type SendSpecialUnlockVerifyCodeParams = {
+    account: string;
+};
+/**
+ * 发送设置特殊解锁方式的验证码
+ * @param  {SendSpecialUnlockVerifyCodeParams} params
+ * @returns  {Promise<SendSpecialUnlockVerifyCodeResult>}
+ */
+export declare const sendSpecialUnlockVerifyCode: (params: SendSpecialUnlockVerifyCodeParams) => Promise<SendSpecialUnlockVerifyCodeResult>;
+type UpdateMemberUnlockModeResult = boolean;
+type UpdateMemberUnlockModeParams = {
+    devId: string;
+    opModeId: number;
+    unlockName?: string;
+    unlockAttr: number;
+    unlockDetail: string;
+    notifyInfo?: NotifyInfo;
+};
+/**
+ * 更新成员的解锁方式
+ * @param   {UpdateMemberUnlockModeParams} params
+ * @returns  {Promise<UpdateMemberUnlockModeResult>}
+ */
+export declare const updateMemberUnlockMode: (params: UpdateMemberUnlockModeParams) => Promise<UpdateMemberUnlockModeResult>;
+type UnlockMethodDetailResult = {
+    phase: number;
+    opmode: string;
+    unlockAttr: number;
+    unlockName: string;
+    userId: string;
+    opmodeValue: string;
+    unlockId: string;
+    lockUserId: number;
+    opmodeId: string;
+    voiceAttr: number;
+    userTimeSet: string;
+    userType: number;
+    sourceAttribute: number;
+    notifyInfo?: NotifyInfoDetail;
+};
+type NotifyInfoDetail = {
+    appSend?: boolean;
+    msgPhone?: string;
+    countryCode?: string;
+    targetUserId?: number;
+};
+type UnlockMethodDetailParams = {
+    devId: string;
+    opModeId: number;
+};
+/**
+ *  查询某个解锁方式的详情
+ * @param  {UnlockMethodDetailParams} params
+ * @returns  {Promise<UnlockMethodDetailResult>}
+ */
+export declare const getUnlockMethodDetail: (params: UnlockMethodDetailParams) => Promise<UnlockMethodDetailResult>;
+type GetPasswordSNResult = number;
+type GetPasswordSNParams = {
+    devId: string;
+    dpId: number;
+};
+/**
+ *  获取创建密码时的序号
+ * @param   {GetPasswordSNParams} params
+ * @returns  {Promise<GetPasswordSNResult>}
+ */
+export declare const getCreatePasswordSN: (params: GetPasswordSNParams) => Promise<GetPasswordSNResult>;
+export {};

package/lib/cloud/doorlock/member-opmode.js

@@ -0,0 +1,104 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 4.1. 校验成员密码是否存在(包括临时密码)
+
+/**
+ *  校验成员密码是否存在(包括临时密码)
+ * @param {ValidatePwdMemberParams} params
+ * @returns {Promise<ValidatePwdMemberResult>}
+ */
+export const validatePasswordForMember = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.pwd.validate"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 通知信息
+
+/**
+ * 添加解锁方式
+ * @param  {AddMemberUnlockMethodParams} params
+ * @returns  {Promise<AddMemberUnlockMethodResult>}
+ */
+export const addMemberUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.add"),
+    version: '5.0',
+    data: params
+  });
+};
+
+// 4.3. 删除解锁方式
+
+/**
+ *  删除解锁方式
+ * @param  {RemoveMemberUnlockMethodParams} params
+ * @returns  {Promise<RemoveMemberUnlockMethodResult>}
+ */
+export const removeMemberUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.remove"),
+    version: '2.0',
+    data: params
+  });
+};
+/**
+ * 发送设置特殊解锁方式的验证码
+ * @param  {SendSpecialUnlockVerifyCodeParams} params
+ * @returns  {Promise<SendSpecialUnlockVerifyCodeResult>}
+ */
+export const sendSpecialUnlockVerifyCode = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.verifycode.send"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 4.5. 更新成员的解锁方式
+
+/**
+ * 更新成员的解锁方式
+ * @param   {UpdateMemberUnlockModeParams} params
+ * @returns  {Promise<UpdateMemberUnlockModeResult>}
+ */
+export const updateMemberUnlockMode = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.update"),
+    version: '5.0',
+    data: params
+  });
+};
+
+// 4.6. 查询某个解锁方式的详情
+
+/**
+ *  查询某个解锁方式的详情
+ * @param  {UnlockMethodDetailParams} params
+ * @returns  {Promise<UnlockMethodDetailResult>}
+ */
+export const getUnlockMethodDetail = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.detail"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 4.7. 获取创建密码时的序号
+
+/**
+ *  获取创建密码时的序号
+ * @param   {GetPasswordSNParams} params
+ * @returns  {Promise<GetPasswordSNResult>}
+ */
+export const getCreatePasswordSN = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.dp.sn.get"),
+    version: '1.0',
+    data: params
+  });
+};