class ConnectWise::Imap

Attributes

_info[RW]

Metadata of the entity

email_connector[RW]
id[RW]
imap_name[RW]
name[RW]
password[RW]
port[RW]
processed_name[RW]
server[RW]
ssl_flag[RW]
user_name[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/imap.rb, line 32
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'imap_name' => :'imapName',
    :'processed_name' => :'processedName',
    :'server' => :'server',
    :'user_name' => :'userName',
    :'password' => :'password',
    :'port' => :'port',
    :'ssl_flag' => :'sslFlag',
    :'email_connector' => :'emailConnector',
    :'_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/imap.rb, line 67
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?(:'imapName')
    self.imap_name = attributes[:'imapName']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'emailConnector')
    self.email_connector = attributes[:'emailConnector']
  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/imap.rb, line 49
def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'imap_name' => :'String',
    :'processed_name' => :'String',
    :'server' => :'String',
    :'user_name' => :'String',
    :'password' => :'String',
    :'port' => :'Integer',
    :'ssl_flag' => :'BOOLEAN',
    :'email_connector' => :'EmailConnectorReference',
    :'_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/imap.rb, line 230
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      imap_name == o.imap_name &&
      processed_name == o.processed_name &&
      server == o.server &&
      user_name == o.user_name &&
      password == o.password &&
      port == o.port &&
      ssl_flag == o.ssl_flag &&
      email_connector == o.email_connector &&
      _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/imap.rb, line 282
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/imap.rb, line 348
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/imap.rb, line 261
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
eql?(o) click to toggle source

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

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

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 254
def hash
  [id, name, imap_name, processed_name, server, user_name, password, port, ssl_flag, email_connector, _info].hash
end
imap_name=(imap_name) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 175
def imap_name=(imap_name)

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

  @imap_name = imap_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/imap.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 200
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 200.")
  end

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

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

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

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

  if !@password.nil? && @password.to_s.length > 80
    invalid_properties.push("invalid value for 'password', the character length must be smaller than or equal to 80.")
  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/imap.rb, line 164
def name=(name)

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

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

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 219
def password=(password)

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

  @password = password
end
processed_name=(processed_name) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 186
def processed_name=(processed_name)

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

  @processed_name = processed_name
end
server=(server) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 197
def server=(server)

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

  @server = server
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/imap.rb, line 328
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/imap.rb, line 334
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/imap.rb, line 322
def to_s
  to_hash.to_s
end
user_name=(user_name) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/imap.rb, line 208
def user_name=(user_name)

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

  @user_name = user_name
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/imap.rb, line 152
def valid?
  return false if !@name.nil? && @name.to_s.length > 200
  return false if !@imap_name.nil? && @imap_name.to_s.length > 40
  return false if !@processed_name.nil? && @processed_name.to_s.length > 40
  return false if !@server.nil? && @server.to_s.length > 200
  return false if !@user_name.nil? && @user_name.to_s.length > 80
  return false if !@password.nil? && @password.to_s.length > 80
  return true
end