@ray-js/api 1.6.4 → 1.6.5

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

@@ -0,0 +1,257 @@
+/**
+ * GetAudioSwitchParams - 查询音箱密码是否开启参数
+ */
+type GetAudioSwitchParams = {
+    devId: string;
+};
+/**
+ * GetAudioSwitchResult - 查询音箱密码是否开启结果
+ */
+type GetAudioSwitchResult = boolean;
+/**
+ * 查询音箱密码是否开启
+ * @param {GetAudioSwitchParams} params - 查询音箱密码是否开启参数
+ * @returns {Promise<GetAudioSwitchResult>} - 查询音箱密码是否开启结果的 Promise
+ */
+declare const getAudioSwitch: (params: GetAudioSwitchParams) => Promise<GetAudioSwitchResult>;
+/**
+ * SetAudioSwitchParams - 设置或取消音箱密码
+ */
+type SetAudioSwitchParams = {
+    devId: string;
+    open: boolean;
+    pwd: string;
+};
+/**
+ * SetAudioSwitchResult - 设置或取消音箱密码
+ */
+type SetAudioSwitchResult = boolean;
+/**
+ * 设置或取消音箱密码
+ * @param {SetAudioSwitchParams} params - 设置或取消音箱密码参数
+ * @returns {Promise<SetAudioSwitchResult>} - 设置或取消音箱密码结果的 Promise
+ */
+declare const setAudioSwitch: (params: SetAudioSwitchParams) => Promise<SetAudioSwitchResult>;
+/**
+ * GetVoiceFileListParams - 获取语音文件列表
+ */
+type GetVoiceFileListParams = {
+    devId: string;
+};
+/**
+ * FileItem - 文件项类型
+ */
+type FileItem = {
+    fileType: number;
+    describe: string;
+    fileKey: string;
+    version: string;
+    fileStatus: number;
+};
+/**
+ * GetHighPowerListResponse - 获取语音文件列表
+ */
+type GetVoiceFileListResponse = FileItem[];
+/**
+ * 获取语音文件列表
+ * @param {GetVoiceFileListParams} params - 获取语音文件列表参数
+ * @returns {Promise<GetVoiceFileListResponse>} - 查询结果的 Promise
+ */
+declare const getVoiceFileList: (params: GetVoiceFileListParams) => Promise<GetVoiceFileListResponse>;
+/**
+ * GetDownloadUrlParams - 获取语音文件下载地址参数
+ */
+type GetDownloadUrlParams = {
+    devId: string;
+    fileKey: string;
+};
+/**
+ * GetDownloadUrlResponse - 获取语音文件下载地址响应
+ */
+type GetDownloadUrlResponse = string;
+/**
+ * 获取语音文件下载地址
+ * @param {GetDownloadUrlParams} params - 获取语音文件下载地址参数
+ * @returns {Promise<GetDownloadUrlResponse>} - 设置结果的 Promise
+ */
+declare const getDownloadUrl: (params: GetDownloadUrlParams) => Promise<GetDownloadUrlResponse>;
+/**
+ * GetBleGeofenceListParams - 获取当前用户在设备下的地理围栏场景信息参数
+ */
+type GetBleGeofenceListParams = {
+    devId: string;
+};
+/**
+ * RuleVO - 规则详细信息
+ */
+type RuleVO = {
+    id: number;
+    name: string;
+    devId: string;
+    ownerId: number;
+    uid: string;
+    status: boolean;
+    module: string;
+    geoTitle: string;
+    centerLng: string;
+    centerLat: string;
+    radius: string;
+    activeTime: number;
+    rssi?: string;
+    displayColor?: string;
+    icon?: string;
+    background?: string;
+    title?: string;
+};
+/**
+ * GetBleGeofenceListResponse - 获取当前用户在设备下的地理围栏场景信息响应
+ */
+type GetBleGeofenceListResponse = {
+    code: string;
+    title: string;
+    description: string;
+    displayColor: string;
+    icon: string;
+    background: string;
+    enable: boolean;
+    ruleVO: RuleVO;
+};
+/**
+ * 获取当前用户在设备下的地理围栏场景信息
+ * @param {GetBleGeofenceListParams} params - 获取当前用户在设备下的地理围栏场景信息参数
+ * @returns {Promise<GetBleGeofenceListResponse>} - 设置结果的 Promise
+ */
+declare const getBleGeofenceList: (params: GetBleGeofenceListParams) => Promise<GetBleGeofenceListResponse>;
+/**
+ * RegisterBleCloudGeofenceParams - 注册地理围栏
+ */
+type RegisterBleCloudGeofenceParams = {
+    devId: string;
+    ownerId: number;
+    geoFenceInfo: GeoFenceInfo;
+};
+type GeoFenceInfo = {
+    module: string;
+    geoTitle?: string;
+    centerLng: string;
+    centerLat: string;
+    radius: string;
+    activeTime: number;
+    rssi?: string;
+    displayColor?: string;
+    icon?: string;
+    background?: string;
+    title?: string;
+};
+/**
+ * RegisterBleCloudGeofenceResponse - 注册地理围栏
+ */
+type RegisterBleCloudGeofenceResponse = {
+    id: number;
+    devId: string;
+    ownerId: number;
+    uid: string;
+    status: boolean;
+    module: string;
+    geoTitle?: string;
+    centerLng: string;
+    centerLat: string;
+    radius: string;
+    activeTime: number;
+    rssi?: string;
+    displayColor?: string;
+    icon?: string;
+    background?: string;
+    title?: string;
+};
+/**
+ * 注册地理围栏
+ * @param {RegisterBleCloudGeofenceParams} params - 注册地理围栏参数
+ * @returns {Promise<RegisterBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+declare const registerBleCloudGeofence: (params: RegisterBleCloudGeofenceParams) => Promise<RegisterBleCloudGeofenceResponse>;
+/**
+ * EditBleCloudGeofenceParams - 修改地理围栏
+ */
+type EditBleCloudGeofenceParams = {
+    id: number;
+    geoFenceInfo: GeoFenceInfo;
+};
+/**
+ * GetHighPowerListResponse - 修改地理围栏
+ */
+type EditBleCloudGeofenceResponse = boolean;
+/**
+ * 修改地理围栏
+ * @param {EditBleCloudGeofenceParams} params - 修改地理围栏参数
+ * @returns {Promise<EditBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+declare const editBleCloudGeofence: (params: EditBleCloudGeofenceParams) => Promise<EditBleCloudGeofenceResponse>;
+/**
+ * HandleBleCloudGeofenceParams - 开启/关闭 地理围栏
+ */
+type HandleBleCloudGeofenceParams = {
+    id: number;
+    targetStatus: boolean;
+};
+/**
+ * HandleBleCloudGeofenceResponse - 开启/关闭 地理围栏
+ */
+type HandleBleCloudGeofenceResponse = boolean;
+/**
+ * 开启/关闭 地理围栏
+ * @param {HandleBleCloudGeofenceParams} params - 开启/关闭 地理围栏参数
+ * @returns {Promise<HandleBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+declare const handleBleCloudGeofence: (params: HandleBleCloudGeofenceParams) => Promise<HandleBleCloudGeofenceResponse>;
+/**
+ * GetRemoteOpenKeyParams - 获取蓝牙开门密钥
+ */
+type GetRemoteOpenKeyParams = {
+    devId: string;
+};
+/**
+ * GetHighPowerListResponse - 获取蓝牙开门密钥
+ */
+type GetRemoteOpenKeyResponse = {
+    devUnlockId: string;
+    dpId: number;
+    wakeUpIns: string;
+    distributed: boolean;
+    ins: string;
+};
+/**
+ * 获取蓝牙开门密钥
+ * @param {GetRemoteOpenKeyParams} params - 获取蓝牙开门密钥参数
+ * @returns {Promise<GetRemoteOpenKeyResponse>} - 查询结果的 Promise
+ */
+declare const getRemoteOpenKey: (params: GetRemoteOpenKeyParams) => Promise<GetRemoteOpenKeyResponse>;
+/**
+ * GetCountryListParams - 获取国家名称
+ */
+type GetCountryListParams = {
+    lang: string;
+};
+/**
+ * GetCountryListResponse - 获取国家名称
+ */
+type GetCountryListResponse = Record<string, any>;
+/**
+ * 获取国家名称
+ * @param {GetCountryListParams} params - 获取国家名称参数
+ * @returns {Promise<GetCountryListResponse>} - 查询结果的 Promise
+ */
+declare const getCountryList: (params: GetCountryListParams) => Promise<GetCountryListResponse>;
+/**
+ * GetUserRegionResult - 获取当前帐号所属地区结果
+ */
+type GetUserRegionResult = {
+    region: string;
+};
+/**
+ * 获取当前帐号所属地区
+ * @param {GetUserRegionParams} params - 获取当前帐号所属地区的参数
+ * @returns {Promise<GetUserRegionResult>} - 带有获取当前帐号所属地区结果的 Promise。
+ */
+declare const getUserRegion: () => Promise<GetUserRegionResult>;
+export { getAudioSwitch, setAudioSwitch, getVoiceFileList, getDownloadUrl, getBleGeofenceList, registerBleCloudGeofence, editBleCloudGeofence, handleBleCloudGeofence, getRemoteOpenKey, getCountryList, getUserRegion, };

