@ray-js/api 1.4.62 → 1.4.63

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

@@ -0,0 +1,110 @@
+type CurrentMemberInfoResult = {
+    userId: number;
+    lockUserId: number;
+    userType: number;
+    allOpenDps: string;
+    allOpenType: Array<number>;
+    productAttribute: number;
+    phase: number;
+    expireTime: number;
+    expireDate: number;
+};
+type CurrentMemberInfoParams = {
+    devId: string;
+    dpIds: string;
+};
+export declare const getCurrentMemberInfo: (params: CurrentMemberInfoParams) => Promise<CurrentMemberInfoResult>;
+type UnlockDetail = {
+    dpId: number;
+    count: number;
+    unlockList: Array<{
+        unlockId: string;
+        opModeId: number;
+        unlockName: string;
+        unlockAttr: number;
+        admin: boolean;
+    }>;
+};
+type ScheduleDetails = {
+    effectiveTime: number;
+    invalidTime: number;
+    workingDay: number;
+    timeZoneId: string;
+    allDay: boolean;
+};
+type TimeScheduleInfo = {
+    permanent: boolean;
+    timeSetShifted: boolean;
+    userTimeSet: string;
+    effectiveTime: number;
+    expiredTime: number;
+    scheduleDetails: Array<ScheduleDetails>;
+};
+type FamilyMemberWithUnlockDetail = {
+    avatarUrl: string;
+    lockUserId: number;
+    nickName: string;
+    userType: number;
+    backHomeNotifyAttr: number;
+    userContact: string;
+    offlineUnlock: boolean;
+    userId: string;
+    unlockDetail: UnlockDetail[];
+    timeScheduleInfo: TimeScheduleInfo;
+};
+type FamilyMemberListWithUnlockCountResult = Array<FamilyMemberWithUnlockDetail>;
+type FamilyMemberListWithUnlockCountParams = {
+    devId: string;
+    dpIds: Array<number>;
+};
+export declare const getFamilyMemberListWithUnlockCount: (params: FamilyMemberListWithUnlockCountParams) => Promise<FamilyMemberListWithUnlockCountResult>;
+type FamilyMemberRemovalResult = boolean;
+type FamilyMemberRemovalParams = {
+    devId: string;
+    userId: string;
+};
+export declare const removeFamilyMember: (params: FamilyMemberRemovalParams) => Promise<FamilyMemberRemovalResult>;
+type UserDeletionQueryResult = Array<{
+    userId: number;
+    lockUserId: number;
+}>;
+type UserDeletionQueryParams = {
+    devId: string;
+};
+export declare const queryUserDeletion: (params: UserDeletionQueryParams) => Promise<UserDeletionQueryResult>;
+type LockSyncBatchResult = {
+    lockRandom: {
+        devUnlockId: string;
+        distributed: boolean;
+        ins: string;
+    };
+    lockFitting: {
+        dpId: number;
+        distributed: boolean;
+        ins: Array<any>;
+    };
+    lockRecord: string;
+    removedUser: Array<{
+        userId: number;
+        lockUserId: number;
+    }>;
+};
+type LockSyncBatchParams = {
+    devId: string;
+};
+export declare const syncLockBatch: (params: LockSyncBatchParams) => Promise<LockSyncBatchResult>;
+type UpdateUserTimeScheduleResult = boolean;
+type UpdateUserTimeScheduleParams = {
+    devId: string;
+    userId: string;
+    timeScheduleInfo: TimeScheduleInfo;
+};
+export declare const updateUserTimeSchedule: (params: UpdateUserTimeScheduleParams) => Promise<UpdateUserTimeScheduleResult>;
+type OpenCloseOfflineUnlockResult = boolean;
+type OpenCloseOfflineUnlockParams = {
+    devId: string;
+    userId: string;
+    enable: boolean;
+};
+export declare const openCloseOfflineUnlock: (params: OpenCloseOfflineUnlockParams) => Promise<OpenCloseOfflineUnlockResult>;
+export {};

package/lib/cloud/doorlock/member.js

@@ -0,0 +1,72 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 3.1. 获取当前登陆用户信息
+
+export const getCurrentMemberInfo = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 3.2. 获取家庭成员列表(带解锁方式个数)
+
+export const getFamilyMemberListWithUnlockCount = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.detail.list"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 3.3. 家庭成员移除成功通知
+
+export const removeFamilyMember = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.remove"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 3.4. 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
+
+export const queryUserDeletion = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.removed"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.5. 门锁批量同步
+
+export const syncLockBatch = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.sync.batch"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.6. 更新用户时效
+
+export const updateUserTimeSchedule = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.time.schedule.update"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.7. 打开/关闭离线解锁开关
+
+export const openCloseOfflineUnlock = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.unlock.offline"),
+    version: '1.0',
+    data: params
+  });
+};

package/lib/cloud/doorlock/offline-pwd.d.ts

