Class: Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg
- Defined in:
- lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb
Instance Attribute Summary collapse
-
#contact_properties ⇒ Object
The contactProperties field is a map of contact property values.
-
#custom_properties ⇒ Object
The customProperties field is a map of property values.
-
#email_id ⇒ Object
The content ID for the transactional email, which can be found in email tool UI.
-
#message ⇒ Object
Returns the value of attribute message.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PublicSingleSendRequestEgg
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PublicSingleSendRequestEgg
Initializes the object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 58 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg` 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 `Hubspot::Marketing::Transactional::PublicSingleSendRequestEgg`. 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?(:'email_id') self.email_id = attributes[:'email_id'] end if attributes.key?(:'message') self. = attributes[:'message'] end if attributes.key?(:'contact_properties') if (value = attributes[:'contact_properties']).is_a?(Hash) self.contact_properties = value end end if attributes.key?(:'custom_properties') if (value = attributes[:'custom_properties']).is_a?(Hash) self.custom_properties = value end end end |
Instance Attribute Details
#contact_properties ⇒ Object
The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under contact.NAME }. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.
25 26 27 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 25 def contact_properties @contact_properties end |
#custom_properties ⇒ Object
The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under custom.NAME }. Note: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.
28 29 30 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 28 def custom_properties @custom_properties end |
#email_id ⇒ Object
The content ID for the transactional email, which can be found in email tool UI.
20 21 22 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 20 def email_id @email_id end |
#message ⇒ Object
Returns the value of attribute message.
22 23 24 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 22 def @message end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 38 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 31 def self.attribute_map { :'email_id' => :'emailId', :'message' => :'message', :'contact_properties' => :'contactProperties', :'custom_properties' => :'customProperties' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
141 142 143 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 141 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
51 52 53 54 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 51 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
41 42 43 44 45 46 47 48 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 41 def self.openapi_types { :'email_id' => :'Integer', :'message' => :'PublicSingleSendEmail', :'contact_properties' => :'Hash<String, String>', :'custom_properties' => :'Hash<String, Object>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
117 118 119 120 121 122 123 124 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 117 def ==(o) return true if self.equal?(o) self.class == o.class && email_id == o.email_id && == o. && contact_properties == o.contact_properties && custom_properties == o.custom_properties end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 169 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 Hubspot::Marketing::Transactional.const_get(type).build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 238 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 148 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]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
128 129 130 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 128 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
134 135 136 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 134 def hash [email_id, , contact_properties, custom_properties].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 94 def list_invalid_properties invalid_properties = Array.new if @email_id.nil? invalid_properties.push('invalid value for "email_id", email_id cannot be nil.') end if @message.nil? invalid_properties.push('invalid value for "message", message cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
214 215 216 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 214 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 220 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 |
#to_s ⇒ String
Returns the string representation of the object
208 209 210 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 208 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
109 110 111 112 113 |
# File 'lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb', line 109 def valid? return false if @email_id.nil? return false if @message.nil? true end |