plaid2.model.credit_relay_refresh_request module

class plaid2.model.credit_relay_refresh_request.CreditRelayRefreshRequest(*, relay_token: str, webhook: Optional[str] = None, report_type: str)[source]

Bases: BaseModel

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

classmethod parse_obj(data: Any) → CreditRelayRefreshRequest[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) → CreditRelayRefreshRequest[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

relay_token: str: The relay_token granting access to the report you would like to refresh.

report_type: str: The report type. It can be assets or income.

webhook: Optional[str]: The URL registered to receive webhooks when the report of a Relay Token has been refreshed.