com.yodlee.api.model.transaction.Description Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation
Yodlee API Model Beta is the stage version
There is a newer version: 1.0.29.beta1
Show newest version
/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.transaction;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.AbstractModelComponent;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"simple", "original", "consumer", "security"})
public class Description extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field."
							  + "Note: The simple description field is available only in the United States, Canada, United Kingdom, and India."//
							  + "

"//
							  + "Applicable containers: creditCard, insurance, loan
"//
	)
	@JsonProperty("simple")
	private String simple;

	@ApiModelProperty(readOnly = true,
					  value = "Original transaction description as it appears at the FI site."//
							  + "

"//
							  + "Applicable containers: creditCard, insurance, loan
"//
	)
	@JsonProperty("original")
	private String original;

	@ApiModelProperty(value = "The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field."//
			+ "

"//
			+ "Applicable containers: creditCard, insurance, loan
"//
	)
	@JsonProperty("consumer")
	private String consumer;

	@ApiModelProperty(readOnly = true,
					  value = "The description will provide the actual name of the security." + "

"//
							  + "Applicable containers: investment
"//
	)
	@JsonProperty("security")
	private String security;

	/**
	 * The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of
	 * the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the
	 * consumer, and this simplified transaction description is provided in the simple description field. Note: The
	 * simple description field is available only in the United States, Canada, United Kingdom, and India. 

	 * 

	 * Applicable containers: creditCard, insurance, loan

	 * 
	 * @return simple
	 */
	public String getSimple() {
		return simple;
	}

	public void setSimple(String simple) {
		this.simple = simple;
	}

	/**
	 * Original transaction description as it appears at the FI site. 

	 * 

	 * Applicable containers: creditCard, insurance, loan

	 * 
	 * @return original
	 */
	public String getOriginal() {
		return original;
	}

	public void setOriginal(String original) {
		this.original = original;
	}

	/**
	 * The description of the transaction as defined by the consumer. The consumer can define or provide more details of
	 * the transaction in this field. 

	 * 

	 * Applicable containers: creditCard, insurance, loan

	 * 
	 * @return consumer
	 */
	public String getConsumer() {
		return consumer;
	}

	public void setConsumer(String consumer) {
		this.consumer = consumer;
	}

	/**
	 * The description will provide the actual name of the security. 

	 * 

	 * Applicable containers: investment

	 * 
	 * @return security
	 */
	public String getSecurity() {
		return security;
	}

	@Override
	public String toString() {
		return "Description [simple=" + simple + ", original=" + original + ", consumer=" + consumer + ", security="
				+ security + "]";
	}
}