@ray-js/api 1.6.0-beta.9 → 1.6.0

package/lib/cloud/doorlock/log.md

@@ -1,153 +0,0 @@
-## getLatestLog
-
-查询最近一条日志记录。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getLatestLog } from '@ray-js/ray'
-```
-
-### 参数
-
-**LatestLogParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 ID |
-
-### 返回
-
-**LatestLogResponse**
-
-结构包含日志记录的各种详细信息。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询最近一条日志记录
- */
-export function getLatestLog(params: LatestLogParams): Promise<LatestLogResponse>
-```
-
-## queryLogRecord
-
-查询日志记录。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryLogRecord } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryLogRecordParams**
-
-| 属性                | 类型       | 必填 | 说明                         |
-| ------------------- | ---------- | ---- | ---------------------------- |
-| devId               | `string`   | 是   | 设备 ID                      |
-| logCategories       | `string[]` | 否   | 日志大类                     |
-| userIds             | `string[]` | 否   | 用户 ID 列表                 |
-| onlyShowMediaRecord | `boolean`  | 是   | 是否仅显示带图片或视频的记录 |
-| startTime           | `number`   | 否   | 开始时间                     |
-| endTime             | `number`   | 否   | 结束时间                     |
-| lastRowKey          | `string`   | 否   | 上一页的数据 key             |
-| limit               | `number`   | 是   | 每页数据个数                 |
-
-### 返回
-
-**QueryLogRecordResponse**
-
-`Array<LogRecord>`，包含日志记录的数组。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询日志记录
- */
-export function queryLogRecord(params: QueryLogRecordParams): Promise<QueryLogRecordResponse>
-```
-
-## uploadLogRecord
-
-上报操作日志记录。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { uploadLogRecord } from '@ray-js/ray'
-```
-
-### 参数
-
-**UploadLogRecordParams**
-
-| 属性    | 类型       | 必填 | 说明     |
-| ------- | ---------- | ---- | -------- |
-| devId   | `string`   | 是   | 设备 ID  |
-| logType | `string`   | 是   | 日志类型 |
-| data    | `string[]` | 是   | 业务参数 |
-
-### 返回
-
-**UploadLogRecordResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 上报操作日志记录
- */
-export function uploadLogRecord(params: UploadLogRecordParams): Promise<UploadLogRecordResult>
-```
-
-## queryAlbumRecord
-
-分页获取可以查看的相册列表。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryAlbumRecord } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryAlbumRecordParams**
-
-| 属性   | 类型     | 必填 | 说明         |
-| ------ | -------- | ---- | ------------ |
-| devId  | `string` | 是   | 设备 ID      |
-| offset | `number` | 是   | 起始页       |
-| limit  | `number` | 是   | 每页数据个数 |
-
-### 返回
-
-**QueryAlbumRecordResponse**
-
-| 属性       | 类型     | 说明         |
-| ---------- | -------- | ------------ |
-| eventTypes | `string` | 事件类型     |
-| albumList  | `any[]`  | 相册信息数组 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 分页获取可以查看的相册列表
- */
-export function queryAlbumRecord(params: QueryAlbumRecordParams): Promise<QueryAlbumRecordResponse>
-```

package/lib/cloud/doorlock/member-opmode.md

