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

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

@@ -0,0 +1,362 @@
+## 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.d.ts

@@ -0,0 +1,62 @@
+/**
+ * CheckUnlockMethodParams - 查询解锁方式参数
+ */
+type CheckUnlockMethodParams = {
+    devId: string;
+};
+/**
+ * CheckUnlockMethodResult - 查询解锁方式结果
+ */
+type CheckUnlockMethodResult = boolean;
+/**
+ * 查询是否有解锁方式需要分配
+ * @param {CheckUnlockMethodParams} params - 查询解锁方式参数
+ * @returns {Promise<CheckUnlockMethodResult>} - 查询结果的 Promise
+ */
+export declare const checkUnlockMethod: (params: CheckUnlockMethodParams) => Promise<CheckUnlockMethodResult>;
+/**
+ * GetUnlockMethodListParams - 查询开锁方式列表参数
+ */
+type GetUnlockMethodListParams = {
+    devId: string;
+};
+/**
+ * UnlockInfo - 解锁方式信息
+ */
+type UnlockInfo = {
+    unlockId: string;
+    unlockName: string;
+    opmodeId?: number;
+};
+/**
+ * GetUnlockMethodListResult - 查询开锁方式列表结果
+ */
+type GetUnlockMethodListResult = {
+    opmode: boolean;
+    unlockInfo: UnlockInfo[];
+};
+/**
+ * 查询需要分配的开锁方式列表
+ * @param {GetUnlockMethodListParams} params - 查询开锁方式列表参数
+ * @returns {Promise<GetUnlockMethodListResult[]>} - 查询结果的 Promise
+ */
+export declare const getUnlockMethodList: (params: GetUnlockMethodListParams) => Promise<GetUnlockMethodListResult[]>;
+/**
+ * BindUnlockMethodToUserParams - 绑定解锁方式参数
+ */
+type BindUnlockMethodToUserParams = {
+    devId: string;
+    userId: string;
+    unlockIds: string[];
+};
+/**
+ * BindUnlockMethodToUserResponse - 绑定解锁方式响应
+ */
+type BindUnlockMethodToUserResponse = boolean;
+/**
+ * 绑定解锁方式到人
+ * @param {BindUnlockMethodToUserParams} params - 绑定解锁方式参数
+ * @returns {Promise<BindUnlockMethodToUserResponse>} - 绑定结果的 Promise
+ */
+export declare const bindUnlockMethodToUser: (params: BindUnlockMethodToUserParams) => Promise<BindUnlockMethodToUserResponse>;
+export {};

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

@@ -0,0 +1,85 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+//#region 查询是否有解锁方式需要分配
+
+/**
+ * CheckUnlockMethodParams - 查询解锁方式参数
+ */
+
+/**
+ * CheckUnlockMethodResult - 查询解锁方式结果
+ */
+
+// 查询结果
+
+/**
+ * 查询是否有解锁方式需要分配
+ * @param {CheckUnlockMethodParams} params - 查询解锁方式参数
+ * @returns {Promise<CheckUnlockMethodResult>} - 查询结果的 Promise
+ */
+export const checkUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.unlock.waitassign"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 查询需要分配的开锁方式列表
+
+/**
+ * GetUnlockMethodListParams - 查询开锁方式列表参数
+ */
+
+/**
+ * UnlockInfo - 解锁方式信息
+ */
+
+/**
+ * GetUnlockMethodListResult - 查询开锁方式列表结果
+ */
+
+/**
+ * 查询需要分配的开锁方式列表
+ * @param {GetUnlockMethodListParams} params - 查询开锁方式列表参数
+ * @returns {Promise<GetUnlockMethodListResult[]>} - 查询结果的 Promise
+ */
+export const getUnlockMethodList = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.unlock.assignlist"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 绑定解锁方式到人
+
+/**
+ * BindUnlockMethodToUserParams - 绑定解锁方式参数
+ */
+
+/**
+ * BindUnlockMethodToUserResponse - 绑定解锁方式响应
+ */
+
+// 返回参数
+
+/**
+ * 绑定解锁方式到人
+ * @param {BindUnlockMethodToUserParams} params - 绑定解锁方式参数
+ * @returns {Promise<BindUnlockMethodToUserResponse>} - 绑定结果的 Promise
+ */
+export const bindUnlockMethodToUser = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.unlock.allocate"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion

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

