class Plaid::EntityWatchlistScreening

Overview

The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.

Included Modules

Defined in:

plaid/models/entity_watchlist_screening.cr

Constant Summary

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, id : String | Nil = nil, search_terms : EntityWatchlistScreeningSearchTerms | Nil = nil, assignee : String | Nil = nil, status : Plaid::WatchlistScreeningStatus | Nil = nil, client_user_id : String | Nil = nil, audit_trail : WatchlistScreeningAuditTrail | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def assignee : String | Nil #

[View source]
def assignee=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] assignee Object to be assigned


[View source]
def audit_trail : WatchlistScreeningAuditTrail | Nil #

[View source]
def audit_trail=(new_value : WatchlistScreeningAuditTrail | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] audit_trail Object to be assigned


[View source]
def client_user_id : String | Nil #

[View source]
def client_user_id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] client_user_id Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned


[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def search_terms : EntityWatchlistScreeningSearchTerms | Nil #

[View source]
def search_terms=(new_value : EntityWatchlistScreeningSearchTerms | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] search_terms Object to be assigned


[View source]
def status : Plaid::WatchlistScreeningStatus | Nil #

[View source]
def status=(new_value : Plaid::WatchlistScreeningStatus | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]