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

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.yodlee.api.model.AbstractModelComponent;
import com.yodlee.api.model.Name;
import com.yodlee.api.model.user.enums.RoleType;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
public abstract class AbstractUser extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for."//
							  + "

"//
							  + "Endpoints:"//
							  + ""//
							  + "POST user/samlLogin"//
							  + "POST user/register"//
							  + "GET user"//
							  + "")
	@JsonProperty("id")
	protected Long id;

	@ApiModelProperty(readOnly = true,
					  value = "The login name of the user used for authentication."//
							  + "

"//
							  + "Endpoints:"//
							  + ""//
							  + "POST user/register"//
							  + "GET user"//
							  + "")
	@JsonProperty("loginName")
	protected String loginName;

	@ApiModelProperty(readOnly = true,
					  value = "First, middle and last names of the user."//
							  + "

"//
							  + "Endpoints:"//
							  + ""//
							  + "POST user/samlLogin"//
							  + "POST user/register"//
							  + "GET user"//
							  + "")
	@JsonProperty("name")
	protected Name name;

	@ApiModelProperty(readOnly = true,
					  value = "Preferences of the user to be respected in the data provided through various API services."//
							  + "

"//
							  + "Endpoints:"//
							  + ""//
							  + "POST user/samlLogin"//
							  + "POST user/register"//
							  + "GET user"//
							  + "")
	@JsonProperty("preferences")
	protected UserResponsePreferences preferences;

	@JsonProperty("roleType")
	protected RoleType roleType;

	public AbstractUser() {}

	/**
	 * The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for. 

	 * 

	 * Endpoints:
	 * 
	 * POST user/samlLogin
	 * POST user/register
	 * GET user
	 * 
	 * 
	 * @return id
	 */
	public Long getId() {
		return id;
	}

	/**
	 * First, middle and last names of the user. 

	 * 

	 * Endpoints:
	 * 
	 * POST user/samlLogin
	 * POST user/register
	 * GET user
	 * 
	 * 
	 * @return name
	 */
	public Name getName() {
		return name;
	}

	/**
	 * Preferences of the user to be respected in the data provided through various API services. 

	 * 

	 * Endpoints:
	 * 
	 * POST user/samlLogin
	 * POST user/register
	 * GET user
	 * 
	 * 
	 * @return user preferences
	 */
	public UserResponsePreferences getPreferences() {
		return preferences;
	}

	/**
	 * The login name of the user used for authentication. 

	 * 

	 * Endpoints:
	 * 
	 * POST user/register
	 * GET user
	 * 
	 * 
	 * @return loginName
	 */
	public String getLoginName() {
		return loginName;
	}

	public RoleType getRoleType() {
		return roleType;
	}
}