@ray-js/api 1.5.0-beta.12 → 1.5.1

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

@@ -0,0 +1,235 @@
+/**
+ * AuthListParams - 获取授权记录列表参数
+ */
+type AuthListParams = {
+    devId: string;
+    authTypes: string[];
+};
+/**
+ * ScheduleDetailsEntry - 授权记录详情条目
+ */
+type ScheduleDetailsEntry = {
+    allDay: boolean;
+    effectiveTime: number;
+    invalidTime: number;
+    workingDay: number;
+};
+/**
+ * OpModeInfo - 操作模式信息
+ */
+type OpModeInfo = {
+    hasClearPwd?: string;
+    revokedPwdName?: string;
+    revokedPwdEffectiveTime?: string;
+    revokedPwdInvalidTime?: string;
+};
+/**
+ * AuthListResultEntry - 获取授权记录列表结果条目
+ */
+type AuthListResultEntry = {
+    unlockBindingId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name: string;
+    userName: string;
+    scheduleDetails: ScheduleDetailsEntry[];
+    opModeType: number;
+    opModeSubType: number;
+    sn: number;
+    lockUserId: number;
+    account: string;
+    countryCode: string;
+    opModeInfo?: OpModeInfo;
+};
+/**
+ * AuthListResult - 获取授权记录列表结果
+ */
+type AuthListResult = {
+    hasNext: boolean;
+    totalCount: number;
+    datas: AuthListResultEntry[];
+};
+/**
+ * getAuthList - 获取授权记录列表函数
+ * @param {AuthListParams} params - 获取授权记录列表参数
+ * @returns {Promise<AuthListResult>} - 获取授权记录列表结果的 Promise
+ */
+export declare const getLockAuthList: (params: AuthListParams) => Promise<AuthListResult>;
+/**
+ * InvalidAuthListParams - 获取已失效的授权记录列表参数
+ */
+type InvalidAuthListParams = {
+    devId: string;
+    offSet: number;
+    limit: number;
+};
+/**
+ * InvalidAuthListResultEntry - 获取已失效的授权记录列表结果条目
+ */
+type InvalidAuthListResultEntry = {
+    unlockBindingId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name: string;
+    userName: string;
+    scheduleDetails: ScheduleDetailsEntry[];
+    opModeType: number;
+    opModeSubType: number;
+    sn: number;
+    lockUserId: number;
+    account: string;
+    countryCode: string;
+    opModeInfo?: OpModeInfo;
+};
+/**
+ * InvalidAuthListResult - 获取已失效的授权记录列表结果
+ */
+type InvalidAuthListResult = InvalidAuthListResultEntry[];
+/**
+ * 获取已失效的授权记录列表
+ * @param {InvalidAuthListParams} params - 获取已失效的授权记录列表参数
+ * @returns {Promise<InvalidAuthListResult>} - 获取已失效的授权记录列表结果的 Promise
+ */
+export declare const getInvalidAuthList: (params: InvalidAuthListParams) => Promise<InvalidAuthListResult>;
+/**
+ * ClearInvalidAuthListParams - 清空已失效的授权记录列表参数
+ */
+type ClearInvalidAuthListParams = {
+    devId: string;
+};
+/**
+ * ClearInvalidAuthListResult - 清空已失效的授权记录列表结果
+ */
+type ClearInvalidAuthListResult = boolean;
+/**
+ * 清空已失效的授权记录列表
+ * @param {ClearInvalidAuthListParams} params - 清空已失效的授权记录列表参数
+ * @returns {Promise<ClearInvalidAuthListResult>} - 清空已失效的授权记录列表结果的 Promise
+ */
+export declare const clearInvalidAuthList: (params: ClearInvalidAuthListParams) => Promise<ClearInvalidAuthListResult>;
+/**
+ * Schedule - 日程设置
+ */
+type Schedule = {
+    allDay: boolean;
+    effectiveTime?: number;
+    invalidTime?: number;
+    workingDay?: number;
+};
+/**
+ * AddBluetoothAuthParams - 添加蓝牙授权参数
+ */
+type AddBluetoothAuthParams = {
+    devId: string;
+    timeSetType: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name: string;
+    schedule?: Schedule;
+    countryCode: string;
+    account: string;
+    offlineUnlock: boolean;
+};
+/**
+ * AddBluetoothAuthResult - 添加蓝牙授权结果
+ */
+type AddBluetoothAuthResult = {
+    unlockBindingId: string;
+    name: string;
+    userExist: boolean;
+};
+/**
+ * 添加蓝牙授权
+ * @param {AddBluetoothAuthParams} params - 添加蓝牙授权参数
+ * @returns {Promise<AddBluetoothAuthResult>} - 添加蓝牙授权结果的 Promise
+ */
+export declare const addBluetoothAuth: (params: AddBluetoothAuthParams) => Promise<AddBluetoothAuthResult>;
+/**
+ * UpdateSchedule - 更新日程设置
+ */
+type UpdateSchedule = {
+    allDay: boolean;
+    effectiveTime?: number;
+    invalidTime?: number;
+    workingDay?: number;
+};
+/**
+ * UpdateBluetoothKeyParams - 修改蓝牙钥匙信息参数
+ */
+type UpdateBluetoothKeyParams = {
+    devId: string;
+    unlockBindingId: string;
+    offlineUnlock: boolean;
+    timeSetType: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name?: string;
+    phase?: number;
+    schedule?: UpdateSchedule;
+};
+/**
+ * UpdateBluetoothKeyResult - 修改蓝牙钥匙信息结果
+ */
+type UpdateBluetoothKeyResult = boolean;
+/**
+ * 修改蓝牙钥匙信息
+ * @param {UpdateBluetoothKeyParams} params - 修改蓝牙钥匙信息参数
+ * @returns {Promise<UpdateBluetoothKeyResult>} - 修改蓝牙钥匙信息结果的 Promise
+ */
+export declare const updateBluetoothKey: (params: UpdateBluetoothKeyParams) => Promise<UpdateBluetoothKeyResult>;
+/**
+ * FreezeUnfreezeBluetoothKeyParams - 冻结/解冻蓝牙钥匙参数
+ */
+type FreezeUnfreezeBluetoothKeyParams = {
+    devId: string;
+    unlockBindingId: string;
+    phase?: number;
+};
+/**
+ * FreezeUnfreezeBluetoothKeyResult - 冻结/解冻蓝牙钥匙结果
+ */
+type FreezeUnfreezeBluetoothKeyResult = boolean;
+/**
+ * 冻结或解冻蓝牙钥匙。
+ * @param {FreezeUnfreezeBluetoothKeyParams} params - 冻结或解冻蓝牙钥匙的参数。
+ * @returns {Promise<FreezeUnfreezeBluetoothKeyResult>} - 带有冻结或解冻蓝牙钥匙结果的 Promise。
+ */
+export declare const freezeUnfreezeBluetoothKey: (params: FreezeUnfreezeBluetoothKeyParams) => Promise<FreezeUnfreezeBluetoothKeyResult>;
+/**
+ * ChangeBluetoothKeyNameParams - 修改蓝牙钥匙名称参数
+ */
+type ChangeBluetoothKeyNameParams = {
+    devId: string;
+    unlockBindingId: string;
+    name: string;
+};
+/**
+ * ChangeBluetoothKeyNameResult - 修改蓝牙钥匙名称结果
+ */
+type ChangeBluetoothKeyNameResult = boolean;
+/**
+ * 修改蓝牙钥匙名称。
+ * @param {ChangeBluetoothKeyNameParams} params - 修改蓝牙钥匙名称的参数。
+ * @returns {Promise<ChangeBluetoothKeyNameResult>} - 带有修改蓝牙钥匙名称结果的 Promise。
+ */
+export declare const changeBluetoothKeyName: (params: ChangeBluetoothKeyNameParams) => Promise<ChangeBluetoothKeyNameResult>;
+/**
+ * RemoveBluetoothKeyParams - 删除蓝牙钥匙授权参数
+ */
+type RemoveBluetoothKeyParams = {
+    devId: string;
+    unlockBindingId: string;
+};
+/**
+ * RemoveBluetoothKeyResult - 删除蓝牙钥匙授权结果
+ */
+type RemoveBluetoothKeyResult = boolean;
+/**
+ * 删除蓝牙钥匙授权。
+ * @param {RemoveBluetoothKeyParams} params - 删除蓝牙钥匙授权的参数。
+ * @returns {Promise<RemoveBluetoothKeyResult>} - 带有删除蓝牙钥匙授权结果的 Promise。
+ */
+export declare const removeBluetoothKeyAuthorization: (params: RemoveBluetoothKeyParams) => Promise<RemoveBluetoothKeyResult>;
+export {};

