@be-link/ecommerce-backend-bff-service-node-sdk 0.0.65 → 0.0.66

package/esm/bff/modules/pandora/store/types.d.ts

@@ -0,0 +1,786 @@
+import { StandardResponse } from '../../../../types';
+import { STORE_SERVICE_ENUM } from '../../../../enums';
+/**
+ * Store Service 的类型定义
+ * 使用命名空间组织类型，与后端 SDK 保持一致
+ */
+export declare namespace StoreService {
+    /**
+     * 实体定义
+     */
+    namespace Entity {
+        /**
+         * 门店基础信息
+         */
+        interface StoreBasicInfo {
+            /** 门店id */
+            id: number;
+            /** 创建时间 */
+            createdAt: number;
+            /** 更新时间 */
+            updatedAt: number;
+            /** 删除时间 */
+            deletedAt: number;
+            /** 门店名称 */
+            storeName: string;
+            /** 省 */
+            province: string;
+            /** 市 */
+            city: string;
+            /** 区 */
+            area: string;
+            /** 详细地址 */
+            address: string;
+            /** 纬度 */
+            latitude: number;
+            /** 经度 */
+            longitude: number;
+            /** 联系电话 */
+            telephone: string;
+            /** 加盟商id */
+            franchiseeId: string;
+            /** BD 负责人 Pandora ID */
+            bdPandoraId: string;
+            /** BD 负责人姓名 */
+            bdName?: string;
+            /** BDM 负责人 Pandora ID */
+            bdmPandoraId?: string;
+            /** BDM 负责人姓名 */
+            bdmName?: string;
+            /** 店长 Pandora ID */
+            storeManagerPandoraId: string;
+            /** 店长姓名 */
+            storeManagerName?: string;
+            /** 店员姓名列表 */
+            staffNames?: string[];
+            /** 门店二维码 */
+            qrCodeState?: any;
+            /** 经营状态，0未绑定负责人，1营业中，2已打烊 */
+            businessStatus: number;
+            /** 商家合作类型:0, 未配置；1, 独立店；2, 店中店 */
+            merchantCooperationType: number;
+            /** 门店类型:0, 未配置；1, 自营；2, 加盟 */
+            storeType: number;
+            /** 门店承接类型：0-未配置，1-老店期承接，2-拉新期承接，3-开播后承接 */
+            storeUndertakingType: number;
+            /** 是否需要平台拉新：0, 未配置；1, 是；2, 否 */
+            isPlatformNewCustomerOperation: number;
+            /** 拉新时间 毫秒级时间戳 */
+            newCustomerTime: number;
+            /** 最新活动时间 毫秒级时间戳 */
+            latestActiveTime: number;
+        }
+        /**
+         * 门店结算信息
+         */
+        interface StoreSettlement {
+            /** 结算信息id */
+            id: string;
+            /** 门店ID */
+            storeId: number;
+            /** 工作机 uid，工作机手机号和授权手机号做系统匹配 */
+            workPhoneUid: string;
+            /** 结算分佣比例 */
+            settlementCommissionRate?: any;
+            /** 直播时间 毫秒级时间戳 */
+            liveTime: number;
+            /** 免润期(天) */
+            gracePeriod: number;
+            /** 工作机企微 id，系统匹配 */
+            workPhoneWxCorpId: string;
+        }
+        /**
+         * 门店仓配信息
+         */
+        interface StoreWarehouseDelivery {
+            /** 仓配信息id */
+            id: string;
+            /** 门店ID */
+            storeId: number;
+            /** 收货紧急联系人姓名 */
+            emergencyContactName: string;
+            /** 收货紧急联系人手机号 */
+            emergencyContactPhone: string;
+            /** 仓配时间：白配、夜配 */
+            warehouseDeliveryTime: number;
+            /** 须知 */
+            remark: string;
+            /** 营业时间，时间格式，手动录入 */
+            businessHours?: any;
+            /** 门店打烊时间;{loop: [mon,tue,wed,thu,fri,sat,sun]},{once: [[1758556800000, 1758643200000]]} */
+            closingHour?: any;
+        }
+        /**
+         * 门店分组信息
+         */
+        interface StoreGroup {
+            /** 标签列表 */
+            tags: Array<{
+                /** 标签名称 */
+                tagName: string;
+            }>;
+        }
+        /**
+         * 完整门店信息（包含基础、结算、仓配信息）
+         */
+        interface StoreFullInfo extends StoreBasicInfo {
+            settlement?: StoreSettlement;
+            warehouseDelivery?: StoreWarehouseDelivery;
+            storeGroup?: StoreGroup;
+        }
+    }
+    /**
+     * 查询块定义
+     */
+    namespace QueryBlock {
+        /**
+         * 门店基础信息查询块
+         */
+        interface BasicInfo {
+            /** 门店名称（模糊搜索） */
+            storeName?: string;
+            /** 门店微赞ID */
+            storeId?: number;
+            /** 省 */
+            province?: string;
+            /** 市 */
+            city?: string;
+            /** 区 */
+            area?: string;
+            /** 加盟商ID列表 */
+            franchiseeIds?: string[];
+            /** 是否绑定加盟商 */
+            hasFranchisee?: boolean;
+            /** BD 负责人 Pandora ID 列表 */
+            bdPandoraIds?: string[];
+            /** 店长 Pandora ID */
+            storeManagerPandoraId?: string;
+            /** 经营状态：0-未绑定负责人，1-营业中，2-已打烊 */
+            businessStatus?: number;
+            /** 商家合作类型：0-未配置，1-独立店，2-店中店 */
+            merchantCooperationType?: number;
+            /** 门店类型：0-未配置，1-自营，2-加盟 */
+            storeType?: number;
+            /** 门店承接类型：0-未配置，1-老店期承接，2-拉新期承接，3-开播后承接 */
+            storeUndertakingType?: number;
+            /** 是否需要平台拉新：0-未配置，1-是，2-否 */
+            isPlatformNewCustomerOperation?: number;
+            /** 是否拉新（根据拉新时间是否大于0判断） */
+            isNewCustomer?: number;
+            /** 门店ID列表 */
+            storeIds?: number[];
+        }
+        /**
+         * 门店结算信息查询块
+         */
+        interface Settlement {
+            /** 直播时间（开始时间，毫秒级时间戳） */
+            liveTimeStart?: number;
+            /** 直播时间（结束时间，毫秒级时间戳） */
+            liveTimeEnd?: number;
+        }
+        /**
+         * 门店仓配信息查询块
+         */
+        interface WarehouseDelivery {
+            /** 仓配时间：白配、夜配 */
+            warehouseDeliveryTime?: number;
+        }
+        /**
+         * 门店分组查询块
+         */
+        interface StoreGroup {
+            /** 门店分组ID列表 */
+            storeGroupIds?: string[];
+            /** 门店分组名称（模糊搜索） */
+            storeGroupName?: string;
+        }
+    }
+    /**
+     * 请求参数定义
+     */
+    namespace Request {
+        /**
+         * 创建门店请求（创建时填写）
+         */
+        interface createStore {
+            /** 门店基础信息 */
+            basicInfo: {
+                /** 门店名称 */
+                storeName: string;
+                /** 省 */
+                province: string;
+                /** 市 */
+                city: string;
+                /** 区 */
+                area: string;
+                /** 详细地址 */
+                address: string;
+                /** 纬度（地图选点） */
+                latitude: number;
+                /** 经度（地图选点） */
+                longitude: number;
+            };
+            /** 门店结算信息 */
+            settlementInfo?: {
+                /** 工作机 uid */
+                workPhoneUid?: string;
+                /** 工作机企微 id */
+                workPhoneWxCorpId?: string;
+                /** 结算分佣比例 */
+                settlementCommissionRate?: any;
+                /** 直播时间 毫秒级时间戳 */
+                liveTime?: number;
+                /** 免润期(天) */
+                gracePeriod?: number;
+            };
+            /** 门店仓配信息 */
+            warehouseDeliveryInfo?: {
+                /** 收货紧急联系人姓名 */
+                emergencyContactName?: string;
+                /** 收货紧急联系人手机号 */
+                emergencyContactPhone?: string;
+                /** 仓配时间：白配、夜配 */
+                warehouseDeliveryTime?: number;
+                /** 须知 */
+                remark?: string;
+                /** 营业时间 */
+                businessHours?: any;
+                /** 门店打烊时间 */
+                closingHour?: any;
+            };
+        }
+        /**
+         * 绑定店长请求（自动同步店长相关信息）
+         */
+        interface bindStoreManager {
+            /** 门店ID */
+            storeId: number;
+            /** 店长 Pandora ID */
+            storeManagerPandoraId: string;
+        }
+        /**
+         * 解绑店长请求
+         */
+        interface unbindStoreManager {
+            /** 门店ID */
+            storeId: number;
+        }
+        /**
+         * 绑定BD请求
+         */
+        interface bindBD {
+            /** 门店ID */
+            storeId: number;
+            /** BD 负责人 Pandora ID */
+            bdPandoraId: string;
+        }
+        /**
+         * 解绑BD请求
+         */
+        interface unbindBD {
+            /** 门店ID */
+            storeId: number;
+        }
+        /**
+         * 绑定加盟商请求
+         */
+        interface bindFranchisee {
+            /** 门店ID */
+            storeId: number;
+            /** 加盟商ID */
+            franchiseeId: string;
+        }
+        /**
+         * 解绑加盟商请求
+         */
+        interface unbindFranchisee {
+            /** 门店ID */
+            storeId: number;
+        }
+        /**
+         * 编辑门店信息请求（手工录入字段）
+         */
+        interface updateStoreInfo {
+            /** 门店id */
+            storeId: number;
+            /** 门店基础信息 */
+            basicInfo?: {
+                /** 经营状态 */
+                businessStatus?: number;
+                /** 商家合作类型 */
+                merchantCooperationType?: number;
+                /** 门店类型 */
+                storeType?: number;
+                /** 是否需要平台拉新 */
+                isPlatformNewCustomerOperation?: number;
+            };
+            /** 门店地址信息 */
+            addressInfo?: {
+                /** 省 */
+                province?: string;
+                /** 市 */
+                city?: string;
+                /** 区 */
+                area?: string;
+                /** 详细地址 */
+                address?: string;
+                /** 纬度（地图选点） */
+                latitude?: number;
+                /** 经度（地图选点） */
+                longitude?: number;
+            };
+            /** 门店结算信息 */
+            settlementInfo?: {
+                /** 工作机 uid */
+                workPhoneUid?: string;
+                /** 工作机企微 id */
+                workPhoneWxCorpId?: string;
+                /** 结算分佣比例 */
+                settlementCommissionRate?: any;
+                /** 直播时间 毫秒级时间戳 */
+                liveTime?: number;
+                /** 免润期(天) */
+                gracePeriod?: number;
+            };
+            /** 门店仓配信息 */
+            warehouseDeliveryInfo?: {
+                /** 收货紧急联系人姓名 */
+                emergencyContactName?: string;
+                /** 收货紧急联系人手机号 */
+                emergencyContactPhone?: string;
+                /** 仓配时间：白配、夜配 */
+                warehouseDeliveryTime?: number;
+                /** 须知 */
+                remark?: string;
+                /** 营业时间 */
+                businessHours?: any;
+                /** 门店打烊时间 */
+                closingHour?: any;
+            };
+        }
+        /**
+         * 更新群直播时间请求（系统同步）
+         */
+        interface updateLiveTime {
+            /** 门店ID */
+            storeId: number;
+            /** 直播时间 毫秒级时间戳 */
+            liveTime: number;
+        }
+        /**
+         * 门店继承请求（系统同步门店承接类型）
+         */
+        interface inheritStore {
+            /** 门店ID */
+            storeId: number;
+            /** 门店承接类型：1-老店期承接，2-拉新期承接，3-开播后承接 */
+            storeUndertakingType: number;
+        }
+        /**
+         * 获取门店详情请求
+         */
+        interface getStoreDetail {
+            /** 门店id */
+            storeId: number;
+        }
+        /**
+         * 批量获取门店信息请求
+         */
+        interface batchGetStoreInfo {
+            /** 门店ID列表 */
+            storeIds: number[];
+            /** 需要返回的响应块（数据表）列表 */
+            responseBlocks: STORE_SERVICE_ENUM.STORE_ENUM.RESPONSE_BLOCK_TYPE[];
+        }
+        /**
+         * 获取门店列表请求
+         */
+        interface getStoreList {
+            /** 页码 */
+            page?: number;
+            /** 每页数量 */
+            pageSize?: number;
+            /** 门店基础信息查询块 */
+            basicInfoQuery?: QueryBlock.BasicInfo;
+            /** 门店结算信息查询块 */
+            settlementQuery?: QueryBlock.Settlement;
+            /** 门店仓配信息查询块 */
+            warehouseDeliveryQuery?: QueryBlock.WarehouseDelivery;
+            /** 门店分组查询块 */
+            storeGroupQuery?: QueryBlock.StoreGroup;
+            /** 需要返回的响应块（数据表）列表 */
+            responseBlocks?: STORE_SERVICE_ENUM.STORE_ENUM.RESPONSE_BLOCK_TYPE[];
+        }
+        /**
+         * 批量修改门店经营状态请求
+         */
+        interface batchUpdateBusinessStatus {
+            /** 门店ID列表 */
+            storeIds: number[];
+            /** 经营状态：0-未绑定负责人，1-营业中，2-已打烊 */
+            businessStatus: number;
+        }
+        /**
+         * 创建门店分组请求
+         */
+        interface createStoreGroup {
+            /** 标签名称 */
+            name: string;
+            /** 门店ID列表 */
+            storeIds?: string[];
+            /** 状态 */
+            status?: number;
+            /** 备注 */
+            remark?: string;
+        }
+        /**
+         * 编辑门店分组请求
+         */
+        interface editStoreGroup {
+            /** 标签ID */
+            tagId?: string;
+            /** 分组名称 */
+            tagName?: string;
+            /** 门店ID列表 */
+            storeIds: string[];
+        }
+        /**
+         * 删除门店分组请求
+         */
+        interface deleteStoreGroup {
+            /** 分组ID */
+            groupId: string;
+        }
+        /**
+         * 查询门店分组列表请求
+         */
+        interface getStoreGroupList {
+            tagName?: string;
+            /** 分页：页码 */
+            page?: number;
+            /** 分页：每页数量 */
+            pageSize?: number;
+        }
+        /**
+         * 查询门店分组标签列表请求
+         */
+        interface queryTagsByGroup {
+        }
+    }
+    /**
+     * 响应数据定义
+     */
+    namespace Response {
+        /**
+         * 创建门店响应
+         */
+        interface createStore {
+            /** 门店id */
+            storeId: number;
+            /** 门店信息 */
+            store: Entity.StoreBasicInfo;
+            /** 门店二维码（系统生成） */
+            qrCodeState: any;
+        }
+        /**
+         * 绑定店长响应
+         */
+        interface bindStoreManager {
+            /** 是否成功 */
+            success: boolean;
+            /** 同步的信息 */
+            syncedInfo: {
+                /** 联系电话（店长手机号） */
+                telephone: string;
+                /** 店长 Pandora ID */
+                storeManagerPandoraId: string;
+                /** 工作机 UID */
+                workPhoneUid: string;
+                /** 工作机企微 ID */
+                workPhoneWxCorpId: string;
+            };
+        }
+        /**
+         * 解绑店长响应
+         */
+        interface unbindStoreManager {
+            /** 是否成功 */
+            success: boolean;
+        }
+        /**
+         * 绑定BD响应
+         */
+        interface bindBD {
+            /** 是否成功 */
+            success: boolean;
+            /** BD 负责人 Pandora ID */
+            bdPandoraId: string;
+        }
+        /**
+         * 解绑BD响应
+         */
+        interface unbindBD {
+            /** 是否成功 */
+            success: boolean;
+        }
+        /**
+         * 绑定加盟商响应
+         */
+        interface bindFranchisee {
+            /** 是否成功 */
+            success: boolean;
+            /** 加盟商ID */
+            franchiseeId: string;
+        }
+        /**
+         * 解绑加盟商响应
+         */
+        interface unbindFranchisee {
+            /** 是否成功 */
+            success: boolean;
+        }
+        /**
+         * 编辑门店信息响应
+         */
+        interface updateStoreInfo {
+            /** 是否成功 */
+            success: boolean;
+            /** 更新后的门店完整信息 */
+            store?: Entity.StoreFullInfo;
+        }
+        /**
+         * 更新群直播时间响应
+         */
+        interface updateLiveTime {
+            /** 是否成功 */
+            success: boolean;
+            /** 直播时间 */
+            liveTime: number;
+        }
+        /**
+         * 门店继承响应
+         */
+        interface inheritStore {
+            /** 是否成功 */
+            success: boolean;
+            /** 门店承接类型 */
+            storeUndertakingType: number;
+        }
+        /**
+         * 获取门店详情响应
+         */
+        interface getStoreDetail {
+            /** 门店完整信息 */
+            store: Entity.StoreFullInfo;
+        }
+        /**
+         * 批量获取门店信息响应
+         */
+        interface batchGetStoreInfo {
+            /** 门店信息列表 */
+            stores: Array<{
+                /** 门店ID */
+                storeId: number;
+                /** 门店基础信息（如果请求了该块） */
+                basicInfo?: Entity.StoreBasicInfo;
+                /** 门店结算信息（如果请求了该块） */
+                settlement?: Entity.StoreSettlement;
+                /** 门店仓配信息（如果请求了该块） */
+                warehouseDelivery?: Entity.StoreWarehouseDelivery;
+                /** 门店分组信息（如果请求了该块） */
+                storeGroup?: Entity.StoreGroup;
+            }>;
+            /** 未找到的门店ID列表 */
+            notFoundStoreIds?: number[];
+        }
+        /**
+         * 获取门店列表响应
+         */
+        interface getStoreList {
+            /** 门店列表 */
+            stores: Array<{
+                /** 门店ID */
+                storeId: number;
+                /** 门店基础信息（如果请求了该块） */
+                basicInfo?: Entity.StoreBasicInfo;
+                /** 门店结算信息（如果请求了该块） */
+                settlement?: Entity.StoreSettlement;
+                /** 门店仓配信息（如果请求了该块） */
+                warehouseDelivery?: Entity.StoreWarehouseDelivery;
+                /** 门店分组信息（如果请求了该块） */
+                storeGroup?: Entity.StoreGroup;
+            }>;
+            /** 总数 */
+            total: number;
+            /** 当前页 */
+            page: number;
+            /** 每页数量 */
+            pageSize: number;
+        }
+        /**
+         * 批量修改门店经营状态响应
+         */
+        interface batchUpdateBusinessStatus {
+            /** 是否成功 */
+            success: boolean;
+            /** 成功更新的门店ID列表 */
+            updatedStoreIds: number[];
+            /** 失败的门店列表 */
+            failedStores?: Array<{
+                /** 门店ID */
+                storeId: number;
+                /** 失败原因 */
+                reason: string;
+            }>;
+        }
+        /**
+         * 创建门店分组响应
+         */
+        interface createStoreGroup {
+            /** 分组ID */
+            tagId: string;
+        }
+        /**
+         * 编辑门店分组响应
+         */
+        interface editStoreGroup {
+            /** 是否成功 */
+            successCount: number;
+        }
+        /**
+         * 删除门店分组响应
+         */
+        interface deleteStoreGroup {
+            /** 是否成功 */
+            success: boolean;
+        }
+        /**
+         * 查询门店分组列表响应
+         */
+        interface getStoreGroupList {
+            /** 标签列表 */
+            tags: Array<{
+                /** 标签ID */
+                tagId: string;
+                /** 标签名称 */
+                tagName: string;
+                /** 标签分组ID */
+                groupId: string;
+                /** 标签状态 */
+                status: number;
+                /** 标签备注 */
+                remark?: string;
+                /** 创建时间 */
+                createdAt: number;
+                /** 标签绑定对象的数量 */
+                bindCount: number;
+            }>;
+            /** 总数 */
+            total: number;
+            /** 当前页 */
+            page: number;
+            /** 每页数量 */
+            pageSize: number;
+        }
+        /**
+         * 查询门店分组标签列表响应
+         */
+        interface queryTagsByGroup {
+            /** 标签列表 */
+            tags: Array<{
+                /** 标签ID */
+                tagId: string;
+                /** 标签名称 */
+                tagName: string;
+                /** 标签状态 */
+                status: number;
+                /** 创建时间 */
+                createdAt: number;
+            }>;
+        }
+    }
+    /**
+     * Store Controller 接口定义
+     */
+    namespace Controller {
+        interface StoreController {
+            /**
+             * 创建门店
+             */
+            createStore(request: StoreService.Request.createStore): Promise<StandardResponse<StoreService.Response.createStore>>;
+            /**
+             * 绑定店长
+             */
+            bindStoreManager(request: StoreService.Request.bindStoreManager): Promise<StandardResponse<StoreService.Response.bindStoreManager>>;
+            /**
+             * 解绑店长
+             */
+            unbindStoreManager(request: StoreService.Request.unbindStoreManager): Promise<StandardResponse<StoreService.Response.unbindStoreManager>>;
+            /**
+             * 绑定BD
+             */
+            bindBD(request: StoreService.Request.bindBD): Promise<StandardResponse<StoreService.Response.bindBD>>;
+            /**
+             * 解绑BD
+             */
+            unbindBD(request: StoreService.Request.unbindBD): Promise<StandardResponse<StoreService.Response.unbindBD>>;
+            /**
+             * 绑定加盟商
+             */
+            bindFranchisee(request: StoreService.Request.bindFranchisee): Promise<StandardResponse<StoreService.Response.bindFranchisee>>;
+            /**
+             * 解绑加盟商
+             */
+            unbindFranchisee(request: StoreService.Request.unbindFranchisee): Promise<StandardResponse<StoreService.Response.unbindFranchisee>>;
+            /**
+             * 编辑门店信息
+             */
+            updateStoreInfo(request: StoreService.Request.updateStoreInfo): Promise<StandardResponse<StoreService.Response.updateStoreInfo>>;
+            /**
+             * 批量修改门店经营状态
+             */
+            batchUpdateBusinessStatus(request: StoreService.Request.batchUpdateBusinessStatus): Promise<StandardResponse<StoreService.Response.batchUpdateBusinessStatus>>;
+            /**
+             * 更新群直播时间
+             */
+            updateLiveTime(request: StoreService.Request.updateLiveTime): Promise<StandardResponse<StoreService.Response.updateLiveTime>>;
+            /**
+             * 门店继承
+             */
+            inheritStore(request: StoreService.Request.inheritStore): Promise<StandardResponse<StoreService.Response.inheritStore>>;
+            /**
+             * 获取门店详情
+             */
+            getStoreDetail(request: StoreService.Request.getStoreDetail): Promise<StandardResponse<StoreService.Response.getStoreDetail>>;
+            /**
+             * 批量获取门店信息
+             */
+            batchGetStoreInfo(request: StoreService.Request.batchGetStoreInfo): Promise<StandardResponse<StoreService.Response.batchGetStoreInfo>>;
+            /**
+             * 获取门店列表
+             */
+            getStoreList(request: StoreService.Request.getStoreList): Promise<StandardResponse<StoreService.Response.getStoreList>>;
+            /**
+             * 创建门店分组
+             */
+            createStoreGroup(request: StoreService.Request.createStoreGroup): Promise<StandardResponse<StoreService.Response.createStoreGroup>>;
+            /**
+             * 编辑门店分组
+             */
+            editStoreGroup(request: StoreService.Request.editStoreGroup): Promise<StandardResponse<StoreService.Response.editStoreGroup>>;
+            /**
+             * 删除门店分组
+             */
+            deleteStoreGroup(request: StoreService.Request.deleteStoreGroup): Promise<StandardResponse<StoreService.Response.deleteStoreGroup>>;
+            /**
+             * 查询门店分组列表
+             */
+            getStoreGroupList(request: StoreService.Request.getStoreGroupList): Promise<StandardResponse<StoreService.Response.getStoreGroupList>>;
+            /**
+             * 查询门店分组标签列表
+             */
+            queryTagsByGroup(request: StoreService.Request.queryTagsByGroup): Promise<StandardResponse<StoreService.Response.queryTagsByGroup>>;
+        }
+    }
+}