com.yodlee.api.model.AccountHolder 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;

import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.account.enums.HolderOwnershipType;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"ownership", "name", "identifier", "gender"})
public class AccountHolder extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "Name of the account holder."//
							  + "

"//
							  + "Aggregated / Manual: Aggregated 
"//
							  + "Applicable containers: bank
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("name")
	private Name name;

	@ApiModelProperty(readOnly = true,
					  value = "Identifiers of the account holder."//
							  + "

"//
							  + "Aggregated / Manual: Aggregated 
"//
							  + "Applicable containers: bank
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("identifier")
	private List identifier;

	@ApiModelProperty(readOnly = true,
					  value = "Identifiers of the account holder."//
							  + "

"//
							  + "Aggregated / Manual: Aggregated 
"//
							  + "Applicable containers: bank
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("gender")
	private String gender;

	@ApiModelProperty(readOnly = true,
					  value = "Indicates the ownership of the account."//
							  + "

"//
							  + "Aggregated / Manual: Aggregated 
"//
							  + "Applicable containers: bank
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + ""//
							  + "Applicable Values
"//
	)
	@JsonProperty("ownership")
	private HolderOwnershipType ownership;

	/**
	 * Name of the account holder. 

	 * 

	 * Aggregated / Manual: Aggregated 

	 * Applicable containers: bank

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return name
	 */
	public Name getName() {
		return name;
	}

	/**
	 * Identifiers of the account holder. 

	 * 

	 * Aggregated / Manual: Aggregated 

	 * Applicable containers: bank

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return identifier
	 */
	public List getIdentifier() {
		return identifier == null ? null : Collections.unmodifiableList(identifier);
	}

	/**
	 * Identifiers of the account holder. 

	 * 

	 * Aggregated / Manual: Aggregated 

	 * Applicable containers: bank

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return gender
	 */
	public String getGender() {
		return gender;
	}

	/**
	 * Indicates the ownership of the account. 

	 * 

	 * Aggregated / Manual: Aggregated 

	 * Applicable containers: bank

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * Applicable Values

	 * 
	 * @return ownership
	 */
	public HolderOwnershipType getOwnership() {
		return ownership;
	}

	@Override
	public String toString() {
		return "AccountHolder [name=" + name + ", identifier=" + identifier + ", gender=" + gender + ", ownership="
				+ ownership + "]";
	}
}