Class: Hubspot::Marketing::Transactional::EmailSendStatusView
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Transactional::EmailSendStatusView
- Defined in:
- lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb
Overview
Describes the status of an email send request.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#completed_at ⇒ Object
Time when the send was completed.
-
#event_id ⇒ Object
Returns the value of attribute event_id.
-
#requested_at ⇒ Object
Time when the send was requested.
-
#send_result ⇒ Object
Result of the send.
-
#started_at ⇒ Object
Time when the send began processing.
-
#status ⇒ Object
Status of the send request.
-
#status_id ⇒ Object
Identifier used to query the status of the send.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.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 = {}) ⇒ EmailSendStatusView
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 = {}) ⇒ EmailSendStatusView
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 102 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Transactional::EmailSendStatusView` 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::EmailSendStatusView`. 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?(:'event_id') self.event_id = attributes[:'event_id'] end if attributes.key?(:'completed_at') self.completed_at = attributes[:'completed_at'] end if attributes.key?(:'status_id') self.status_id = attributes[:'status_id'] end if attributes.key?(:'send_result') self.send_result = attributes[:'send_result'] end if attributes.key?(:'requested_at') self.requested_at = attributes[:'requested_at'] end if attributes.key?(:'started_at') self.started_at = attributes[:'started_at'] end if attributes.key?(:'status') self.status = attributes[:'status'] end end |
Instance Attribute Details
#completed_at ⇒ Object
Time when the send was completed.
24 25 26 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 24 def completed_at @completed_at end |
#event_id ⇒ Object
Returns the value of attribute event_id.
21 22 23 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 21 def event_id @event_id end |
#requested_at ⇒ Object
Time when the send was requested.
33 34 35 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 33 def requested_at @requested_at end |
#send_result ⇒ Object
Result of the send.
30 31 32 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 30 def send_result @send_result end |
#started_at ⇒ Object
Time when the send began processing.
36 37 38 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 36 def started_at @started_at end |
#status ⇒ Object
Status of the send request.
39 40 41 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 39 def status @status end |
#status_id ⇒ Object
Identifier used to query the status of the send.
27 28 29 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 27 def status_id @status_id end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
77 78 79 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 77 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 64 def self.attribute_map { :'event_id' => :'eventId', :'completed_at' => :'completedAt', :'status_id' => :'statusId', :'send_result' => :'sendResult', :'requested_at' => :'requestedAt', :'started_at' => :'startedAt', :'status' => :'status' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
220 221 222 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 220 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
95 96 97 98 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 95 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 82 def self.openapi_types { :'event_id' => :'EventIdView', :'completed_at' => :'Time', :'status_id' => :'String', :'send_result' => :'String', :'requested_at' => :'Time', :'started_at' => :'Time', :'status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 193 def ==(o) return true if self.equal?(o) self.class == o.class && event_id == o.event_id && completed_at == o.completed_at && status_id == o.status_id && send_result == o.send_result && requested_at == o.requested_at && started_at == o.started_at && status == o.status end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 251 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 = Hubspot::Marketing::Transactional.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 322 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
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 227 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 |
#eql?(o) ⇒ Boolean
207 208 209 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 207 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
213 214 215 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 213 def hash [event_id, completed_at, status_id, send_result, requested_at, started_at, status].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 146 def list_invalid_properties invalid_properties = Array.new if @status_id.nil? invalid_properties.push('invalid value for "status_id", status_id cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
298 299 300 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 298 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 304 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
292 293 294 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 292 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
161 162 163 164 165 166 167 168 169 |
# File 'lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb', line 161 def valid? return false if @status_id.nil? send_result_validator = EnumAttributeValidator.new('String', ["SENT", "IDEMPOTENT_IGNORE", "QUEUED", "IDEMPOTENT_FAIL", "THROTTLED", "EMAIL_DISABLED", "PORTAL_SUSPENDED", "INVALID_TO_ADDRESS", "BLOCKED_DOMAIN", "PREVIOUSLY_BOUNCED", "EMAIL_UNCONFIRMED", "PREVIOUS_SPAM", "PREVIOUSLY_UNSUBSCRIBED_MESSAGE", "PREVIOUSLY_UNSUBSCRIBED_PORTAL", "INVALID_FROM_ADDRESS", "CAMPAIGN_CANCELLED", "VALIDATION_FAILED", "MTA_IGNORE", "BLOCKED_ADDRESS", "PORTAL_OVER_LIMIT", "PORTAL_EXPIRED", "PORTAL_MISSING_MARKETING_SCOPE", "MISSING_TEMPLATE_PROPERTIES", "MISSING_REQUIRED_PARAMETER", "PORTAL_AUTHENTICATION_FAILURE", "MISSING_CONTENT", "CORRUPT_INPUT", "TEMPLATE_RENDER_EXCEPTION", "GRAYMAIL_SUPPRESSED", "UNCONFIGURED_SENDING_DOMAIN", "UNDELIVERABLE", "CANCELLED_ABUSE", "QUARANTINED_ADDRESS", "ADDRESS_ONLY_ACCEPTED_ON_PROD", "PORTAL_NOT_AUTHORIZED_FOR_APPLICATION", "ADDRESS_LIST_BOMBED", "ADDRESS_OPTED_OUT", "RECIPIENT_FATIGUE_SUPPRESSED", "TOO_MANY_RECIPIENTS", "PREVIOUSLY_UNSUBSCRIBED_BRAND", "NON_MARKETABLE_CONTACT", "PREVIOUSLY_UNSUBSCRIBED_BUSINESS_UNIT", "GDPR_DOI_ENABLED"]) return false unless send_result_validator.valid?(@send_result) return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"]) return false unless status_validator.valid?(@status) true end |