@@ -1,279 +0,0 @@
-## validatePasswordForMember
-
-校验成员密码是否存在（包括临时密码）。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { validatePasswordForMember } from '@ray-js/ray'
-```
-
-### 参数
-
-**ValidatePwdMemberParams**
-
-| 属性     | 类型     | 必填 | 说明        |
-| -------- | -------- | ---- | ----------- |
-| devId    | `string` | 是   | 设备 ID     |
-| opModeId | `number` | 否   | 操作模式 ID |
-| password | `string` | 是   | 密码        |
-
-### 返回
-
-**ValidatePwdMemberResult**
-
-| 属性      | 类型      | 说明             |
-| --------- | --------- | ---------------- |
-| valid     | `boolean` | 是否有效         |
-| errorCode | `string`  | 错误代码（可选） |
-| errorMsg  | `string`  | 错误信息（可选） |
-
-### 函数定义示例
-
-```typescript
-/**
- * 校验成员密码是否存在（包括临时密码）
- */
-export function validatePasswordForMember(
-  params: ValidatePwdMemberParams
-): Promise<ValidatePwdMemberResult>
-```
-
-## addMemberUnlockMethod
-
-添加解锁方式。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { addMemberUnlockMethod } from '@ray-js/ray'
-```
-
-### 参数
-
-**AddMemberUnlockMethodParams**
-
-| 属性         | 类型         | 必填 | 说明         |
-| ------------ | ------------ | ---- | ------------ |
-| devId        | `string`     | 是   | 设备 ID      |
-| userId       | `string`     | 是   | 用户 ID      |
-| unlockId     | `number`     | 是   | 解锁 ID      |
-| unlockName   | `string`     | 否   | 解锁名称     |
-| unlockAttr   | `number`     | 是   | 解锁属性     |
-| notifyInfo   | `NotifyInfo` | 否   | 通知信息     |
-| unlockDetail | `string`     | 否   | 解锁详细信息 |
-
-### 返回
-
-**AddMemberUnlockMethodResult**
-
-| 属性       | 类型     | 说明        |
-| ---------- | -------- | ----------- |
-| opModeId   | `string` | 操作模式 ID |
-| unlockName | `string` | 解锁名称    |
-
-### 函数定义示例
-
-```typescript
-/**
- * 添加解锁方式
- */
-export function addMemberUnlockMethod(
-  params: AddMemberUnlockMethodParams
-): Promise<AddMemberUnlockMethodResult>
-```
-
-## removeMemberUnlockMethod
-
-删除解锁方式。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { removeMemberUnlockMethod } from '@ray-js/ray'
-```
-
-### 参数
-
-**RemoveMemberUnlockMethodParams**
-
-| 属性     | 类型     | 必填 | 说明        |
-| -------- | -------- | ---- | ----------- |
-| devId    | `string` | 是   | 设备 ID     |
-| opmodeId | `number` | 是   | 操作模式 ID |
-
-### 返回
-
-**RemoveMemberUnlockMethodResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 删除解锁方式
- */
-export function removeMemberUnlockMethod(
-  params: RemoveMemberUnlockMethodParams
-): Promise<RemoveMemberUnlockMethodResult>
-```
-
-## sendSpecialUnlockVerifyCode
-
-发送设置特殊解锁方式的验证码。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { sendSpecialUnlockVerifyCode } from '@ray-js/ray'
-```
-
-### 参数
-
-**SendSpecialUnlockVerifyCodeParams**
-
-| 属性    | 类型     | 必填 | 说明     |
-| ------- | -------- | ---- | -------- |
-| account | `string` | 是   | 用户账号 |
-
-### 返回
-
-**SendSpecialUnlockVerifyCodeResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 发送设置特殊解锁方式的验证码
- */
-export function sendSpecialUnlockVerifyCode(
-  params: SendSpecialUnlockVerifyCodeParams
-): Promise<SendSpecialUnlockVerifyCodeResult>
-```
-
-## updateMemberUnlockMode
-
-更新成员的解锁方式。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { updateMemberUnlockMode } from '@ray-js/ray'
-```
-
-### 参数
-
-**UpdateMemberUnlockModeParams**
-
-| 属性         | 类型         | 必填 | 说明         |
-| ------------ | ------------ | ---- | ------------ |
-| devId        | `string`     | 是   | 设备 ID      |
-| opModeId     | `number`     | 是   | 操作模式 ID  |
-| unlockName   | `string`     | 否   | 解锁名称     |
-| unlockAttr   | `number`     | 是   | 解锁属性     |
-| unlockDetail | `string`     | 是   | 解锁详细信息 |
-| notifyInfo   | `NotifyInfo` | 否   | 通知信息     |
-
-### 返回
-
-**UpdateMemberUnlockModeResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 更新成员的解锁方式
- */
-export function updateMemberUnlockMode(
-  params: UpdateMemberUnlockModeParams
-): Promise<UpdateMemberUnlockModeResult>
-```
-
-## getUnlockMethodDetail
-
-查询某个解锁方式的详情。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getUnlockMethodDetail } from '@ray-js/ray'
-```
-
-### 参数
-
-**UnlockMethodDetailParams**
-
-| 属性     | 类型     | 必填 | 说明        |
-| -------- | -------- | ---- | ----------- |
-| devId    | `string` | 是   | 设备 ID     |
-| opModeId | `number` | 是   | 操作模式 ID |
-
-### 返回
-
-**UnlockMethodDetailResult**
-
-结构包含解锁方式的详细信息。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询某个解锁方式的详情
- */
-export function getUnlockMethodDetail(
-  params: UnlockMethodDetailParams
-): Promise<UnlockMethodDetailResult>
-```
-
-## getCreatePasswordSN
-
-获取创建密码时的序号。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getCreatePasswordSN } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetPasswordSNParams**
-
-| 属性  | 类型     | 必填 | 说明      |
-| ----- | -------- | ---- | --------- |
-| devId | `string` | 是   | 设备 ID   |
-| dpId  | `number` | 是   | 数据点 ID |
-
-### 返回
-
-**GetPasswordSNResult**
-
-`number`，表示创建密码时的序号。
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取创建密码时的序号
- */
-export function getCreatePasswordSN(params: GetPasswordSNParams): Promise<GetPasswordSNResult>
-```

package/lib/cloud/doorlock/member.md

@@ -1,276 +0,0 @@
-## getCurrentMemberInfo
-
-获取当前登录用户信息。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getCurrentMemberInfo } from '@ray-js/ray'
-```
-
-### 参数
-
-**CurrentMemberInfoParams**
-
-| 属性  | 类型     | 必填 | 说明      |
-| ----- | -------- | ---- | --------- |
-| devId | `string` | 是   | 设备 ID   |
-| dpIds | `string` | 是   | 数据点 ID |
-
-### 返回
-
-**CurrentMemberInfoResult**
-
-| 属性             | 类型            | 说明               |
-| ---------------- | --------------- | ------------------ |
-| userId           | `number`        | 用户 ID            |
-| lockUserId       | `number`        | 锁用户 ID          |
-| userType         | `number`        | 用户类型           |
-| allOpenDps       | `string`        | 所有开放的数据点   |
-| allOpenType      | `Array<number>` | 所有开放类型的数组 |
-| productAttribute | `number`        | 产品属性           |
-| phase            | `number`        | 阶段               |
-| expireTime       | `number`        | 过期时间           |
-| expireDate       | `number`        | 过期日期           |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取当前登录用户信息
- */
-export function getCurrentMemberInfo(
-  params: CurrentMemberInfoParams
-): Promise<CurrentMemberInfoResult>
-```
-
-## getFamilyMemberListWithUnlockCount
-
-获取家庭成员列表（带解锁方式个数）。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getFamilyMemberListWithUnlockCount } from '@ray-js/ray'
-```
-
-### 参数
-
-**FamilyMemberListWithUnlockCountParams**
-
-| 属性  | 类型            | 必填 | 说明           |
-| ----- | --------------- | ---- | -------------- |
-| devId | `string`        | 是   | 设备 ID        |
-| dpIds | `Array<number>` | 是   | 数据点 ID 数组 |
-
-### 返回
-
-**FamilyMemberListWithUnlockCountResult**
-
-`Array<FamilyMemberWithUnlockDetail>`，家庭成员列表数组。
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取家庭成员列表（带解锁方式个数）
- */
-export function getFamilyMemberListWithUnlockCount(
-  params: FamilyMemberListWithUnlockCountParams
-): Promise<FamilyMemberListWithUnlockCountResult>
-```
-
-## removeFamilyMember
-
-家庭成员移除成功通知。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { removeFamilyMember } from '@ray-js/ray'
-```
-
-### 参数
-
-**FamilyMemberRemovalParams**
-
-| 属性   | 类型     | 必填 | 说明    |
-| ------ | -------- | ---- | ------- |
-| devId  | `string` | 是   | 设备 ID |
-| userId | `string` | 是   | 用户 ID |
-
-### 返回
-
-**FamilyMemberRemovalResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 家庭成员移除成功通知
- */
-export function removeFamilyMember(
-  params: FamilyMemberRemovalParams
-): Promise<FamilyMemberRemovalResult>
-```
-
-## queryUserDeletion
-
-查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryUserDeletion } from '@ray-js/ray'
-```
-
-### 参数
-
-**UserDeletionQueryParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 ID |
-
-### 返回
-
-**UserDeletionQueryResult**
-
-`Array<{ userId: number, lockUserId: number }>`，数组包含已删除用户的 ID 和锁用户 ID。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
- */
-export function queryUserDeletion(params: UserDeletionQueryParams): Promise<UserDeletionQueryResult>
-```
-
-## syncLockBatch
-
-门锁批量同步。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { syncLockBatch } from '@ray-js/ray'
-```
-
-### 参数
-
-**LockSyncBatchParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 ID |
-
-### 返回
-
-**LockSyncBatchResult**
-
-| 属性        | 类型     | 说明           |
-| ----------- | -------- | -------------- |
-| lockRandom  | `object` | 随机锁信息     |
-| lockFitting | `object` | 锁具信息       |
-| lockRecord  | `string` | 锁记录         |
-| removedUser | `Array`  | 已移除用户信息 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 门锁批量同步
- */
-export function syncLockBatch(params: LockSyncBatchParams): Promise<LockSyncBatchResult>
-```
-
-## updateUserTimeSchedule
-
-更新用户时效。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { updateUserTimeSchedule } from '@ray-js/ray'
-```
-
-### 参数
-
-**UpdateUserTimeScheduleParams**
-
-| 属性             | 类型               | 必填 | 说明     |
-| ---------------- | ------------------ | ---- | -------- |
-| devId            | `string`           | 是   | 设备 ID  |
-| userId           | `string`           | 是   | 用户 ID  |
-| timeScheduleInfo | `TimeScheduleInfo` | 是   | 时效信息 |
-
-### 返回
-
-**UpdateUserTimeScheduleResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 更新用户时效
- */
-export function updateUserTimeSchedule(
-  params: UpdateUserTimeScheduleParams
-): Promise<UpdateUserTimeScheduleResult>
-```
-
-## openCloseOfflineUnlock
-
-打开/关闭离线解锁开关。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { openCloseOfflineUnlock } from '@ray-js/ray'
-```
-
-### 参数
-
-**OpenCloseOfflineUnlockParams**
-
-| 属性   | 类型      | 必填 | 说明     |
-| ------ | --------- | ---- | -------- |
-| devId  | `string`  | 是   | 设备 ID  |
-| userId | `string`  | 是   | 用户 ID  |
-| enable | `boolean` | 是   | 是否启用 |
-
-### 返回
-
-**OpenCloseOfflineUnlockResult**
-
-`boolean`，表示操作是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 打开/关闭离线解锁开关
- */
-export function openCloseOfflineUnlock(
-  params: OpenCloseOfflineUnlockParams
-): Promise<OpenCloseOfflineUnlockResult>
-```