class Plaid::FDXNotification
Provides the base fields of a notification. Clients will read the ‘type` property to determine the expected notification payload
Attributes
Id of notification
ISO 8601 date-time in format ‘YYYY-MM-DDThh:mm:ss.nnn[Z|hh:mm]’ according to [IETF RFC3339](xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/fdx_notification.rb, line 80 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/fdx_notification.rb, line 64 def self.attribute_map { :'notification_id' => :'notificationId', :'type' => :'type', :'sent_on' => :'sentOn', :'category' => :'category', :'severity' => :'severity', :'priority' => :'priority', :'publisher' => :'publisher', :'subscriber' => :'subscriber', :'notification_payload' => :'notificationPayload', :'url' => :'url' } 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/fdx_notification.rb, line 232 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/fdx_notification.rb, line 108 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::FDXNotification` 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::FDXNotification`. 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?(:'notification_id') self.notification_id = attributes[:'notification_id'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'sent_on') self.sent_on = attributes[:'sent_on'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'severity') self.severity = attributes[:'severity'] end if attributes.key?(:'priority') self.priority = attributes[:'priority'] end if attributes.key?(:'publisher') self.publisher = attributes[:'publisher'] end if attributes.key?(:'subscriber') self.subscriber = attributes[:'subscriber'] end if attributes.key?(:'notification_payload') self.notification_payload = attributes[:'notification_payload'] end if attributes.key?(:'url') self.url = attributes[:'url'] end end
List of attributes with nullable: true
# File lib/plaid/models/fdx_notification.rb, line 101 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/plaid/models/fdx_notification.rb, line 85 def self.openapi_types { :'notification_id' => :'String', :'type' => :'FDXNotificationType', :'sent_on' => :'Time', :'category' => :'FDXNotificationCategory', :'severity' => :'FDXNotificationSeverity', :'priority' => :'FDXNotificationPriority', :'publisher' => :'FDXParty', :'subscriber' => :'FDXParty', :'notification_payload' => :'FDXNotificationPayload', :'url' => :'FDXHateoasLink' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/fdx_notification.rb, line 202 def ==(o) return true if self.equal?(o) self.class == o.class && notification_id == o.notification_id && type == o.type && sent_on == o.sent_on && category == o.category && severity == o.severity && priority == o.priority && publisher == o.publisher && subscriber == o.subscriber && notification_payload == o.notification_payload && url == o.url 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/fdx_notification.rb, line 263 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/fdx_notification.rb, line 334 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/fdx_notification.rb, line 239 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/fdx_notification.rb, line 219 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/fdx_notification.rb, line 225 def hash [notification_id, type, sent_on, category, severity, priority, publisher, subscriber, notification_payload, url].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/fdx_notification.rb, line 164 def list_invalid_properties invalid_properties = Array.new if @notification_id.nil? invalid_properties.push('invalid value for "notification_id", notification_id cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @sent_on.nil? invalid_properties.push('invalid value for "sent_on", sent_on cannot be nil.') end if @category.nil? invalid_properties.push('invalid value for "category", category cannot be nil.') end if @notification_payload.nil? invalid_properties.push('invalid value for "notification_payload", notification_payload 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/fdx_notification.rb, line 316 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/fdx_notification.rb, line 304 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/fdx_notification.rb, line 191 def valid? return false if @notification_id.nil? return false if @type.nil? return false if @sent_on.nil? return false if @category.nil? return false if @notification_payload.nil? true end