@ray-js/api 1.5.0-beta.11 → 1.5.0

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

package/lib/cloud/doorlock/auth.md

@@ -0,0 +1,323 @@
+## getLockAuthList
+
+获取授权记录列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getLockAuthList } from '@ray-js/ray'
+```
+
+### 参数
+
+**AuthListParams**
+
+| 属性      | 类型            | 必填 | 说明         |
+| --------- | --------------- | ---- | ------------ |
+| devId     | `string`        | 是   | 设备 ID      |
+| authTypes | `Array<string>` | 是   | 授权类型数组 |
+
+### 返回
+
+**AuthListResult**
+
+| 属性       | 类型                         | 说明                     |
+| ---------- | ---------------------------- | ------------------------ |
+| hasNext    | `boolean`                    | 是否还有下一页           |
+| totalCount | `number`                     | 总记录数                 |
+| datas      | `Array<AuthListResultEntry>` | 授权记录列表结果条目数组 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取授权记录列表
+ */
+export function getLockAuthList(params: AuthListParams): Promise<AuthListResult>
+```
+
+## getInvalidAuthList
+
+获取已失效的授权记录列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getInvalidAuthList } from '@ray-js/ray'
+```
+
+### 参数
+
+**InvalidAuthListParams**
+
+| 属性   | 类型     | 必填 | 说明       |
+| ------ | -------- | ---- | ---------- |
+| devId  | `string` | 是   | 设备 ID    |
+| offSet | `number` | 是   | 起始记录数 |
+| limit  | `number` | 是   | 每页个数   |
+
+### 返回
+
+**InvalidAuthListResult**
+
+`Array<InvalidAuthListResultEntry>`，包含已失效的授权记录列表结果条目。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取已失效的授权记录列表
+ */
+export function getInvalidAuthList(params: InvalidAuthListParams): Promise<InvalidAuthListResult>
+```
+
+## clearInvalidAuthList
+
+清空已失效的授权记录列表。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { clearInvalidAuthList } from '@ray-js/ray'
+```
+
+### 参数
+
+**ClearInvalidAuthListParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**ClearInvalidAuthListResult**
+
+`boolean`，表示是否成功清空列表。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 清空已失效的授权记录列表
+ */
+export function clearInvalidAuthList(
+  params: ClearInvalidAuthListParams
+): Promise<ClearInvalidAuthListResult>
+```
+
+## addBluetoothAuth
+
+添加蓝牙授权记录。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { addBluetoothAuth } from '@ray-js/ray'
+```
+
+### 参数
+
+**AddBluetoothAuthParams**
+
+| 属性          | 类型       | 必填 | 说明             |
+| ------------- | ---------- | ---- | ---------------- |
+| devId         | `string`   | 是   | 设备 ID          |
+| timeSetType   | `number`   | 是   | 时效类型         |
+| effectiveTime | `number`   | 是   | 生效时间         |
+| invalidTime   | `number`   | 是   | 失效时间         |
+| availTime     | `number`   | 否   | 可用次数         |
+| name          | `string`   | 是   | 名称             |
+| schedule      | `Schedule` | 否   | 周期设置         |
+| countryCode   | `string`   | 是   | 国家码           |
+| account       | `string`   | 是   | 账号             |
+| offlineUnlock | `boolean`  | 是   | 是否支持离线解锁 |
+
+### 返回
+
+**AddBluetoothAuthResult**
+
+| 属性            | 类型      | 说明                   |
+| --------------- | --------- | ---------------------- |
+| unlockBindingId | `string`  | 临时蓝牙开锁对应的序号 |
+| name            | `string`  | 名称                   |
+| userExist       | `boolean` | 用户是否已注册涂鸦智能 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 添加蓝牙授权记录
+ */
+export function addBluetoothAuth(params: AddBluetoothAuthParams): Promise<AddBluetoothAuthResult>
+```
+
+## updateBluetoothKey
+
+修改蓝牙钥匙信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { updateBluetoothKey } from '@ray-js/ray'
+```
+
+### 参数
+
+**UpdateBluetoothKeyParams**
+
+| 属性            | 类型             | 必填 | 说明                   |
+| --------------- | ---------------- | ---- | ---------------------- |
+| devId           | `string`         | 是   | 设备 ID                |
+| unlockBindingId | `string`         | 是   | 临时蓝牙开锁对应的序号 |
+| offlineUnlock   | `boolean`        | 是   | 是否支持离线解锁       |
+| timeSetType     | `number`         | 是   | 时效类型               |
+| effectiveTime   | `number`         | 是   | 生效时间               |
+| invalidTime     | `number`         | 是   | 失效时间               |
+| availTime       | `number`         | 否   | 可用次数               |
+| name            | `string`         | 否   | 名称                   |
+| phase           | `number`         | 否   | 状态                   |
+| schedule        | `UpdateSchedule` | 否   | 周期设置               |
+
+### 返回
+
+**UpdateBluetoothKeyResult**
+
+`boolean`，表示修改是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 修改蓝牙钥匙信息
+ */
+export function updateBluetoothKey(
+  params: UpdateBluetoothKeyParams
+): Promise<UpdateBluetoothKeyResult>
+```
+
+## freezeUnfreezeBluetoothKey
+
+冻结或解冻蓝牙钥匙。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { freezeUnfreezeBluetoothKey } from '@ray-js/ray'
+```
+
+### 参数
+
+**FreezeUnfreezeBluetoothKeyParams**
+
+| 属性            | 类型     | 必填 | 说明                   |
+| --------------- | -------- | ---- | ---------------------- |
+| devId           | `string` | 是   | 设备 ID                |
+| unlockBindingId | `string` | 是   | 临时蓝牙开锁对应的序号 |
+| phase           | `number` | 否   | 状态：2. 正常 4. 冻结  |
+
+### 返回
+
+**FreezeUnfreezeBluetoothKeyResult**
+
+`boolean`，表示冻结或解冻是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 冻结或解冻蓝牙钥匙
+ */
+export function freezeUnfreezeBluetoothKey(
+  params: FreezeUnfreezeBluetoothKeyParams
+): Promise<FreezeUnfreezeBluetoothKeyResult>
+```
+
+## changeBluetoothKeyName
+
+修改蓝牙钥匙名称。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { changeBluetoothKeyName } from '@ray-js/ray'
+```
+
+### 参数
+
+**ChangeBluetoothKeyNameParams**
+
+| 属性            | 类型     | 必填 | 说明                   |
+| --------------- | -------- | ---- | ---------------------- |
+| devId           | `string` | 是   | 设备 ID                |
+| unlockBindingId | `string` | 是   | 临时蓝牙开锁对应的序号 |
+| name            | `string` | 是   | 新名称                 |
+
+### 返回
+
+**ChangeBluetoothKeyNameResult**
+
+`boolean`，表示修改名称是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 修改蓝牙钥匙名称
+ */
+export function changeBluetoothKeyName(
+  params: ChangeBluetoothKeyNameParams
+): Promise<ChangeBluetoothKeyNameResult>
+```
+
+## removeBluetoothKeyAuthorization
+
+删除蓝牙钥匙授权。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { removeBluetoothKeyAuthorization } from '@ray-js/ray'
+```
+
+### 参数
+
+**RemoveBluetoothKeyParams**
+
+| 属性            | 类型     | 必填 | 说明                   |
+| --------------- | -------- | ---- | ---------------------- |
+| devId           | `string` | 是   | 设备 ID                |
+| unlockBindingId | `string` | 是   | 临时蓝牙开锁对应的序号 |
+
+### 返回
+
+**RemoveBluetoothKeyResult**
+
+`boolean`，表示删除授权是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 删除蓝牙钥匙授权
+ */
+export function removeBluetoothKeyAuthorization(
+  params: RemoveBluetoothKeyParams
+): Promise<RemoveBluetoothKeyResult>
+```

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

