plaid2.model.paystub_address module

class plaid2.model.paystub_address.PaystubAddress(*, line_2: Optional[str] = None, region: Optional[str] = None, postal_code: Optional[str] = None, city: Optional[str] = None, street: Optional[str] = None, line_1: Optional[str] = None, country: Optional[str] = None, state_code: Optional[str] = None)[source]

Bases: BaseModel

city: Optional[str]

The full city name.

country: Optional[str]

The ISO 3166-1 alpha-2 country code.

dict(**kwargs: Any) Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

json(**kwargs: Any) str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

line_1: Optional[str]

Street address line 1.

line_2: Optional[str]

Street address line 2.

classmethod parse_obj(data: Any) PaystubAddress[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) PaystubAddress[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

postal_code: Optional[str]

The postal code of the address.

region: Optional[str]

The region or state Example: “NC”

state_code: Optional[str]

The region or state Example: “NC”

street: Optional[str]

The full street address.