class ConnectWise::ContactGroup

Attributes

_info[RW]

Metadata of the entity

company_group_unsubscribed_email_message[RW]
company_unsubcribed_email_message[RW]
contact[RW]
contact_group_unsubscribed_email_message[RW]
contact_unsubscribed_email_message[RW]
description[RW]
group[RW]
id[RW]
unsubscribe_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/contact_group.rb, line 30
def self.attribute_map
  {
    :'id' => :'id',
    :'group' => :'group',
    :'contact' => :'contact',
    :'description' => :'description',
    :'unsubscribe_flag' => :'unsubscribeFlag',
    :'company_unsubcribed_email_message' => :'companyUnsubcribedEmailMessage',
    :'company_group_unsubscribed_email_message' => :'companyGroupUnsubscribedEmailMessage',
    :'contact_unsubscribed_email_message' => :'contactUnsubscribedEmailMessage',
    :'contact_group_unsubscribed_email_message' => :'contactGroupUnsubscribedEmailMessage',
    :'_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/contact_group.rb, line 63
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?(:'group')
    self.group = attributes[:'group']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'contactGroupUnsubscribedEmailMessage')
    self.contact_group_unsubscribed_email_message = attributes[:'contactGroupUnsubscribedEmailMessage']
  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/contact_group.rb, line 46
def self.swagger_types
  {
    :'id' => :'Integer',
    :'group' => :'GroupReference',
    :'contact' => :'ContactReference',
    :'description' => :'String',
    :'unsubscribe_flag' => :'BOOLEAN',
    :'company_unsubcribed_email_message' => :'String',
    :'company_group_unsubscribed_email_message' => :'String',
    :'contact_unsubscribed_email_message' => :'String',
    :'contact_group_unsubscribed_email_message' => :'String',
    :'_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/contact_group.rb, line 147
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      group == o.group &&
      contact == o.contact &&
      description == o.description &&
      unsubscribe_flag == o.unsubscribe_flag &&
      company_unsubcribed_email_message == o.company_unsubcribed_email_message &&
      company_group_unsubscribed_email_message == o.company_group_unsubscribed_email_message &&
      contact_unsubscribed_email_message == o.contact_unsubscribed_email_message &&
      contact_group_unsubscribed_email_message == o.contact_group_unsubscribed_email_message &&
      _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/contact_group.rb, line 198
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/contact_group.rb, line 264
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/contact_group.rb, line 177
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
description=(description) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/contact_group.rb, line 136
def description=(description)

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

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

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

# File lib/connectwise-ruby-sdk/models/contact_group.rb, line 164
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/contact_group.rb, line 170
def hash
  [id, group, contact, description, unsubscribe_flag, company_unsubcribed_email_message, company_group_unsubscribed_email_message, contact_unsubscribed_email_message, contact_group_unsubscribed_email_message, _info].hash
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/contact_group.rb, line 113
def list_invalid_properties
  invalid_properties = Array.new
  if @group.nil?
    invalid_properties.push("invalid value for 'group', group cannot be nil.")
  end

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

  return invalid_properties
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/contact_group.rb, line 244
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/contact_group.rb, line 250
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/contact_group.rb, line 238
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/contact_group.rb, line 128
def valid?
  return false if @group.nil?
  return false if !@description.nil? && @description.to_s.length > 50
  return true
end