class Bfwd::Email
Attributes
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":[] }
{ "description" : "", "verbs":[] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : ".", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/email.rb, line 124 def self.attribute_map { :'created' => :'created', :'changed_by' => :'changedBy', :'updated' => :'updated', :'id' => :'id', :'account_id' => :'accountID', :'subscription_id' => :'subscriptionID', :'invoice_id' => :'invoiceID', :'from' => :'from', :'to' => :'to', :'cc' => :'cc', :'bcc' => :'bcc', :'subject' => :'subject', :'html' => :'html', :'attachment_filename' => :'attachmentFilename', :'attachment_html' => :'attachmentHtml', :'plain' => :'plain', :'sent' => :'sent', :'state' => :'state', :'deleted' => :'deleted', :'header_url' => :'headerURL', :'salutation' => :'salutation', :'paragraph1' => :'paragraph1', :'paragraph2' => :'paragraph2', :'footer_information' => :'footerInformation', :'signoff' => :'signoff', :'emai_subscription_type' => :'emaiSubscriptionType', :'notification_id' => :'notificationID', :'organization_id' => :'organizationID' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/email.rb, line 193 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'updated') self.updated = attributes[:'updated'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'accountID') self.account_id = attributes[:'accountID'] end if attributes.has_key?(:'subscriptionID') self.subscription_id = attributes[:'subscriptionID'] end if attributes.has_key?(:'invoiceID') self.invoice_id = attributes[:'invoiceID'] end if attributes.has_key?(:'from') self.from = attributes[:'from'] end if attributes.has_key?(:'to') self.to = attributes[:'to'] end if attributes.has_key?(:'cc') self.cc = attributes[:'cc'] end if attributes.has_key?(:'bcc') self.bcc = attributes[:'bcc'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'html') self.html = attributes[:'html'] end if attributes.has_key?(:'attachmentFilename') self.attachment_filename = attributes[:'attachmentFilename'] end if attributes.has_key?(:'attachmentHtml') self.attachment_html = attributes[:'attachmentHtml'] end if attributes.has_key?(:'plain') self.plain = attributes[:'plain'] end if attributes.has_key?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] else self.deleted = false end if attributes.has_key?(:'headerURL') self.header_url = attributes[:'headerURL'] end if attributes.has_key?(:'salutation') self.salutation = attributes[:'salutation'] end if attributes.has_key?(:'paragraph1') self.paragraph1 = attributes[:'paragraph1'] end if attributes.has_key?(:'paragraph2') self.paragraph2 = attributes[:'paragraph2'] end if attributes.has_key?(:'footerInformation') self.footer_information = attributes[:'footerInformation'] end if attributes.has_key?(:'signoff') self.signoff = attributes[:'signoff'] end if attributes.has_key?(:'emaiSubscriptionType') self.emai_subscription_type = attributes[:'emaiSubscriptionType'] end if attributes.has_key?(:'notificationID') self.notification_id = attributes[:'notificationID'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/email.rb, line 158 def self.swagger_types { :'created' => :'DateTime', :'changed_by' => :'String', :'updated' => :'DateTime', :'id' => :'String', :'account_id' => :'String', :'subscription_id' => :'String', :'invoice_id' => :'String', :'from' => :'String', :'to' => :'String', :'cc' => :'String', :'bcc' => :'String', :'subject' => :'String', :'html' => :'String', :'attachment_filename' => :'String', :'attachment_html' => :'String', :'plain' => :'String', :'sent' => :'DateTime', :'state' => :'String', :'deleted' => :'BOOLEAN', :'header_url' => :'String', :'salutation' => :'String', :'paragraph1' => :'String', :'paragraph2' => :'String', :'footer_information' => :'String', :'signoff' => :'String', :'emai_subscription_type' => :'String', :'notification_id' => :'String', :'organization_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/email.rb, line 364 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && changed_by == o.changed_by && updated == o.updated && id == o.id && account_id == o.account_id && subscription_id == o.subscription_id && invoice_id == o.invoice_id && from == o.from && to == o.to && cc == o.cc && bcc == o.bcc && subject == o.subject && html == o.html && attachment_filename == o.attachment_filename && attachment_html == o.attachment_html && plain == o.plain && sent == o.sent && state == o.state && deleted == o.deleted && header_url == o.header_url && salutation == o.salutation && paragraph1 == o.paragraph1 && paragraph2 == o.paragraph2 && footer_information == o.footer_information && signoff == o.signoff && emai_subscription_type == o.emai_subscription_type && notification_id == o.notification_id && organization_id == o.organization_id 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/bf_ruby2/models/email.rb, line 433 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 temp_model = Bfwd.const_get(type).new temp_model.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/bf_ruby2/models/email.rb, line 499 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/bf_ruby2/models/email.rb, line 412 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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
Custom attribute writer method checking allowed values (enum). @param [Object] emai_subscription_type
Object to be assigned
# File lib/bf_ruby2/models/email.rb, line 354 def emai_subscription_type=(emai_subscription_type) validator = EnumAttributeValidator.new('String', ["FailedPayment", "InvoicePaid", "SubscriptionCancellation", "SubscriptionCancelled", "SubscriptionPlanMigrated", "SubscriptionPlanMigrating", "CardExpired", "CardExpiring"]) unless validator.valid?(emai_subscription_type) fail ArgumentError, "invalid value for 'emai_subscription_type', must be one of #{validator.allowable_values}." end @emai_subscription_type = emai_subscription_type end
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/email.rb, line 399 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/email.rb, line 405 def hash [created, changed_by, updated, id, account_id, subscription_id, invoice_id, from, to, cc, bcc, subject, html, attachment_filename, attachment_html, plain, sent, state, deleted, header_url, salutation, paragraph1, paragraph2, footer_information, signoff, emai_subscription_type, notification_id, organization_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/email.rb, line 317 def list_invalid_properties invalid_properties = Array.new if @state.nil? invalid_properties.push("invalid value for 'state', state cannot be nil.") end if @organization_id.nil? invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/bf_ruby2/models/email.rb, line 344 def state=(state) validator = EnumAttributeValidator.new('String', ["Pending", "Unsent", "Sent"]) unless validator.valid?(state) fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}." end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/email.rb, line 485 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/bf_ruby2/models/email.rb, line 473 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/bf_ruby2/models/email.rb, line 332 def valid? return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ["Pending", "Unsent", "Sent"]) return false unless state_validator.valid?(@state) emai_subscription_type_validator = EnumAttributeValidator.new('String', ["FailedPayment", "InvoicePaid", "SubscriptionCancellation", "SubscriptionCancelled", "SubscriptionPlanMigrated", "SubscriptionPlanMigrating", "CardExpired", "CardExpiring"]) return false unless emai_subscription_type_validator.valid?(@emai_subscription_type) return false if @organization_id.nil? return true end