from typing import Any, Dict, List, Optional, Union
from enum import Enum
from pydantic import BaseModel, Field
from .entity_screening_hit_analysis import EntityScreeningHitAnalysis
from .entity_screening_hit_data import EntityScreeningHitData
[docs]class EntityWatchlistScreeningHit(BaseModel):
id: str
"""ID of the associated entity screening hit."""
review_status: str
"""The current state of review. All watchlist screening hits begin in a `pending_review` state but can be changed by creating a review. When a hit is in the `pending_review` state, it will always show the latest version of the watchlist data Plaid has available and be compared against the latest customer information saved in the watchlist screening. Once a hit has been marked as `confirmed` or `dismissed` it will no longer be updated so that the state is as it was when the review was first conducted."""
first_active: str
"""An ISO8601 formatted timestamp."""
historical_since: Optional[str] = None
"""An ISO8601 formatted timestamp."""
plaid_uid: str
"""A universal identifier for a watchlist individual that is stable across searches and updates."""
analysis: Optional[EntityScreeningHitAnalysis] = None
"""Analysis information describing why a screening hit matched the provided entity information"""
inactive_since: Optional[str] = None
"""An ISO8601 formatted timestamp."""
list_code: str
"""Shorthand identifier for a specific screening list for entities."""
source_uid: Optional[str] = None
"""The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is `null`."""
data: Optional[EntityScreeningHitData] = None
"""Information associated with the entity watchlist hit"""
[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) -> "EntityWatchlistScreeningHit":
"""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) -> "EntityWatchlistScreeningHit":
"""Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw"""
return super().parse_raw(b, **kwargs)