package/lib/cloud/doorlock/auth.js

@@ -0,0 +1,223 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+//#region 获取授权记录列表
+
+/**
+ * AuthListParams - 获取授权记录列表参数
+ */
+
+/**
+ * ScheduleDetailsEntry - 授权记录详情条目
+ */
+
+/**
+ * OpModeInfo - 操作模式信息
+ */
+
+/**
+ * AuthListResultEntry - 获取授权记录列表结果条目
+ */
+
+/**
+ * AuthListResult - 获取授权记录列表结果
+ */
+
+/**
+ * getAuthList - 获取授权记录列表函数
+ * @param {AuthListParams} params - 获取授权记录列表参数
+ * @returns {Promise<AuthListResult>} - 获取授权记录列表结果的 Promise
+ */
+export const getLockAuthList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.auth.list"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 获取已失效的授权记录列表
+
+/**
+ * InvalidAuthListParams - 获取已失效的授权记录列表参数
+ */
+
+/**
+ * InvalidAuthListResultEntry - 获取已失效的授权记录列表结果条目
+ */
+
+/**
+ * InvalidAuthListResult - 获取已失效的授权记录列表结果
+ */
+
+/**
+ * 获取已失效的授权记录列表
+ * @param {InvalidAuthListParams} params - 获取已失效的授权记录列表参数
+ * @returns {Promise<InvalidAuthListResult>} - 获取已失效的授权记录列表结果的 Promise
+ */
+export const getInvalidAuthList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.auth.list.invalid"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 清空已失效的授权记录列表
+
+/**
+ * ClearInvalidAuthListParams - 清空已失效的授权记录列表参数
+ */
+
+/**
+ * ClearInvalidAuthListResult - 清空已失效的授权记录列表结果
+ */
+
+/**
+ * 清空已失效的授权记录列表
+ * @param {ClearInvalidAuthListParams} params - 清空已失效的授权记录列表参数
+ * @returns {Promise<ClearInvalidAuthListResult>} - 清空已失效的授权记录列表结果的 Promise
+ */
+export const clearInvalidAuthList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.auth.list.clear"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+//#region 添加蓝牙授权
+
+/**
+ * Schedule - 日程设置
+ */
+
+/**
+ * AddBluetoothAuthParams - 添加蓝牙授权参数
+ */
+
+/**
+ * AddBluetoothAuthResult - 添加蓝牙授权结果
+ */
+
+/**
+ * 添加蓝牙授权
+ * @param {AddBluetoothAuthParams} params - 添加蓝牙授权参数
+ * @returns {Promise<AddBluetoothAuthResult>} - 添加蓝牙授权结果的 Promise
+ */
+export const addBluetoothAuth = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.key.virtual.add"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 修改蓝牙钥匙信息
+
+/**
+ * UpdateSchedule - 更新日程设置
+ */
+
+/**
+ * UpdateBluetoothKeyParams - 修改蓝牙钥匙信息参数
+ */
+
+/**
+ * UpdateBluetoothKeyResult - 修改蓝牙钥匙信息结果
+ */
+
+/**
+ * 修改蓝牙钥匙信息
+ * @param {UpdateBluetoothKeyParams} params - 修改蓝牙钥匙信息参数
+ * @returns {Promise<UpdateBluetoothKeyResult>} - 修改蓝牙钥匙信息结果的 Promise
+ */
+export const updateBluetoothKey = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.key.virtual.update"),
+    version: '1.0',
+    data: params
+  });
+};
+//#endregion
+//#region 冻结/解冻蓝牙钥匙
+
+/**
+ * FreezeUnfreezeBluetoothKeyParams - 冻结/解冻蓝牙钥匙参数
+ */
+
+/**
+ * FreezeUnfreezeBluetoothKeyResult - 冻结/解冻蓝牙钥匙结果
+ */
+
+/**
+ * 冻结或解冻蓝牙钥匙。
+ * @param {FreezeUnfreezeBluetoothKeyParams} params - 冻结或解冻蓝牙钥匙的参数。
+ * @returns {Promise<FreezeUnfreezeBluetoothKeyResult>} - 带有冻结或解冻蓝牙钥匙结果的 Promise。
+ */
+export const freezeUnfreezeBluetoothKey = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.key.virtual.phase"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 修改蓝牙钥匙名称
+
+/**
+ * ChangeBluetoothKeyNameParams - 修改蓝牙钥匙名称参数
+ */
+
+/**
+ * ChangeBluetoothKeyNameResult - 修改蓝牙钥匙名称结果
+ */
+
+/**
+ * 修改蓝牙钥匙名称。
+ * @param {ChangeBluetoothKeyNameParams} params - 修改蓝牙钥匙名称的参数。
+ * @returns {Promise<ChangeBluetoothKeyNameResult>} - 带有修改蓝牙钥匙名称结果的 Promise。
+ */
+export const changeBluetoothKeyName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.key.virtual.name"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 删除蓝牙钥匙授权
+
+/**
+ * RemoveBluetoothKeyParams - 删除蓝牙钥匙授权参数
+ */
+
+/**
+ * RemoveBluetoothKeyResult - 删除蓝牙钥匙授权结果
+ */
+
+/**
+ * 删除蓝牙钥匙授权。
+ * @param {RemoveBluetoothKeyParams} params - 删除蓝牙钥匙授权的参数。
+ * @returns {Promise<RemoveBluetoothKeyResult>} - 带有删除蓝牙钥匙授权结果的 Promise。
+ */
+export const removeBluetoothKeyAuthorization = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.key.virtual.remove"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion