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

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
+  });
+};

package/lib/cloud/doorlock/member.md

@@ -0,0 +1,276 @@
+## getCurrentMemberInfo
+
+获取当前登录用户信息。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getCurrentMemberInfo } from '@ray-js/ray'
+```
+
+### 参数
+
+**CurrentMemberInfoParams**
+
+| 属性  | 类型     | 必填 | 说明      |
+| ----- | -------- | ---- | --------- |
+| devId | `string` | 是   | 设备 ID   |
+| dpIds | `string` | 是   | 数据点 ID |
+
+### 返回
+
+**CurrentMemberInfoResult**
+
+| 属性             | 类型            | 说明               |
+| ---------------- | --------------- | ------------------ |
+| userId           | `number`        | 用户 ID            |
+| lockUserId       | `number`        | 锁用户 ID          |
+| userType         | `number`        | 用户类型           |
+| allOpenDps       | `string`        | 所有开放的数据点   |
+| allOpenType      | `Array<number>` | 所有开放类型的数组 |
+| productAttribute | `number`        | 产品属性           |
+| phase            | `number`        | 阶段               |
+| expireTime       | `number`        | 过期时间           |
+| expireDate       | `number`        | 过期日期           |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取当前登录用户信息
+ */
+export function getCurrentMemberInfo(
+  params: CurrentMemberInfoParams
+): Promise<CurrentMemberInfoResult>
+```
+
+## getFamilyMemberListWithUnlockCount
+
+获取家庭成员列表（带解锁方式个数）。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { getFamilyMemberListWithUnlockCount } from '@ray-js/ray'
+```
+
+### 参数
+
+**FamilyMemberListWithUnlockCountParams**
+
+| 属性  | 类型            | 必填 | 说明           |
+| ----- | --------------- | ---- | -------------- |
+| devId | `string`        | 是   | 设备 ID        |
+| dpIds | `Array<number>` | 是   | 数据点 ID 数组 |
+
+### 返回
+
+**FamilyMemberListWithUnlockCountResult**
+
+`Array<FamilyMemberWithUnlockDetail>`，家庭成员列表数组。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 获取家庭成员列表（带解锁方式个数）
+ */
+export function getFamilyMemberListWithUnlockCount(
+  params: FamilyMemberListWithUnlockCountParams
+): Promise<FamilyMemberListWithUnlockCountResult>
+```
+
+## removeFamilyMember
+
+家庭成员移除成功通知。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { removeFamilyMember } from '@ray-js/ray'
+```
+
+### 参数
+
+**FamilyMemberRemovalParams**
+
+| 属性   | 类型     | 必填 | 说明    |
+| ------ | -------- | ---- | ------- |
+| devId  | `string` | 是   | 设备 ID |
+| userId | `string` | 是   | 用户 ID |
+
+### 返回
+
+**FamilyMemberRemovalResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 家庭成员移除成功通知
+ */
+export function removeFamilyMember(
+  params: FamilyMemberRemovalParams
+): Promise<FamilyMemberRemovalResult>
+```
+
+## queryUserDeletion
+
+查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { queryUserDeletion } from '@ray-js/ray'
+```
+
+### 参数
+
+**UserDeletionQueryParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**UserDeletionQueryResult**
+
+`Array<{ userId: number, lockUserId: number }>`，数组包含已删除用户的 ID 和锁用户 ID。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 查询是否有家庭里已删除但是门锁端未删除且有设置硬件解锁方式的成员
+ */
+export function queryUserDeletion(params: UserDeletionQueryParams): Promise<UserDeletionQueryResult>
+```
+
+## syncLockBatch
+
+门锁批量同步。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { syncLockBatch } from '@ray-js/ray'
+```
+
+### 参数
+
+**LockSyncBatchParams**
+
+| 属性  | 类型     | 必填 | 说明    |
+| ----- | -------- | ---- | ------- |
+| devId | `string` | 是   | 设备 ID |
+
+### 返回
+
+**LockSyncBatchResult**
+
+| 属性        | 类型     | 说明           |
+| ----------- | -------- | -------------- |
+| lockRandom  | `object` | 随机锁信息     |
+| lockFitting | `object` | 锁具信息       |
+| lockRecord  | `string` | 锁记录         |
+| removedUser | `Array`  | 已移除用户信息 |
+
+### 函数定义示例
+
+```typescript
+/**
+ * 门锁批量同步
+ */
+export function syncLockBatch(params: LockSyncBatchParams): Promise<LockSyncBatchResult>
+```
+
+## updateUserTimeSchedule
+
+更新用户时效。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { updateUserTimeSchedule } from '@ray-js/ray'
+```
+
+### 参数
+
+**UpdateUserTimeScheduleParams**
+
+| 属性             | 类型               | 必填 | 说明     |
+| ---------------- | ------------------ | ---- | -------- |
+| devId            | `string`           | 是   | 设备 ID  |
+| userId           | `string`           | 是   | 用户 ID  |
+| timeScheduleInfo | `TimeScheduleInfo` | 是   | 时效信息 |
+
+### 返回
+
+**UpdateUserTimeScheduleResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 更新用户时效
+ */
+export function updateUserTimeSchedule(
+  params: UpdateUserTimeScheduleParams
+): Promise<UpdateUserTimeScheduleResult>
+```
+
+## openCloseOfflineUnlock
+
+打开/关闭离线解锁开关。
+
+### 引入
+
+> @ray-js/ray^1.5.0 以上版本可使用
+
+```js
+import { openCloseOfflineUnlock } from '@ray-js/ray'
+```
+
+### 参数
+
+**OpenCloseOfflineUnlockParams**
+
+| 属性   | 类型      | 必填 | 说明     |
+| ------ | --------- | ---- | -------- |
+| devId  | `string`  | 是   | 设备 ID  |
+| userId | `string`  | 是   | 用户 ID  |
+| enable | `boolean` | 是   | 是否启用 |
+
+### 返回
+
+**OpenCloseOfflineUnlockResult**
+
+`boolean`，表示操作是否成功。
+
+### 函数定义示例
+
+```typescript
+/**
+ * 打开/关闭离线解锁开关
+ */
+export function openCloseOfflineUnlock(
+  params: OpenCloseOfflineUnlockParams
+): Promise<OpenCloseOfflineUnlockResult>
+```

package/lib/cloud/doorlock/offline-pwd.d.ts

@@ -0,0 +1,61 @@
+type OfflinePwdParams = {
+    devId: string;
+    pwdType: string;
+    gmtStart: number;
+    gmtExpired: number;
+    pwdName?: string;
+    countryCode?: string;
+    mobile?: string;
+};
+type OfflinePwdResult = {
+    pwd: string;
+    pwdId: string;
+    unlockBindingId: string;
+};
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export declare const getOfflinePassword: (params: OfflinePwdParams) => Promise<OfflinePwdResult>;
+type PwdRevokeParams = {
+    devId: string;
+    unlockBindingId: string;
+    name?: string;
+};
+type PwdRevokeResult = string;
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export declare const revokeOfflinePassword: (params: PwdRevokeParams) => Promise<PwdRevokeResult>;
+type PwdNameUpdateParams = {
+    devId: string;
+    unlockBindingId: string;
+    pwdName: string;
+};
+type PwdNameUpdateResult = string;
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export declare const updateOfflinePasswordName: (params: PwdNameUpdateParams) => Promise<PwdNameUpdateResult>;
+type RevocablePwdParams = {
+    devId: string;
+};
+type RevocablePwdResultEntry = {
+    gmtExpired: string;
+    pwdName: string;
+    pwdId: string;
+    gmtStart: string;
+};
+type RevocablePwdResult = RevocablePwdResultEntry[];
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export declare const getRevocableOfflinePasswords: (params: RevocablePwdParams) => Promise<RevocablePwdResult>;
+export {};

package/lib/cloud/doorlock/offline-pwd.js

@@ -0,0 +1,67 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 6.1. 获取离线临时密码
+
+/**
+ * 获取离线临时密码
+ * @param {OfflinePwdParams} params - 请求参数
+ * @returns {Promise<OfflinePwdResult>} - 响应结果的 Promise
+ */
+export const getOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 6.2. 获取某个离线临时密码的删除密码
+
+// 离线删除密码
+
+/**
+ * 删除离线临时密码
+ * @param {PwdRevokeParams} params - 请求参数
+ * @returns {Promise<PwdRevokeResult>} - 响应结果的 Promise
+ */
+export const revokeOfflinePassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revoke"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.3. 设置某个密码的名称
+
+// 更新结果
+
+/**
+ * 更新离线密码名称
+ * @param {PwdNameUpdateParams} params - 请求参数
+ * @returns {Promise<PwdNameUpdateResult>} - 响应结果的 Promise
+ */
+export const updateOfflinePasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.name.update"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 6.4. 获取生效中的，可以被清空的多次离线临时密码
+
+// 结果的数组
+
+/**
+ * 获取可清空的多次离线临时密码
+ * @param {RevocablePwdParams} params - 请求参数
+ * @returns {Promise<RevocablePwdResult>} - 响应结果的 Promise
+ */
+export const getRevocableOfflinePasswords = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.offlinepwd.revocable"),
+    version: '1.0',
+    data: params
+  });
+};