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

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

@@ -0,0 +1,194 @@
+type GetDynapwdParams = {
+    devId: string;
+    adminPwd: string;
+};
+type GetDynapwdResponse = {
+    dynamicPassword: string;
+};
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export declare const getDynamicPassword: (params: GetDynapwdParams) => Promise<GetDynapwdResponse>;
+type ValidateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name: string;
+    schedule?: {
+        invalidTime?: number;
+        workingDay?: number;
+        allDay?: boolean;
+        effectiveTime?: number;
+    }[];
+    countryCode?: string;
+    phone?: string;
+    password: string;
+};
+type ValidateTempPasswordResult = {
+    valid: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateTemporaryPassword: (params: ValidateTempPasswordParams) => Promise<ValidateTempPasswordResult>;
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+type Schedule_Ver2 = {
+    invalidTime?: number;
+    workingDay?: number;
+    allDay: boolean;
+    effectiveTime?: number;
+};
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+type ValidateUpdateTempPasswordParams = {
+    unlockBindingId?: number;
+    devId: string;
+    effectiveTime: number;
+    invalidTime: number;
+    name?: string;
+    schedule?: string;
+    countryCode?: string;
+    phone?: string;
+};
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+type ValidateUpdateTempPasswordResult = {
+    valid?: boolean;
+    errorCode?: string;
+    errorMsg?: string;
+};
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export declare const validateAndUpdateTemporaryPassword: (params: ValidateUpdateTempPasswordParams) => Promise<ValidateUpdateTempPasswordResult>;
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+type CreateTempPasswordParams = {
+    devId: string;
+    sn: number;
+    effectiveTime: number;
+    invalidTime: number;
+    availTime?: number;
+    name?: string;
+    symbolic: boolean;
+    dpTunnel?: string;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+type CreateTempPasswordResult = {
+    unlockBindingId?: string;
+};
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export declare const createTemporaryPassword: (params: CreateTempPasswordParams) => Promise<CreateTempPasswordResult>;
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+type UpdateTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    effectiveTime?: number;
+    invalidTime?: number;
+    name?: string;
+    phase?: number;
+    symbolic: boolean;
+    dpTunnel: number;
+    schedule?: Schedule_Ver2;
+};
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+type UpdateTempPasswordResult = boolean;
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPassword: (params: UpdateTempPasswordParams) => Promise<UpdateTempPasswordResult>;
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+type UpdateTempPasswordNameParams = {
+    unlockBindingId: number;
+    devId: string;
+    name?: string;
+};
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+type UpdateTempPasswordNameResult = boolean;
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export declare const updateTempPasswordName: (params: UpdateTempPasswordNameParams) => Promise<UpdateTempPasswordNameResult>;
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+type DeleteTempPasswordParams = {
+    unlockBindingId: number;
+    devId: string;
+    symbolic?: boolean;
+    dpTunnel?: boolean;
+};
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+type DeleteTempPasswordResult = boolean;
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export declare const deleteTemporaryPassword: (params: DeleteTempPasswordParams) => Promise<DeleteTempPasswordResult>;
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+type ShareAvailabilityParams = {
+    unlockBindingId?: number;
+    devId: string;
+    availTime: number;
+    countryCode: string;
+    account: string;
+    name?: string;
+    effectiveTime: number;
+    invalidTime: number;
+    schedule?: string;
+};
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+type ShareAvailabilityResult = {
+    validateResult: boolean;
+    registered?: boolean;
+    dialogueType: number;
+    errorMsg: string;
+    errorCode: string;
+};
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export declare const checkShareAvailability: (params: ShareAvailabilityParams) => Promise<ShareAvailabilityResult>;
+export {};

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

@@ -0,0 +1,193 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+// 5.1. 获取动态密码参数类型定义
+
+// 5.1. 获取动态密码响应类型定义
+
+/**
+ * 获取动态密码
+ * @param {GetDynapwdParams} params - 包含设备Id和管理员密码的参数对象
+ * @returns {Promise<GetDynapwdResponse>} - 包含动态密码数据的响应对象的 Promise
+ */
+export const getDynamicPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.dynapwd.get"),
+    version: '3.0',
+    data: params
+  });
+};
+
+// 5.2. 临时密码参数有效性校验参数类型定义
+
+// 5.2. 临时密码参数有效性校验响应类型定义
+
+/**
+ * 临时密码参数有效性校验（包括密码内容）
+ * @param {ValidateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '3.0',
+    data: params
+  });
+};
+
+//#region 5.3. 校验临时密码参数
+
+/**
+ * Schedule_Ver2 - 版本2的周期设置
+ */
+
+/**
+ * ValidateUpdateTempPasswordParams - 校验临时密码参数
+ */
+
+/**
+ * ValidateUpdateTempPasswordResult - 校验临时密码结果
+ */
+
+/**
+ * 校验临时密码是否可以添加或更新
+ * @param {ValidateUpdateTempPasswordParams} params - 临时密码参数
+ * @returns {Promise<ValidateUpdateTempPasswordResult>} - 校验结果的 Promise
+ */
+export const validateAndUpdateTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.validate"),
+    version: '2.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.4.  临时密码页创建临时密码
+
+/**
+ * CreateTempPasswordParams - 创建临时密码参数
+ */
+
+/**
+ * CreateTempPasswordResult - 创建临时密码结果
+ */
+
+/**
+ * 临时开锁页创建临时密码
+ * @param {CreateTempPasswordParams} params - 创建临时密码参数
+ * @returns {Promise<CreateTempPasswordResult>} - 创建结果的 Promise
+ */
+export const createTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.create"),
+    version: '8.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 5.5.  更新临时密码
+
+/**
+ * UpdateTempPasswordParams - 更新临时密码参数
+ */
+
+/**
+ * UpdateTempPasswordResult - 更新临时密码结果
+ */
+
+// 请求结果：是否成功更新临时密码
+
+/**
+ * 更新临时密码相关的信息
+ * @param {UpdateTempPasswordParams} params - 更新临时密码参数
+ * @returns {Promise<UpdateTempPasswordResult>} - 更新结果的 Promise
+ */
+export const updateTempPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.update"),
+    version: '4.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region 更新临时密码名称
+
+/**
+ * UpdateTempPasswordNameParams - 更新临时密码名称参数
+ */
+
+/**
+ * UpdateTempPasswordNameResult - 更新临时密码名称结果
+ */
+
+// 请求结果：是否成功更新临时密码名称
+
+/**
+ * 更新临时密码的名称
+ * @param {UpdateTempPasswordNameParams} params - 更新临时密码名称参数
+ * @returns {Promise<UpdateTempPasswordNameResult>} - 更新结果的 Promise
+ */
+export const updateTempPasswordName = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.name"),
+    version: '1.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  删除临时密码
+
+/**
+ * DeleteTempPasswordParams - 删除临时密码参数
+ */
+
+/**
+ * DeleteTempPasswordResult - 删除临时密码结果
+ */
+
+// 请求结果：是否成功删除临时密码
+
+/**
+ * 删除生效中的临时密码
+ * @param {DeleteTempPasswordParams} params - 删除临时密码参数
+ * @returns {Promise<DeleteTempPasswordResult>} - 删除结果的 Promise
+ */
+export const deleteTemporaryPassword = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.temppwd.remove"),
+    version: '5.0',
+    data: params
+  });
+};
+
+//#endregion
+
+//#region  检查分享可用性
+
+/**
+ * ShareAvailabilityParams - 检查分享可用性参数
+ */
+
+/**
+ * ShareAvailabilityResult - 检查分享可用性结果
+ */
+
+/**
+ * 获取某个账号是否可以用于分享
+ * @param {ShareAvailabilityParams} params - 检查分享可用性参数
+ * @returns {Promise<ShareAvailabilityResult>} - 检查结果的 Promise
+ */
+export const checkShareAvailability = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.share.available"),
+    version: '1.0',
+    data: params
+  });
+};