com.alipay.v3.model.CommonVoucherSendRule Maven / Gradle / Ivy
The newest version!
/*
* 支付宝开放平台API
* 支付宝开放平台v3协议文档
*
* The version of the OpenAPI document: 2024-08-30
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.alipay.v3.model;
import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.alipay.v3.JSON;
/**
* CommonVoucherSendRule
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CommonVoucherSendRule {
public static final String SERIALIZED_NAME_MAX_QUANTITY_BY_DAY = "max_quantity_by_day";
@SerializedName(SERIALIZED_NAME_MAX_QUANTITY_BY_DAY)
private Integer maxQuantityByDay;
public static final String SERIALIZED_NAME_NATURAL_PERSON_LIMIT = "natural_person_limit";
@SerializedName(SERIALIZED_NAME_NATURAL_PERSON_LIMIT)
private Boolean naturalPersonLimit;
public static final String SERIALIZED_NAME_PHONE_NUMBER_LIMIT = "phone_number_limit";
@SerializedName(SERIALIZED_NAME_PHONE_NUMBER_LIMIT)
private Boolean phoneNumberLimit;
public static final String SERIALIZED_NAME_REAL_NAME_LIMIT = "real_name_limit";
@SerializedName(SERIALIZED_NAME_REAL_NAME_LIMIT)
private Boolean realNameLimit;
public static final String SERIALIZED_NAME_VOUCHER_QUANTITY = "voucher_quantity";
@SerializedName(SERIALIZED_NAME_VOUCHER_QUANTITY)
private Integer voucherQuantity;
public static final String SERIALIZED_NAME_VOUCHER_QUANTITY_LIMIT_PER_USER = "voucher_quantity_limit_per_user";
@SerializedName(SERIALIZED_NAME_VOUCHER_QUANTITY_LIMIT_PER_USER)
private Integer voucherQuantityLimitPerUser;
public static final String SERIALIZED_NAME_VOUCHER_QUANTITY_LIMIT_PER_USER_PERIOD_TYPE = "voucher_quantity_limit_per_user_period_type";
@SerializedName(SERIALIZED_NAME_VOUCHER_QUANTITY_LIMIT_PER_USER_PERIOD_TYPE)
private String voucherQuantityLimitPerUserPeriodType;
public CommonVoucherSendRule() {
}
public CommonVoucherSendRule maxQuantityByDay(Integer maxQuantityByDay) {
this.maxQuantityByDay = maxQuantityByDay;
return this;
}
/**
* 设置此字段，允许指定单天最大发券数量。
* @return maxQuantityByDay
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "设置此字段，允许指定单天最大发券数量。")
public Integer getMaxQuantityByDay() {
return maxQuantityByDay;
}
public void setMaxQuantityByDay(Integer maxQuantityByDay) {
this.maxQuantityByDay = maxQuantityByDay;
}
public CommonVoucherSendRule naturalPersonLimit(Boolean naturalPersonLimit) {
this.naturalPersonLimit = naturalPersonLimit;
return this;
}
/**
* 限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。 枚举值 true：是 false：否
* @return naturalPersonLimit
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。 枚举值 true：是 false：否")
public Boolean getNaturalPersonLimit() {
return naturalPersonLimit;
}
public void setNaturalPersonLimit(Boolean naturalPersonLimit) {
this.naturalPersonLimit = naturalPersonLimit;
}
public CommonVoucherSendRule phoneNumberLimit(Boolean phoneNumberLimit) {
this.phoneNumberLimit = phoneNumberLimit;
return this;
}
/**
* 限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制 枚举值 true：是 false：否
* @return phoneNumberLimit
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制 枚举值 true：是 false：否")
public Boolean getPhoneNumberLimit() {
return phoneNumberLimit;
}
public void setPhoneNumberLimit(Boolean phoneNumberLimit) {
this.phoneNumberLimit = phoneNumberLimit;
}
public CommonVoucherSendRule realNameLimit(Boolean realNameLimit) {
this.realNameLimit = realNameLimit;
return this;
}
/**
* 限制支付宝实名用户才能领取支付券，默认为false表示不限制。枚举值 true\\false
* @return realNameLimit
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "限制支付宝实名用户才能领取支付券，默认为false表示不限制。枚举值 true\\false")
public Boolean getRealNameLimit() {
return realNameLimit;
}
public void setRealNameLimit(Boolean realNameLimit) {
this.realNameLimit = realNameLimit;
}
public CommonVoucherSendRule voucherQuantity(Integer voucherQuantity) {
this.voucherQuantity = voucherQuantity;
return this;
}
/**
* 发行券的总数量。
* @return voucherQuantity
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "发行券的总数量。")
public Integer getVoucherQuantity() {
return voucherQuantity;
}
public void setVoucherQuantity(Integer voucherQuantity) {
this.voucherQuantity = voucherQuantity;
}
public CommonVoucherSendRule voucherQuantityLimitPerUser(Integer voucherQuantityLimitPerUser) {
this.voucherQuantityLimitPerUser = voucherQuantityLimitPerUser;
return this;
}
/**
* 每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制。
* @return voucherQuantityLimitPerUser
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制。")
public Integer getVoucherQuantityLimitPerUser() {
return voucherQuantityLimitPerUser;
}
public void setVoucherQuantityLimitPerUser(Integer voucherQuantityLimitPerUser) {
this.voucherQuantityLimitPerUser = voucherQuantityLimitPerUser;
}
public CommonVoucherSendRule voucherQuantityLimitPerUserPeriodType(String voucherQuantityLimitPerUserPeriodType) {
this.voucherQuantityLimitPerUserPeriodType = voucherQuantityLimitPerUserPeriodType;
return this;
}
/**
* 周期限领配置,限制每人在固定周期内领取张数（voucher_quantity_limit_per_user），默认LIFE_CYCLE。
* @return voucherQuantityLimitPerUserPeriodType
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "周期限领配置,限制每人在固定周期内领取张数（voucher_quantity_limit_per_user），默认LIFE_CYCLE。")
public String getVoucherQuantityLimitPerUserPeriodType() {
return voucherQuantityLimitPerUserPeriodType;
}
public void setVoucherQuantityLimitPerUserPeriodType(String voucherQuantityLimitPerUserPeriodType) {
this.voucherQuantityLimitPerUserPeriodType = voucherQuantityLimitPerUserPeriodType;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the CommonVoucherSendRule instance itself
*/
public CommonVoucherSendRule putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CommonVoucherSendRule commonVoucherSendRule = (CommonVoucherSendRule) o;
return Objects.equals(this.maxQuantityByDay, commonVoucherSendRule.maxQuantityByDay) &&
Objects.equals(this.naturalPersonLimit, commonVoucherSendRule.naturalPersonLimit) &&
Objects.equals(this.phoneNumberLimit, commonVoucherSendRule.phoneNumberLimit) &&
Objects.equals(this.realNameLimit, commonVoucherSendRule.realNameLimit) &&
Objects.equals(this.voucherQuantity, commonVoucherSendRule.voucherQuantity) &&
Objects.equals(this.voucherQuantityLimitPerUser, commonVoucherSendRule.voucherQuantityLimitPerUser) &&
Objects.equals(this.voucherQuantityLimitPerUserPeriodType, commonVoucherSendRule.voucherQuantityLimitPerUserPeriodType)&&
Objects.equals(this.additionalProperties, commonVoucherSendRule.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(maxQuantityByDay, naturalPersonLimit, phoneNumberLimit, realNameLimit, voucherQuantity, voucherQuantityLimitPerUser, voucherQuantityLimitPerUserPeriodType, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CommonVoucherSendRule {\n");
sb.append(" maxQuantityByDay: ").append(toIndentedString(maxQuantityByDay)).append("\n");
sb.append(" naturalPersonLimit: ").append(toIndentedString(naturalPersonLimit)).append("\n");
sb.append(" phoneNumberLimit: ").append(toIndentedString(phoneNumberLimit)).append("\n");
sb.append(" realNameLimit: ").append(toIndentedString(realNameLimit)).append("\n");
sb.append(" voucherQuantity: ").append(toIndentedString(voucherQuantity)).append("\n");
sb.append(" voucherQuantityLimitPerUser: ").append(toIndentedString(voucherQuantityLimitPerUser)).append("\n");
sb.append(" voucherQuantityLimitPerUserPeriodType: ").append(toIndentedString(voucherQuantityLimitPerUserPeriodType)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("max_quantity_by_day");
openapiFields.add("natural_person_limit");
openapiFields.add("phone_number_limit");
openapiFields.add("real_name_limit");
openapiFields.add("voucher_quantity");
openapiFields.add("voucher_quantity_limit_per_user");
openapiFields.add("voucher_quantity_limit_per_user_period_type");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to CommonVoucherSendRule
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (CommonVoucherSendRule.openapiRequiredFields.isEmpty()) {
return;
} else { // has required fields
throw new IllegalArgumentException(String.format("The required field(s) %s in CommonVoucherSendRule is not found in the empty JSON string", CommonVoucherSendRule.openapiRequiredFields.toString()));
}
}
if (jsonObj.get("voucher_quantity_limit_per_user_period_type") != null && !jsonObj.get("voucher_quantity_limit_per_user_period_type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `voucher_quantity_limit_per_user_period_type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("voucher_quantity_limit_per_user_period_type").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CommonVoucherSendRule.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CommonVoucherSendRule' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CommonVoucherSendRule.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CommonVoucherSendRule value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additonal properties
if (value.getAdditionalProperties() != null) {
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else {
obj.add(entry.getKey(), gson.toJsonTree(entry.getValue()).getAsJsonObject());
}
}
}
elementAdapter.write(out, obj);
}
@Override
public CommonVoucherSendRule read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
// store additional fields in the deserialized instance
CommonVoucherSendRule instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else { // non-primitive type
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of CommonVoucherSendRule given an JSON string
*
* @param jsonString JSON string
* @return An instance of CommonVoucherSendRule
* @throws IOException if the JSON string is invalid with respect to CommonVoucherSendRule
*/
public static CommonVoucherSendRule fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CommonVoucherSendRule.class);
}
/**
* Convert an instance of CommonVoucherSendRule to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}