class Plaid::IndividualWatchlistProgram
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
Attributes
An ISO8601 formatted timestamp.
ID of the associated program.
Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
Indicator specifying whether the program is enabled and will perform daily rescans.
Watchlists enabled for the associated program
A name for the program to define its purpose. For example, "High Risk Individuals", "US Cardholders", or "Applicants".
Public Class Methods
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 78 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 64 def self.attribute_map { :'id' => :'id', :'created_at' => :'created_at', :'is_rescanning_enabled' => :'is_rescanning_enabled', :'lists_enabled' => :'lists_enabled', :'name' => :'name', :'name_sensitivity' => :'name_sensitivity', :'audit_trail' => :'audit_trail', :'is_archived' => :'is_archived' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 247 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 104 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IndividualWatchlistProgram` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IndividualWatchlistProgram`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'is_rescanning_enabled') self.is_rescanning_enabled = attributes[:'is_rescanning_enabled'] end if attributes.key?(:'lists_enabled') if (value = attributes[:'lists_enabled']).is_a?(Array) self.lists_enabled = value end end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'name_sensitivity') self.name_sensitivity = attributes[:'name_sensitivity'] end if attributes.key?(:'audit_trail') self.audit_trail = attributes[:'audit_trail'] end if attributes.key?(:'is_archived') self.is_archived = attributes[:'is_archived'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 97 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 83 def self.openapi_types { :'id' => :'String', :'created_at' => :'Time', :'is_rescanning_enabled' => :'Boolean', :'lists_enabled' => :'Array<IndividualWatchlistCode>', :'name' => :'String', :'name_sensitivity' => :'ProgramNameSensitivity', :'audit_trail' => :'WatchlistScreeningAuditTrail', :'is_archived' => :'Boolean' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 219 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created_at == o.created_at && is_rescanning_enabled == o.is_rescanning_enabled && lists_enabled == o.lists_enabled && name == o.name && name_sensitivity == o.name_sensitivity && audit_trail == o.audit_trail && is_archived == o.is_archived end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 278 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 349 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 254 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 234 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 240 def hash [id, created_at, is_rescanning_enabled, lists_enabled, name, name_sensitivity, audit_trail, is_archived].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 154 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @is_rescanning_enabled.nil? invalid_properties.push('invalid value for "is_rescanning_enabled", is_rescanning_enabled cannot be nil.') end if @lists_enabled.nil? invalid_properties.push('invalid value for "lists_enabled", lists_enabled cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name_sensitivity.nil? invalid_properties.push('invalid value for "name_sensitivity", name_sensitivity cannot be nil.') end if @audit_trail.nil? invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.') end if @is_archived.nil? invalid_properties.push('invalid value for "is_archived", is_archived cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 208 def lists_enabled=(lists_enabled) if lists_enabled.nil? fail ArgumentError, 'lists_enabled cannot be nil' end @lists_enabled = lists_enabled end
Custom attribute writer method with validation @param [Object] lists_enabled
Value to be assigned
Source
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 331 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 319 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/individual_watchlist_program.rb, line 194 def valid? return false if @id.nil? return false if @created_at.nil? return false if @is_rescanning_enabled.nil? return false if @lists_enabled.nil? return false if @name.nil? return false if @name_sensitivity.nil? return false if @audit_trail.nil? return false if @is_archived.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid