@ray-js/api 1.4.62 → 1.4.63

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.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 {};

package/lib/cloud/doorlock/unlock.js

@@ -0,0 +1,76 @@
+import { THING } from '../../constants';
+import requestCloud from '../../requestCloud';
+
+// 1.1. RemoteOpenParams - 远程免密开门的参数类型
+
+// RemoteOpenResponse - 远程免密开门的响应类型
+
+/**
+ * 远程免密开门
+ * @param {RemoteOpenParams} params - 包含设备Id和开门状态的参数
+ * @returns {Promise<RemoteOpenResponse>} - 包含执行结果和状态的响应
+ */
+export const remoteOpenDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.zigbee.lock.remotepwd.execute"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.2. Unlock - 远程免密开门的参数和响应类型
+
+/**
+ * 远程免密解锁
+ * @param {UnlockParams} params - 包含设备Id、开门状态和确认状态的参数
+ * @returns {Promise<UnlockResponse>} - 包含请求结果和状态的响应
+ */
+export const remoteUnlockDoor = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock"),
+    version: '2.0',
+    data: params
+  });
+};
+
+// 1.3. 判断用户是否可以远程开门
+
+/**
+ * 判断用户是否可以远程开门
+ * @param {CanUnlockRemoteResponse} params - 包含设备Id的参数
+ * @returns {Promise<CanUnlockRemoteResponse>} - 包含请求结果和状态的响应
+ */
+export const checkCanRemoteUnlock = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.remote.unlock.available"),
+    version: '1.0',
+    data: params
+  });
+};
+/**
+ * 获取最近一条记录的信息
+ * @param   {GetLatestRecordInfoParams} params  - 包含设备Id的参数
+ * @returns {Promise<GetLatestRecordInfoResponse>} - 包含请求结果和状态的响应
+ */
+export const getLatestUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.latest"),
+    version: '1.0',
+    data: params
+  });
+};
+
+// 1.5. 查询开门记录
+
+/**
+ * 查询开门记录
+ * @param { QueryRecordInfoParams} params -  包含设备Id的参数
+ * @returns {Promise<QueryRecordInfoResponse[]>} - 包含请求结果和状态的响应
+ */
+export const queryUnlockRecord = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.device.lock.history.list"),
+    version: '2.0',
+    data: params
+  });
+};

package/lib/cloud/index.d.ts

@@ -4,5 +4,7 @@ export * from './alarm';
 export * from './statistic';
 export * from './device';
 export * from './linkage';
-export * from './doorlock';
+export * from './remoteGroup';
 export * from './outdoor';
+export * from './doorlock';
+export * from './recipe';

package/lib/cloud/index.js

@@ -4,9 +4,12 @@ export * from './alarm';
 export * from './statistic';
 export * from './device';
 export * from './linkage';
-
-// 仅用于门锁模版，在门锁未OpenAPI时使用。
-export * from './doorlock';
+export * from './remoteGroup';
 
 // 仅用于出行产品
-export * from './outdoor';
+export * from './outdoor';
+
+// 门锁
+export * from './doorlock';
+// 菜谱
+export * from './recipe';

package/lib/cloud/interface.d.ts

@@ -969,3 +969,29 @@ export interface DeviceProperty {
     value: string;
 }
 export type ISaveDevPropertyResponse = boolean;
+export interface IGetZigbeeLocalGroupRelation {
+    /**
+     * 遥控器设备 ID
+     */
+    devId: string;
+}
+export interface IGetZigbeeLocalGroupDeviceList {
+    /**
+     * 遥控器的设备 ID
+     */
+    devId: string;
+    /**
+     * 遥控器的网关 id
+     */
+    meshId: string;
+    /**
+     * 分组 Code，遥控器可支持多个群组，与 localId 匹配范围为 7001-7008；
+     * localId 为云端分配，步长为 8，因此一个遥控器内部最多支持关联 8 个群组，localId 为初始值依次+1，与之匹配的 categoryCode 从 7001 依次 +1。
+     * 可以通过 getZigbeeLocalGroupRelation 获取
+     */
+    categoryCode: string;
+    /**
+     * 家庭 id，可以通过 getCurrentHomeInfo 获取
+     */
+    homeId: string;
+}

