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

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

package/lib/cloud/doorlock/member.d.ts

@@ -0,0 +1,110 @@
+type CurrentMemberInfoResult = {
+    userId: number;
+    lockUserId: number;
+    userType: number;
+    allOpenDps: string;
+    allOpenType: Array<number>;
+    productAttribute: number;
+    phase: number;
+    expireTime: number;
+    expireDate: number;
+};
+type CurrentMemberInfoParams = {
+    devId: string;
+    dpIds: string;
+};
+export declare const getCurrentMemberInfo: (params: CurrentMemberInfoParams) => Promise<CurrentMemberInfoResult>;
+type UnlockDetail = {
+    dpId: number;
+    count: number;
+    unlockList: Array<{
+        unlockId: string;
+        opModeId: number;
+        unlockName: string;
+        unlockAttr: number;
+        admin: boolean;
+    }>;
+};
+type ScheduleDetails = {
+    effectiveTime: number;
+    invalidTime: number;
+    workingDay: number;
+    timeZoneId: string;
+    allDay: boolean;
+};
+type TimeScheduleInfo = {
+    permanent: boolean;
+    timeSetShifted: boolean;
+    userTimeSet: string;
+    effectiveTime: number;
+    expiredTime: number;
+    scheduleDetails: Array<ScheduleDetails>;
+};
+type FamilyMemberWithUnlockDetail = {
+    avatarUrl: string;
+    lockUserId: number;
+    nickName: string;
+    userType: number;
+    backHomeNotifyAttr: number;
+    userContact: string;
+    offlineUnlock: boolean;
+    userId: string;
+    unlockDetail: UnlockDetail[];
+    timeScheduleInfo: TimeScheduleInfo;
+};
+type FamilyMemberListWithUnlockCountResult = Array<FamilyMemberWithUnlockDetail>;
+type FamilyMemberListWithUnlockCountParams = {
+    devId: string;
+    dpIds: Array<number>;
+};
+export declare const getFamilyMemberListWithUnlockCount: (params: FamilyMemberListWithUnlockCountParams) => Promise<FamilyMemberListWithUnlockCountResult>;
+type FamilyMemberRemovalResult = boolean;
+type FamilyMemberRemovalParams = {
+    devId: string;
+    userId: string;
+};
+export declare const removeFamilyMember: (params: FamilyMemberRemovalParams) => Promise<FamilyMemberRemovalResult>;
+type UserDeletionQueryResult = Array<{
+    userId: number;
+    lockUserId: number;
+}>;
+type UserDeletionQueryParams = {
+    devId: string;
+};
+export declare const queryUserDeletion: (params: UserDeletionQueryParams) => Promise<UserDeletionQueryResult>;
+type LockSyncBatchResult = {
+    lockRandom: {
+        devUnlockId: string;
+        distributed: boolean;
+        ins: string;
+    };
+    lockFitting: {
+        dpId: number;
+        distributed: boolean;
+        ins: Array<any>;
+    };
+    lockRecord: string;
+    removedUser: Array<{
+        userId: number;
+        lockUserId: number;
+    }>;
+};
+type LockSyncBatchParams = {
+    devId: string;
+};
+export declare const syncLockBatch: (params: LockSyncBatchParams) => Promise<LockSyncBatchResult>;
+type UpdateUserTimeScheduleResult = boolean;
+type UpdateUserTimeScheduleParams = {
+    devId: string;
+    userId: string;
+    timeScheduleInfo: TimeScheduleInfo;
+};
+export declare const updateUserTimeSchedule: (params: UpdateUserTimeScheduleParams) => Promise<UpdateUserTimeScheduleResult>;
+type OpenCloseOfflineUnlockResult = boolean;
+type OpenCloseOfflineUnlockParams = {
+    devId: string;
+    userId: string;
+    enable: boolean;
+};
+export declare const openCloseOfflineUnlock: (params: OpenCloseOfflineUnlockParams) => Promise<OpenCloseOfflineUnlockResult>;
+export {};

package/lib/cloud/doorlock/member.js

@@ -0,0 +1,72 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 3.1. 获取当前登陆用户信息
+
+export const getCurrentMemberInfo = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 3.2. 获取家庭成员列表(带解锁方式个数)
+
+export const getFamilyMemberListWithUnlockCount = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.detail.list"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 3.3. 家庭成员移除成功通知
+
+export const removeFamilyMember = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.remove"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 3.4. 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
+
+export const queryUserDeletion = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.member.removed"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.5. 门锁批量同步
+
+export const syncLockBatch = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.sync.batch"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.6. 更新用户时效
+
+export const updateUserTimeSchedule = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.time.schedule.update"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 3.7. 打开/关闭离线解锁开关
+
+export const openCloseOfflineUnlock = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.user.unlock.offline"),
+    version: '1.0',
+    data: params
+  });
+};