class Plaid::BeaconReportCreateRequest
Request input for creating a Beacon Report
Attributes
ID of the associated Beacon User.
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 date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
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.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/beacon_report_create_request.rb, line 70 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/beacon_report_create_request.rb, line 58 def self.attribute_map { :'beacon_user_id' => :'beacon_user_id', :'type' => :'type', :'fraud_date' => :'fraud_date', :'fraud_amount' => :'fraud_amount', :'client_id' => :'client_id', :'secret' => :'secret' } 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/beacon_report_create_request.rb, line 189 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/beacon_report_create_request.rb, line 95 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BeaconReportCreateRequest` 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::BeaconReportCreateRequest`. 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?(:'beacon_user_id') self.beacon_user_id = attributes[:'beacon_user_id'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'fraud_date') self.fraud_date = attributes[:'fraud_date'] end if attributes.key?(:'fraud_amount') self.fraud_amount = attributes[:'fraud_amount'] end if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end end
List of attributes with nullable: true
# File lib/plaid/models/beacon_report_create_request.rb, line 87 def self.openapi_nullable Set.new([ :'fraud_amount', ]) end
Attribute type mapping.
# File lib/plaid/models/beacon_report_create_request.rb, line 75 def self.openapi_types { :'beacon_user_id' => :'String', :'type' => :'BeaconReportCreateType', :'fraud_date' => :'Date', :'fraud_amount' => :'FraudAmount', :'client_id' => :'String', :'secret' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/beacon_report_create_request.rb, line 163 def ==(o) return true if self.equal?(o) self.class == o.class && beacon_user_id == o.beacon_user_id && type == o.type && fraud_date == o.fraud_date && fraud_amount == o.fraud_amount && client_id == o.client_id && secret == o.secret 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/beacon_report_create_request.rb, line 220 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/beacon_report_create_request.rb, line 291 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/beacon_report_create_request.rb, line 196 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/beacon_report_create_request.rb, line 176 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/beacon_report_create_request.rb, line 182 def hash [beacon_user_id, type, fraud_date, fraud_amount, client_id, secret].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/beacon_report_create_request.rb, line 135 def list_invalid_properties invalid_properties = Array.new if @beacon_user_id.nil? invalid_properties.push('invalid value for "beacon_user_id", beacon_user_id cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @fraud_date.nil? invalid_properties.push('invalid value for "fraud_date", fraud_date 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/beacon_report_create_request.rb, line 273 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/beacon_report_create_request.rb, line 261 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/beacon_report_create_request.rb, line 154 def valid? return false if @beacon_user_id.nil? return false if @type.nil? return false if @fraud_date.nil? true end