com.ziqni.admin.sdk.model.Reward Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ziqni-admin-sdk Show documentation
Show all versions of ziqni-admin-sdk Show documentation
ZIQNI Admin SDK Java Client
/*
* ZIQNI Admin API
* Ziqni Application Services are used to manage and configure spaces.
*
* The version of the OpenAPI document: 3.0.1
* Contact: [email protected]
*
* 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.ziqni.admin.sdk.model;
import java.util.Objects;
import java.util.Arrays;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import com.ziqni.admin.sdk.model.EntityType;
import com.ziqni.admin.sdk.model.ModelDefault;
import com.ziqni.admin.sdk.model.OptParamModels;
import com.ziqni.admin.sdk.model.RewardAllOf;
import com.ziqni.admin.sdk.model.RewardTypeReduced;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* Reward
*/
@JsonPropertyOrder({
Reward.JSON_PROPERTY_ID,
Reward.JSON_PROPERTY_SPACE_NAME,
Reward.JSON_PROPERTY_CREATED,
Reward.JSON_PROPERTY_CUSTOM_FIELDS,
Reward.JSON_PROPERTY_TAGS,
Reward.JSON_PROPERTY_METADATA,
Reward.JSON_PROPERTY_ENTITY_TYPE,
Reward.JSON_PROPERTY_ENTITY_ID,
Reward.JSON_PROPERTY_NAME,
Reward.JSON_PROPERTY_DESCRIPTION,
Reward.JSON_PROPERTY_REWARD_RANK,
Reward.JSON_PROPERTY_REWARD_VALUE,
Reward.JSON_PROPERTY_REWARD_TYPE,
Reward.JSON_PROPERTY_ICON,
Reward.JSON_PROPERTY_ISSUE_LIMIT,
Reward.JSON_PROPERTY_DELAY,
Reward.JSON_PROPERTY_POINT_IN_TIME,
Reward.JSON_PROPERTY_PERIOD,
Reward.JSON_PROPERTY_CONSTRAINTS
})
@javax.annotation.processing.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Reward {
public static final String JSON_PROPERTY_ID = "id";
private String id;
public static final String JSON_PROPERTY_SPACE_NAME = "spaceName";
private String spaceName;
public static final String JSON_PROPERTY_CREATED = "created";
private OffsetDateTime created;
public static final String JSON_PROPERTY_CUSTOM_FIELDS = "customFields";
private Map customFields = null;
public static final String JSON_PROPERTY_TAGS = "tags";
private List tags = null;
public static final String JSON_PROPERTY_METADATA = "metadata";
private Map metadata = null;
public static final String JSON_PROPERTY_ENTITY_TYPE = "entityType";
private EntityType entityType;
public static final String JSON_PROPERTY_ENTITY_ID = "entityId";
private String entityId;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_REWARD_RANK = "rewardRank";
private String rewardRank;
public static final String JSON_PROPERTY_REWARD_VALUE = "rewardValue";
private Double rewardValue;
public static final String JSON_PROPERTY_REWARD_TYPE = "rewardType";
private RewardTypeReduced rewardType;
public static final String JSON_PROPERTY_ICON = "icon";
private String icon;
public static final String JSON_PROPERTY_ISSUE_LIMIT = "issueLimit";
private Integer issueLimit;
public static final String JSON_PROPERTY_DELAY = "delay";
private Integer delay;
public static final String JSON_PROPERTY_POINT_IN_TIME = "pointInTime";
private OffsetDateTime pointInTime;
public static final String JSON_PROPERTY_PERIOD = "period";
private Integer period;
public static final String JSON_PROPERTY_CONSTRAINTS = "constraints";
private List constraints = new ArrayList<>();
public Reward id(String id) {
this.id = id;
return this;
}
/**
* A unique system generated identifier
* @return id
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "sc1samQmVr61KgaPQq7x", required = true, value = "A unique system generated identifier")
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getId() {
return id;
}
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setId(String id) {
this.id = id;
}
public Reward spaceName(String spaceName) {
this.spaceName = spaceName;
return this;
}
/**
* This is the space name which is linked to the account
* @return spaceName
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Your_space_name", required = true, value = "This is the space name which is linked to the account")
@JsonProperty(JSON_PROPERTY_SPACE_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSpaceName() {
return spaceName;
}
@JsonProperty(JSON_PROPERTY_SPACE_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSpaceName(String spaceName) {
this.spaceName = spaceName;
}
public Reward created(OffsetDateTime created) {
this.created = created;
return this;
}
/**
* ISO8601 timestamp for when a Model was created. All records are stored in UTC time zone
* @return created
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "ISO8601 timestamp for when a Model was created. All records are stored in UTC time zone")
@JsonProperty(JSON_PROPERTY_CREATED)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public OffsetDateTime getCreated() {
return created;
}
@JsonProperty(JSON_PROPERTY_CREATED)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCreated(OffsetDateTime created) {
this.created = created;
}
public Reward customFields(Map customFields) {
this.customFields = customFields;
return this;
}
public Reward putCustomFieldsItem(String key, Object customFieldsItem) {
if (this.customFields == null) {
this.customFields = new HashMap<>();
}
this.customFields.put(key, customFieldsItem);
return this;
}
/**
* Get customFields
* @return customFields
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS)
@JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
public Map getCustomFields() {
return customFields;
}
@JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS)
@JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS)
public void setCustomFields(Map customFields) {
this.customFields = customFields;
}
public Reward tags(List tags) {
this.tags = tags;
return this;
}
public Reward addTagsItem(String tagsItem) {
if (this.tags == null) {
this.tags = new ArrayList<>();
}
this.tags.add(tagsItem);
return this;
}
/**
* A list of id's used to tag models
* @return tags
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "A list of id's used to tag models")
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getTags() {
return tags;
}
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTags(List tags) {
this.tags = tags;
}
public Reward metadata(Map metadata) {
this.metadata = metadata;
return this;
}
public Reward putMetadataItem(String key, String metadataItem) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, metadataItem);
return this;
}
/**
* Get metadata
* @return metadata
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Map getMetadata() {
return metadata;
}
@JsonProperty(JSON_PROPERTY_METADATA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMetadata(Map metadata) {
this.metadata = metadata;
}
public Reward entityType(EntityType entityType) {
this.entityType = entityType;
return this;
}
/**
* Get entityType
* @return entityType
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public EntityType getEntityType() {
return entityType;
}
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEntityType(EntityType entityType) {
this.entityType = entityType;
}
public Reward entityId(String entityId) {
this.entityId = entityId;
return this;
}
/**
* A unique identifier of an achievement or contest. Dependant on entityType
* @return entityId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Dc4swmQBVd51K6gPQqFx", value = "A unique identifier of an achievement or contest. Dependant on entityType")
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEntityId() {
return entityId;
}
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEntityId(String entityId) {
this.entityId = entityId;
}
public Reward name(String name) {
this.name = name;
return this;
}
/**
* The name of a reward
* @return name
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Welcome badge", value = "The name of a reward")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setName(String name) {
this.name = name;
}
public Reward description(String description) {
this.description = description;
return this;
}
/**
* The description of a Reward
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "A badge to welcome a new player", value = "The description of a Reward")
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescription(String description) {
this.description = description;
}
public Reward rewardRank(String rewardRank) {
this.rewardRank = rewardRank;
return this;
}
/**
* If used in the context of contest this will associate with the rank of the leaderboard
* @return rewardRank
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "1,2 3 ...10", required = true, value = "If used in the context of contest this will associate with the rank of the leaderboard")
@JsonProperty(JSON_PROPERTY_REWARD_RANK)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getRewardRank() {
return rewardRank;
}
@JsonProperty(JSON_PROPERTY_REWARD_RANK)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRewardRank(String rewardRank) {
this.rewardRank = rewardRank;
}
public Reward rewardValue(Double rewardValue) {
this.rewardValue = rewardValue;
return this;
}
/**
* Numerical value of the reward that will be issued based on the reward type
* @return rewardValue
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "1", required = true, value = "Numerical value of the reward that will be issued based on the reward type")
@JsonProperty(JSON_PROPERTY_REWARD_VALUE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Double getRewardValue() {
return rewardValue;
}
@JsonProperty(JSON_PROPERTY_REWARD_VALUE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRewardValue(Double rewardValue) {
this.rewardValue = rewardValue;
}
public Reward rewardType(RewardTypeReduced rewardType) {
this.rewardType = rewardType;
return this;
}
/**
* Get rewardType
* @return rewardType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_REWARD_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public RewardTypeReduced getRewardType() {
return rewardType;
}
@JsonProperty(JSON_PROPERTY_REWARD_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRewardType(RewardTypeReduced rewardType) {
this.rewardType = rewardType;
}
public Reward icon(String icon) {
this.icon = icon;
return this;
}
/**
* An Icon id that has been pre uploaded to the system to display for reward
* @return icon
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Dc4swmQBVd51K6gPQqFx", value = "An Icon id that has been pre uploaded to the system to display for reward")
@JsonProperty(JSON_PROPERTY_ICON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getIcon() {
return icon;
}
@JsonProperty(JSON_PROPERTY_ICON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIcon(String icon) {
this.icon = icon;
}
public Reward issueLimit(Integer issueLimit) {
this.issueLimit = issueLimit;
return this;
}
/**
* how many of thsese rewards are
* @return issueLimit
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "2", value = "how many of thsese rewards are")
@JsonProperty(JSON_PROPERTY_ISSUE_LIMIT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getIssueLimit() {
return issueLimit;
}
@JsonProperty(JSON_PROPERTY_ISSUE_LIMIT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIssueLimit(Integer issueLimit) {
this.issueLimit = issueLimit;
}
public Reward delay(Integer delay) {
this.delay = delay;
return this;
}
/**
* Delay of issuing a reward in minutes
* @return delay
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "2", value = "Delay of issuing a reward in minutes")
@JsonProperty(JSON_PROPERTY_DELAY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getDelay() {
return delay;
}
@JsonProperty(JSON_PROPERTY_DELAY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDelay(Integer delay) {
this.delay = delay;
}
public Reward pointInTime(OffsetDateTime pointInTime) {
this.pointInTime = pointInTime;
return this;
}
/**
* ISO8601 timestamp for when a Reward is available until a specific point in time. All records are stored in UTC time zone
* @return pointInTime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ISO8601 timestamp for when a Reward is available until a specific point in time. All records are stored in UTC time zone")
@JsonProperty(JSON_PROPERTY_POINT_IN_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public OffsetDateTime getPointInTime() {
return pointInTime;
}
@JsonProperty(JSON_PROPERTY_POINT_IN_TIME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPointInTime(OffsetDateTime pointInTime) {
this.pointInTime = pointInTime;
}
public Reward period(Integer period) {
this.period = period;
return this;
}
/**
* Reward available for a period of time from issuing in minutes
* @return period
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "2", value = "Reward available for a period of time from issuing in minutes")
@JsonProperty(JSON_PROPERTY_PERIOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getPeriod() {
return period;
}
@JsonProperty(JSON_PROPERTY_PERIOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPeriod(Integer period) {
this.period = period;
}
public Reward constraints(List constraints) {
this.constraints = constraints;
return this;
}
public Reward addConstraintsItem(String constraintsItem) {
this.constraints.add(constraintsItem);
return this;
}
/**
* Additional constraints
* @return constraints
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "- notifyMember - isMemberAcknowledgmentRequired", required = true, value = "Additional constraints")
@JsonProperty(JSON_PROPERTY_CONSTRAINTS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public List getConstraints() {
return constraints;
}
@JsonProperty(JSON_PROPERTY_CONSTRAINTS)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setConstraints(List constraints) {
this.constraints = constraints;
}
/**
* Return true if this Reward object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Reward reward = (Reward) o;
return Objects.equals(this.id, reward.id) &&
Objects.equals(this.spaceName, reward.spaceName) &&
Objects.equals(this.created, reward.created) &&
Objects.equals(this.customFields, reward.customFields) &&
Objects.equals(this.tags, reward.tags) &&
Objects.equals(this.metadata, reward.metadata) &&
Objects.equals(this.entityType, reward.entityType) &&
Objects.equals(this.entityId, reward.entityId) &&
Objects.equals(this.name, reward.name) &&
Objects.equals(this.description, reward.description) &&
Objects.equals(this.rewardRank, reward.rewardRank) &&
Objects.equals(this.rewardValue, reward.rewardValue) &&
Objects.equals(this.rewardType, reward.rewardType) &&
Objects.equals(this.icon, reward.icon) &&
Objects.equals(this.issueLimit, reward.issueLimit) &&
Objects.equals(this.delay, reward.delay) &&
Objects.equals(this.pointInTime, reward.pointInTime) &&
Objects.equals(this.period, reward.period) &&
Objects.equals(this.constraints, reward.constraints);
}
@Override
public int hashCode() {
return Objects.hash(id, spaceName, created, customFields, tags, metadata, entityType, entityId, name, description, rewardRank, rewardValue, rewardType, icon, issueLimit, delay, pointInTime, period, constraints);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Reward {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" spaceName: ").append(toIndentedString(spaceName)).append("\n");
sb.append(" created: ").append(toIndentedString(created)).append("\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append(" entityType: ").append(toIndentedString(entityType)).append("\n");
sb.append(" entityId: ").append(toIndentedString(entityId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" rewardRank: ").append(toIndentedString(rewardRank)).append("\n");
sb.append(" rewardValue: ").append(toIndentedString(rewardValue)).append("\n");
sb.append(" rewardType: ").append(toIndentedString(rewardType)).append("\n");
sb.append(" icon: ").append(toIndentedString(icon)).append("\n");
sb.append(" issueLimit: ").append(toIndentedString(issueLimit)).append("\n");
sb.append(" delay: ").append(toIndentedString(delay)).append("\n");
sb.append(" pointInTime: ").append(toIndentedString(pointInTime)).append("\n");
sb.append(" period: ").append(toIndentedString(period)).append("\n");
sb.append(" constraints: ").append(toIndentedString(constraints)).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 ");
}
}