All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.ziqni.admin.sdk.model.Product Maven / Gradle / Ivy

There is a newer version: 1.0.24
Show newest version
/*
 * 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.ActionTypeAdjustmentFactor;
import com.ziqni.admin.sdk.model.ModelDefault;
import com.ziqni.admin.sdk.model.OptParamModels;
import com.ziqni.admin.sdk.model.ProductAllOf;
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 Product model
 */
@ApiModel(description = "This is the Product model")
@JsonPropertyOrder({
  Product.JSON_PROPERTY_ID,
  Product.JSON_PROPERTY_SPACE_NAME,
  Product.JSON_PROPERTY_CREATED,
  Product.JSON_PROPERTY_CUSTOM_FIELDS,
  Product.JSON_PROPERTY_TAGS,
  Product.JSON_PROPERTY_METADATA,
  Product.JSON_PROPERTY_NAME,
  Product.JSON_PROPERTY_DESCRIPTION,
  Product.JSON_PROPERTY_ADJUSTMENT_FACTOR,
  Product.JSON_PROPERTY_PRODUCT_REF_ID,
  Product.JSON_PROPERTY_PRODUCT_TYPE,
  Product.JSON_PROPERTY_ACTION_TYPE_ADJUSTMENT_FACTORS,
  Product.JSON_PROPERTY_ICON,
  Product.JSON_PROPERTY_BANNER,
  Product.JSON_PROPERTY_BANNER_LOW_RESOLUTION,
  Product.JSON_PROPERTY_BANNER_HIGH_RESOLUTION
})
@javax.annotation.processing.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Product {
  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_NAME = "name";
  private String name;

  public static final String JSON_PROPERTY_DESCRIPTION = "description";
  private String description;

  public static final String JSON_PROPERTY_ADJUSTMENT_FACTOR = "adjustmentFactor";
  private Double adjustmentFactor;

  public static final String JSON_PROPERTY_PRODUCT_REF_ID = "productRefId";
  private String productRefId;

  public static final String JSON_PROPERTY_PRODUCT_TYPE = "productType";
  private String productType;

  public static final String JSON_PROPERTY_ACTION_TYPE_ADJUSTMENT_FACTORS = "actionTypeAdjustmentFactors";
  private List actionTypeAdjustmentFactors = null;

  public static final String JSON_PROPERTY_ICON = "icon";
  private String icon;

  public static final String JSON_PROPERTY_BANNER = "banner";
  private String banner;

  public static final String JSON_PROPERTY_BANNER_LOW_RESOLUTION = "bannerLowResolution";
  private String bannerLowResolution;

  public static final String JSON_PROPERTY_BANNER_HIGH_RESOLUTION = "bannerHighResolution";
  private String bannerHighResolution;


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

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

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

  public Product 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 Product name(String name) {
    this.name = name;
    return this;
  }

   /**
   * The name of the product
   * @return name
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "Hockey madness", required = true, value = "The name of the product")
  @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 Product description(String description) {
    this.description = description;
    return this;
  }

   /**
   * The description of the product for your reference
   * @return description
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "Spin the hockey wheal", value = "The description of the product for your reference")
  @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 Product adjustmentFactor(Double adjustmentFactor) {
    this.adjustmentFactor = adjustmentFactor;
    return this;
  }

   /**
   * The multiplier to apply to source values received for this product events
   * @return adjustmentFactor
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "1", required = true, value = "The multiplier to apply to source values received for this product events")
  @JsonProperty(JSON_PROPERTY_ADJUSTMENT_FACTOR)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public Double getAdjustmentFactor() {
    return adjustmentFactor;
  }


  @JsonProperty(JSON_PROPERTY_ADJUSTMENT_FACTOR)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setAdjustmentFactor(Double adjustmentFactor) {
    this.adjustmentFactor = adjustmentFactor;
  }


  public Product productRefId(String productRefId) {
    this.productRefId = productRefId;
    return this;
  }

   /**
   * The reference to this product in your system. The reference identifier can not be changed after the product has been created
   * @return productRefId
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "hockey-madness", required = true, value = "The reference to this product in your system. The reference identifier can not be changed after the product has been created")
  @JsonProperty(JSON_PROPERTY_PRODUCT_REF_ID)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public String getProductRefId() {
    return productRefId;
  }


  @JsonProperty(JSON_PROPERTY_PRODUCT_REF_ID)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setProductRefId(String productRefId) {
    this.productRefId = productRefId;
  }


  public Product productType(String productType) {
    this.productType = productType;
    return this;
  }

   /**
   * The type to this product in your system.
   * @return productType
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "hockey-madness", value = "The type to this product in your system.")
  @JsonProperty(JSON_PROPERTY_PRODUCT_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getProductType() {
    return productType;
  }


  @JsonProperty(JSON_PROPERTY_PRODUCT_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setProductType(String productType) {
    this.productType = productType;
  }


  public Product actionTypeAdjustmentFactors(List actionTypeAdjustmentFactors) {
    this.actionTypeAdjustmentFactors = actionTypeAdjustmentFactors;
    return this;
  }

  public Product addActionTypeAdjustmentFactorsItem(ActionTypeAdjustmentFactor actionTypeAdjustmentFactorsItem) {
    if (this.actionTypeAdjustmentFactors == null) {
      this.actionTypeAdjustmentFactors = new ArrayList<>();
    }
    this.actionTypeAdjustmentFactors.add(actionTypeAdjustmentFactorsItem);
    return this;
  }

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

  public List getActionTypeAdjustmentFactors() {
    return actionTypeAdjustmentFactors;
  }


  @JsonProperty(JSON_PROPERTY_ACTION_TYPE_ADJUSTMENT_FACTORS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setActionTypeAdjustmentFactors(List actionTypeAdjustmentFactors) {
    this.actionTypeAdjustmentFactors = actionTypeAdjustmentFactors;
  }


  public Product icon(String icon) {
    this.icon = icon;
    return this;
  }

   /**
   * An Icon id that has been pre uploaded to the system to display for Product
   * @return icon
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "An Icon id that has been pre uploaded to the system to display for Product")
  @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 Product banner(String banner) {
    this.banner = banner;
    return this;
  }

   /**
   * Link to the banner
   * @return banner
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "https://.cdn.ziqni.com/_id/", value = "Link to the banner")
  @JsonProperty(JSON_PROPERTY_BANNER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getBanner() {
    return banner;
  }


  @JsonProperty(JSON_PROPERTY_BANNER)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setBanner(String banner) {
    this.banner = banner;
  }


  public Product bannerLowResolution(String bannerLowResolution) {
    this.bannerLowResolution = bannerLowResolution;
    return this;
  }

   /**
   * Link to the bannerLowResolution
   * @return bannerLowResolution
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "https://.cdn.ziqni.com/_id/", value = "Link to the bannerLowResolution")
  @JsonProperty(JSON_PROPERTY_BANNER_LOW_RESOLUTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getBannerLowResolution() {
    return bannerLowResolution;
  }


  @JsonProperty(JSON_PROPERTY_BANNER_LOW_RESOLUTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setBannerLowResolution(String bannerLowResolution) {
    this.bannerLowResolution = bannerLowResolution;
  }


  public Product bannerHighResolution(String bannerHighResolution) {
    this.bannerHighResolution = bannerHighResolution;
    return this;
  }

   /**
   * Link to the bannerHighResolution
   * @return bannerHighResolution
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "https://.cdn.ziqni.com/_id/", value = "Link to the bannerHighResolution")
  @JsonProperty(JSON_PROPERTY_BANNER_HIGH_RESOLUTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getBannerHighResolution() {
    return bannerHighResolution;
  }


  @JsonProperty(JSON_PROPERTY_BANNER_HIGH_RESOLUTION)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setBannerHighResolution(String bannerHighResolution) {
    this.bannerHighResolution = bannerHighResolution;
  }


  /**
   * Return true if this Product object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Product product = (Product) o;
    return Objects.equals(this.id, product.id) &&
        Objects.equals(this.spaceName, product.spaceName) &&
        Objects.equals(this.created, product.created) &&
        Objects.equals(this.customFields, product.customFields) &&
        Objects.equals(this.tags, product.tags) &&
        Objects.equals(this.metadata, product.metadata) &&
        Objects.equals(this.name, product.name) &&
        Objects.equals(this.description, product.description) &&
        Objects.equals(this.adjustmentFactor, product.adjustmentFactor) &&
        Objects.equals(this.productRefId, product.productRefId) &&
        Objects.equals(this.productType, product.productType) &&
        Objects.equals(this.actionTypeAdjustmentFactors, product.actionTypeAdjustmentFactors) &&
        Objects.equals(this.icon, product.icon) &&
        Objects.equals(this.banner, product.banner) &&
        Objects.equals(this.bannerLowResolution, product.bannerLowResolution) &&
        Objects.equals(this.bannerHighResolution, product.bannerHighResolution);
  }

  @Override
  public int hashCode() {
    return Objects.hash(id, spaceName, created, customFields, tags, metadata, name, description, adjustmentFactor, productRefId, productType, actionTypeAdjustmentFactors, icon, banner, bannerLowResolution, bannerHighResolution);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Product {\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("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    adjustmentFactor: ").append(toIndentedString(adjustmentFactor)).append("\n");
    sb.append("    productRefId: ").append(toIndentedString(productRefId)).append("\n");
    sb.append("    productType: ").append(toIndentedString(productType)).append("\n");
    sb.append("    actionTypeAdjustmentFactors: ").append(toIndentedString(actionTypeAdjustmentFactors)).append("\n");
    sb.append("    icon: ").append(toIndentedString(icon)).append("\n");
    sb.append("    banner: ").append(toIndentedString(banner)).append("\n");
    sb.append("    bannerLowResolution: ").append(toIndentedString(bannerLowResolution)).append("\n");
    sb.append("    bannerHighResolution: ").append(toIndentedString(bannerHighResolution)).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