ls-pro-common 3.1.45 → 3.1.47

package/lib/http/mdmRequest.d.ts

@@ -1,85 +1,137 @@
+/**
+ * 设置分页，默认取50000条
+ *
+ * @param params
+ */
 export declare const setPageSize: (params?: Record<string, any>) => void;
+/** 主数据接口地址 */
+export declare const mdmApi: {
+    owner: string;
+    store: string;
+    brandDept: string;
+    logisticRegion: string;
+    expressCompany: string;
+    expressCompanyPage: string;
+    physicalStore: string;
+    settleCategory: string;
+    profitLossMain: string;
+    settleCompany: string;
+    powerUnit: string;
+    settleAccount: string;
+    logisticCategory: string;
+    managingCity: string;
+    area: string;
+    transportLocno: string;
+    transportPointPage: string;
+    uploadPointPage: string;
+    shopPage: string;
+    color: string;
+    sizeType: string;
+    gender: string;
+    year: string;
+    season: string;
+    category: string;
+    supplier: string;
+};
 /**
  * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取主数据货主数据，调用接口/lesoon-mdm-center-api/bmOwner/page
  * @returns
  */
-export declare const getOwner: (params?: any) => Promise<any>;
+export declare const getOwner: (params?: any, cache?: boolean) => Promise<any>;
 /**
  * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取主数据仓库数据，调用接口/lesoon-mdm-center-api/bmStore/page
  * @returns
  */
-export declare const getStore: (params?: any) => Promise<any>;
+export declare const getStore: (params?: any, cache?: boolean) => Promise<any>;
 /**
  * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取主数据品牌部数据，调用接口/lesoon-mdm-center-api/bmBrandDept/page
  * @returns
  */
-export declare const getBrandDept: (params?: any) => Promise<any>;
+export declare const getBrandDept: (params?: any, cache?: boolean) => Promise<any>;
 /**
  * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取主数据物流大区数据，调用接口/lesoon-mdm-center-api/bmLogisticRegion/page
  * @returns
  */
