class Notifo::PublishDto
Attributes
A custom id to identity the creator.
Additional user defined data.
The notification settings.
True when silent.
The template code.
True when using test integrations.
The time to live in seconds.
A custom timestamp.
The topic path.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/notifo/models/publish_dto.rb, line 50 def self.attribute_map { :'topic' => :'topic', :'creator_id' => :'creatorId', :'template_code' => :'templateCode', :'data' => :'data', :'timestamp' => :'timestamp', :'preformatted' => :'preformatted', :'settings' => :'settings', :'properties' => :'properties', :'scheduling' => :'scheduling', :'silent' => :'silent', :'test' => :'test', :'time_to_live_in_seconds' => :'timeToLiveInSeconds' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/notifo/models/publish_dto.rb, line 214 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/notifo/models/publish_dto.rb, line 98 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::PublishDto` 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 `Notifo::PublishDto`. 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?(:'topic') self.topic = attributes[:'topic'] end if attributes.key?(:'creator_id') self.creator_id = attributes[:'creator_id'] end if attributes.key?(:'template_code') self.template_code = attributes[:'template_code'] end if attributes.key?(:'data') self.data = attributes[:'data'] end if attributes.key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.key?(:'preformatted') self.preformatted = attributes[:'preformatted'] end if attributes.key?(:'settings') if (value = attributes[:'settings']).is_a?(Hash) self.settings = value end end if attributes.key?(:'properties') self.properties = attributes[:'properties'] end if attributes.key?(:'scheduling') self.scheduling = attributes[:'scheduling'] end if attributes.key?(:'silent') self.silent = attributes[:'silent'] end if attributes.key?(:'test') self.test = attributes[:'test'] end if attributes.key?(:'time_to_live_in_seconds') self.time_to_live_in_seconds = attributes[:'time_to_live_in_seconds'] end end
List of attributes with nullable: true
# File lib/notifo/models/publish_dto.rb, line 86 def self.openapi_nullable Set.new([ :'creator_id', :'template_code', :'data', :'settings', :'time_to_live_in_seconds' ]) end
Attribute type mapping.
# File lib/notifo/models/publish_dto.rb, line 68 def self.openapi_types { :'topic' => :'Object', :'creator_id' => :'Object', :'template_code' => :'Object', :'data' => :'Object', :'timestamp' => :'Object', :'preformatted' => :'Object', :'settings' => :'Object', :'properties' => :'Object', :'scheduling' => :'Object', :'silent' => :'Object', :'test' => :'Object', :'time_to_live_in_seconds' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/notifo/models/publish_dto.rb, line 182 def ==(o) return true if self.equal?(o) self.class == o.class && topic == o.topic && creator_id == o.creator_id && template_code == o.template_code && data == o.data && timestamp == o.timestamp && preformatted == o.preformatted && settings == o.settings && properties == o.properties && scheduling == o.scheduling && silent == o.silent && test == o.test && time_to_live_in_seconds == o.time_to_live_in_seconds 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/notifo/models/publish_dto.rb, line 244 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 Notifo.const_get(type).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/notifo/models/publish_dto.rb, line 313 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/notifo/models/publish_dto.rb, line 221 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/notifo/models/publish_dto.rb, line 201 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/notifo/models/publish_dto.rb, line 207 def hash [topic, creator_id, template_code, data, timestamp, preformatted, settings, properties, scheduling, silent, test, time_to_live_in_seconds].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/notifo/models/publish_dto.rb, line 164 def list_invalid_properties invalid_properties = Array.new if @topic.nil? invalid_properties.push('invalid value for "topic", topic 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/notifo/models/publish_dto.rb, line 295 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/notifo/models/publish_dto.rb, line 283 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/notifo/models/publish_dto.rb, line 175 def valid? return false if @topic.nil? true end