class SibApiV3Sdk::CreateSmtpTemplate
Attributes
Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty
Url which contents the body of the email message. REQUIRED if htmlContent is empty
Status of template. isActive = true means template is active and isActive = false means template is inactive
Email on which campaign recipients will be able to reply to
Subject of the template
Tag of the template
Name of the template
To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 47 def self.attribute_map { :'tag' => :'tag', :'sender' => :'sender', :'template_name' => :'templateName', :'html_content' => :'htmlContent', :'html_url' => :'htmlUrl', :'subject' => :'subject', :'reply_to' => :'replyTo', :'to_field' => :'toField', :'attachment_url' => :'attachmentUrl', :'is_active' => :'isActive' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 80 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?(:'tag') self.tag = attributes[:'tag'] end if attributes.has_key?(:'sender') self.sender = attributes[:'sender'] end if attributes.has_key?(:'templateName') self.template_name = attributes[:'templateName'] end if attributes.has_key?(:'htmlContent') self.html_content = attributes[:'htmlContent'] end if attributes.has_key?(:'htmlUrl') self.html_url = attributes[:'htmlUrl'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'replyTo') self.reply_to = attributes[:'replyTo'] end if attributes.has_key?(:'toField') self.to_field = attributes[:'toField'] end if attributes.has_key?(:'attachmentUrl') self.attachment_url = attributes[:'attachmentUrl'] end if attributes.has_key?(:'isActive') self.is_active = attributes[:'isActive'] end end
Attribute type mapping.
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 63 def self.swagger_types { :'tag' => :'String', :'sender' => :'CreateSmtpTemplateSender', :'template_name' => :'String', :'html_content' => :'String', :'html_url' => :'String', :'subject' => :'String', :'reply_to' => :'String', :'to_field' => :'String', :'attachment_url' => :'String', :'is_active' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 157 def ==(o) return true if self.equal?(o) self.class == o.class && tag == o.tag && sender == o.sender && template_name == o.template_name && html_content == o.html_content && html_url == o.html_url && subject == o.subject && reply_to == o.reply_to && to_field == o.to_field && attachment_url == o.attachment_url && is_active == o.is_active 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/sib-api-v3-sdk/models/create_smtp_template.rb, line 208 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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/create_smtp_template.rb, line 274 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/sib-api-v3-sdk/models/create_smtp_template.rb, line 187 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 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
@see the `==` method @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 174 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 180 def hash [tag, sender, template_name, html_content, html_url, subject, reply_to, to_field, attachment_url, is_active].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sib-api-v3-sdk/models/create_smtp_template.rb, line 129 def list_invalid_properties invalid_properties = Array.new if @sender.nil? invalid_properties.push('invalid value for "sender", sender cannot be nil.') end if @template_name.nil? invalid_properties.push('invalid value for "template_name", template_name cannot be nil.') end if @subject.nil? invalid_properties.push('invalid value for "subject", subject 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/sib-api-v3-sdk/models/create_smtp_template.rb, line 260 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/sib-api-v3-sdk/models/create_smtp_template.rb, line 248 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/sib-api-v3-sdk/models/create_smtp_template.rb, line 148 def valid? return false if @sender.nil? return false if @template_name.nil? return false if @subject.nil? true end