-export declare const getLogisticRegion: (params?: any) => Promise<any>;
+export declare const getLogisticRegion: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param where: {forwarderLevel: 1 // 承运商级别 1:一级 2:二级 , forwarderType: 1 // 承运商类型 0:货运公司 1:快递公司 }
+ * @param params 请求参数 {where:{forwarderLevel: 1 // 承运商级别 1:一级 2:二级 , forwarderType: 1 // 承运商类型
+ *     0:货运公司 1:快递公司 }}
+ * @param cache 是否启用缓存
  * @name 获取快递/快运承运商，调用接口/lesoon-mdm-center-api/bmForwarder/page
  * @returns
  */
-export declare const getExpressCompany: (params?: any) => Promise<any>;
+export declare const getExpressCompany: (params?: any, cache?: boolean) => Promise<any>;
 /**
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 分页获取快递公司/承运商，调用接口/lesoon-mdm-center-api/bmForwarder/pageVo
  * @returns
  */
-export declare const getExpressCompanyPage: (params?: any) => Promise<any>;
+export declare const getExpressCompanyPage: (params?: any, cache?: boolean) => Promise<any>;
 /**
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 实体仓，调用接口/lesoon-mdm-center-api/bmPhysicalStore/page
  * @returns
  */
-export declare const getPhysicalStore: (params?: any) => Promise<any>;
+export declare const getPhysicalStore: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param params
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 结算大类，调用接口/lesoon-mdm-center-api/bmSettlementCate/page
  * @returns
  */
-export declare const getSettleCategory: (params?: any) => Promise<any>;
+export declare const getSettleCategory: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取损益主体，调用接口/lesoon-mdm-center-api/bmProfitLossMain/page
  * @returns
  */
-export declare const getProfitLossMain: (param?: any) => Promise<any>;
+export declare const getProfitLossMain: (param?: any, cache?: boolean) => Promise<any>;
 /**
- * @param params
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 结算公司，调用接口/lesoon-mdm-center-api/bmSettleCompany/page
  * @returns
  */
-export declare const getSettleCompany: (params?: any) => Promise<any>;
+export declare const getSettleCompany: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param params
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 货权，调用接口/lesoon-mdm-center-api/bmPowerUnit/page
  * @returns
  */
-export declare const getPowerUnit: (params?: any) => Promise<any>;
+export declare const getPowerUnit: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param params
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 结算账号，调用接口/lesoon-mdm-center-api/bmSettleAccount/page
  * @returns
  */
-export declare const getSettleAccount: (params?: any) => Promise<any>;
+export declare const getSettleAccount: (params?: any, cache?: boolean) => Promise<any>;
 /**
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取物流大类，调用接口/lesoon-mdm-center-api/bmLogisticCategory/page
  * @returns
  */
-export declare const getLogisticCategory: (params?: any) => Promise<any>;
+export declare const getLogisticCategory: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 管理城市，调用接口/lesoon-mdm-center-api/bmManagingCity/page
  * @returns
  */
-export declare const getManagingCity: (params?: any) => Promise<any>;
+export declare const getManagingCity: (params?: any, cache?: boolean) => Promise<any>;
 interface AreaParams {
     where?: {
         level?: 'province' | 'city' | 'district';
@@ -88,106 +140,129 @@ interface AreaParams {
     [key: string]: any;
 }
 /**
- * @param {where: {level:'province'}} level Province=省,city=市,district=区
+ * @param params 请求参数 {where: {level:'province'}} level Province=省,city=市,district=区
+ * @param cache 是否启用缓存
  * @name 获取省市区，调用接口/lesoon-mdm-center-api/sysAdministrativeDivision/page
  * @returns
  */
-export declare const getArea: (params?: AreaParams) => Promise<any>;
+export declare const getArea: (params?: AreaParams, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取集散中心，调用接口/lesoon-mdm-center-api/tmsTransportLocno/page
  * @returns
  */
-export declare const getTransportLocno: (params?: any) => Promise<any>;
+export declare const getTransportLocno: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 分页获取配送点，调用接口/lesoon-mdm-center-api/tmsTransportPoint/getTransportPointByPage
  * @returns
  */
-export declare const getTransportPointPage: (params?: any) => Promise<any>;
+export declare const getTransportPointPage: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 分页获取卸货点，调用接口/lesoon-mdm-center-api/tmsUploadPoint/findTmpUploadPintList
  * @returns
  */
-export declare const getUploadPointPage: (params?: any) => Promise<any>;
+export declare const getUploadPointPage: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 分页获取店铺，调用接口/lesoon-mdm-center-api/bmShop/pageVo
  * @returns
  */
-export declare const getShopPage: (params?: any) => Promise<any>;
+export declare const getShopPage: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取颜色，调用接口/lesoon-mdm-center-api/bmColor/page
  * @returns
  */
-export declare const getColor: (params?: any) => Promise<any>;
+export declare const getColor: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取尺码类型，调用接口/lesoon-mdm-center-api/bmSizeType/page
  * @returns
  */
-export declare const getSizeType: (params?: any) => Promise<any>;
+export declare const getSizeType: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取性别，调用接口/lesoon-mdm-center-api/bmGender/page
  * @returns
  */
-export declare const getGender: (params?: any) => Promise<any>;
+export declare const getGender: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取年份，调用接口/lesoon-mdm-center-api/bmYear/page
  * @returns
  */
-export declare const getYear: (params?: any) => Promise<any>;
+export declare const getYear: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取季节，调用接口/lesoon-mdm-center-api/bmSeason/page
  * @returns
  */
-export declare const getSeason: (params?: any) => Promise<any>;
+export declare const getSeason: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param param
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 获取品类，调用接口/lesoon-mdm-center-api/bmCategory/page
  * @returns
  */
-export declare const getCategory: (params?: any) => Promise<any>;
+export declare const getCategory: (params?: any, cache?: boolean) => Promise<any>;
 /**
- * @param params 查询参数
+ * @param params 请求参数
+ * @param cache 是否启用缓存
  * @name 供应商，调用接口/lesoon-mdm-center-api/bmSupplier/page
  * @returns
  */
-export declare const getSupplier: (params?: any) => Promise<any>;
+export declare const getSupplier: (params?: any, cache?: boolean) => Promise<any>;
+/** 主数据类型映射 */
 declare const mdmMap: {
-    owner: (params?: any) => Promise<any>;
-    store: (params?: any) => Promise<any>;
-    brandDept: (params?: any) => Promise<any>;
-    logisticRegion: (params?: any) => Promise<any>;
-    expressCompany: (params?: any) => Promise<any>;
-    expressCompanyPage: (params?: any) => Promise<any>;
-    physicalStore: (params?: any) => Promise<any>;
-    settleCategory: (params?: any) => Promise<any>;
-    profitLossMain: (param?: any) => Promise<any>;
-    settleCompany: (params?: any) => Promise<any>;
-    powerUnit: (params?: any) => Promise<any>;
-    settleAccount: (params?: any) => Promise<any>;
-    logisticCategory: (params?: any) => Promise<any>;
-    managingCity: (params?: any) => Promise<any>;
-    area: (params?: AreaParams) => Promise<any>;
-    transportLocno: (params?: any) => Promise<any>;
-    transportPointPage: (params?: any) => Promise<any>;
-    uploadPointPage: (params?: any) => Promise<any>;
-    shopPage: (params?: any) => Promise<any>;
-    color: (params?: any) => Promise<any>;
-    sizeType: (params?: any) => Promise<any>;
-    gender: (params?: any) => Promise<any>;
-    year: (params?: any) => Promise<any>;
-    season: (params?: any) => Promise<any>;
-    category: (params?: any) => Promise<any>;
-    supplier: (params?: any) => Promise<any>;
+    owner: (params?: any, cache?: boolean) => Promise<any>;
+    store: (params?: any, cache?: boolean) => Promise<any>;
+    brandDept: (params?: any, cache?: boolean) => Promise<any>;
+    logisticRegion: (params?: any, cache?: boolean) => Promise<any>;
+    expressCompany: (params?: any, cache?: boolean) => Promise<any>;
+    expressCompanyPage: (params?: any, cache?: boolean) => Promise<any>;
+    physicalStore: (params?: any, cache?: boolean) => Promise<any>;
+    settleCategory: (params?: any, cache?: boolean) => Promise<any>;
+    profitLossMain: (param?: any, cache?: boolean) => Promise<any>;
+    settleCompany: (params?: any, cache?: boolean) => Promise<any>;
+    powerUnit: (params?: any, cache?: boolean) => Promise<any>;
+    settleAccount: (params?: any, cache?: boolean) => Promise<any>;
+    logisticCategory: (params?: any, cache?: boolean) => Promise<any>;
+    managingCity: (params?: any, cache?: boolean) => Promise<any>;
+    area: (params?: AreaParams, cache?: boolean) => Promise<any>;
+    transportLocno: (params?: any, cache?: boolean) => Promise<any>;
+    transportPointPage: (params?: any, cache?: boolean) => Promise<any>;
+    uploadPointPage: (params?: any, cache?: boolean) => Promise<any>;
+    shopPage: (params?: any, cache?: boolean) => Promise<any>;
+    color: (params?: any, cache?: boolean) => Promise<any>;
+    sizeType: (params?: any, cache?: boolean) => Promise<any>;
+    gender: (params?: any, cache?: boolean) => Promise<any>;
+    year: (params?: any, cache?: boolean) => Promise<any>;
+    season: (params?: any, cache?: boolean) => Promise<any>;
+    category: (params?: any, cache?: boolean) => Promise<any>;
+    supplier: (params?: any, cache?: boolean) => Promise<any>;
 };
+/** 主数据类型 */
 export declare type MdmType = keyof typeof mdmMap;
-export declare const getMdmData: (type: MdmType, params?: any) => Promise<any>;
-export declare const clearMdmCache: () => void;
+/**
+ * 通用获取主数据方法
+ *
+ * @param type 主数据类型
+ * @param params 请求参数
+ * @param cache 是否启用缓存
+ * @returns
+ */
+export declare const getMdmData: (type: MdmType, params?: any, cache?: boolean) => Promise<any>;
+/** 清空主数据缓存 */
+export declare const clearMdmCache: (keys?: string[] | undefined) => void;
 export {};