@ray-js/lock-sdk 1.0.1 → 1.0.2

package/lib/unlock-method.d.ts

@@ -1,167 +1,54 @@
 import { ErrorData, UnBindUnlockMethodGroup, UnlockMethodDetail, UnlockMethodType } from "./interface";
 export interface SpecialUnlockMethodInfo {
-    /**
-     * 是否支持 App 消息通知
-     */
     appSend?: boolean;
-    /**
-     * 短信通知手机号，有手机号时，表示开启短信通知
-     */
     msgPhone?: string;
-    /**
-     * 手机验证码
-     * 在未开启短信通知时开启短信通知，此字段必传
-     */
     verifyCode?: string;
-    /**
-     * 短信通知国家码
-     * 当开启短信通知时，必传
-     */
     countryCode?: string;
 }
 export interface AddUnlockMethodBaseParams {
-    /**
-     * 用户 id
-     */
     userId: string;
-    /**
-     * 开锁方式名称
-     */
     name: string;
-    /**
-     * 是否特殊开锁方式，配置与劫持告警 dp 相关
-     * 当开启特殊开锁方式时，appSend 和 msgPhone 必须有一个
-     * 注意：门卡与人脸不支持特殊开锁方式配置
-     */
     isSpecial?: boolean;
-    /**
-     * 特殊开锁方式配置信息
-     */
     specialInfo?: SpecialUnlockMethodInfo;
 }
 export interface AddPasswordParams extends AddUnlockMethodBaseParams {
-    /**
-     * 密码值
-     */
     password: string;
 }
 export interface updateUnlockMethodParams {
-    /**
-     * 开锁方式 id
-     */
     id: number;
-    /**
-     * 开锁方式名称
-     */
     name: string;
-    /**
-     * 是否特殊开锁方式，配置与劫持告警 dp 相关
-     * 当开启特殊开锁方式时，appSend 和 msgPhone 必须有一个
-     */
     isSpecial?: boolean;
-    /**
-     * 特殊开锁方式配置信息
-     */
     specialInfo?: SpecialUnlockMethodInfo;
 }
-/**
- * 获取开锁方式详细信息
- * @param {number} id 开锁方式 id
- * @returns
- */
 export declare const getUnlockMethodDetail: (id: number) => Promise<UnlockMethodDetail>;
-/**
- * 检查是否支持短信通知
- * @returns 是否支持短信通知
- */
 export declare const checkSpecialSupportPhone: () => boolean;
-/**
- * 添加开锁密码
- */
 export declare const addPassword: (params: AddPasswordParams) => Promise<{
     opModeId: number;
     unlockName: string;
 }>;
 interface StartAddUnlockMethodParams {
-    /**
-     * 开锁方式
-     */
     type: UnlockMethodType;
-    /**
-     * 用户 id
-     */
     userId: string;
-    /**
-     * 每个步骤的超时时间
-     * 默认 15000 毫秒
-     */
     timeout?: number;
 }
 export declare const startAddUnlockMethod: (params: StartAddUnlockMethodParams) => Promise<{
     total: number;
 }>;
-/**
- * 更新开锁方式
- * 仅支持更新开锁方式名称和特殊开锁方式的通知信息
- * @param {updateUnlockMethodParams} params 入参
- * @returns
- */
 export declare const updateUnlockMethod: (params: updateUnlockMethodParams) => Promise<unknown>;
 interface CancelAddUnlockMethodParams extends StartAddUnlockMethodParams {
 }
-/**
- * 取消添加开锁方式
- * @param {CancelAddUnlockMethodParams} params 入参
- * @returns
- */
 export declare const cancelAddUnlockMethod: (params: CancelAddUnlockMethodParams) => Promise<boolean>;
-/**
- * 删除开锁方式
- * @param {number} id 开锁方式 id
- */
 export declare const deleteUnlockMethod: (id: number) => Promise<void>;
-/**
- * 检测是否有未绑定的开锁方式
- * @returns
- */
 export declare const checkUnBindUnlockMethods: () => Promise<boolean>;
-/**
- * 获取未关联开锁方式列表
- */
 export declare const getUnbindUnlockMethods: () => Promise<UnBindUnlockMethodGroup[]>;
-/**
- * 绑定未关联开锁方式到用户入参
- */
 interface BindUnlockMethodParams {
-    /**
-     * 用户 id
-     */
     userId: string;
-    /**
-     * 待关联的开锁试
-     */
     unlockList: {
-        /**
-         * 开锁方式类型
-         */
         type: UnlockMethodType;
-        /**
-         * 开锁方式的硬件id
-         */
         unlockId: number;
     }[];
 }
-/**
- * 绑定未关联开锁方式到用户
- * @param params
- * @returns
- */
 export declare const bindUnlockMethod: (params: BindUnlockMethodParams) => Promise<boolean>;
-/**
- * 解绑用户的开锁方式
- * @param {number} id 开锁方式 id
- * @returns
- */
 export declare const unbindUnlockMethod: (id: number) => Promise<boolean>;
 interface BindUnlockMethodFromLogParams {
     userId: string;
@@ -170,104 +57,32 @@ interface BindUnlockMethodFromLogParams {
         unlockId: number;
     }[];
 }
-/**
- * 绑定开门记录中未关联开锁方式到用户
- * @param {UnbindUnlockMethodParams} params
- * @returns
- */
 export declare const bindUnlockMethodFromLog: (params: BindUnlockMethodFromLogParams) => Promise<boolean>;
 interface SendVerifyCodeParams {
     account: string;
 }
-/**
- *
- * @param params
- * @returns
- */
 export declare const sendVerifyCode: (params: SendVerifyCodeParams) => Promise<unknown>;
-/**
- * 添加开锁方式步骤事件类型
- */
 interface StepEvent {
-    /**
-     * 开锁方式类型
-     */
     type: UnlockMethodType;
-    /**
-     * 锁端用户 id
-     */
     lockUserId: number;
-    /**
-     * 表示为录入成功
-     */
     stage: "step";
-    /**
-     * 当前步骤
-     */
     step: number;
-    /**
-     * 总步骤
-     */
     total: number;
 }
-/**
- * 添加开锁方式成员事件类型
- */
 interface SuccessEvent {
-    /**
-     * 开锁方式类型
-     */
     type: UnlockMethodType;
-    /**
-     * 开锁方式云端 id
-     */
     id: number;
-    /**
-     * 开锁方式默认名称
-     */
     name: string;
-    /**
-     * 表示录入成功
-     */
     stage: "success";
 }
-/**
- * 添加开锁方式错误事件类型
- */
 interface ErrorEvent {
-    /**
-     * 开锁方式类型
-     */
     type: UnlockMethodType;
-    /**
-     * 锁端用户 id
-     */
     lockUserId: number;
-    /**
-     * 表示为失败
-     */
     stage: "fail";
-    /**
-     * 错误信息
-     */
     error: ErrorData;
 }
-/**
- * 添加开锁方式监听器事件类型
- */
 export type AddUnlockMethodEvent = StepEvent | SuccessEvent | ErrorEvent;
-/**
- * 添加开锁方式步骤监听器类型
- */
 export type AddUnlockMethodListener = (event: AddUnlockMethodEvent) => void;
-/**
- * 注册开锁方式步骤监听器
- * @param {AddUnlockMethodListener} listener 监听器
- */
 export declare const onAddUnlockMethod: (listener: AddUnlockMethodListener) => void;
-/**
- * 注销开锁方式步骤监听器
- * @param {AddUnlockMethodListener} listener 监听器
- */
 export declare const offAddUnlockMethod: (listener: AddUnlockMethodListener) => void;
 export {};