feat(channel): 支持商品辅助接口

Author: binarywang

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/WxChannelProductAssistantService.java

@@ -1,7 +1,77 @@
 package me.chanjar.weixin.channel.api;
 
+import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.BeginTimingSaleParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CancelTimingSaleParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CategoryPreCheckParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CategoryPreCheckResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingNewParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingNewResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ProductBrandRecommendParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ProductBrandRecommendResponse;
+import me.chanjar.weixin.common.error.WxErrorException;
+
 /**
  * 微信小店商品辅助功能服务。
  */
 public interface WxChannelProductAssistantService {
+
+  /**
+   * 发品前校验。
+   *
+   * @param param 校验参数
+   * @return 校验结果
+   * @throws WxErrorException 异常
+   */
+  CategoryPreCheckResponse categoryPreCheck(CategoryPreCheckParam param) throws WxErrorException;
+
+  /**
+   * 获取商品品牌推荐。
+   *
+   * @param param 推荐参数
+   * @return 推荐结果
+   * @throws WxErrorException 异常
+   */
+  ProductBrandRecommendResponse getProductBrandRecommend(ProductBrandRecommendParam param)
+    throws WxErrorException;
+
+  /**
+   * 获取站内外商品属性映射。
+   *
+   * @param param 映射参数
+   * @return 映射结果
+   * @throws WxErrorException 异常
+   */
+  ExternalProductMappingResponse externalProductMapping(ExternalProductMappingParam param)
+    throws WxErrorException;
+
+  /**
+   * 获取商品属性映射及推荐。
+   *
+   * @param param 映射参数
+   * @return 映射结果
+   * @throws WxErrorException 异常
+   */
+  ExternalProductMappingNewResponse externalProductMappingNew(ExternalProductMappingNewParam param)
+    throws WxErrorException;
+
+  /**
+   * 将定时开售商品改为立即开售。
+   *
+   * @param param 开售参数
+   * @return 操作结果
+   * @throws WxErrorException 异常
+   */
+  WxChannelBaseResponse beginTimingSale(BeginTimingSaleParam param) throws WxErrorException;
+
+  /**
+   * 取消商品定时开售。
+   *
+   * @param param 取消参数
+   * @return 操作结果
+   * @throws WxErrorException 异常
+   */
+  WxChannelBaseResponse cancelTimingSale(CancelTimingSaleParam param) throws WxErrorException;
 }

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/api/impl/WxChannelProductAssistantServiceImpl.java

@@ -1,6 +1,27 @@
 package me.chanjar.weixin.channel.api.impl;
 
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.BEGIN_TIMING_SALE_URL;
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.CANCEL_TIMING_SALE_URL;
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.CATEGORY_PRE_CHECK_URL;
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.EXTERNAL_PRODUCT_MAPPING_NEW_URL;
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.EXTERNAL_PRODUCT_MAPPING_URL;
+import static me.chanjar.weixin.channel.constant.WxChannelApiUrlConstants.Spu.PRODUCT_BRAND_RECOMMEND_URL;
+
 import me.chanjar.weixin.channel.api.WxChannelProductAssistantService;