package/lib/cloud/recipe/basket.d.ts

@@ -0,0 +1,220 @@
+/**
+ * BasketStatusResult - 菜篮子开关结果
+ */
+type BasketStatusResult = {
+    appId: number;
+    basketStatus: string;
+};
+/**
+ * GetBasketStatusResponse - 获取菜篮子开关响应
+ */
+type GetBasketStatusResponse = BasketStatusResult;
+/**
+ * 获取菜篮子开关
+ * @returns 获取菜篮子开关结果的 Promise
+ */
+export declare function getBasketStatus(): Promise<GetBasketStatusResponse>;
+/**
+ * BasketInfo - 菜篮子信息
+ */
+type BasketInfo = {
+    menuId: number;
+    name: string;
+    tagId: number;
+    tagName: string;
+    foodId: number;
+    foodImage: string;
+    foodName: string;
+    foodDesc: string;
+    amount: string;
+    secAmount: string;
+    secUnit: string;
+    secUnitCode: string;
+    secUnitDesc: string;
+    ownStatus: number;
+};
+/**
+ * GetBasketListResponse - 菜篮子列表响应
+ */
+type GetBasketListResponse = BasketInfo[];
+/**
+ * 获取菜篮子列表
+ * @returns 获取菜篮子列表结果的 Promise
+ */
+export declare function getBasketList(): Promise<GetBasketListResponse>;
+/**
+ * FoodInfoToAdd - 添加的食材信息
+ */
+type FoodInfoToAdd = {
+    menuId: number;
+    tagId?: number;
+    foodId: number;
+    amount: string;
+    secAmount?: string;
+    secUnit?: string;
+};
+/**
+ * AddFoodToBasketParams - 菜篮子食材添加参数
+ */
+type AddFoodToBasketParams = {
+    foodList: FoodInfoToAdd[];
+};
+/**
+ * AddFoodToBasketResponse - 菜篮子食材添加响应
+ */
+type AddFoodToBasketResponse = boolean;
+/**
+ * 添加食材到菜篮子
+ * @param params - 菜篮子食材添加参数
+ * @returns 添加食材到菜篮子结果的 Promise
+ */
+export declare function addFoodToBasket(params: AddFoodToBasketParams): Promise<AddFoodToBasketResponse>;
+/**
+ * FoodInfoToUpdate - 编辑的食材信息
+ */
+type FoodInfoToUpdate = {
+    foodId: number;
+    tagId?: number;
+    dataType: number;
+    amountType: number;
+    menuIds: number[];
+    amount?: string;
+    secUnit?: string;
+};
+/**
+ * UpdateFoodInBasketParams - 菜篮子食材编辑参数
+ */
+type UpdateFoodInBasketParams = {
+    foodInfo: FoodInfoToUpdate;
+};
+/**
+ * UpdateFoodInBasketResponse - 菜篮子食材编辑响应
+ */
+type UpdateFoodInBasketResponse = boolean;
+/**
+ * 编辑菜篮子中的食材
+ * @param params - 菜篮子食材编辑参数
+ * @returns 编辑菜篮子中的食材结果的 Promise
+ */
+export declare function updateFoodInBasket(params: UpdateFoodInBasketParams): Promise<UpdateFoodInBasketResponse>;
+/**
+ * DeleteFoodFromBasketParams - 菜篮子食材删除参数
+ */
+type DeleteFoodFromBasketParams = {
+    foodList: FoodInfoToDelete[];
+};
+/**
+ * FoodInfoToDelete - 删除的食材信息
+ */
+type FoodInfoToDelete = {
+    menuId: number;
+    tagId?: number;
+    foodId: number;
+    secUnit?: string;
+    ownStatus: number;
+};
+/**
+ * DeleteFoodFromBasketResponse - 菜篮子食材删除响应
+ */
+type DeleteFoodFromBasketResponse = boolean;
+/**
+ * 删除菜篮子中的食材
+ * @param params - 菜篮子食材删除参数
+ * @returns 删除菜篮子中的食材结果的 Promise
+ */
+export declare function deleteFoodFromBasket(params: DeleteFoodFromBasketParams): Promise<DeleteFoodFromBasketResponse>;
+/**
+ * OwnFoodInBasketParams - 菜篮子食材持有参数
+ */
+type OwnFoodInBasketParams = {
+    foodList: FoodInfoToOwn[];
+};
+/**
+ * FoodInfoToOwn - 持有的食材信息
+ */
+type FoodInfoToOwn = {
+    menuId: number;
+    tagId?: number;
+    foodId: number;
+    secUnit?: string;
+};
+/**
+ * OwnFoodInBasketResponse - 菜篮子食材持有响应
+ */
+type OwnFoodInBasketResponse = boolean;
+/**
+ * 将菜篮子中的食材变为已持有
+ * @param params - 菜篮子食材持有参数
+ * @returns 将菜篮子中的食材变为已持有结果的 Promise
+ */
+export declare function ownFoodInBasket(params: OwnFoodInBasketParams): Promise<OwnFoodInBasketResponse>;
+/**
+ * WantFoodInBasketParams - 菜篮子食材未持有参数
+ */
+type WantFoodInBasketParams = {
+    foodList: FoodInfoToWant[];
+};
+/**
+ * FoodInfoToWant - 未持有的食材信息
+ */
+type FoodInfoToWant = {
+    menuId: number;
+    tagId?: number;
+    foodId: number;
+    secUnit?: string;
+};
+/**
+ * WantFoodInBasketResponse - 菜篮子食材未持有响应
+ */
+type WantFoodInBasketResponse = boolean;
+/**
+ * 将菜篮子中的食材变为未持有
+ * @param params - 菜篮子食材未持有参数
+ * @returns 将菜篮子中的食材变为未持有结果的 Promise
+ */
+export declare function wantFoodInBasket(params: WantFoodInBasketParams): Promise<WantFoodInBasketResponse>;
+/**
+ * CleanBasketResponse - 菜篮子清空响应
+ */
+type CleanBasketResponse = boolean;
+/**
+ * 清空菜篮子中所有食材
+ * @returns 清空菜篮子中所有食材结果的 Promise
+ */
+export declare function cleanBasket(): Promise<CleanBasketResponse>;
+/**
+ * GetNutritionOfBasketParams - 菜篮子营养成分参数
+ */
+/**
+ * NutritionInfo - 营养成分信息
+ */
+type NutritionInfo = {
+    code: string;
+    value: string;
+};
+/**
+ * GetNutritionOfBasketResponse - 菜篮子营养成分响应
+ */
+type GetNutritionOfBasketResponse = NutritionInfo[];
+/**
+ * 获取菜篮子中未持有状态食材的营养成分
+ * @returns 获取菜篮子中未持有状态食材的营养成分结果的 Promise
+ */
+export declare function getNutritionOfBasket(): Promise<GetNutritionOfBasketResponse>;
+/**
+ * CheckMenuExistInBasketParams - 食谱是否有食材添加至菜篮子参数
+ */
+type CheckMenuExistInBasketParams = {
+    menuId: number;
+};
+/**
+ * CheckMenuExistInBasketResponse - 食谱是否有食材添加至菜篮子响应
+ */
+type CheckMenuExistInBasketResponse = boolean;
+/**
+ * 判断食谱中是否有添加过食材至菜篮子
+ * @param params - 食谱是否有食材添加至菜篮子参数
+ * @returns 判断食谱中是否有添加过食材至菜篮子结果的 Promise
+ */
+export declare function checkMenuExistInBasket(params: CheckMenuExistInBasketParams): Promise<CheckMenuExistInBasketResponse>;
+export {};