@@ -0,0 +1,61 @@
+type OfflinePwdParams = {
+    devId: string;
+    pwdType: string;
+    gmtStart: number;
+    gmtExpired: number;
+    pwdName?: string;
+    countryCode?: string;
+    mobile?: string;
+};
+type OfflinePwdResult = {
+    pwd: string;
+    pwdId: string;
+    unlockBindingId: string;
+};
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export declare const getOfflinePassword: (params: OfflinePwdParams) => Promise<OfflinePwdResult>;
+type PwdRevokeParams = {
+    devId: string;
+    unlockBindingId: string;
+    name?: string;
+};
+type PwdRevokeResult = string;
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export declare const revokeOfflinePassword: (params: PwdRevokeParams) => Promise<PwdRevokeResult>;
+type PwdNameUpdateParams = {
+    devId: string;
+    unlockBindingId: string;
+    pwdName: string;
+};
+type PwdNameUpdateResult = string;
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export declare const updateOfflinePasswordName: (params: PwdNameUpdateParams) => Promise<PwdNameUpdateResult>;
+type RevocablePwdParams = {
+    devId: string;
+};
+type RevocablePwdResultEntry = {
+    gmtExpired: string;
+    pwdName: string;
+    pwdId: string;
+    gmtStart: string;
+};
+type RevocablePwdResult = RevocablePwdResultEntry[];
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export declare const getRevocableOfflinePasswords: (params: RevocablePwdParams) => Promise<RevocablePwdResult>;
+export {};

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

@@ -0,0 +1,67 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 6.1. 获取离线临时密码
+
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export const getOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 6.2. 获取某个离线临时密码的删除密码
+
+// 离线删除密码
+
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export const revokeOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revoke"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.3. 设置某个密码的名称
+
+// 更新结果
+
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export const updateOfflinePasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.name.update"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.4. 获取生效中的，可以被清空的多次离线临时密码
+
+// 结果的数组
+
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export const getRevocableOfflinePasswords = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revocable"),
+    version: '1.0',
+    data: params
+  });
+};

package/lib/cloud/{doorlock.js → doorlock/old.js}

@@ -1,6 +1,7 @@
+// 仅用于门锁模版
 // 门锁模版中涉及到的atop接口，暂时封装，后续会根据实际情况进行封装。
-import { THING } from '../constants';
-import requestCloud from '../requestCloud';
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
 
 // 获取云能力
 export const getUiConfig = function (productId) {

package/lib/cloud/doorlock/temp-pwd.d.ts

@@ -0,0 +1,194 @@
+type GetDynapwdParams = {
+    devId: string;
+    adminPwd: string;
+};
+type GetDynapwdResponse = {
+    dynamicPassword: string;
+};
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<GetDynapwdResponse>;
+type ValidateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name: string;
+    schedule?: {
+        invalidTime?: number;
+        workingDay?: number;
+        allDay?: boolean;
+        effectiveTime?: number;
+    }[];
+    countryCode?: string;
+    phone?: string;
+    password: string;
+};
+type ValidateTempPasswordResult = {
+    valid: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateTemporaryPassword: (params: ValidateTempPasswordParams) => Promise<ValidateTempPasswordResult>;
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+type Schedule_Ver2 = {
+    invalidTime?: number;
+    workingDay?: number;
+    allDay: boolean;
+    effectiveTime?: number;
+};
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+type ValidateUpdateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name?: string;
+    schedule?: string;
+    countryCode?: string;
+    phone?: string;
+};
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+type ValidateUpdateTempPasswordResult = {
+    valid?: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateAndUpdateTemporaryPassword: (params: ValidateUpdateTempPasswordParams) => Promise<ValidateUpdateTempPasswordResult>;
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+type CreateTempPasswordParams = {
+    devId: string;
+    sn: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name?: string;
+    symbolic: boolean;
+    dpTunnel?: string;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+type CreateTempPasswordResult = {
+    unlockBindingId?: string;
+};
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+type UpdateTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    effectiveTime?: number;
+    invalidTime?: number;
+    name?: string;
+    phase?: number;
+    symbolic: boolean;
+    dpTunnel: number;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+type UpdateTempPasswordResult = boolean;
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPassword: (params: UpdateTempPasswordParams) => Promise<UpdateTempPasswordResult>;
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+type UpdateTempPasswordNameParams = {
+    unlockBindingId: number;
+    devId: string;
+    name?: string;
+};
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+type UpdateTempPasswordNameResult = boolean;
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPasswordName: (params: UpdateTempPasswordNameParams) => Promise<UpdateTempPasswordNameResult>;
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+type DeleteTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    symbolic?: boolean;
+    dpTunnel?: boolean;
+};
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+type DeleteTempPasswordResult = boolean;
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export declare const deleteTemporaryPassword: (params: DeleteTempPasswordParams) => Promise<DeleteTempPasswordResult>;
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+type ShareAvailabilityParams = {
+    unlockBindingId?: number;
+    devId: string;
+    availTime: number;
+    countryCode: string;
+    account: string;
+    name?: string;
+    effectiveTime: number;
+    invalidTime: number;
+    schedule?: string;
+};
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+type ShareAvailabilityResult = {
+    validateResult: boolean;
+    registered?: boolean;
+    dialogueType: number;
+    errorMsg: string;
+    errorCode: string;
+};
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export declare const checkShareAvailability: (params: ShareAvailabilityParams) => Promise<ShareAvailabilityResult>;
+export {};

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
+  });
+};