com.ziqni.admin.sdk.model.CreateEntityRewardRequest 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. Change log: 2024-02-27 Added rewards reduced to the LeaderboardEntry response
*
* The version of the OpenAPI document: 3.0.17
* 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.AwardScheduling;
import com.ziqni.admin.sdk.model.CreateEntityRewardRequestAllOf;
import com.ziqni.admin.sdk.model.CreateOptParamModels;
import com.ziqni.admin.sdk.model.DependantOn;
import com.ziqni.admin.sdk.model.RewardEntityType;
import com.ziqni.admin.sdk.model.Translation;
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;
/**
* CreateEntityRewardRequest
*/
@JsonPropertyOrder({
CreateEntityRewardRequest.JSON_PROPERTY_CUSTOM_FIELDS,
CreateEntityRewardRequest.JSON_PROPERTY_TAGS,
CreateEntityRewardRequest.JSON_PROPERTY_METADATA,
CreateEntityRewardRequest.JSON_PROPERTY_ENTITY_TYPE,
CreateEntityRewardRequest.JSON_PROPERTY_ENTITY_ID,
CreateEntityRewardRequest.JSON_PROPERTY_NAME,
CreateEntityRewardRequest.JSON_PROPERTY_DESCRIPTION,
CreateEntityRewardRequest.JSON_PROPERTY_REWARD_RANK,
CreateEntityRewardRequest.JSON_PROPERTY_REWARD_VALUE,
CreateEntityRewardRequest.JSON_PROPERTY_ICON,
CreateEntityRewardRequest.JSON_PROPERTY_ISSUE_LIMIT,
CreateEntityRewardRequest.JSON_PROPERTY_DELAY,
CreateEntityRewardRequest.JSON_PROPERTY_POINT_IN_TIME,
CreateEntityRewardRequest.JSON_PROPERTY_PERIOD,
CreateEntityRewardRequest.JSON_PROPERTY_MEMBER_TAGS_FILTER,
CreateEntityRewardRequest.JSON_PROPERTY_TRANSLATIONS,
CreateEntityRewardRequest.JSON_PROPERTY_CONSTRAINTS,
CreateEntityRewardRequest.JSON_PROPERTY_REWARD_TYPE_ID,
CreateEntityRewardRequest.JSON_PROPERTY_SCHEDULING
})
@javax.annotation.processing.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CreateEntityRewardRequest {
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 RewardEntityType 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_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_MEMBER_TAGS_FILTER = "memberTagsFilter";
private DependantOn memberTagsFilter;
public static final String JSON_PROPERTY_TRANSLATIONS = "translations";
private List translations = null;
public static final String JSON_PROPERTY_CONSTRAINTS = "constraints";
private List constraints = new ArrayList<>();
public static final String JSON_PROPERTY_REWARD_TYPE_ID = "rewardTypeId";
private String rewardTypeId;
public static final String JSON_PROPERTY_SCHEDULING = "scheduling";
private List scheduling = null;
public CreateEntityRewardRequest customFields(Map customFields) {
this.customFields = customFields;
return this;
}
public CreateEntityRewardRequest putCustomFieldsItem(String key, Object customFieldsItem) {
if (this.customFields == null) {
this.customFields = new HashMap<>();
}
this.customFields.put(key, customFieldsItem);
return this;
}
/**
* A list of custom field entries
* @return customFields
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "A list of custom field entries")
@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 CreateEntityRewardRequest tags(List tags) {
this.tags = tags;
return this;
}
public CreateEntityRewardRequest 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(example = "[\"Dc4swmQBVd51K6gPQqFx\",\"Dc4swmQBVd51K6gPQqF2\"]", 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 CreateEntityRewardRequest metadata(Map metadata) {
this.metadata = metadata;
return this;
}
public CreateEntityRewardRequest 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 CreateEntityRewardRequest entityType(RewardEntityType entityType) {
this.entityType = entityType;
return this;
}
/**
* Get entityType
* @return entityType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public RewardEntityType getEntityType() {
return entityType;
}
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEntityType(RewardEntityType entityType) {
this.entityType = entityType;
}
public CreateEntityRewardRequest entityId(String entityId) {
this.entityId = entityId;
return this;
}
/**
* A unique identifier of an achievement or contest. Dependant on entityType
* @return entityId
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Dc4swmQBVd51K6gPQqFx", required = true, value = "A unique identifier of an achievement or contest. Dependant on entityType")
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getEntityId() {
return entityId;
}
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEntityId(String entityId) {
this.entityId = entityId;
}
public CreateEntityRewardRequest name(String name) {
this.name = name;
return this;
}
/**
* The name of a reward
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Welcome badge", required = true, value = "The name of a reward")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setName(String name) {
this.name = name;
}
public CreateEntityRewardRequest 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 CreateEntityRewardRequest 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 CreateEntityRewardRequest 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 CreateEntityRewardRequest 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 CreateEntityRewardRequest 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 CreateEntityRewardRequest delay(Integer delay) {
this.delay = delay;
return this;
}
/**
* ***DEPRECATED, use scheduling*** Delay of issuing a reward in minutes
* @return delay
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "2", value = "***DEPRECATED, use scheduling*** 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 CreateEntityRewardRequest pointInTime(OffsetDateTime pointInTime) {
this.pointInTime = pointInTime;
return this;
}
/**
* ***DEPRECATED, use scheduling*** 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 = "***DEPRECATED, use scheduling*** 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 CreateEntityRewardRequest period(Integer period) {
this.period = period;
return this;
}
/**
* ***DEPRECATED, use scheduling*** Reward available for a period of time from issuing in minutes
* @return period
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "2", value = "***DEPRECATED, use scheduling*** 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 CreateEntityRewardRequest memberTagsFilter(DependantOn memberTagsFilter) {
this.memberTagsFilter = memberTagsFilter;
return this;
}
/**
* Get memberTagsFilter
* @return memberTagsFilter
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_MEMBER_TAGS_FILTER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public DependantOn getMemberTagsFilter() {
return memberTagsFilter;
}
@JsonProperty(JSON_PROPERTY_MEMBER_TAGS_FILTER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setMemberTagsFilter(DependantOn memberTagsFilter) {
this.memberTagsFilter = memberTagsFilter;
}
public CreateEntityRewardRequest translations(List translations) {
this.translations = translations;
return this;
}
public CreateEntityRewardRequest addTranslationsItem(Translation translationsItem) {
if (this.translations == null) {
this.translations = new ArrayList<>();
}
this.translations.add(translationsItem);
return this;
}
/**
* Get translations
* @return translations
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_TRANSLATIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getTranslations() {
return translations;
}
@JsonProperty(JSON_PROPERTY_TRANSLATIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTranslations(List translations) {
this.translations = translations;
}
public CreateEntityRewardRequest constraints(List constraints) {
this.constraints = constraints;
return this;
}
public CreateEntityRewardRequest 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;
}
public CreateEntityRewardRequest rewardTypeId(String rewardTypeId) {
this.rewardTypeId = rewardTypeId;
return this;
}
/**
* A unique id of the Reward Type
* @return rewardTypeId
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Dc4swmQBVd51K6gPQqFx", required = true, value = "A unique id of the Reward Type")
@JsonProperty(JSON_PROPERTY_REWARD_TYPE_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getRewardTypeId() {
return rewardTypeId;
}
@JsonProperty(JSON_PROPERTY_REWARD_TYPE_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setRewardTypeId(String rewardTypeId) {
this.rewardTypeId = rewardTypeId;
}
public CreateEntityRewardRequest scheduling(List scheduling) {
this.scheduling = scheduling;
return this;
}
public CreateEntityRewardRequest addSchedulingItem(AwardScheduling schedulingItem) {
if (this.scheduling == null) {
this.scheduling = new ArrayList<>();
}
this.scheduling.add(schedulingItem);
return this;
}
/**
* Set the default time based constraints using either an exact point in time or duration to manage the life cycle of the award
* @return scheduling
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Set the default time based constraints using either an exact point in time or duration to manage the life cycle of the award")
@JsonProperty(JSON_PROPERTY_SCHEDULING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getScheduling() {
return scheduling;
}
@JsonProperty(JSON_PROPERTY_SCHEDULING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setScheduling(List scheduling) {
this.scheduling = scheduling;
}
/**
* Return true if this CreateEntityRewardRequest object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateEntityRewardRequest createEntityRewardRequest = (CreateEntityRewardRequest) o;
return Objects.equals(this.customFields, createEntityRewardRequest.customFields) &&
Objects.equals(this.tags, createEntityRewardRequest.tags) &&
Objects.equals(this.metadata, createEntityRewardRequest.metadata) &&
Objects.equals(this.entityType, createEntityRewardRequest.entityType) &&
Objects.equals(this.entityId, createEntityRewardRequest.entityId) &&
Objects.equals(this.name, createEntityRewardRequest.name) &&
Objects.equals(this.description, createEntityRewardRequest.description) &&
Objects.equals(this.rewardRank, createEntityRewardRequest.rewardRank) &&
Objects.equals(this.rewardValue, createEntityRewardRequest.rewardValue) &&
Objects.equals(this.icon, createEntityRewardRequest.icon) &&
Objects.equals(this.issueLimit, createEntityRewardRequest.issueLimit) &&
Objects.equals(this.delay, createEntityRewardRequest.delay) &&
Objects.equals(this.pointInTime, createEntityRewardRequest.pointInTime) &&
Objects.equals(this.period, createEntityRewardRequest.period) &&
Objects.equals(this.memberTagsFilter, createEntityRewardRequest.memberTagsFilter) &&
Objects.equals(this.translations, createEntityRewardRequest.translations) &&
Objects.equals(this.constraints, createEntityRewardRequest.constraints) &&
Objects.equals(this.rewardTypeId, createEntityRewardRequest.rewardTypeId) &&
Objects.equals(this.scheduling, createEntityRewardRequest.scheduling);
}
@Override
public int hashCode() {
return Objects.hash(customFields, tags, metadata, entityType, entityId, name, description, rewardRank, rewardValue, icon, issueLimit, delay, pointInTime, period, memberTagsFilter, translations, constraints, rewardTypeId, scheduling);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateEntityRewardRequest {\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(" 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(" memberTagsFilter: ").append(toIndentedString(memberTagsFilter)).append("\n");
sb.append(" translations: ").append(toIndentedString(translations)).append("\n");
sb.append(" constraints: ").append(toIndentedString(constraints)).append("\n");
sb.append(" rewardTypeId: ").append(toIndentedString(rewardTypeId)).append("\n");
sb.append(" scheduling: ").append(toIndentedString(scheduling)).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 ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy