class

Plaid::EntityWatchlistProgram

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.

Constants

MIN_LENGTH_FOR_NAME = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, created_at : Time | Nil = nil, is_rescanning_enabled : Bool | Nil = nil, lists_enabled : Array(EntityWatchlistCode) | Nil = nil, name : String | Nil = nil, name_sensitivity : Plaid::ProgramNameSensitivity | Nil = nil, audit_trail : WatchlistScreeningAuditTrail | Nil = nil, is_archived : Bool | Nil = nil)

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

Source

Instance methods

==(other : self)

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

audit_trail
Source
audit_trail=(new_value : WatchlistScreeningAuditTrail | Nil)

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

Source
created_at

An ISO8601 formatted timestamp.

Source
created_at=(new_value : Time | Nil)

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

Source
hash(hasher)

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

id

ID of the associated entity program.

Source
id=(new_value : String | Nil)

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

Source
is_archived

Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.

Source
is_archived=(new_value : Bool | Nil)

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

Source
is_rescanning_enabled

Indicator specifying whether the program is enabled and will perform daily rescans.

Source
is_rescanning_enabled=(new_value : Bool | Nil)

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

Source
list_invalid_properties

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

Source
lists_enabled

Watchlists enabled for the associated program

Source
lists_enabled=(new_value : Array(EntityWatchlistCode) | Nil)

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

Source
name

A name for the entity program to define its purpose. For example, "High Risk Organizations" or "Applicants".

Source
name=(new_value : String | Nil)

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

Source
name_sensitivity
Source
name_sensitivity=(new_value : Plaid::ProgramNameSensitivity | Nil)

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

Source
valid?

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

Source