@@ -0,0 +1,137 @@
+/**
+ * SetDevicePropertiesParams - 设置设备属性参数
+ */
+type SetDevicePropertiesParams = {
+    devId: string;
+    propKvs: string;
+};
+/**
+ * SetDevicePropertiesResponse - 设置设备属性响应
+ */
+type SetDevicePropertiesResponse = boolean;
+/**
+ * 设置设备属性
+ * @param {SetDevicePropertiesParams} params - 设置设备属性参数
+ * @returns {Promise<SetDevicePropertiesResponse>} - 设置结果的 Promise
+ */
+export declare const setDeviceProperties: (params: SetDevicePropertiesParams) => Promise<SetDevicePropertiesResponse>;
+/**
+ * GetDevicePropertiesParams - 查看设置的设备属性参数
+ */
+type GetDevicePropertiesParams = {
+    devId: string;
+    props: string;
+};
+/**
+ * GetDevicePropertiesResponse - 查看设置的设备属性响应
+ */
+type GetDevicePropertiesResponse = Record<string, string>;
+/**
+ * 查看设置的设备属性
+ * @param {GetDevicePropertiesParams} params - 查看设备属性参数
+ * @returns {Promise<GetDevicePropertiesResponse>} - 查看结果的 Promise
+ */
+export declare const getDeviceProperties: (params: GetDevicePropertiesParams) => Promise<GetDevicePropertiesResponse>;
+/**
+ * MemberListParams - 获取家庭成员基础信息列表参数
+ */
+type MemberListParams = {
+    devId: string;
+};
+/**
+ * MemberListResponseItem - 家庭成员基础信息列表项
+ */
+type MemberListResponseItem = {
+    avatarUrl: string;
+    lockUserId: number;
+    nickName: string;
+    userType: number;
+    userContact: string;
+    userId: string;
+};
+/**
+ * MemberListResponse - 获取家庭成员基础信息列表响应
+ */
+type MemberListResponse = MemberListResponseItem[];
+/**
+ * 获取家庭成员基础信息列表
+ * @param {MemberListParams} params - 获取成员列表参数
+ * @returns {Promise<MemberListResponse>} - 成员列表的 Promise
+ */
+export declare const getMemberList: (params: MemberListParams) => Promise<MemberListResponse>;
+/**
+ * UnlockSyncParams - 解锁方式同步参数
+ */
+type UnlockSyncParams = {
+    devId: string;
+    dpIds: Array<string>;
+};
+/**
+ * UnlockSyncResponse - 解锁方式同步响应
+ */
+type UnlockSyncResponse = {
+    ins: string;
+    distributed: number;
+    dpId: number;
+};
+/**
+ * 解锁方式同步
+ * @param {UnlockSyncParams} params - 解锁方式同步参数
+ * @returns {Promise<UnlockSyncResponse>} - 同步结果的 Promise
+ */
+export declare const syncUnlockMode: (params: UnlockSyncParams) => Promise<UnlockSyncResponse>;
+/**
+ * QueryDateFormatParams - 查询时间对应的格式参数
+ */
+type QueryDateFormatParams = {
+    devId: string;
+    uiId: string;
+};
+/**
+ * QueryDateFormatResponse - 查询时间对应的格式响应
+ */
+type QueryDateFormatResponse = string;
+/**
+ * 查询时间对应的格式
+ * @param {QueryDateFormatParams} params - 查询时间对应的格式参数
+ * @returns {Promise<QueryDateFormatResponse>} - 查询结果的 Promise
+ */
+export declare const queryDateFormat: (params: QueryDateFormatParams) => Promise<QueryDateFormatResponse>;
+/**
+ * QueryActiveDateParams - 用户获取设备自身的激活时间参数
+ */
+type QueryActiveDateParams = {
+    devId: string;
+};
+/**
+ * QueryActiveDateResponse - 用户获取设备自身的激活时间响应
+ */
+type QueryActiveDateResponse = string;
+/**
+ * 用户获取设备自身的激活时间(配网时间)
+ * @param {QueryActiveDateParams} params - 查询激活时间参数
+ * @returns {Promise<QueryActiveDateResponse>} - 查询结果的 Promise
+ */
+export declare const queryDeviceActiveDate: (params: QueryActiveDateParams) => Promise<QueryActiveDateResponse>;
+/**
+ * QueryTrackDetailsParams - 获取设备位置参数
+ */
+type QueryTrackDetailsParams = {
+    devId: string;
+    startTime: number;
+    stopTime: number;
+};
+/**
+ * QueryTrackDetailsResponse - 获取设备位置响应
+ */
+type QueryTrackDetailsResponse = {
+    lat: number;
+    lng: number;
+};
+/**
+ * 获取设备位置
+ * @param {QueryTrackDetailsParams} params - 获取设备位置参数
+ * @returns {Promise<QueryTrackDetailsResponse>} - 查询结果的 Promise
+ */
+export declare const queryDeviceTrackDetails: (params: QueryTrackDetailsParams) => Promise<QueryTrackDetailsResponse>;
+export {};