java.lang.Object

com.plaid.client.model.AssetReportUser

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class AssetReportUser
extends java.lang.Object

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SERIALIZED_NAME_CLIENT_USER_ID`
`static java.lang.String`	`SERIALIZED_NAME_EMAIL`
`static java.lang.String`	`SERIALIZED_NAME_FIRST_NAME`
`static java.lang.String`	`SERIALIZED_NAME_LAST_NAME`
`static java.lang.String`	`SERIALIZED_NAME_MIDDLE_NAME`
`static java.lang.String`	`SERIALIZED_NAME_PHONE_NUMBER`
`static java.lang.String`	`SERIALIZED_NAME_SSN`

Constructor Summary

Constructors

Constructor Description

AssetReportUser()

Method Summary

Modifier and Type	Method	Description
`AssetReportUser`	`clientUserId(java.lang.String clientUserId)`
`AssetReportUser`	`email(java.lang.String email)`
`boolean`	`equals(java.lang.Object o)`
`AssetReportUser`	`firstName(java.lang.String firstName)`
`java.lang.String`	`getClientUserId()`	An identifier you determine and submit for the user.
`java.lang.String`	`getEmail()`	The user's email address.
`java.lang.String`	`getFirstName()`	The user's first name.
`java.lang.String`	`getLastName()`	The user's last name.
`java.lang.String`	`getMiddleName()`	The user's middle name
`java.lang.String`	`getPhoneNumber()`	The user's phone number, in E.164 format: +{countrycode}{number}.
`java.lang.String`	`getSsn()`	The user's Social Security Number.
`int`	`hashCode()`
`AssetReportUser`	`lastName(java.lang.String lastName)`
`AssetReportUser`	`middleName(java.lang.String middleName)`
`AssetReportUser`	`phoneNumber(java.lang.String phoneNumber)`
`void`	`setClientUserId(java.lang.String clientUserId)`
`void`	`setEmail(java.lang.String email)`
`void`	`setFirstName(java.lang.String firstName)`
`void`	`setLastName(java.lang.String lastName)`
`void`	`setMiddleName(java.lang.String middleName)`
`void`	`setPhoneNumber(java.lang.String phoneNumber)`
`void`	`setSsn(java.lang.String ssn)`
`AssetReportUser`	`ssn(java.lang.String ssn)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- SERIALIZED_NAME_CLIENT_USER_ID
  
  public static final java.lang.String SERIALIZED_NAME_CLIENT_USER_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_FIRST_NAME
  
  public static final java.lang.String SERIALIZED_NAME_FIRST_NAME
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_MIDDLE_NAME
  
  public static final java.lang.String SERIALIZED_NAME_MIDDLE_NAME
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_LAST_NAME
  
  public static final java.lang.String SERIALIZED_NAME_LAST_NAME
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SSN
  
  public static final java.lang.String SERIALIZED_NAME_SSN
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_PHONE_NUMBER
  
  public static final java.lang.String SERIALIZED_NAME_PHONE_NUMBER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_EMAIL
  
  public static final java.lang.String SERIALIZED_NAME_EMAIL
  
  See Also:
  
  Constant Field Values
Constructor Details
- AssetReportUser
  
  public AssetReportUser()
Method Details
- clientUserId
  
  public AssetReportUser clientUserId(java.lang.String clientUserId)
- getClientUserId
  
  @Nullable public java.lang.String getClientUserId()
  
  An identifier you determine and submit for the user.
  
  Returns:
  
  clientUserId
- setClientUserId
  
  public void setClientUserId(java.lang.String clientUserId)
- firstName
  
  public AssetReportUser firstName(java.lang.String firstName)
- getFirstName
  
  @Nullable public java.lang.String getFirstName()
  
  The user's first name. Required for the Fannie Mae Day 1 Certainty™ program.
  
  Returns:
  
  firstName
- setFirstName
  
  public void setFirstName(java.lang.String firstName)
- middleName
  
  public AssetReportUser middleName(java.lang.String middleName)
- getMiddleName
  
  @Nullable public java.lang.String getMiddleName()
  
  The user's middle name
  
  Returns:
  
  middleName
- setMiddleName
  
  public void setMiddleName(java.lang.String middleName)
- lastName
  
  public AssetReportUser lastName(java.lang.String lastName)
- getLastName
  
  @Nullable public java.lang.String getLastName()
  
  The user's last name. Required for the Fannie Mae Day 1 Certainty™ program.
  
  Returns:
  
  lastName
- setLastName
  
  public void setLastName(java.lang.String lastName)
- ssn
  
  public AssetReportUser ssn(java.lang.String ssn)
- getSsn
  
  @Nullable public java.lang.String getSsn()
  
  The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: \"ddd-dd-dddd\"
  
  Returns:
  
  ssn
- setSsn
  
  public void setSsn(java.lang.String ssn)
- phoneNumber
  
  public AssetReportUser phoneNumber(java.lang.String phoneNumber)
- getPhoneNumber
  
  @Nullable public java.lang.String getPhoneNumber()
  
  The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\". Phone numbers provided in other formats will be parsed on a best-effort basis.
  
  Returns:
  
  phoneNumber
- setPhoneNumber
  
  public void setPhoneNumber(java.lang.String phoneNumber)
- email
  
  public AssetReportUser email(java.lang.String email)
- getEmail
  
  @Nullable public java.lang.String getEmail()
  
  The user's email address.
  
  Returns:
  
  email
- setEmail
  
  public void setEmail(java.lang.String email)
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class AssetReportUser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details