package/lib/cloud/doorlock/setting.js

@@ -0,0 +1,283 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+//#region 查询音箱密码是否开启
+
+/**
+ * GetAudioSwitchParams - 查询音箱密码是否开启参数
+ */
+
+/**
+ * GetAudioSwitchResult - 查询音箱密码是否开启结果
+ */
+
+/**
+ * 查询音箱密码是否开启
+ * @param {GetAudioSwitchParams} params - 查询音箱密码是否开启参数
+ * @returns {Promise<GetAudioSwitchResult>} - 查询音箱密码是否开启结果的 Promise
+ */
+const getAudioSwitch = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.voice.pwd.flag"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 设置或取消音箱密码
+
+/**
+ * SetAudioSwitchParams - 设置或取消音箱密码
+ */
+
+/**
+ * SetAudioSwitchResult - 设置或取消音箱密码
+ */
+
+/**
+ * 设置或取消音箱密码
+ * @param {SetAudioSwitchParams} params - 设置或取消音箱密码参数
+ * @returns {Promise<SetAudioSwitchResult>} - 设置或取消音箱密码结果的 Promise
+ */
+const setAudioSwitch = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.voice.pwd.setting"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 获取语音文件列表
+
+/**
+ * GetVoiceFileListParams - 获取语音文件列表
+ */
+
+/**
+ * FileItem - 文件项类型
+ */
+
+/**
+ * GetHighPowerListResponse - 获取语音文件列表
+ */
+
+/**
+ * 获取语音文件列表
+ * @param {GetVoiceFileListParams} params - 获取语音文件列表参数
+ * @returns {Promise<GetVoiceFileListResponse>} - 查询结果的 Promise
+ */
+const getVoiceFileList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.voice.list"),
+    version: '1.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 获取语音文件下载地址
+
+/**
+ * GetDownloadUrlParams - 获取语音文件下载地址参数
+ */
+
+/**
+ * GetDownloadUrlResponse - 获取语音文件下载地址响应
+ */
+
+/**
+ * 获取语音文件下载地址
+ * @param {GetDownloadUrlParams} params - 获取语音文件下载地址参数
+ * @returns {Promise<GetDownloadUrlResponse>} - 设置结果的 Promise
+ */
+const getDownloadUrl = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.voice.download"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 获取当前用户在设备下的地理围栏场景信息
+
+/**
+ * GetBleGeofenceListParams - 获取当前用户在设备下的地理围栏场景信息参数
+ */
+
+/**
+ * RuleVO - 规则详细信息
+ */
+
+/**
+ * GetBleGeofenceListResponse - 获取当前用户在设备下的地理围栏场景信息响应
+ */
+
+/**
+ * 获取当前用户在设备下的地理围栏场景信息
+ * @param {GetBleGeofenceListParams} params - 获取当前用户在设备下的地理围栏场景信息参数
+ * @returns {Promise<GetBleGeofenceListResponse>} - 设置结果的 Promise
+ */
+const getBleGeofenceList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.geofence.rule.shell.get"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 注册地理围栏
+
+/**
+ * RegisterBleCloudGeofenceParams - 注册地理围栏
+ */
+
+/**
+ * RegisterBleCloudGeofenceResponse - 注册地理围栏
+ */
+
+/**
+ * 注册地理围栏
+ * @param {RegisterBleCloudGeofenceParams} params - 注册地理围栏参数
+ * @returns {Promise<RegisterBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+const registerBleCloudGeofence = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.geofence.register"),
+    version: '1.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 修改地理围栏
+
+/**
+ * EditBleCloudGeofenceParams - 修改地理围栏
+ */
+
+/**
+ * GetHighPowerListResponse - 修改地理围栏
+ */
+
+/**
+ * 修改地理围栏
+ * @param {EditBleCloudGeofenceParams} params - 修改地理围栏参数
+ * @returns {Promise<EditBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+const editBleCloudGeofence = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.geofence.modify"),
+    version: '1.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 开启/关闭 地理围栏
+
+/**
+ * HandleBleCloudGeofenceParams - 开启/关闭 地理围栏
+ */
+
+/**
+ * HandleBleCloudGeofenceResponse - 开启/关闭 地理围栏
+ */
+
+/**
+ * 开启/关闭 地理围栏
+ * @param {HandleBleCloudGeofenceParams} params - 开启/关闭 地理围栏参数
+ * @returns {Promise<HandleBleCloudGeofenceResponse>} - 查询结果的 Promise
+ */
+const handleBleCloudGeofence = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.geofence.status.switch"),
+    version: '1.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 获取蓝牙开门密钥
+
+/**
+ * GetRemoteOpenKeyParams - 获取蓝牙开门密钥
+ */
+
+/**
+ * GetHighPowerListResponse - 获取蓝牙开门密钥
+ */
+
+/**
+ * 获取蓝牙开门密钥
+ * @param {GetRemoteOpenKeyParams} params - 获取蓝牙开门密钥参数
+ * @returns {Promise<GetRemoteOpenKeyResponse>} - 查询结果的 Promise
+ */
+const getRemoteOpenKey = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.open.pwd.get"),
+    version: '1.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 获取国家名称
+
+/**
+ * GetCountryListParams - 获取国家名称
+ */
+
+/**
+ * GetCountryListResponse - 获取国家名称
+ */
+
+/**
+ * 获取国家名称
+ * @param {GetCountryListParams} params - 获取国家名称参数
+ * @returns {Promise<GetCountryListResponse>} - 查询结果的 Promise
+ */
+const getCountryList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.country.list"),
+    version: '4.0',
+    data: _objectSpread({}, params)
+  });
+};
+
+//#endregion
+
+//#region 获取当前帐号所属地区
+
+/**
+ * GetUserRegionResult - 获取当前帐号所属地区结果
+ */
+
+/**
+ * 获取当前帐号所属地区
+ * @param {GetUserRegionParams} params - 获取当前帐号所属地区的参数
+ * @returns {Promise<GetUserRegionResult>} - 带有获取当前帐号所属地区结果的 Promise。
+ */
+const getUserRegion = () => {
+  return requestCloud({
+    api: "".concat(THING, ".m.user.region.get"),
+    version: '1.0',
+    data: {}
+  });
+};
+//#endregion
+
+export { getAudioSwitch, setAudioSwitch, getVoiceFileList, getDownloadUrl, getBleGeofenceList, registerBleCloudGeofence, editBleCloudGeofence, handleBleCloudGeofence, getRemoteOpenKey, getCountryList, getUserRegion };

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