@@ -0,0 +1,121 @@
+## 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.d.ts

@@ -0,0 +1,89 @@
+type RemoteOpenParams = {
+    devId: string;
+    open: boolean;
+};
+type RemoteOpenResponse = boolean;
+/**
+ * 远程免密开门
+ * @param {RemoteOpenParams} params - 包含设备Id和开门状态的参数
+ * @returns {Promise<RemoteOpenResponse>} - 包含执行结果和状态的响应
+ */
+export declare const remoteOpenDoor: (params: RemoteOpenParams) => Promise<RemoteOpenResponse>;
+type UnlockParams = {
+    devId: string;
+    open: boolean;
+    confirm: boolean;
+};
+type UnlockResponse = boolean;
+/**
+ * 远程免密解锁
+ * @param {UnlockParams} params - 包含设备Id、开门状态和确认状态的参数
+ * @returns {Promise<UnlockResponse>} - 包含请求结果和状态的响应
+ */
+export declare const remoteUnlockDoor: (params: UnlockParams) => Promise<UnlockResponse>;
+type CanUnlockRemoteParams = {
+    devId: string;
+};
+type CanUnlockRemoteResponse = boolean;
+/**
+ * 判断用户是否可以远程开门
+ * @param {CanUnlockRemoteResponse} params - 包含设备Id的参数
+ * @returns {Promise<CanUnlockRemoteResponse>} - 包含请求结果和状态的响应
+ */
+export declare const checkCanRemoteUnlock: (params: CanUnlockRemoteParams) => Promise<CanUnlockRemoteResponse>;
+type UnlockRecord = {
+    userName: string;
+    opMode: string;
+    unlockName: string;
+};
+type GetLatestRecordInfoParams = {
+    devId: string;
+};
+type GetLatestRecordInfoResponse = {
+    dpId: number;
+    dpValue: string;
+    recordType: number;
+    userName: string;
+    time: number;
+    unionUnlockInfo: UnlockRecord[];
+    unReadCount: number;
+};
+/**
+ * 获取最近一条记录的信息
+ * @param   {GetLatestRecordInfoParams} params  - 包含设备Id的参数
+ * @returns {Promise<GetLatestRecordInfoResponse>} - 包含请求结果和状态的响应
+ */
+export declare const getLatestUnlockRecord: (params: GetLatestRecordInfoParams) => Promise<GetLatestRecordInfoResponse>;
+type QueryUnlockRecord = {
+    userName: string;
+    opMode: string;
+    unlockName: string;
+};
+type QueryRecordInfoParams = {
+    devId: string;
+    dpIds: string[];
+    offset?: number;
+    limit?: number;
+    startTime?: number;
+    endTime?: number;
+    nameless?: boolean;
+};
+type QueryRecordInfoResponse = {
+    id: number;
+    dpId: number;
+    userId: string;
+    unlockName: string;
+    userName: string;
+    avatarUrl: string;
+    time: number;
+    relateDevName: string;
+    relateOpMode?: number;
+    unionUnlockInfo: QueryUnlockRecord[];
+};
+/**
+ * 查询开门记录
+ * @param { QueryRecordInfoParams} params -  包含设备Id的参数
+ * @returns {Promise<QueryRecordInfoResponse[]>} - 包含请求结果和状态的响应
+ */
+export declare const queryUnlockRecord: (params: QueryRecordInfoParams) => Promise<QueryRecordInfoResponse[]>;
+export {};