Class: ConnectWise::ManagementEmail

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/management_email.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementEmail

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 79

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?(:'managementSolution')
    self.management_solution = attributes[:'managementSolution']
  end

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 25

def _info
  @_info
end

#email_password ⇒ Object

emailPassword is required when managementSolution set to Postini. The password field can only be set on initial POST.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 19

def email_password
  @email_password
end

#email_username ⇒ Object

emailUsername is required when managementSolution set to Postini.



16
17
18
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 16

def email_username
  @email_username
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 7

def id
  @id
end

#identifier ⇒ Object

Returns the value of attribute identifier.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 13

def identifier
  @identifier
end

#management_solution ⇒ Object

Returns the value of attribute management_solution.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 11

def management_solution
  @management_solution
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 9

def name
  @name
end

#server_prefix ⇒ Object

serverPrefix is required when managementSolution set to Postini.



22
23
24
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 22

def server_prefix
  @server_prefix
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 50

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'management_solution' => :'managementSolution',
    :'identifier' => :'identifier',
    :'email_username' => :'emailUsername',
    :'email_password' => :'emailPassword',
    :'server_prefix' => :'serverPrefix',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 64

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'management_solution' => :'String',
    :'identifier' => :'String',
    :'email_username' => :'String',
    :'email_password' => :'String',
    :'server_prefix' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      management_solution == o.management_solution &&
      identifier == o.identifier &&
      email_username == o.email_username &&
      email_password == o.email_password &&
      server_prefix == o.server_prefix &&
      _info == o._info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 296

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 362

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 275

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


262
263
264
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 268

def hash
  [id, name, management_solution, identifier, email_username, email_password, server_prefix, _info].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 121

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 > 30
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 30.")
  end

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

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

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

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

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

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

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



342
343
344
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 342

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



348
349
350
351
352
353
354
355
356
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 348

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



336
337
338
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 336

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/connectwise-ruby-sdk/models/management_email.rb', line 160

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 30
  return false if @management_solution.nil?
  management_solution_validator = EnumAttributeValidator.new('String', ["DoubleCheck", "Postini"])
  return false unless management_solution_validator.valid?(@management_solution)
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if !@email_username.nil? && @email_username.to_s.length > 50
  return false if !@email_password.nil? && @email_password.to_s.length > 50
  return false if !@server_prefix.nil? && @server_prefix.to_s.length > 30
  return true
end