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

package/lib/cloud/doorlock/auth.md

@@ -1,323 +0,0 @@
-## 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.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>
-```