plaid2.model.assets_relay_webhook module

class plaid2.model.assets_relay_webhook.AssetsRelayWebhook(*, asset_relay_token: str, relay_event: str, secondary_client_id: str, webhook_type: str, webhook_code: str, asset_report_id: str)[source]

Bases: BaseModel

asset_relay_token: str

The asset_relay_token that was created by calling `/asset_report/relay/create.

asset_report_id: str

The asset_report_id that can be provided to /asset_report/relay/get to retrieve the Asset Report.

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) AssetsRelayWebhook[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) AssetsRelayWebhook[source]

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

relay_event: str

The webhook code indicating which endpoint was called. It can be one of GET_CALLED, REFRESH_CALLED or AUDIT_COPY_CREATE_CALLED.

secondary_client_id: str

The id of the client with whom the Asset Report is being shared.

webhook_code: str

RELAY_EVENT

webhook_type: str

ASSETS