@polyv/product-sdk 1.0.0-rc-20250612.3

package/index.es.d.ts

@@ -0,0 +1,1520 @@
+import { ChannelProductPushingStatusInfo as ChannelProductPushingStatusInfo_2 } from '@polyv/iar-core-sdk';
+import { CommonResult } from '@polyv/iar-core-sdk';
+import { EventEmitter } from '@polyv/utils/es/event';
+import { InteractionReceiveCore } from '@polyv/iar-core-sdk';
+import { PageContent } from '@polyv/iar-core-sdk';
+import { PageOptions } from '@polyv/iar-core-sdk';
+
+export declare class Address {
+    iarCore: InteractionReceiveCore;
+    config: ProductSDKConfig;
+    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    /**
+     * 获取地址列表
+     * @param params 分页参数
+     * @example
+     * ```js
+     * const data = await addressTarget.getAddressList({ pageNumber: 1, pageSize: 10 });
+     * console.log('地址列表', data.contents);
+     * ```
+     */
+    getAddressList(options?: PageOptions): Promise<PageContent<AddressData>>;
+    /**
+     * 获取默认地址
+     * @example
+     * ```js
+     * const data = await addressTarget.getDefaultAddress();
+     * console.log('默认地址', data);
+     */
+    getDefaultAddress(): Promise<AddressData>;
+    /**
+     * 新增地址
+     * @param params 新增地址参数
+     * @example
+     * ```js
+     * const data = await addressTarget.addAddress({
+     *   phone: '13800138000',
+     *   name: '张三',
+     *   area: '广东省/广州市/番禺区',
+     *   address: '国家创新创业基地',
+     * });
+     * console.log('新增地址', data);
+     */
+    addAddress(params: AddressBasicData): Promise<AddressData>;
+    /**
+     * 修改地址
+     * @param params 修改地址参数
+     * @example
+     * ```js
+     * await addressTarget.updateAddress({
+     *   id: '123',
+     *   address: '国家创新创业基地',
+     *   area: '广东省/广州市/番禺区',
+     *   phone: '13800138000',
+     *   name: '张三',
+     * });
+     */
+    updateAddress(params: EditAddressParams): Promise<void>;
+    /**
+     * 删除地址
+     * @param id 地址 id
+     * @example
+     * ```js
+     * await addressTarget.deleteAddress('123');
+     * ```
+     */
+    deleteAddress(id: string): Promise<void>;
+}
+
+/**
+ * 地址基础信息
+ */
+export declare interface AddressBasicData {
+    /**
+     * 地址
+     */
+    address: string;
+    /**
+     * 所在地区
+     */
+    area: string;
+    /**
+     * 手机号
+     */
+    mobile: string;
+    /**
+     * 收货人姓名
+     */
+    name: string;
+}
+
+/**
+ * 地址信息
+ */
+export declare interface AddressData extends AddressBasicData {
+    /**
+     * 地址id
+     */
+    id: string;
+}
+
+/**
+ * 退款接口响应
+ */
+export declare interface ApplyOrderRefundResponse {
+    /**
+     * 退款状态
+     */
+    refundStatus: RefundStatus;
+}
+
+/**
+ * 部分观看条件类型
+ */
+export declare enum AuthType {
+    /**
+     * 无条件观看
+     */
+    None = "none",
+    /**
+     * 自定义授权
+     */
+    Custom = "custom",
+    /**
+     * 外部授权
+     */
+    External = "external",
+    /**
+     * 独立授权
+     */
+    Direct = "direct",
+    /**
+     * 企业微信授权
+     */
+    EnterpriseWeChat = "enterpriseWeChat"
+}
+
+/**
+ * 频道商品热卖中文案
+ */
+export declare interface ChannelProductHotEffectTips {
+    /**
+     * 金融产品热卖中文案
+     */
+    financeProductTips: string;
+    /**
+     * 职位产品热卖中文案
+     */
+    jobProductTips: string;
+    /**
+     * 普通产品热卖中文案
+     */
+    normalProductTips: string;
+}
+
+/**
+ * 频道商品推送状态信息
+ */
+export declare interface ChannelProductPushingStatusInfo {
+    productId: number;
+    pushRule: ProductPushRule;
+}
+
+/**
+ * 创建订单失败原因
+ */
+export declare enum CreateOrderFailReason {
+    Unknown = "unknown"
+}
+
+/**
+ * 创建订单参数
+ */
+export declare interface CreateOrderParams {
+    /**
+     * 物流信息
+     */
+    address: AddressBasicData;
+    /**
+     * 购买商品
+     */
+    products: CreateOrderProductItem[];
+    /**
+     * 支付方式
+     */
+    payProvider: PaymentProvider;
+}
+
+export declare interface CreateOrderProductItem {
+    /**
+     * 商品 ID
+     */
+    productId: number;
+    /**
+     * 购买数量
+     */
+    quantity: number;
+}
+
+/**
+ * 创建订单接口响应
+ */
+export declare interface CreateOrderResponse {
+    /**
+     * 支付类型
+     * 微信支付下 jsapi | native
+     * 支付宝支付下 qrCode
+     */
+    type: string;
+    /**
+     * 支付宝支付链接
+     */
+    aliPayLink: string;
+    /**
+     * 订单号
+     */
+    orderNo: string;
+    /**
+     * 支付状态
+     */
+    payStatus: PayStatus;
+    /**
+     * 微信支付 appId
+     */
+    wxAppId: string;
+    /**
+     * 微信支付签名随机串
+     */
+    nonceStr: string;
+    /**
+     * 微信支付参数
+     */
+    package: string;
+    /**
+     * 微信支付签名
+     */
+    paySign: string;
+    /**
+     * 微信支付签名方式
+     */
+    signType: string;
+    /**
+     * 微信支付签名时间戳
+     */
+    timeStamp: number;
+    /**
+     * 当前支付方式
+     */
+    payProvider: PaymentProvider;
+}
+
+/**
+ * 编辑地址传给接口的参数，其中 area 地区以 / 连接
+ */
+export declare interface EditAddressParams extends AddressBasicData {
+    /**
+     * 地址id
+     */
+    id: string;
+}
+
+/**
+ * 金融商品数据
+ */
+export declare interface FinanceProductData extends ProductBasicData, ProductLinkData, ProductExplainData {
+    /**
+     * 商品类型
+     */
+    productType: ProductType.Finance;
+    /**
+     * 收益率
+     */
+    yield: string;
+}
+
+/**
+ * 获取订单详情参数
+ */
+export declare interface GetOrderDetailParams {
+    /**
+     * 订单号
+     */
+    orderNo: string;
+    /**
+     * 是否同步订单最新状态
+     */
+    syncPayStatus: boolean;
+}
+
+/**
+ * 序号参数
+ */
+export declare interface GetProductListDisplayNumberParams {
+    /**
+     * 商品序号
+     */
+    displayNumber?: number;
+    /**
+     * 获取数量
+     * @default 10
+     */
+    count?: number;
+}
+
+export declare interface GetProductListParams {
+    /**
+     * 获取数量
+     * @default 10
+     */
+    count?: number;
+    /**
+     * 商品序号
+     */
+    displayNumber?: number;
+    /**
+     * 标签 id
+     */
+    tagId?: number;
+    /**
+     * 关键词
+     */
+    keyword?: string;
+    /**
+     * 页数，仅传入 `tagId` 或 `keyword` 时生效
+     */
+    page?: number;
+}
+
+export declare type MaybePromise<R> = () => Promise<R> | R;
+
+/**
+ * 普通商品数据
+ */
+export declare interface NormalProductData extends ProductBasicData, ProductLinkData, ProductExplainData {
+    /**
+     * 商品类型
+     */
+    productType: ProductType.Normal;
+    /**
+     * 购买类型
+     */
+    buyType: ProductBuyType;
+    /**
+     * 价格类型
+     */
+    priceType: ProductPriceType;
+    /**
+     * 价格
+     */
+    realPrice: number;
+    /**
+     * 原价
+     */
+    originPrice: number;
+    /**
+     * 自定义价格
+     */
+    customPrice: string;
+    /**
+     * 是否开价
+     */
+    priceVisible: boolean;
+    /**
+     * 履约方式
+     */
+    deliveryType: ProductDeliveryType;
+    /**
+     * 客服联系方式(二维码图片地址), 渠道码被删除则没有值
+     */
+    customerServiceContact: string;
+    /**
+     * 客服方式
+     */
+    customerServiceType: ProductServiceType;
+    /**
+     * 库存开关
+     */
+    stockEnabled: boolean;
+    /**
+     * 库存
+     */
+    stock: number;
+}
+
+export declare class Order {
+    iarCore: InteractionReceiveCore;
+    config: ProductSDKConfig;
+    OrderStatus: typeof OrderStatus;
+    PayStatus: typeof PayStatus;
+    PaymentProvider: typeof PaymentProvider;
+    ProductBuyType: typeof ProductBuyType;
+    ProductType: typeof ProductType;
+    ProductDeliveryType: typeof ProductDeliveryType;
+    RefundStatus: typeof RefundStatus;
+    CreateOrderFailReason: typeof CreateOrderFailReason;
+    OrderRefundFailReason: typeof OrderRefundFailReason;
+    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    /**
+     * 获取订单列表
+     * @param params 获取参数
+     * @example
+     * ```js
+     * const data = await orderTarget.getOrderList({ pageNumber: 1, pageSize: 10 });
+     * console.log('订单列表', data.contents);
+     * ```
+     */
+    getOrderList(params?: PageOptions & {
+        orderStatus?: OrderStatus;
+    }): Promise<PageContent<OrderData>>;
+    /**
+     * 获取订单详情
+     * @param params 获取参数
+     * @example
+     * ```js
+     * const data = await orderTarget.getOrderDetail({ orderNo: '1234567890' });
+     * console.log('订单详情', data);
+     * ```
+     */
+    getOrderDetail(params: GetOrderDetailParams): Promise<OrderData>;
+    /**
+     * 创建订单
+     * @param params 创建订单参数
+     * @example
+     * ```js
+     * const res = await orderTarget.createOrder({ address: { name: '张三', mobile: '13800138000', area: '广东省 广州市 天河区', address: '天河路1号' }, products: [{ productId: 1, quantity: 1 }], payProvider: PaymentProvider.Wechat });
+     * if (res.success) {
+     *   console.log('创建订单成功', res.orderNo);
+     * } else {
+     *   console.log('创建订单失败', res.failReason, res.failMessage);
+     * }
+     * ```
+     */
+    createOrder(params: CreateOrderParams): Promise<CommonResult<CreateOrderFailReason, CreateOrderResponse>>;
+    /**
+     * 确认收货
+     * @param orderNo 订单号
+     * @example
+     * ```js
+     * await orderTarget.confirmOrder('1234567890');
+     * ```
+     */
+    confirmOrder(orderNo: string): Promise<void>;
+    /**
+     * 申请退款
+     * @param orderNo 订单号
+     * @example
+     * ```js
+     * const res = await orderTarget.applyOrderRefund('1234567890');
+     * if (res.success) {
+     *   console.log('退款成功', res);
+     * } else {
+     *   console.log('退款失败', res.failReason, res.failMessage);
+     * }
+     * ```
+     */
+    applyOrderRefund(orderNo: string): Promise<CommonResult<OrderRefundFailReason, ApplyOrderRefundResponse>>;
+}
+
+/**
+ * 订单基础数据
+ */
+export declare interface OrderBasicData {
+    /**
+     * 订单金额
+     */
+    amount: number;
+    /**
+     * 频道号
+     */
+    channelId: number | null;
+    /**
+     * 购买商品
+     */
+    products: OrderProductData[];
+    /**
+     * 订单号
+     */
+    orderNo: string;
+    /**
+     * 创建时间（单位：毫秒）
+     */
+    createAt?: number;
+    /**
+     * 交易ID
+     */
+    transactionId?: string;
+    /**
+     * 是否开启物流
+     */
+    expressEnabled?: boolean;
+    /**
+     * 物流信息
+     */
+    expressInfo: AddressData;
+}
+
+/**
+ * 已关闭订单数据 (通常由未支付订单关闭)
+ */
+export declare interface OrderCloseData extends OrderBasicData {
+    status: OrderStatus.Close;
+    expiredAt: number;
+}
+
+/**
+ * 订单数据
+ */
+export declare type OrderData = OrderWaitPayData | OrderWaitDeliveryData | OrderDeliveringData | OrderFinishData | OrderCloseData | OrderRefundingData | OrderRefundedData;
+
+/**
+ * 待收货订单数据
+ */
+export declare interface OrderDeliveringData extends OrderPaidData {
+    status: OrderStatus.Delivering;
+    /**
+     * 发货时间（单位：毫秒）
+     */
+    deliveryAt: number;
+}
+
+/**
+ * 已完成订单数据
+ */
+export declare interface OrderFinishData extends OrderPaidData {
+    status: OrderStatus.Finish;
+    /**
+     * 发货时间（单位：毫秒）
+     */
+    deliveryAt: number;
+    /**
+     * 订单完成时间（单位：毫秒）
+     */
+    finishAt: number;
+}
+
+/**
+ * 已支付订单数据 (待发货、发货中、已完成、退款中、已退款的共同基础)
+ */
+declare interface OrderPaidData extends OrderBasicData {
+    /**
+     * 支付时间（单位：毫秒）
+     */
+    payAt: number;
+    transactionId: string;
+}
+
+/**
+ * 订单购买商品数据
+ */
+export declare interface OrderProductData {
+    /**
+     * 客服联系方式(二维码图片地址), 渠道码被删除则没有值
+     */
+    customerServiceContact: string;
+    /**
+     * 客服方式
+     */
+    customerServiceType: ProductServiceType;
+    /**
+     * 履约方式
+     */
+    deliveryType: ProductDeliveryType;
+    /**
+     * 商品封面
+     */
+    cover: string;
+    /**
+     * 商品名称
+     */
+    name: string;
+    /**
+     * 商品描述
+     */
+    description?: string;
+    /**
+     * 特色标签
+     */
+    featureTags?: string[];
+    /**
+     * 商品 ID
+     */
+    productId: number;
+    /**
+     * 商品快照ID
+     */
+    productSnapshotId: number;
+    /**
+     * 商品金额
+     */
+    realPrice: number;
+    /**
+     * 购买数量
+     */
+    quantity: number;
+    /**
+     * 商品总金额
+     */
+    totalAmount: number;
+}
+
+/**
+ * 已退款订单数据
+ */
+export declare interface OrderRefundedData extends OrderPaidData {
+    status: OrderStatus.Refunded;
+    /**
+     * 退款时间（单位：毫秒）
+     */
+    refundAt: number;
+    /**
+     * 发货时间（单位：毫秒）
+     */
+    deliveryAt?: number;
+    /**
+     * 订单过期时间（单位：毫秒）
+     */
+    expiredAt?: number;
+}
+
+/**
+ * 退款失败原因
+ */
+export declare enum OrderRefundFailReason {
+    Unknown = "unknown"
+}
+
+/**
+ * 退款中订单数据
+ */
+export declare interface OrderRefundingData extends OrderPaidData {
+    status: OrderStatus.Refunding;
+    /**
+     * 退款时间（单位：毫秒）
+     */
+    refundAt: number;
+    deliveryAt?: number;
+}
+
+/**
+ * 订单状态
+ */
+export declare enum OrderStatus {
+    /**
+     * 待支付
+     */
+    WaitPay = "wait_pay",
+    /**
+     * 待发货
+     */
+    WaitDelivery = "wait_delivery",
+    /**
+     * 待收货
+     */
+    Delivering = "delivering",
+    /**
+     * 已完成
+     */
+    Finish = "finish",
+    /**
+     * 已关闭
+     */
+    Close = "close",
+    /**
+     * 退款中
+     */
+    Refunding = "refunding",
+    /**
+     * 已退款
+     */
+    Refunded = "refunded"
+}
+
+/**
+ * 待发货订单数据
+ */
+export declare interface OrderWaitDeliveryData extends OrderPaidData {
+    status: OrderStatus.WaitDelivery;
+}
+
+/**
+ * 待支付订单数据
+ */
+export declare interface OrderWaitPayData extends OrderBasicData {
+    status: OrderStatus.WaitPay;
+    /**
+     * 订单过期时间（单位：毫秒）
+     */
+    expiredAt: number;
+}
+
+export declare class Payment {
+    iarCore: InteractionReceiveCore;
+    config: ProductSDKConfig;
+    PaymentProvider: typeof PaymentProvider;
+    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    /**
+     * 获取微信/支付宝支付参数
+     * @param options 支付订单参数
+     * @example
+     * ```js
+     * const data = await paymentTarget.payOrder({ orderNo: '1234567890', payProvider: PaymentProvider.Wechat });
+     * console.log('支付参数', data);
+     * ```
+     */
+    getPayOrderParams(options: PayOrderParams): Promise<CreateOrderResponse>;
+    /** 支付方式缓存 */
+    private __payProviderCache;
+    /**
+     * 获取支付方式
+     * @example
+     * ```js
+     * const data = await paymentTarget.getPayProviders();
+     * console.log('支付方式', data);
+     * ```
+     */
+    getPayProviders(): Promise<PaymentProvider[]>;
+}
+
+/**
+ * 支付方式
+ */
+export declare enum PaymentProvider {
+    /**
+     * 微信
+     */
+    Wechat = "WECHAT",
+    /**
+     * 支付宝
+     */
+    Alipay = "ALIPAY"
+}
+
+/**
+ * 请求参数
+ */
+declare interface PayOrderParams {
+    /**
+     * 订单号
+     */
+    orderNo: string;
+    /**
+     * 支付方式
+     */
+    payProvider: PaymentProvider;
+}
+
+/**
+ * 支付状态
+ */
+export declare enum PayStatus {
+    /**
+     * 待支付
+     */
+    WaitPay = "wait_pay",
+    /**
+     * 已支付
+     */
+    Payed = "payed",
+    /**
+     * 免费
+     */
+    Free = "free"
+}
+
+/**
+ * 职位商品数据
+ */
+export declare interface PositionProductData extends ProductBasicData, ProductLinkData, ProductExplainData {
+    /**
+     * 商品类型
+     */
+    productType: ProductType.Position;
+    /**
+     * 薪资/待遇
+     */
+    treatment: string;
+}
+
+/**
+ * 商品库 SDK 模块
+ */
+export declare class Product {
+    iarCore: InteractionReceiveCore;
+    config: ProductSDKConfig;
+    ProductType: typeof ProductType;
+    ProductLinkType: typeof ProductLinkType;
+    ProductLinkJumpWay: typeof ProductLinkJumpWay;
+    ProductBuyType: typeof ProductBuyType;
+    ProductStatus: typeof ProductStatus;
+    ProductEvents: typeof ProductEvents;
+    ProductPriceType: typeof ProductPriceType;
+    ProductExplainStatus: typeof ProductExplainStatus;
+    ProductMediaType: typeof ProductMediaType;
+    ProductDeliveryType: typeof ProductDeliveryType;
+    ProductServiceType: typeof ProductServiceType;
+    eventEmitter: EventEmitter<ProductEventsRelations, ProductEvents>;
+    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    /**
+     * 获取商品标签列表
+     * @param params 获取参数
+     * @example
+     * ```js
+     * const data = await productTarget.getProductTagList({ pageNumber: 1 });
+     * console.log('标签列表', data.contents);
+     * ```
+     */
+    getProductTagList(params?: PageOptions): Promise<PageContent<ProductTag>>;
+    /**
+     * 获取商品列表
+     *
+     * 该方法可通过 **商品序号**、**标签 id + 关键词** 两种方式获取商品列表，
+     * @param params 获取参数
+     * @example
+     * ```js
+     * // 通过商品序号获取：获取 12 号商品之后的商品列表
+     * const data = await productTarget.getProductList({ displayNumber: 12 });
+     *
+     * // 通过标签 id 或关键词获取：获取标签 id 为 8 的商品列表，并根据关键词 '水果' 进行搜索，页数为第 2 页
+     * const data = await productTarget.getProductList({ tagId: 8, keyword: '水果', page: 2 });
+     * ```
+     */
+    getProductList(params?: GetProductListParams): Promise<ProductListResult>;
+    /**
+     * 获取商品数据
+     * @param productId 商品 id
+     */
+    getProductData(productId: number): Promise<ProductData>;
+    /**
+     * 发送商品点击事件
+     *
+     * 当观众点击商品时，调用该方法发送商品点击事件
+     * @param params 发送参数
+     * @example
+     * ```js
+     * await productTarget.sendProductClickEvent({
+     *   productId: 123,
+     *   name: '商品名称',
+     *   productType: 'normal',
+     * });
+     * ```
+     */
+    sendProductClickEvent(params: SendProductClickParams): Promise<void>;
+    /**
+     * 关闭当前正在推送中的商品
+     *
+     * 当需要关闭 UI 层的推送节点时，调用该方法关闭当前正在推送中的商品
+     * @example
+     * ```js
+     * await productTarget.closeProductPush();
+     * ```
+     */
+    closeProductPush(): void;
+    /**
+     * 获取商品讲解开关
+     *
+     * 获取当前频道是否开启商品讲解
+     * @example
+     * ```js
+     * const enabled = await productTarget.getProductExplainEnabled();
+     * console.log('商品讲解开关', enabled);
+     * ```
+     */
+    getProductExplainEnabled(): Promise<boolean>;
+    /**
+     * 获取当前频道是否开启点击"外链购买"商品的封面/标题区域直接跳转外链
+     * @example
+     * ```js
+     * const enabled = await productTarget.getOutLinkProductRedirectEnabled();
+     * console.log('商品点击直接跳转外链开关', enabled);
+     * ```
+     */
+    getOutLinkProductRedirectEnabled(): Promise<boolean>;
+    /**
+     * 生成商品讲解页面地址
+     * @param params url 携带参数
+     * @example
+     * ```js
+     * const url = await productTarget.generateProductExplainPageUrl({ productId: 123 });
+     * console.log('商品讲解页面地址', url);
+     * ```
+     */
+    generateProductExplainPageUrl<T extends object = object>(params?: T): Promise<string | null>;
+    /**
+     * 获取商品支付订单是否开启
+     * @example
+     * ```js
+     * const enabled = await productTarget.getProductPayOrderEnabled();
+     * console.log('商品支付订单是否开启', enabled);
+     * ```
+     */
+    getProductPayOrderEnabled(): Promise<boolean>;
+    getCurrentPushingProduct(): Promise<ChannelProductPushingStatusInfo_2 | undefined>;
+    /**
+     * 判断当前用户是否支持直接购买商品
+     * @example
+     * ```js
+     * const supported = await productTarget.getSupportToDirectBuy();
+     * console.log('是否支持直接购买', supported);
+     * ```
+     */
+    getSupportToDirectBuy(): Promise<boolean>;
+    private __handleProductMessage;
+    private __handleRefreshProductList;
+    private __handleProductClickEvent;
+    private __handleProductClickTimes;
+}
+
+/**
+ * 商品基础数据
+ */
+export declare interface ProductBasicData {
+    /**
+     * 商品 id
+     */
+    productId: number;
+    /**
+     * 商品封面
+     */
+    cover: string;
+    /**
+     * 封面列表
+     */
+    coverList: string[];
+    /**
+     * 素材库视频列表
+     */
+    videoList: string[];
+    /**
+     * 商品媒体列表
+     */
+    mediaList: ProductMediaData[];
+    /**
+     * 商品名称
+     */
+    name: string;
+    /**
+     * 商品描述
+     */
+    description: string;
+    /**
+     * 商品详情
+     */
+    detail: string;
+    /**
+     * 商品状态
+     */
+    status: ProductStatus;
+    /**
+     * 商品序号
+     */
+    displayNumber: number;
+    /**
+     * 按钮文案
+     */
+    buttonText: string;
+    /**
+     * 特色标签
+     */
+    featureTags: string[];
+    /**
+     * 是否为置顶商品
+     */
+    isTopping?: boolean;
+}
+
+/**
+ * 商品购买类型
+ */
+export declare enum ProductBuyType {
+    /**
+     * 直接购买
+     */
+    DirectBuy = "inner",
+    /**
+     * 外链购买
+     */
+    Link = "link"
+}
+
+/**
+ * 商品配置
+ */
+export declare interface ProductConfig {
+    /**
+     * 埋点上报总开关
+     */
+    watchEventTrackEnabled: boolean;
+    /**
+     * 互动事件上报开关
+     */
+    productTrackEnabled?: boolean;
+    /**
+     * 当前推送的商品信息
+     */
+    channelProductPushingStatusVO?: ChannelProductPushingStatusInfo;
+    /**
+     * 商品讲解开关
+     */
+    productExplainEnabled: boolean;
+    /**
+     * 商品热卖中开关
+     */
+    productHotEffectEnabled?: boolean;
+    /**
+     * 商品热卖中文案
+     */
+    productHotEffectTips?: ChannelProductHotEffectTips;
+    /**
+     * 点击商品的封面/标题区域是否直接跳转外链
+     */
+    outLinkProductRedirectEnabled: boolean;
+    /**
+     * 商品订单入口是否显示
+     */
+    productPayOrderEnabled: boolean;
+}
+
+/**
+ * 商品数据
+ */
+export declare type ProductData = NormalProductData | FinanceProductData | PositionProductData;
+
+/**
+ * 履约方式
+ */
+export declare enum ProductDeliveryType {
+    /**
+     * 物流
+     */
+    Express = "express",
+    /**
+     * 无物流
+     */
+    Virtual = "virtual"
+}
+
+export declare enum ProductEvents {
+    /**
+     * 上架商品
+     */
+    OnSaleProduct = "OnSaleProduct",
+    /**
+     * 下架商品
+     */
+    OffSaleProduct = "OffSaleProduct",
+    /**
+     * 添加商品
+     */
+    AddProduct = "AddProduct",
+    /**
+     * 删除商品
+     */
+    DeleteProduct = "DeleteProduct",
+    /**
+     * 修改商品
+     */
+    ChangeProduct = "ChangeProduct",
+    /**
+     * 上移或下移商品
+     */
+    MoveProduct = "MoveProduct",
+    /**
+     * 修改商品排序
+     */
+    ChangeProductRank = "ChangeProductRank",
+    /**
+     * 商品售罄
+     */
+    ProductSoldOut = "ProductSoldOut",
+    /**
+     * 推送商品
+     */
+    PushProduct = "PushProduct",
+    /**
+     * 取消推送商品
+     */
+    CancelPushProduct = "CancelPushProduct",
+    /**
+     * 商品库列表开关
+     */
+    ProductListEnabled = "ProductListEnabled",
+    /**
+     * 刷新当前商品列表
+     */
+    RefreshProductList = "RefreshProductList",
+    /**
+     * 商品点击事件
+     */
+    ProductClick = "ProductClick",
+    /**
+     * 商品点击次数统计事件
+     */
+    ProductClickTimes = "ProductClickTimes"
+}
+
+export declare type ProductEventsRelations = {
+    [ProductEvents.OnSaleProduct]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+    };
+    [ProductEvents.OffSaleProduct]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+    };
+    [ProductEvents.AddProduct]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+    };
+    [ProductEvents.DeleteProduct]: {
+        /**
+         * 商品 id
+         */
+        productId: number;
+    };
+    [ProductEvents.ChangeProduct]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+    };
+    [ProductEvents.MoveProduct]: {
+        /**
+         * 发生改变的两个商品
+         */
+        targetProducts: [ProductData, ProductData];
+    };
+    [ProductEvents.ChangeProductRank]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+    };
+    [ProductEvents.ProductSoldOut]: {
+        /**
+         * 商品 id
+         */
+        productId: number;
+    };
+    [ProductEvents.PushProduct]: {
+        /**
+         * 商品数据
+         */
+        productData: ProductData;
+        /**
+         * 推送方式
+         */
+        pushRule: ProductPushRule;
+    };
+    [ProductEvents.CancelPushProduct]: {
+        /**
+         * 商品 id
+         */
+        productId?: number;
+    };
+    [ProductEvents.ProductListEnabled]: {
+        /**
+         * 开启或关闭
+         */
+        enabled: boolean;
+    };
+    [ProductEvents.ProductClick]: {
+        /**
+         * 商品 id
+         */
+        productId: number;
+        /**
+         * 商品名称
+         */
+        name: string;
+        /**
+         * 商品类型
+         */
+        productType: ProductType;
+    };
+    [ProductEvents.ProductClickTimes]: {
+        /**
+         * 商品 id
+         */
+        productId: number;
+        /**
+         * 商品名称
+         */
+        name: string;
+        /**
+         * 商品类型
+         */
+        productType: ProductType;
+        /**
+         * 点击次数
+         */
+        times: number;
+    };
+};
+
+/**
+ * 商品讲解数据
+ */
+export declare interface ProductExplainData {
+    /**
+     * 讲解状态
+     */
+    explainStatus?: ProductExplainStatus;
+    /**
+     * 讲解类型
+     */
+    explainType?: ProductExplainType;
+}
+
+/**
+ * 商品讲解状态
+ */
+export declare enum ProductExplainStatus {
+    /**
+     * 待讲解
+     */
+    NotExplained = "notExplained",
+    /**
+     * 讲解中
+     */
+    Explaining = "explaining",
+    /**
+     * 已讲解
+     */
+    Explained = "explained"
+}
+
+/**
+ * 商品讲解类型
+ */
+export declare enum ProductExplainType {
+    /**
+     * 直播中的讲解
+     */
+    Live = "live",
+    /**
+     * 回放中的讲解
+     */
+    Playback = "recordFile"
+}
+
+/**
+ * 商品链接数据
+ */
+export declare interface ProductLinkData {
+    /**
+     * 链接类型
+     */
+    linkType: ProductLinkType;
+    /**
+     * 跳转方式
+     */
+    jumpWay: ProductLinkJumpWay;
+    /**
+     * 通用平台跳转链接
+     */
+    link: string;
+    /**
+     * PC 端跳转链接
+     */
+    pcLink: string;
+    /**
+     * 移动端跳转链接
+     */
+    mobileLink: string;
+    /**
+     * App 链接
+     */
+    mobileAppLink: string;
+    /**
+     * 安卓端 app 跳转链接
+     */
+    androidLink: string;
+    /**
+     * iOS app 跳转链接
+     */
+    iosLink: string;
+    /**
+     * 其他链接
+     */
+    otherLink: string;
+    /**
+     * 微信小程序原始 id
+     */
+    wxMiniprogramOriginalId: string;
+    /**
+     * 微信小程序应用 id
+     */
+    wxMiniprogramAppId: string;
+    /**
+     * 微信小程序内页面路径及参数
+     */
+    wxMiniprogramLink: string;
+}
+
+/**
+ * 商品外链跳转方式
+ */
+export declare enum ProductLinkJumpWay {
+    /**
+     * iframe 弹框形式打开
+     */
+    PopUp = "POP_UP",
+    /**
+     * 新窗口打开
+     */
+    NewWindow = "NEW_WINDOW",
+    /**
+     * 当前窗口打开
+     */
+    CurrentWindow = "CURRENT_WINDOW"
+}
+
+/**
+ * 商品链接类型
+ */
+export declare enum ProductLinkType {
+    /**
+     * 通用链接
+     */
+    Normal = 10,
+    /**
+     * 多平台链接
+     */
+    MultiPlatform = 11,
+    /**
+     * 原生方法跳转
+     */
+    Native = 12
+}
+
+export declare interface ProductListResult {
+    /**
+     * 商品列表
+     */
+    contents: ProductData[];
+    /**
+     * 总数
+     */
+    total: number;
+    /**
+     * 置顶商品
+     */
+    toppingProduct?: ProductData;
+}
+
+/**
+ * 媒体数据
+ */
+export declare type ProductMediaData = ProductMediaImageData | ProductMediaMaterialVideoData;
+
+export declare interface ProductMediaImageData {
+    /**
+     * 媒体类型
+     */
+    type: ProductMediaType.Image;
+    /**
+     * 图片链接
+     */
+    url: string;
+}
+
+export declare interface ProductMediaMaterialVideoData {
+    /**
+     * 媒体类型
+     */
+    type: ProductMediaType.MaterialVideo;
+    /**
+     * 素材库 id
+     */
+    materialId: string;
+}
+
+/**
+ * 商品媒体类型
+ */
+export declare enum ProductMediaType {
+    /**
+     * 图片
+     */
+    Image = "image",
+    /**
+     * 素材库视频
+     */
+    MaterialVideo = "material-video"
+}
+
+/**
+ * 商品价格类型
+ */
+export declare enum ProductPriceType {
+    /**
+     * 金额
+     */
+    Amount = "AMOUNT",
+    /**
+     * 自定义
+     */
+    Custom = "CUSTOM"
+}
+
+/**
+ * 商品推送规则
+ */
+export declare enum ProductPushRule {
+    /**
+     * 大卡片
+     */
+    BigCard = "bigCard",
+    /**
+     * 小卡片
+     */
+    SmallCard = "smallCard"
+}
+
+export declare interface ProductSDKConfig {
+    /**
+     * 传入的商品配置
+     */
+    getProductConfig: MaybePromise<ProductConfig>;
+}
+
+/**
+ * 客服方式
+ */
+export declare enum ProductServiceType {
+    /**
+     * 渠道码
+     */
+    WxWorkCode = "wxWorkCode",
+    /**
+     * 自定义
+     */
+    Custom = "custom"
+}
+
+/**
+ * 商品状态
+ */
+export declare enum ProductStatus {
+    /**
+     * 上架
+     */
+    OnSale = 1,
+    /**
+     * 下架
+     */
+    OffSale = 0
+}
+
+/**
+ * 商品标签
+ */
+export declare interface ProductTag {
+    /**
+     * 标签 id
+     */
+    id: number;
+    /**
+     * 标签名
+     */
+    name: string;
+}
+
+/**
+ * 商品类型
+ */
+export declare enum ProductType {
+    /**
+     * 普通产品
+     */
+    Normal = "normal",
+    /**
+     * 金融产品
+     */
+    Finance = "finance",
+    /**
+     * 职位产品
+     */
+    Position = "position"
+}
+
+/**
+ * 退款状态
+ */
+export declare enum RefundStatus {
+    /**
+     * 成功
+     */
+    Success = "SUCCESS",
+    /**
+     * 失败
+     */
+    Fail = "FAIL",
+    /**
+     * 处理中
+     */
+    Processing = "PROCESSING"
+}
+
+export declare interface SendProductClickParams {
+    /**
+     * 商品 id
+     */
+    productId: number;
+    /**
+     * 商品名称
+     */
+    name: string;
+    /**
+     * 商品类型
+     */
+    productType: ProductType;
+}
+
+export { }