Source code for plaid2.model.institutions_get_by_id_request_options

from typing import Any, Dict, List, Optional, Union
from enum import Enum
from pydantic import BaseModel, Field


[docs]class InstitutionsGetByIdRequestOptions(BaseModel): include_payment_initiation_metadata: Optional[bool] = None """When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.""" include_optional_metadata: Optional[bool] = None """When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`. Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.""" include_status: Optional[bool] = None """If `true`, the response will include status information about the institution. Default value is `false`.""" include_auth_metadata: Optional[bool] = None """When `true`, returns metadata related to the Auth product indicating which auth methods are supported."""
[docs] def json(self, **kwargs: Any) -> str: """Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json""" kwargs.setdefault("by_alias", True) return super().json(**kwargs)
[docs] def dict(self, **kwargs: Any) -> Dict[str, Any]: """Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict""" kwargs.setdefault("by_alias", True) return super().dict(**kwargs)
[docs] @classmethod def parse_obj(cls, data: Any) -> "InstitutionsGetByIdRequestOptions": """Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj""" return super().parse_obj(data)
[docs] @classmethod def parse_raw(cls, b: Union[bytes, str], **kwargs: Any) -> "InstitutionsGetByIdRequestOptions": """Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw""" return super().parse_raw(b, **kwargs)