🆕 #2018 【微信支付】增加营销代金券接口和营销专用图片上传接口

Co-authored-by: 黄星 <huang.xing@aquilaflycloud.com>

Author: thinsstar

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/FavorCallbacksSaveRequest.java

@@ -0,0 +1,70 @@
+package com.github.binarywang.wxpay.bean.marketing;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 设置消息通知地址
+ * <pre>
+ *   文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_12.shtml
+ * </pre>
+ *
+ * @author thinsstar
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class FavorCallbacksSaveRequest implements Serializable {
+
+  private static final long serialVersionUID = 1L;
+
+  /**
+   * <pre>
+   * 字段名：商户号
+   * 变量名：mchid
+   * 是否必填：是
+   * 类型：string[1,20]
+   * 描述：
+   *  微信支付商户号。
+   *  示例值：9856888
+   * </pre>
+   */
+  @SerializedName(value = "mchid")
+  private String mchid;
+
+  /**
+   * <pre>
+   * 字段名：通知url地址
+   * 变量名：notify_url
+   * 是否必填：是
+   * 类型：string[1,256]
+   * 描述：
+   *  支付通知商户url地址。
+   *  示例值：https://pay.weixin.qq.com
+   * </pre>
+   */
+  @SerializedName(value = "notify_url")
+  private String notifyUrl;
+
+  /**
+   * <pre>
+   * 字段名：回调开关
+   * 变量名：switch
+   * 是否必填：否
+   * 类型：bool
+   * 描述：
+   *  如果商户不需要再接收营销事件通知，可通过该开关关闭。枚举值：
+   *  true：开启推送
+   *  false：停止推送
+   *  示例值：true
+   * </pre>
+   */
+  @SerializedName(value = "switch")
+  private Boolean switchBool;
+}

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/FavorCallbacksSaveResult.java

@@ -0,0 +1,38 @@
+package com.github.binarywang.wxpay.bean.marketing;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import me.chanjar.weixin.common.util.json.WxGsonBuilder;
+
+/**
+ * 设置消息通知地址返回结果对象
+ *
+ * @author thinsstar
+ */
+@NoArgsConstructor
+@Data
+public class FavorCallbacksSaveResult {
+
+  public static FavorCallbacksSaveResult fromJson(String json) {
+    return WxGsonBuilder.create().fromJson(json, FavorCallbacksSaveResult.class);
+  }
+
+  /**
+   * 修改时间
+   * <p>
+   * 修改时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示，北京时间2015年5月20日 13点29分35秒。
+   * 示例值：2015-05-20T13:29:35.120+08:00
+   */
+  @SerializedName("update_time")
+  private String updateTime;
+
+  /**
+   * 通知地址
+   * <p>
+   * 通知地址
+   * 示例值：api.weixin.qq.com
+   */
+  @SerializedName("notify_url")
+  private String notifyUrl;
+}

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/FavorCouponsCreateRequest.java

@@ -0,0 +1,116 @@
+package com.github.binarywang.wxpay.bean.marketing;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 发放代金券
+ * <pre>
+ *   文档地址：https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_2.shtml
+ * </pre>
+ *
+ * @author thinsstar
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class FavorCouponsCreateRequest implements Serializable {
+
+  private static final long serialVersionUID = 1L;
+
+  /**
+   * <pre>
+   * 字段名：批次号
+   * 变量名：stock_id
+   * 是否必填：是
+   * 类型：string[1,20]
+   * 描述：
+   *  微信为每个批次分配的唯一id。
+   *  校验规则：必须为代金券（全场券或单品券）批次号，不支持立减与折扣。
+   *  示例值：9856000
+   * </pre>
+   */
+  @SerializedName(value = "stock_id")
+  private String stockId;
+
+  /**
+   * <pre>
+   * 字段名：商户单据号
+   * 变量名：out_request_no
+   * 是否必填：是
+   * 类型：string[1,128]
+   * 描述：
+   *  商户此次发放凭据号（格式：商户id+日期+流水号），可包含英文字母，数字，|，_，*，-等内容，不允许出现其他不合法符号，商户侧需保持唯一性。
+   *  示例值： 89560002019101000121
+   * </pre>
+   */
+  @SerializedName(value = "out_request_no")
+  private String outRequestNo;
+
+  /**
+   * <pre>
+   * 字段名：公众账号ID
+   * 变量名：appid
+   * 是否必填：是
+   * 类型：string[1,128]
+   * 描述：
+   *  微信为发券方商户分配的公众账号ID，接口传入的所有appid应该为公众号的appid或者小程序的appid（在mp.weixin.qq.com申请的），不能为APP的appid（在open.weixin.qq.com申请的）。。
+   *  校验规则：
+   *  1、该appid需要与接口传入中的openid有对应关系；
+   *  2、该appid需要与调用接口的商户号（即请求头中的商户号）有绑定关系，若未绑定，可参考该指引完成绑定（商家商户号与AppID账号关联管理）
+   *  示例值：wx233544546545989
+   * </pre>
+   */
+  @SerializedName(value = "appid")
+  private String appid;
+
+  /**
+   * <pre>
+   * 字段名：创建批次的商户号
+   * 变量名：stock_creator_mchid
+   * 是否必填：是
+   * 类型：string[1,20]
+   * 描述：
+   *  批次创建方商户号。
+   *  示例值：8956000
+   * </pre>
+   */
+  @SerializedName(value = "stock_creator_mchid")
+  private String stockCreatorMchid;
+
+  /**
+   * <pre>
+   * 字段名：指定面额发券，面额
+   * 变量名：coupon_value
+   * 是否必填：否
+   * 类型：uint64
+   * 描述：
+   *  指定面额发券场景，券面额，其他场景不需要填，单位：分。
+   *  校验规则：仅在发券时指定面额及门槛的场景才生效，常规发券场景请勿传入该信息。
+   *  示例值：100
+   * </pre>
+   */
+  @SerializedName(value = "coupon_value")
+  private Integer couponValue;
+
+  /**
+   * <pre>
+   * 字段名：指定面额发券，券门槛
+   * 变量名：coupon_minimum
+   * 是否必填：是
+   * 类型：uint64
+   * 描述：
+   *  指定面额发券批次门槛，其他场景不需要，单位：分。
+   *  校验规则：仅在发券时指定面额及门槛的场景才生效，常规发券场景请勿传入该信息。
+   *  示例值：100
+   * </pre>
+   */
+  @SerializedName(value = "coupon_minimum")
+  private Integer couponMinimum;
+}

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/FavorCouponsCreateResult.java

@@ -0,0 +1,29 @@
+package com.github.binarywang.wxpay.bean.marketing;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import me.chanjar.weixin.common.util.json.WxGsonBuilder;
+
+/**
+ * 发放代金券返回结果对象
+ *
+ * @author thinsstar
+ */
+@NoArgsConstructor
+@Data
+public class FavorCouponsCreateResult {
+
+  public static FavorCouponsCreateResult fromJson(String json) {
+    return WxGsonBuilder.create().fromJson(json, FavorCouponsCreateResult.class);
+  }
+
+  /**
+   * 代金券id
+   * <p>
+   * 发放给用户的代金券id。
+   * 示例值：9867041
+   */
+  @SerializedName("coupon_id")
+  private String couponId;
+}