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

package/lib/cloud/doorlock/log.md

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

@@ -0,0 +1,121 @@
+type ValidatePwdMemberResult = {
+    valid: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+type ValidatePwdMemberParams = {
+    devId: string;
+    opModeId?: number;
+    password: string;
+};
+/**
+ *  校验成员密码是否存在(包括临时密码)
+ * @param {ValidatePwdMemberParams} params
+ * @returns {Promise<ValidatePwdMemberResult>}
+ */
+export declare const validatePasswordForMember: (params: ValidatePwdMemberParams) => Promise<ValidatePwdMemberResult>;
+type AddMemberUnlockMethodResult = {
+    opModeId: string;
+    unlockName: string;
+};
+type NotifyInfo = {
+    appSend?: boolean;
+    msgPhone?: string;
+    countryCode?: string;
+    msgPhoneVerifyCode?: string;
+};
+type AddMemberUnlockMethodParams = {
+    devId: string;
+    userId: string;
+    unlockId: number;
+    unlockName?: string;
+    unlockAttr: number;
+    notifyInfo?: NotifyInfo;
+    unlockDetail?: string;
+};
+/**
+ * 添加解锁方式
+ * @param  {AddMemberUnlockMethodParams} params
+ * @returns  {Promise<AddMemberUnlockMethodResult>}
+ */
+export declare const addMemberUnlockMethod: (params: AddMemberUnlockMethodParams) => Promise<AddMemberUnlockMethodResult>;
+type RemoveMemberUnlockMethodResult = boolean;
+type RemoveMemberUnlockMethodParams = {
+    devId: string;
+    opmodeId: number;
+};
+/**
+ *  删除解锁方式
+ * @param  {RemoveMemberUnlockMethodParams} params
+ * @returns  {Promise<RemoveMemberUnlockMethodResult>}
+ */
+export declare const removeMemberUnlockMethod: (params: RemoveMemberUnlockMethodParams) => Promise<RemoveMemberUnlockMethodResult>;
+type SendSpecialUnlockVerifyCodeResult = boolean;
+type SendSpecialUnlockVerifyCodeParams = {
+    account: string;
+};
+/**
+ * 发送设置特殊解锁方式的验证码
+ * @param  {SendSpecialUnlockVerifyCodeParams} params
+ * @returns  {Promise<SendSpecialUnlockVerifyCodeResult>}
+ */
+export declare const sendSpecialUnlockVerifyCode: (params: SendSpecialUnlockVerifyCodeParams) => Promise<SendSpecialUnlockVerifyCodeResult>;
+type UpdateMemberUnlockModeResult = boolean;
+type UpdateMemberUnlockModeParams = {
+    devId: string;
+    opModeId: number;
+    unlockName?: string;
+    unlockAttr: number;
+    unlockDetail: string;
+    notifyInfo?: NotifyInfo;
+};
+/**
+ * 更新成员的解锁方式
+ * @param   {UpdateMemberUnlockModeParams} params
+ * @returns  {Promise<UpdateMemberUnlockModeResult>}
+ */
+export declare const updateMemberUnlockMode: (params: UpdateMemberUnlockModeParams) => Promise<UpdateMemberUnlockModeResult>;
+type UnlockMethodDetailResult = {
+    phase: number;
+    opmode: string;
+    unlockAttr: number;
+    unlockName: string;
+    userId: string;
+    opmodeValue: string;
+    unlockId: string;
+    lockUserId: number;
+    opmodeId: string;
+    voiceAttr: number;
+    userTimeSet: string;
+    userType: number;
+    sourceAttribute: number;
+    notifyInfo?: NotifyInfoDetail;
+};
+type NotifyInfoDetail = {
+    appSend?: boolean;
+    msgPhone?: string;
+    countryCode?: string;
+    targetUserId?: number;
+};
+type UnlockMethodDetailParams = {
+    devId: string;
+    opModeId: number;
+};
+/**
+ *  查询某个解锁方式的详情
+ * @param  {UnlockMethodDetailParams} params
+ * @returns  {Promise<UnlockMethodDetailResult>}
+ */
+export declare const getUnlockMethodDetail: (params: UnlockMethodDetailParams) => Promise<UnlockMethodDetailResult>;
+type GetPasswordSNResult = number;
+type GetPasswordSNParams = {
+    devId: string;
+    dpId: number;
+};
+/**
+ *  获取创建密码时的序号
+ * @param   {GetPasswordSNParams} params
+ * @returns  {Promise<GetPasswordSNResult>}
+ */
+export declare const getCreatePasswordSN: (params: GetPasswordSNParams) => Promise<GetPasswordSNResult>;
+export {};

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

@@ -0,0 +1,104 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 4.1. 校验成员密码是否存在(包括临时密码)
+
+/**
+ *  校验成员密码是否存在(包括临时密码)
+ * @param {ValidatePwdMemberParams} params
+ * @returns {Promise<ValidatePwdMemberResult>}
+ */
+export const validatePasswordForMember = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.pwd.validate"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 通知信息
+
+/**
+ * 添加解锁方式
+ * @param  {AddMemberUnlockMethodParams} params
+ * @returns  {Promise<AddMemberUnlockMethodResult>}
+ */
+export const addMemberUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.add"),
+    version: '5.0',
+    data: params
+  });
+};
+
+// 4.3. 删除解锁方式
+
+/**
+ *  删除解锁方式
+ * @param  {RemoveMemberUnlockMethodParams} params
+ * @returns  {Promise<RemoveMemberUnlockMethodResult>}
+ */
+export const removeMemberUnlockMethod = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.remove"),
+    version: '2.0',
+    data: params
+  });
+};
+/**
+ * 发送设置特殊解锁方式的验证码
+ * @param  {SendSpecialUnlockVerifyCodeParams} params
+ * @returns  {Promise<SendSpecialUnlockVerifyCodeResult>}
+ */
+export const sendSpecialUnlockVerifyCode = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.verifycode.send"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 4.5. 更新成员的解锁方式
+
+/**
+ * 更新成员的解锁方式
+ * @param   {UpdateMemberUnlockModeParams} params
+ * @returns  {Promise<UpdateMemberUnlockModeResult>}
+ */
+export const updateMemberUnlockMode = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.update"),
+    version: '5.0',
+    data: params
+  });
+};
+
+// 4.6. 查询某个解锁方式的详情
+
+/**
+ *  查询某个解锁方式的详情
+ * @param  {UnlockMethodDetailParams} params
+ * @returns  {Promise<UnlockMethodDetailResult>}
+ */
+export const getUnlockMethodDetail = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.opmode.detail"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 4.7. 获取创建密码时的序号
+
+/**
+ *  获取创建密码时的序号
+ * @param   {GetPasswordSNParams} params
+ * @returns  {Promise<GetPasswordSNResult>}
+ */
+export const getCreatePasswordSN = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.dp.sn.get"),
+    version: '1.0',
+    data: params
+  });
+};

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

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