@@ -1,3 +1,12 @@
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+type Schedule_Ver2 = {
+    invalidTime?: number;
+    workingDay?: number;
+    allDay: boolean;
+    effectiveTime?: number;
+};
 type GetDynapwdParams = {
     devId: string;
     adminPwd: string;
@@ -10,7 +19,7 @@ type GetDynapwdResponse = {
  * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
  * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
  */
-export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<GetDynapwdResponse>;
+declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<GetDynapwdResponse>;
 type ValidateTempPasswordParams = {
     unlockBindingId?: number;
     devId: string;
@@ -37,43 +46,7 @@ type ValidateTempPasswordResult = {
  * @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>;
+declare const validateTemporaryPassword: (params: ValidateTempPasswordParams) => Promise<ValidateTempPasswordResult>;
 /**
  * CreateTempPasswordParams - 创建临时密码参数
  */
@@ -99,7 +72,7 @@ type CreateTempPasswordResult = {
  * @param {CreateTempPasswordParams} params - 创建临时密码参数
  * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
  */
-export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
+declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
 /**
  * UpdateTempPasswordParams - 更新临时密码参数
  */
@@ -123,7 +96,7 @@ type UpdateTempPasswordResult = boolean;
  * @param {UpdateTempPasswordParams} params - 更新临时密码参数
  * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
  */
-export declare const updateTempPassword: (params: UpdateTempPasswordParams) => Promise<UpdateTempPasswordResult>;
+declare const updateTempPassword: (params: UpdateTempPasswordParams) => Promise<UpdateTempPasswordResult>;
 /**
  * UpdateTempPasswordNameParams - 更新临时密码名称参数
  */
@@ -141,7 +114,7 @@ type UpdateTempPasswordNameResult = boolean;
  * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
  * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
  */
-export declare const updateTempPasswordName: (params: UpdateTempPasswordNameParams) => Promise<UpdateTempPasswordNameResult>;
+declare const updateTempPasswordName: (params: UpdateTempPasswordNameParams) => Promise<UpdateTempPasswordNameResult>;
 /**
  * DeleteTempPasswordParams - 删除临时密码参数
  */
@@ -160,7 +133,7 @@ type DeleteTempPasswordResult = boolean;
  * @param {DeleteTempPasswordParams} params - 删除临时密码参数
  * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
  */
-export declare const deleteTemporaryPassword: (params: DeleteTempPasswordParams) => Promise<DeleteTempPasswordResult>;
+declare const deleteTemporaryPassword: (params: DeleteTempPasswordParams) => Promise<DeleteTempPasswordResult>;
 /**
  * ShareAvailabilityParams - 检查分享可用性参数
  */
@@ -190,5 +163,5 @@ type ShareAvailabilityResult = {
  * @param {ShareAvailabilityParams} params - 检查分享可用性参数
  * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
  */
-export declare const checkShareAvailability: (params: ShareAvailabilityParams) => Promise<ShareAvailabilityResult>;
-export {};
+declare const checkShareAvailability: (params: ShareAvailabilityParams) => Promise<ShareAvailabilityResult>;
+export { getDynamicPassword, validateTemporaryPassword, createTemporaryPassword, updateTempPassword, updateTempPasswordName, deleteTemporaryPassword, checkShareAvailability, };