class ConnectWise::InvoiceEmailTemplate

Attributes

_info[RW]

Metadata of the entity

body[RW]
copy_sender_flag[RW]
email_address[RW]

From fields (first name, last name, email address) are required if useSenderFlag is false

first_name[RW]

From fields (first name, last name, email address) are required if useSenderFlag is false

id[RW]
invoice_status[RW]
last_name[RW]

From fields (first name, last name, email address) are required if useSenderFlag is false

name[RW]
service_survey[RW]
subject[RW]
use_sender_flag[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 37
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'service_survey' => :'serviceSurvey',
    :'use_sender_flag' => :'useSenderFlag',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'email_address' => :'emailAddress',
    :'subject' => :'subject',
    :'body' => :'body',
    :'copy_sender_flag' => :'copySenderFlag',
    :'invoice_status' => :'invoiceStatus',
    :'_info' => :'_info'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 74
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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'serviceSurvey')
    self.service_survey = attributes[:'serviceSurvey']
  end

  if attributes.has_key?(:'useSenderFlag')
    self.use_sender_flag = attributes[:'useSenderFlag']
  end

  if attributes.has_key?(:'firstName')
    self.first_name = attributes[:'firstName']
  end

  if attributes.has_key?(:'lastName')
    self.last_name = attributes[:'lastName']
  end

  if attributes.has_key?(:'emailAddress')
    self.email_address = attributes[:'emailAddress']
  end

  if attributes.has_key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.has_key?(:'body')
    self.body = attributes[:'body']
  end

  if attributes.has_key?(:'copySenderFlag')
    self.copy_sender_flag = attributes[:'copySenderFlag']
  end

  if attributes.has_key?(:'invoiceStatus')
    self.invoice_status = attributes[:'invoiceStatus']
  end

  if attributes.has_key?(:'_info')
    self._info = attributes[:'_info']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 55
def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'service_survey' => :'ServiceSurveyReference',
    :'use_sender_flag' => :'BOOLEAN',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email_address' => :'String',
    :'subject' => :'String',
    :'body' => :'String',
    :'copy_sender_flag' => :'BOOLEAN',
    :'invoice_status' => :'BillingStatusReference',
    :'_info' => :'Metadata'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 241
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      service_survey == o.service_survey &&
      use_sender_flag == o.use_sender_flag &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email_address == o.email_address &&
      subject == o.subject &&
      body == o.body &&
      copy_sender_flag == o.copy_sender_flag &&
      invoice_status == o.invoice_status &&
      _info == o._info
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 294
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 = ConnectWise.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/connectwise-ruby-sdk/models/invoice_email_template.rb, line 360
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 273
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
email_address=(email_address) click to toggle source

Custom attribute writer method with validation @param [Object] email_address Value to be assigned

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 216
def email_address=(email_address)

  if !email_address.nil? && email_address.to_s.length > 100
    fail ArgumentError, "invalid value for 'email_address', the character length must be smaller than or equal to 100."
  end

  @email_address = email_address
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 260
def eql?(o)
  self == o
end
first_name=(first_name) click to toggle source

Custom attribute writer method with validation @param [Object] first_name Value to be assigned

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 194
def first_name=(first_name)

  if !first_name.nil? && first_name.to_s.length > 100
    fail ArgumentError, "invalid value for 'first_name', the character length must be smaller than or equal to 100."
  end

  @first_name = first_name
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 266
def hash
  [id, name, service_survey, use_sender_flag, first_name, last_name, email_address, subject, body, copy_sender_flag, invoice_status, _info].hash
end
last_name=(last_name) click to toggle source

Custom attribute writer method with validation @param [Object] last_name Value to be assigned

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 205
def last_name=(last_name)

  if !last_name.nil? && last_name.to_s.length > 100
    fail ArgumentError, "invalid value for 'last_name', the character length must be smaller than or equal to 100."
  end

  @last_name = last_name
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 132
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length > 50
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.")
  end

  if !@first_name.nil? && @first_name.to_s.length > 100
    invalid_properties.push("invalid value for 'first_name', the character length must be smaller than or equal to 100.")
  end

  if !@last_name.nil? && @last_name.to_s.length > 100
    invalid_properties.push("invalid value for 'last_name', the character length must be smaller than or equal to 100.")
  end

  if !@email_address.nil? && @email_address.to_s.length > 100
    invalid_properties.push("invalid value for 'email_address', the character length must be smaller than or equal to 100.")
  end

  if @subject.nil?
    invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
  end

  if @subject.to_s.length > 200
    invalid_properties.push("invalid value for 'subject', the character length must be smaller than or equal to 200.")
  end

  return invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 180
def name=(name)
  if name.nil?
    fail ArgumentError, "name cannot be nil"
  end

  if name.to_s.length > 50
    fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 50."
  end

  @name = name
end
subject=(subject) click to toggle source

Custom attribute writer method with validation @param [Object] subject Value to be assigned

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 227
def subject=(subject)
  if subject.nil?
    fail ArgumentError, "subject cannot be nil"
  end

  if subject.to_s.length > 200
    fail ArgumentError, "invalid value for 'subject', the character length must be smaller than or equal to 200."
  end

  @subject = subject
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 340
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 346
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 334
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/connectwise-ruby-sdk/models/invoice_email_template.rb, line 167
def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if !@first_name.nil? && @first_name.to_s.length > 100
  return false if !@last_name.nil? && @last_name.to_s.length > 100
  return false if !@email_address.nil? && @email_address.to_s.length > 100
  return false if @subject.nil?
  return false if @subject.to_s.length > 200
  return true
end