com.ziqni.admin.sdk.model.MemberMessage 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
ZIQNI Admin SDK Java Client
There is a newer version: 1.0.24
/*
 * 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.EventRefType;
import com.ziqni.admin.sdk.model.MemberMessageAllOf;
import com.ziqni.admin.sdk.model.MessageLink;
import com.ziqni.admin.sdk.model.MessageStatus;
import com.ziqni.admin.sdk.model.MessageType;
import com.ziqni.admin.sdk.model.ModelDefault;
import com.ziqni.admin.sdk.model.OptParamModels;
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;


/**
 * This is the Member Message model
 */
@ApiModel(description = "This is the Member Message model")
@JsonPropertyOrder({
  MemberMessage.JSON_PROPERTY_ID,
  MemberMessage.JSON_PROPERTY_SPACE_NAME,
  MemberMessage.JSON_PROPERTY_CREATED,
  MemberMessage.JSON_PROPERTY_CUSTOM_FIELDS,
  MemberMessage.JSON_PROPERTY_TAGS,
  MemberMessage.JSON_PROPERTY_METADATA,
  MemberMessage.JSON_PROPERTY_EVENT_REF_TYPE,
  MemberMessage.JSON_PROPERTY_EVENT_REF_ID,
  MemberMessage.JSON_PROPERTY_MESSAGE_TYPE,
  MemberMessage.JSON_PROPERTY_SUBJECT,
  MemberMessage.JSON_PROPERTY_BODY,
  MemberMessage.JSON_PROPERTY_STATUS,
  MemberMessage.JSON_PROPERTY_EXPIRY,
  MemberMessage.JSON_PROPERTY_LINKS,
  MemberMessage.JSON_PROPERTY_MEMBER_IDS
})
@javax.annotation.processing.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class MemberMessage {
  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_EVENT_REF_TYPE = "eventRefType";
  private EventRefType eventRefType;

  public static final String JSON_PROPERTY_EVENT_REF_ID = "eventRefId";
  private String eventRefId;

  public static final String JSON_PROPERTY_MESSAGE_TYPE = "messageType";
  private MessageType messageType;

  public static final String JSON_PROPERTY_SUBJECT = "subject";
  private String subject;

  public static final String JSON_PROPERTY_BODY = "body";
  private String body;

  public static final String JSON_PROPERTY_STATUS = "status";
  private MessageStatus status;

  public static final String JSON_PROPERTY_EXPIRY = "expiry";
  private OffsetDateTime expiry;

  public static final String JSON_PROPERTY_LINKS = "links";
  private MessageLink links;

  public static final String JSON_PROPERTY_MEMBER_IDS = "memberIds";
  private List memberIds = null;


  public MemberMessage 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 MemberMessage 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 MemberMessage 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 MemberMessage customFields(Map customFields) {
    this.customFields = customFields;
    return this;
  }

  public MemberMessage 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 MemberMessage tags(List tags) {
    this.tags = tags;
    return this;
  }

  public MemberMessage 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 MemberMessage metadata(Map metadata) {
    this.metadata = metadata;
    return this;
  }

  public MemberMessage 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 MemberMessage eventRefType(EventRefType eventRefType) {
    this.eventRefType = eventRefType;
    return this;
  }

   /**
   * Get eventRefType
   * @return eventRefType
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "")
  @JsonProperty(JSON_PROPERTY_EVENT_REF_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public EventRefType getEventRefType() {
    return eventRefType;
  }


  @JsonProperty(JSON_PROPERTY_EVENT_REF_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setEventRefType(EventRefType eventRefType) {
    this.eventRefType = eventRefType;
  }


  public MemberMessage eventRefId(String eventRefId) {
    this.eventRefId = eventRefId;
    return this;
  }

   /**
   * The reference ID of the event object
   * @return eventRefId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "Dc4swmQBVd51K6gPQqFx", value = "The reference ID of the event object")
  @JsonProperty(JSON_PROPERTY_EVENT_REF_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getEventRefId() {
    return eventRefId;
  }


  @JsonProperty(JSON_PROPERTY_EVENT_REF_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setEventRefId(String eventRefId) {
    this.eventRefId = eventRefId;
  }


  public MemberMessage messageType(MessageType messageType) {
    this.messageType = messageType;
    return this;
  }

   /**
   * Get messageType
   * @return messageType
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "")
  @JsonProperty(JSON_PROPERTY_MESSAGE_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public MessageType getMessageType() {
    return messageType;
  }


  @JsonProperty(JSON_PROPERTY_MESSAGE_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setMessageType(MessageType messageType) {
    this.messageType = messageType;
  }


  public MemberMessage subject(String subject) {
    this.subject = subject;
    return this;
  }

   /**
   * The title of the message
   * @return subject
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "Hello and welcome", required = true, value = "The title of the message")
  @JsonProperty(JSON_PROPERTY_SUBJECT)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public String getSubject() {
    return subject;
  }


  @JsonProperty(JSON_PROPERTY_SUBJECT)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setSubject(String subject) {
    this.subject = subject;
  }


  public MemberMessage body(String body) {
    this.body = body;
    return this;
  }

   /**
   * The context of the message
   * @return body
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "Here is a message to welcome you on board!", required = true, value = "The context of the message")
  @JsonProperty(JSON_PROPERTY_BODY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public String getBody() {
    return body;
  }


  @JsonProperty(JSON_PROPERTY_BODY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setBody(String body) {
    this.body = body;
  }


  public MemberMessage status(MessageStatus status) {
    this.status = status;
    return this;
  }

   /**
   * Get status
   * @return status
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "")
  @JsonProperty(JSON_PROPERTY_STATUS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public MessageStatus getStatus() {
    return status;
  }


  @JsonProperty(JSON_PROPERTY_STATUS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setStatus(MessageStatus status) {
    this.status = status;
  }


  public MemberMessage expiry(OffsetDateTime expiry) {
    this.expiry = expiry;
    return this;
  }

   /**
   * The time that the message will disappear after. ISO8601 timestamp
   * @return expiry
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "The time that the message will disappear after. ISO8601 timestamp")
  @JsonProperty(JSON_PROPERTY_EXPIRY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public OffsetDateTime getExpiry() {
    return expiry;
  }


  @JsonProperty(JSON_PROPERTY_EXPIRY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setExpiry(OffsetDateTime expiry) {
    this.expiry = expiry;
  }


  public MemberMessage links(MessageLink links) {
    this.links = links;
    return this;
  }

   /**
   * Get links
   * @return links
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(required = true, value = "")
  @JsonProperty(JSON_PROPERTY_LINKS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public MessageLink getLinks() {
    return links;
  }


  @JsonProperty(JSON_PROPERTY_LINKS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setLinks(MessageLink links) {
    this.links = links;
  }


  public MemberMessage memberIds(List memberIds) {
    this.memberIds = memberIds;
    return this;
  }

  public MemberMessage addMemberIdsItem(String memberIdsItem) {
    if (this.memberIds == null) {
      this.memberIds = new ArrayList<>();
    }
    this.memberIds.add(memberIdsItem);
    return this;
  }

   /**
   * Get memberIds
   * @return memberIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_MEMBER_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getMemberIds() {
    return memberIds;
  }


  @JsonProperty(JSON_PROPERTY_MEMBER_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMemberIds(List memberIds) {
    this.memberIds = memberIds;
  }


  /**
   * Return true if this MemberMessage object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    MemberMessage memberMessage = (MemberMessage) o;
    return Objects.equals(this.id, memberMessage.id) &&
        Objects.equals(this.spaceName, memberMessage.spaceName) &&
        Objects.equals(this.created, memberMessage.created) &&
        Objects.equals(this.customFields, memberMessage.customFields) &&
        Objects.equals(this.tags, memberMessage.tags) &&
        Objects.equals(this.metadata, memberMessage.metadata) &&
        Objects.equals(this.eventRefType, memberMessage.eventRefType) &&
        Objects.equals(this.eventRefId, memberMessage.eventRefId) &&
        Objects.equals(this.messageType, memberMessage.messageType) &&
        Objects.equals(this.subject, memberMessage.subject) &&
        Objects.equals(this.body, memberMessage.body) &&
        Objects.equals(this.status, memberMessage.status) &&
        Objects.equals(this.expiry, memberMessage.expiry) &&
        Objects.equals(this.links, memberMessage.links) &&
        Objects.equals(this.memberIds, memberMessage.memberIds);
  }

  @Override
  public int hashCode() {
    return Objects.hash(id, spaceName, created, customFields, tags, metadata, eventRefType, eventRefId, messageType, subject, body, status, expiry, links, memberIds);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class MemberMessage {\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("    eventRefType: ").append(toIndentedString(eventRefType)).append("\n");
    sb.append("    eventRefId: ").append(toIndentedString(eventRefId)).append("\n");
    sb.append("    messageType: ").append(toIndentedString(messageType)).append("\n");
    sb.append("    subject: ").append(toIndentedString(subject)).append("\n");
    sb.append("    body: ").append(toIndentedString(body)).append("\n");
    sb.append("    status: ").append(toIndentedString(status)).append("\n");
    sb.append("    expiry: ").append(toIndentedString(expiry)).append("\n");
    sb.append("    links: ").append(toIndentedString(links)).append("\n");
    sb.append("    memberIds: ").append(toIndentedString(memberIds)).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    ");
  }

}