@ray-js/api 1.5.35 → 1.5.37-alpha.0

package/lib/cloud/doorlock/device.md

@@ -1,265 +0,0 @@
-## setDeviceProperties
-
-设置设备属性。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { setDeviceProperties } from '@ray-js/ray'
-```
-
-### 参数
-
-**SetDevicePropertiesParams**
-
-| 属性    | 类型     | 必填 | 说明                                               |
-| ------- | -------- | ---- | -------------------------------------------------- |
-| devId   | `string` | 是   | 设备 ID                                            |
-| propKvs | `string` | 是   | JSON 字符串，例如：`{"LOST_ALERTER_HELPER": true}` |
-
-### 返回
-
-**SetDevicePropertiesResponse**
-
-`boolean`，表示设置是否成功。
-
-### 函数定义示例
-
-```typescript
-/**
- * 设置设备属性
- */
-export function setDeviceProperties(
-  params: SetDevicePropertiesParams
-): Promise<SetDevicePropertiesResponse>
-```
-
-## getDeviceProperties
-
-查看设置的设备属性。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getDeviceProperties } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetDevicePropertiesParams**
-
-| 属性  | 类型     | 必填 | 说明                                                          |
-| ----- | -------- | ---- | ------------------------------------------------------------- |
-| devId | `string` | 是   | 设备 ID                                                       |
-| props | `string` | 是   | 属性代码字符串，多个代码用逗号隔开，如："LOST_ALERTER_HELPER" |
-
-### 返回
-
-**GetDevicePropertiesResponse**
-
-`Record<string, string>`，返回参数键值对，key 为属性代码，值为对应状态字符串。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查看设置的设备属性
- */
-export function getDeviceProperties(
-  params: GetDevicePropertiesParams
-): Promise<GetDevicePropertiesResponse>
-```
-
-## getMemberList
-
-获取家庭成员基础信息列表。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getMemberList } from '@ray-js/ray'
-```
-
-### 参数
-
-**MemberListParams**
-
-| 属性  | 类型     | 必填 | 说明     |
-| ----- | -------- | ---- | -------- |
-| devId | `string` | 是   | 门锁编号 |
-
-### 返回
-
-**MemberListResponse**
-
-`Array<MemberListResponseItem>`，包含家庭成员基础信息列表项。
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取家庭成员基础信息列表
- */
-export function getMemberList(params: MemberListParams): Promise<MemberListResponse>
-```
-
-## syncUnlockMode
-
-解锁方式同步。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { syncUnlockMode } from '@ray-js/ray'
-```
-
-### 参数
-
-**UnlockSyncParams**
-
-| 属性  | 类型            | 必填 | 说明                  |
-| ----- | --------------- | ---- | --------------------- |
-| devId | `string`        | 是   | 门锁编号              |
-| dpIds | `Array<string>` | 是   | 需要同步的解锁方式 dp |
-
-### 返回
-
-**UnlockSyncResponse**
-
-| 属性        | 类型     | 说明                   |
-| ----------- | -------- | ---------------------- |
-| ins         | `string` | 同步指令（仅协议部分） |
-| distributed | `number` | 是否需要下发           |
-| dpId        | `number` | dp 点                  |
-
-### 函数定义示例
-
-```typescript
-/**
- * 解锁方式同步
- */
-export function syncUnlockMode(params: UnlockSyncParams): Promise<UnlockSyncResponse>
-```
-
-## queryDateFormat
-
-查询时间对应的格式。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryDateFormat } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryDateFormatParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 ID |
-| uiId  | `string` | 是   | 面板 ID |
-
-### 返回
-
-**QueryDateFormatResponse**
-
-`string`，日期格式化格式。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询时间对应的格式
- */
-export function queryDateFormat(params: QueryDateFormatParams): Promise<QueryDateFormatResponse>
-```
-
-## queryDeviceActiveDate
-
-用户获取设备自身的激活时间（配网时间）。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryDeviceActiveDate } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryActiveDateParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 ID |
-
-### 返回
-
-**QueryActiveDateResponse**
-
-`string`，64 dp password_offline_time 最新数据。
-
-### 函数定义示例
-
-```typescript
-/**
- * 用户获取设备自身的激活时间（配网时间）
- */
-export function queryDeviceActiveDate(
-  params: QueryActiveDateParams
-): Promise<QueryActiveDateResponse>
-```
-
-## queryDeviceTrackDetails
-
-获取设备位置。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryDeviceTrackDetails } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryTrackDetailsParams**
-
-| 属性      | 类型     | 必填 | 说明     |
-| --------- | -------- | ---- | -------- |
-| devId     | `string` | 是   | 设备 ID  |
-| startTime | `number` | 是   | 开始时间 |
-| stopTime  | `number` | 是   | 结束时间 |
-
-### 返回
-
-**QueryTrackDetailsResponse**
-
-| 属性 | 类型     | 说明 |
-| ---- | -------- | ---- |
-| lat  | `number` | 纬度 |
-| lng  | `number` | 经度 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取设备位置
- */
-export function queryDeviceTrackDetails(
-  params: QueryTrackDetailsParams
-): Promise<QueryTrackDetailsResponse>
-```

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>
-```