class Plaid::WatchlistScreeningIndividualUpdateRequest
Request input for editing an individual watchlist screening
Attributes
ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use ‘/dashboard_user/get`.
Your Plaid
API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid
products. Financial Account Matching requires this field and the ‘/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
A list of fields to reset back to null
Your Plaid
API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
ID of the associated screening.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 78 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 64 def self.attribute_map { :'watchlist_screening_id' => :'watchlist_screening_id', :'search_terms' => :'search_terms', :'assignee' => :'assignee', :'status' => :'status', :'client_user_id' => :'client_user_id', :'client_id' => :'client_id', :'secret' => :'secret', :'reset_fields' => :'reset_fields' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 202 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 106 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::WatchlistScreeningIndividualUpdateRequest` 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::WatchlistScreeningIndividualUpdateRequest`. 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?(:'watchlist_screening_id') self.watchlist_screening_id = attributes[:'watchlist_screening_id'] end if attributes.key?(:'search_terms') self.search_terms = attributes[:'search_terms'] end if attributes.key?(:'assignee') self.assignee = attributes[:'assignee'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'client_user_id') self.client_user_id = attributes[:'client_user_id'] end if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'reset_fields') if (value = attributes[:'reset_fields']).is_a?(Array) self.reset_fields = value end end end
List of attributes with nullable: true
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 97 def self.openapi_nullable Set.new([ :'search_terms', :'reset_fields' ]) end
Attribute type mapping.
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 83 def self.openapi_types { :'watchlist_screening_id' => :'String', :'search_terms' => :'UpdateIndividualScreeningRequestSearchTerms', :'assignee' => :'String', :'status' => :'WatchlistScreeningStatus', :'client_user_id' => :'String', :'client_id' => :'String', :'secret' => :'String', :'reset_fields' => :'Array<WatchlistScreeningIndividualUpdateRequestResettableField>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 174 def ==(o) return true if self.equal?(o) self.class == o.class && watchlist_screening_id == o.watchlist_screening_id && search_terms == o.search_terms && assignee == o.assignee && status == o.status && client_user_id == o.client_user_id && client_id == o.client_id && secret == o.secret && reset_fields == o.reset_fields end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 233 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
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
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 304 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 209 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 189 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 195 def hash [watchlist_screening_id, search_terms, assignee, status, client_user_id, client_id, secret, reset_fields].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 156 def list_invalid_properties invalid_properties = Array.new if @watchlist_screening_id.nil? invalid_properties.push('invalid value for "watchlist_screening_id", watchlist_screening_id cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 286 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 string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 274 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/watchlist_screening_individual_update_request.rb, line 167 def valid? return false if @watchlist_screening_id.nil? true end