Class: ConnectWise::ServiceEmailTemplate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceEmailTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 116

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

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

  if attributes.has_key?(:'serviceBoard')
    self.service_board = attributes[:'serviceBoard']
  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?(:'tasksFlag')
    self.tasks_flag = attributes[:'tasksFlag']
  end

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



44
45
46
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 44

def _info
  @_info
end

#body ⇒ Object

Returns the value of attribute body.



28
29
30
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 28

def body
  @body
end

#copy_sender_flag ⇒ Object

Returns the value of attribute copy_sender_flag.



30
31
32
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 30

def copy_sender_flag
  @copy_sender_flag
end

#email_address ⇒ Object

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



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

def email_address
  @email_address
end

#external_contact_notifications ⇒ Object

Returns the value of attribute external_contact_notifications.



36
37
38
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 36

def external_contact_notifications
  @external_contact_notifications
end

#first_name ⇒ Object

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



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

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#internal_contact_notifications ⇒ Object

Returns the value of attribute internal_contact_notifications.



38
39
40
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 38

def internal_contact_notifications
  @internal_contact_notifications
end

#last_name ⇒ Object

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



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

def last_name
  @last_name
end

#resource_records_flag ⇒ Object

Returns the value of attribute resource_records_flag.



34
35
36
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 34

def resource_records_flag
  @resource_records_flag
end

#service_board ⇒ Object

Returns the value of attribute service_board.



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

def service_board
  @service_board
end

#service_status ⇒ Object

serviceStatus is required if the email template type is "Specific".



41
42
43
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 41

def service_status
  @service_status
end

#service_survey ⇒ Object

Returns the value of attribute service_survey.



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

def service_survey
  @service_survey
end

#subject ⇒ Object

Returns the value of attribute subject.



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

def subject
  @subject
end

#tasks_flag ⇒ Object

Returns the value of attribute tasks_flag.



32
33
34
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 32

def tasks_flag
  @tasks_flag
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#use_sender_flag ⇒ Object

Returns the value of attribute use_sender_flag.



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

def use_sender_flag
  @use_sender_flag
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'service_survey' => :'serviceSurvey',
    :'service_board' => :'serviceBoard',
    :'use_sender_flag' => :'useSenderFlag',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'email_address' => :'emailAddress',
    :'subject' => :'subject',
    :'body' => :'body',
    :'copy_sender_flag' => :'copySenderFlag',
    :'tasks_flag' => :'tasksFlag',
    :'resource_records_flag' => :'resourceRecordsFlag',
    :'external_contact_notifications' => :'externalContactNotifications',
    :'internal_contact_notifications' => :'internalContactNotifications',
    :'service_status' => :'serviceStatus',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 92

def self.swagger_types
  {
    :'id' => :'Integer',
    :'type' => :'String',
    :'service_survey' => :'ServiceSurveyReference',
    :'service_board' => :'BoardReference',
    :'use_sender_flag' => :'BOOLEAN',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email_address' => :'String',
    :'subject' => :'String',
    :'body' => :'String',
    :'copy_sender_flag' => :'BOOLEAN',
    :'tasks_flag' => :'BOOLEAN',
    :'resource_records_flag' => :'BOOLEAN',
    :'external_contact_notifications' => :'BOOLEAN',
    :'internal_contact_notifications' => :'BOOLEAN',
    :'service_status' => :'ServiceStatusReference',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 288

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      service_survey == o.service_survey &&
      service_board == o.service_board &&
      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 &&
      tasks_flag == o.tasks_flag &&
      resource_records_flag == o.resource_records_flag &&
      external_contact_notifications == o.external_contact_notifications &&
      internal_contact_notifications == o.internal_contact_notifications &&
      service_status == o.service_status &&
      _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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 346

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 412

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 325

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


312
313
314
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 318

def hash
  [id, type, service_survey, service_board, use_sender_flag, first_name, last_name, email_address, subject, body, copy_sender_flag, tasks_flag, resource_records_flag, external_contact_notifications, internal_contact_notifications, service_status, _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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  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? && @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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 392

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



398
399
400
401
402
403
404
405
406
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 398

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



386
387
388
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 386

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



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/connectwise-ruby-sdk/models/service_email_template.rb', line 221

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["New", "Closed", "Other", "Specific", "RMA", "Invoice", "SalesOrder", "PurchaseOrder"])
  return false unless type_validator.valid?(@type)
  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? && @subject.to_s.length > 200
  return true
end