Class: ConnectWise::InvoiceEmailTemplate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceEmailTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
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
118
119
120
121
122
123
124
125
126
127
128
 
# 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

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



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

def _info
  @_info
end

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#copy_sender_flag ⇒ Object

Returns the value of attribute copy_sender_flag.



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

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



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

def email_address
  @email_address
end

#first_name ⇒ Object

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



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

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_status ⇒ Object

Returns the value of attribute invoice_status.



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

def invoice_status
  @invoice_status
end

#last_name ⇒ Object

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



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

def last_name
  @last_name
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#service_survey ⇒ Object

Returns the value of attribute service_survey.



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

def service_survey
  @service_survey
end

#subject ⇒ Object

Returns the value of attribute subject.



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

def subject
  @subject
end

#use_sender_flag ⇒ Object

Returns the value of attribute use_sender_flag.



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

def use_sender_flag
  @use_sender_flag
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



294
295
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
 
# 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) ⇒ 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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


260
261
262
 
# File 'lib/connectwise-ruby-sdk/models/invoice_email_template.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# 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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
 
# File 'lib/connectwise-ruby-sdk/models/invoice_email_template.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



334
335
336
 
# File 'lib/connectwise-ruby-sdk/models/invoice_email_template.rb', line 334

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



167
168
169
170
171
172
173
174
175
176
 
# 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