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

package/lib/cloud/doorlock/temp-pwd.md

@@ -1,362 +0,0 @@
-## getDynamicPassword
-
-获取动态密码。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getDynamicPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetDynapwdParams**
-
-| 属性     | 类型     | 必填 | 说明       |
-| -------- | -------- | ---- | ---------- |
-| devId    | `string` | 是   | 设备 ID    |
-| adminPwd | `string` | 是   | 管理员密码 |
-
-### 返回
-
-**GetDynapwdResponse**
-
-| 属性            | 类型     | 说明         |
-| --------------- | -------- | ------------ |
-| dynamicPassword | `string` | 动态密码数据 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取动态密码
- */
-export function getDynamicPassword(params: GetDynapwdParams): Promise<GetDynapwdResponse>
-```
-
-## validateTemporaryPassword
-
-临时密码参数有效性校验。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { validateTemporaryPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**ValidateTempPasswordParams**
-
-| 属性            | 类型              | 必填 | 说明           |
-| --------------- | ----------------- | ---- | -------------- |
-| unlockBindingId | `number`          | 否   | 临时密码的编号 |
-| devId           | `string`          | 是   | 设备 ID        |
-| effectiveTime   | `number`          | 是   | 生效时间       |
-| invalidTime     | `number`          | 是   | 失效时间       |
-| name            | `string`          | 是   | 临时密码名称   |
-| schedule        | `Schedule_Ver2[]` | 否   | 周期设置       |
-| countryCode     | `string`          | 否   | 国家码         |
-| phone           | `string`          | 否   | 手机号         |
-| password        | `string`          | 是   | 临时密码内容   |
-
-### 返回
-
-**ValidateTempPasswordResult**
-
-| 属性      | 类型      | 说明         |
-| --------- | --------- | ------------ |
-| valid     | `boolean` | 是否有效     |
-| errorCode | `string`  | 云端错误码   |
-| errorMsg  | `string`  | 云端错误内容 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 临时密码参数有效性校验
- */
-export function validateTemporaryPassword(
-  params: ValidateTempPasswordParams
-): Promise<ValidateTempPasswordResult>
-```
-
-## validateAndUpdateTemporaryPassword
-
-校验临时密码是否可以添加或更新。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { validateAndUpdateTemporaryPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**ValidateUpdateTempPasswordParams**
-
-| 属性            | 类型     | 必填 | 说明           |
-| --------------- | -------- | ---- | -------------- |
-| unlockBindingId | `number` | 否   | 临时密码的编号 |
-| devId           | `string` | 是   | 设备 ID        |
-| effectiveTime   | `number` | 是   | 生效时间       |
-| invalidTime     | `number` | 是   | 失效时间       |
-| name            | `string` | 否   | 名称           |
-| schedule        | `string` | 否   | 周期设置       |
-| countryCode     | `string` | 否   | 国家码         |
-| phone           | `string` | 否   | 手机号         |
-
-### 返回
-
-**ValidateUpdateTempPasswordResult**
-
-| 属性      | 类型      | 说明         |
-| --------- | --------- | ------------ |
-| valid     | `boolean` | 是否有效     |
-| errorCode | `string`  | 云端错误码   |
-| errorMsg  | `string`  | 云端错误内容 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 校验临时密码是否可以添加或更新
- */
-export function validateAndUpdateTemporaryPassword(
-  params: ValidateUpdateTempPasswordParams
-): Promise<ValidateUpdateTempPasswordResult>
-```
-
-## createTemporaryPassword
-
-创建临时密码。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { createTemporaryPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**CreateTempPasswordParams**
-
-| 属性          | 类型            | 必填 | 说明               |
-| ------------- | --------------- | ---- | ------------------ |
-| devId         | `string`        | 是   | 设备 ID            |
-| sn            | `number`        | 是   | 编号               |
-| effectiveTime | `number`        | 是   | 生效时间           |
-| invalidTime   | `number`        | 是   | 失效时间           |
-| availTime     | `number`        | 否   | 可用次数           |
-| name          | `string`        | 否   | 名称               |
-| symbolic      | `boolean`       | 是   | 是否仅保存静态数据 |
-| dpTunnel      | `string`        | 否   | 数据通道           |
-| schedule      | `Schedule_Ver2` | 否   | 周期设置           |
-
-### 返回
-
-**CreateTempPasswordResult**
-
-| 属性            | 类型     | 说明               |
-| --------------- | -------- | ------------------ |
-| unlockBindingId | `string` | 临时密码对应的编号 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 创建临时密码
- */
-export function createTemporaryPassword(
-  params: CreateTempPasswordParams
-): Promise<CreateTempPasswordResult>
-```
-
-## updateTempPassword
-
-更新临时密码。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { updateTempPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**UpdateTempPasswordParams**
-
-| 属性            | 类型            | 必填 | 说明               |
-| --------------- | --------------- | ---- | ------------------ |
-| unlockBindingId | `number`        | 是   | 密码序号           |
-| devId           | `string`        | 是   | 设备 ID            |
-| effectiveTime   | `number`        | 否   | 生效时间           |
-| invalidTime     | `number`        | 否   | 失效时间           |
-| name            | `string`        | 否   | 名称               |
-| phase           | `number`        | 否   | 状态               |
-| symbolic        | `boolean`       | 是   | 是否仅保存静态数据 |
-| dpTunnel        | `number`        | 是   | 数据通道           |
-| schedule        | `Schedule_Ver2` | 否   | 周期设置           |
-
-### 返回
-
-**UpdateTempPasswordResult**
-
-`boolean`，请求结果：是否成功更新临时密码。
-
-### 函数定义示例
-
-```typescript
-/**
- * 更新临时密码
- */
-export function updateTempPassword(
-  params: UpdateTempPasswordParams
-): Promise<UpdateTempPasswordResult>
-```
-
-## updateTempPasswordName
-
-更新临时密码名称。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { updateTempPasswordName } from '@ray-js/ray'
-```
-
-### 参数
-
-**UpdateTempPasswordNameParams**
-
-| 属性            | 类型     | 必填 | 说明     |
-| --------------- | -------- | ---- | -------- |
-| unlockBindingId | `number` | 是   | 密码序号 |
-| devId           | `string` | 是   | 设备 ID  |
-| name            | `string` | 否   | 名称     |
-
-### 返回
-
-**UpdateTempPasswordNameResult**
-
-`boolean`，请求结果：是否成功更新临时密码名称。
-
-### 函数定义示例
-
-```typescript
-/**
- * 更新临时密码的名称
- */
-export function updateTempPasswordName(
-  params: UpdateTempPasswordNameParams
-): Promise<UpdateTempPasswordNameResult>
-```
-
-## deleteTemporaryPassword
-
-删除临时密码。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { deleteTemporaryPassword } from '@ray-js/ray'
-```
-
-### 参数
-
-**DeleteTempPasswordParams**
-
-| 属性            | 类型      | 必填 | 说明               |
-| --------------- | --------- | ---- | ------------------ |
-| unlockBindingId | `number`  | 是   | 密码序号           |
-| devId           | `string`  | 是   | 设备 ID            |
-| symbolic        | `boolean` | 否   | 是否仅保存静态数据 |
-| dpTunnel        | `boolean` | 否   | 数据通道           |
-
-### 返回
-
-**DeleteTempPasswordResult**
-
-`boolean`，请求结果：是否成功删除临时密码。
-
-### 函数定义示例
-
-```typescript
-/**
- * 删除生效中的临时密码
- */
-export function deleteTemporaryPassword(
-  params: DeleteTempPasswordParams
-): Promise<DeleteTempPasswordResult>
-```
-
-## checkShareAvailability
-
-获取某个账号是否可以用于分享。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { checkShareAvailability } from '@ray-js/ray'
-```
-
-**参数**
-
-`ShareAvailabilityParams` - 检查分享可用性参数对象。
-
-| 属性            | 类型     | 必填 | 说明                 |
-| --------------- | -------- | ---- | -------------------- |
-| unlockBindingId | `number` | 否   | 分享在云端的唯一编号 |
-| devId           | `string` | 是   | 设备 Id              |
-| availTime       | `number` | 是   | 可用次数             |
-| countryCode     | `string` | 是   | 国家码               |
-| account         | `string` | 是   | 账号                 |
-| name            | `string` | 否   | 名称                 |
-| effectiveTime   | `number` | 是   | 生效时间             |
-| invalidTime     | `number` | 是   | 失效时间             |
-| schedule        | `string` | 否   | 周期                 |
-
-**返回**
-
-`Promise<ShareAvailabilityResult>` - Promise 对象，解析为检查分享可用性的结果。
-
-**ShareAvailabilityResult**
-
-检查分享可用性结果。
-
-| 属性           | 类型      | 说明                   |
-| -------------- | --------- | ---------------------- |
-| validateResult | `boolean` | 是否允许分享           |
-| registered     | `boolean` | 账号是否已注册涂鸦智能 |
-| dialogueType   | `number`  | 弹框类型               |
-| errorMsg       | `string`  | 不允许分享的原因       |
-| errorCode      | `string`  | 错误代码               |
-
-**函数定义示例**
-
-```typescript
-/**
- * 获取某个账号是否可以用于分享
- * @param {ShareAvailabilityParams} params - 检查分享可用性参数
- * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
- */
-export const checkShareAvailability = (
-  params: ShareAvailabilityParams
-): Promise<ShareAvailabilityResult>;
-```

package/lib/cloud/doorlock/unlock-method.md

@@ -1,121 +0,0 @@
-## checkUnlockMethod
-
-查询是否有解锁方式需要分配。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { checkUnlockMethod } from '@ray-js/ray'
-```
-
-### 参数
-
-**CheckUnlockMethodParams**
-
-| 属性  | 类型     | 必填 | 说明     |
-| ----- | -------- | ---- | -------- |
-| devId | `string` | 是   | 门锁编号 |
-
-### 返回
-
-**CheckUnlockMethodResult**
-
-`boolean`，查询结果。
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询是否有解锁方式需要分配
- */
-export function checkUnlockMethod(params: CheckUnlockMethodParams): Promise<CheckUnlockMethodResult>
-```
-
-## getUnlockMethodList
-
-查询需要分配的开锁方式列表。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getUnlockMethodList } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetUnlockMethodListParams**
-
-| 属性  | 类型     | 必填 | 说明     |
-| ----- | -------- | ---- | -------- |
-| devId | `string` | 是   | 门锁编号 |
-
-### 返回
-
-**GetUnlockMethodListResult**
-
-| 属性       | 类型           | 说明                             |
-| ---------- | -------------- | -------------------------------- |
-| opmode     | `boolean`      | 解锁方式(指纹 1，密码 2，门卡 3) |
-| unlockInfo | `UnlockInfo[]` | 待分配的解锁方式详情             |
-
-**UnlockInfo**
-
-| 属性       | 类型     | 说明             |
-| ---------- | -------- | ---------------- |
-| unlockId   | `string` | 解锁方式编号     |
-| unlockName | `string` | 解锁方式名称     |
-| opmodeId   | `number` | 解锁方式云端序号 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询需要分配的开锁方式列表
- */
-export function getUnlockMethodList(
-  params: GetUnlockMethodListParams
-): Promise<GetUnlockMethodListResult[]>
-```
-
-## bindUnlockMethodToUser
-
-绑定解锁方式到人。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { bindUnlockMethodToUser } from '@ray-js/ray'
-```
-
-### 参数
-
-**BindUnlockMethodToUserParams**
-
-| 属性      | 类型       | 必填 | 说明         |
-| --------- | ---------- | ---- | ------------ |
-| devId     | `string`   | 是   | 门锁编号     |
-| userId    | `string`   | 是   | 用户编号     |
-| unlockIds | `string[]` | 是   | 解锁方式列表 |
-
-### 返回
-
-**BindUnlockMethodToUserResponse**
-
-`boolean`，返回参数。
-
-### 函数定义示例
-
-```typescript
-/**
- * 绑定解锁方式到人
- */
-export function bindUnlockMethodToUser(
-  params: BindUnlockMethodToUserParams
-): Promise<BindUnlockMethodToUserResponse>
-```

package/lib/cloud/doorlock/unlock.md

@@ -1,222 +0,0 @@
-## remoteOpenDoor
-
-远程免密开门功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { remoteOpenDoor } from '@ray-js/ray'
-```
-
-### 参数
-
-**RemoteOpenParams**
-
-| 属性  | 类型      | 必填 | 说明     |
-| ----- | --------- | ---- | -------- |
-| devId | `string`  | 是   | 设备 Id  |
-| open  | `boolean` | 是   | 是否开门 |
-
-### 返回
-
-**RemoteOpenResponse**
-
-`boolean`，远程免密开门的响应结果。
-
-### 函数定义示例
-
-```typescript
-/**
- * 远程免密开门
- */
-export function remoteOpenDoor(params: RemoteOpenParams): Promise<RemoteOpenResponse>
-```
-
-## remoteUnlockDoor
-
-远程免密解锁功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { remoteUnlockDoor } from '@ray-js/ray'
-```
-
-### 参数
-
-**UnlockParams**
-
-| 属性    | 类型      | 必填 | 说明                           |
-| ------- | --------- | ---- | ------------------------------ |
-| devId   | `string`  | 是   | 设备 Id                        |
-| open    | `boolean` | 是   | 是否开门                       |
-| confirm | `boolean` | 是   | 是否确认，蓝牙门锁固定传 false |
-
-### 返回
-
-**UnlockResponse**
-
-`boolean`，远程免密解锁的响应结果。
-
-### 函数定义示例
-
-```typescript
-/**
- * 远程免密解锁
- */
-export function remoteUnlockDoor(params: UnlockParams): Promise<UnlockResponse>
-```
-
-## checkCanRemoteUnlock
-
-判断用户是否可以远程开门功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { checkCanRemoteUnlock } from '@ray-js/ray'
-```
-
-### 参数
-
-**CanUnlockRemoteParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 Id |
-
-### 返回
-
-**CanUnlockRemoteResponse**
-
-`boolean`，判断用户是否可以远程开门的响应结果。
-
-### 函数定义示例
-
-```typescript
-/**
- * 判断用户是否可以远程开门
- */
-export function checkCanRemoteUnlock(
-  params: CanUnlockRemoteParams
-): Promise<CanUnlockRemoteResponse>
-```
-
-## getLatestUnlockRecord
-
-获取最近一条记录的信息。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { getLatestUnlockRecord } from '@ray-js/ray'
-```
-
-### 参数
-
-**GetLatestRecordInfoParams**
-
-| 属性  | 类型     | 必填 | 说明    |
-| ----- | -------- | ---- | ------- |
-| devId | `string` | 是   | 设备 Id |
-
-### 返回
-
-**GetLatestRecordInfoResponse**
-
-| 属性            | 类型             | 说明              |
-| --------------- | ---------------- | ----------------- |
-| dpId            | `number`         | 类型(门锁端 dpId) |
-| dpValue         | `string`         | dp 值             |
-| recordType      | `number`         | 记录类型          |
-| userName        | `string`         | 用户名称          |
-| time            | `number`         | 时间              |
-| unionUnlockInfo | `UnlockRecord[]` | 组合开锁信息      |
-| unReadCount     | `number`         | 未读记录数        |
-
-**UnlockRecord**
-
-| 属性       | 类型     | 说明                   |
-| ---------- | -------- | ---------------------- |
-| userName   | `string` | 组合开锁的用户名称     |
-| opMode     | `string` | 组合开锁的解锁方式     |
-| unlockName | `string` | 组合开锁的解锁方式名称 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 获取最近一条记录的信息
- */
-export function getLatestUnlockRecord(
-  params: GetLatestRecordInfoParams
-): Promise<GetLatestRecordInfoResponse>
-```
-
-## queryUnlockRecord
-
-查询开门记录功能。
-
-### 引入
-
-> @ray-js/ray^1.5.0 以上版本可使用
-
-```js
-import { queryUnlockRecord } from '@ray-js/ray'
-```
-
-### 参数
-
-**QueryRecordInfoParams**
-
-| 属性      | 类型       | 必填 | 说明                 |
-| --------- | ---------- | ---- | -------------------- |
-| devId     | `string`   | 是   | 门锁编号             |
-| dpIds     | `string[]` | 是   | dpId 列表            |
-| offset    | `number`   | 否   | 起始页               |
-| limit     | `number`   | 否   | 每页数据大小         |
-| startTime | `number`   | 否   | 开始时间             |
-| endTime   | `number`   | 否   | 结束时间             |
-| nameless  | `boolean`  | 否   | 是否仅查询匿名的记录 |
-
-### 返回
-
-**QueryRecordInfoResponse**
-
-| 属性            | 类型                  | 说明                 |
-| --------------- | --------------------- | -------------------- |
-| id              | `number`              | 绑定的编号           |
-| dpId            | `number`              | 类型(门锁端 dpId)    |
-| userId          | `string`              | 开门的用户编号       |
-| unlockName      | `string`              | 解锁方式名称(如果有) |
-| userName        | `string`              | 用户名称             |
-| avatarUrl       | `string`              | 用户头像             |
-| time            | `number`              | 时间                 |
-| relateDevName   | `string`              | 关联设备的名称       |
-| relateOpMode    | `number`              | 关联设备的解锁方式   |
-| unionUnlockInfo | `QueryUnlockRecord[]` | 组合开锁信息         |
-
-**QueryUnlockRecord**
-
-| 属性       | 类型     | 说明                   |
-| ---------- | -------- | ---------------------- |
-| userName   | `string` | 组合开锁的用户名称     |
-| opMode     | `string` | 组合开锁的解锁方式     |
-| unlockName | `string` | 组合开锁的解锁方式名称 |
-
-### 函数定义示例
-
-```typescript
-/**
- * 查询开门记录
- */
-export function queryUnlockRecord(params: QueryRecordInfoParams): Promise<QueryRecordInfoResponse[]>
-```