+import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.BeginTimingSaleParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CancelTimingSaleParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CategoryPreCheckParam;
+import me.chanjar.weixin.channel.bean.product.assistant.CategoryPreCheckResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingNewParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingNewResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ExternalProductMappingResponse;
+import me.chanjar.weixin.channel.bean.product.assistant.ProductBrandRecommendParam;
+import me.chanjar.weixin.channel.bean.product.assistant.ProductBrandRecommendResponse;
+import me.chanjar.weixin.channel.util.JsonUtils;
+import me.chanjar.weixin.channel.util.ResponseUtils;
+import me.chanjar.weixin.common.error.WxErrorException;
 
 /**
  * 微信小店商品辅助功能服务实现。
@@ -13,4 +34,44 @@ public class WxChannelProductAssistantServiceImpl implements WxChannelProductAss
   public WxChannelProductAssistantServiceImpl(BaseWxChannelServiceImpl<?, ?> shopService) {
     this.shopService = shopService;
   }
+
+  @Override
+  public CategoryPreCheckResponse categoryPreCheck(CategoryPreCheckParam param) throws WxErrorException {
+    return post(CATEGORY_PRE_CHECK_URL, param, CategoryPreCheckResponse.class);
+  }
+
+  @Override
+  public ProductBrandRecommendResponse getProductBrandRecommend(ProductBrandRecommendParam param)
+    throws WxErrorException {
+    return post(PRODUCT_BRAND_RECOMMEND_URL, param, ProductBrandRecommendResponse.class);
+  }
+
+  @Override
+  public ExternalProductMappingResponse externalProductMapping(ExternalProductMappingParam param)
+    throws WxErrorException {
+    return post(EXTERNAL_PRODUCT_MAPPING_URL, param, ExternalProductMappingResponse.class);
+  }
+
+  @Override
+  public ExternalProductMappingNewResponse externalProductMappingNew(ExternalProductMappingNewParam param)
+    throws WxErrorException {
+    return post(EXTERNAL_PRODUCT_MAPPING_NEW_URL, param, ExternalProductMappingNewResponse.class);
+  }
+
+  @Override
+  public WxChannelBaseResponse beginTimingSale(BeginTimingSaleParam param) throws WxErrorException {
+    return post(BEGIN_TIMING_SALE_URL, param, WxChannelBaseResponse.class);
+  }
+
+  @Override
+  public WxChannelBaseResponse cancelTimingSale(CancelTimingSaleParam param) throws WxErrorException {
+    return post(CANCEL_TIMING_SALE_URL, param, WxChannelBaseResponse.class);
+  }
+
+  private <T extends WxChannelBaseResponse> T post(String url, Object param, Class<T> responseType)
+    throws WxErrorException {
+    String reqJson = JsonUtils.encode(param);
+    String resJson = shopService.post(url, reqJson);
+    return ResponseUtils.decode(resJson, responseType);
+  }
 }

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/BeginTimingSaleParam.java

@@ -0,0 +1,24 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 商品立即开售参数。
+ */
+@Data
+@NoArgsConstructor
+public class BeginTimingSaleParam implements Serializable {
+
+  private static final long serialVersionUID = -1525220756273987016L;
+
+  /** 商品 ID。 */
+  @JsonProperty("product_id")
+  private String productId;
+
+  /** 定时开售任务 ID。 */
+  @JsonProperty("task_id")
+  private String taskId;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/CancelTimingSaleParam.java

@@ -0,0 +1,20 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 取消商品开售参数。
+ */
+@Data
+@NoArgsConstructor
+public class CancelTimingSaleParam implements Serializable {
+
+  private static final long serialVersionUID = -3750831026611057323L;
+
+  /** 商品 ID。 */
+  @JsonProperty("product_id")
+  private String productId;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/CategoryPreCheckParam.java

@@ -0,0 +1,20 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 发品前校验参数。
+ */
+@Data
+@NoArgsConstructor
+public class CategoryPreCheckParam implements Serializable {
+
+  private static final long serialVersionUID = 3616569394767815856L;
+
+  /** 叶子类目 ID，不传时只校验店铺相关条件。 */
+  @JsonProperty("cat_id")
+  private Long catId;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/CategoryPreCheckResponse.java

@@ -0,0 +1,27 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
+
+/**
+ * 发品前校验响应。
+ */
+@Data
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public class CategoryPreCheckResponse extends WxChannelBaseResponse {
+
+  private static final long serialVersionUID = 8912798390684239592L;
+
+  /** 是否全部校验通过。 */
+  @JsonProperty("all_pass")
+  private Boolean allPass;
+
+  /** 校验不通过的原因。 */
+  @JsonProperty("fail_reasons")
+  private List<String> failReasons;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/ExternalAttribute.java

@@ -0,0 +1,24 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 商品属性键值对。
+ */
+@Data
+@NoArgsConstructor
+public class ExternalAttribute implements Serializable {
+
+  private static final long serialVersionUID = -8639178782951125101L;
+
+  /** 属性名。 */
+  @JsonProperty("key")
+  private String key;
+
+  /** 属性值。 */
+  @JsonProperty("value")
+  private String value;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/ExternalProductMappingNewParam.java

@@ -0,0 +1,41 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import java.util.List;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 商品属性映射及推荐参数。
+ */
+@Data
+@NoArgsConstructor
+public class ExternalProductMappingNewParam implements Serializable {
+
+  private static final long serialVersionUID = -4942505655791636645L;
+
+  /** 叶子类目 ID。 */
+  @JsonProperty("cat_id")
+  private Long catId;
+
+  /** 外部商品类目名称。 */
+  @JsonProperty("external_category_name")
+  private String externalCategoryName;
+
+  /** 商品主图，至少一张。 */
+  @JsonProperty("head_imgs")
+  private List<String> headImgs;
+
+  /** 商品详情图。 */
+  @JsonProperty("detail_imgs")
+  private List<String> detailImgs;
+
+  /** 商品标题。 */
+  @JsonProperty("title")
+  private String title;
+
+  /** 外部商品属性列表。 */
+  @JsonProperty("external_attributes")
+  private List<ExternalAttribute> externalAttributes;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/ExternalProductMappingNewResponse.java

@@ -0,0 +1,23 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
+
+/**
+ * 商品属性映射及推荐响应。
+ */
+@Data
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public class ExternalProductMappingNewResponse extends WxChannelBaseResponse {
+
+  private static final long serialVersionUID = -6192580254142696913L;
+
+  /** 映射属性结果。 */
+  @JsonProperty("attributes")
+  private List<ExternalAttribute> attributes;
+}

weixin-java-channel/src/main/java/me/chanjar/weixin/channel/bean/product/assistant/ExternalProductMappingParam.java

@@ -0,0 +1,32 @@
+package me.chanjar.weixin.channel.bean.product.assistant;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 站内外商品属性映射参数。
+ */
+@Data
+@NoArgsConstructor
+public class ExternalProductMappingParam implements Serializable {
+
+  private static final long serialVersionUID = 1944528166283981889L;
+
+  /** 叶子类目 ID。 */
+  @JsonProperty("cat_id")
+  private Long catId;
+
+  /** 外部商品属性名。 */
+  @JsonProperty("external_attribute_name")
+  private String externalAttributeName;
+
+  /** 外部商品属性值。 */
+  @JsonProperty("external_attribute_value")
+  private String externalAttributeValue;
+
+  /** 外部商品类目名称。 */
+  @JsonProperty("external_category_name")
+  private String externalCategoryName;
+}