Class: ConnectWise::ServiceEmailTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/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

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/service_email_template.rb', line 117

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ServiceEmailTemplate` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::ServiceEmailTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.type = attributes[:type] if attributes.key?(:type)

  self.id = attributes[:id] if attributes.key?(:id)

  self.service_survey = attributes[:service_survey] if attributes.key?(:service_survey)

  self.service_board = attributes[:service_board] if attributes.key?(:service_board)

  self.use_sender_flag = attributes[:use_sender_flag] if attributes.key?(:use_sender_flag)

  self.first_name = attributes[:first_name] if attributes.key?(:first_name)

  self.last_name = attributes[:last_name] if attributes.key?(:last_name)

  self.email_address = attributes[:email_address] if attributes.key?(:email_address)

  self.subject = attributes[:subject] if attributes.key?(:subject)

  self.body = attributes[:body] if attributes.key?(:body)

  self.copy_sender_flag = attributes[:copy_sender_flag] if attributes.key?(:copy_sender_flag)

  self.tasks_flag = attributes[:tasks_flag] if attributes.key?(:tasks_flag)

  self.resource_records_flag = attributes[:resource_records_flag] if attributes.key?(:resource_records_flag)

  self.external_contact_notifications = attributes[:external_contact_notifications] if attributes.key?(:external_contact_notifications)

  self.internal_contact_notifications = attributes[:internal_contact_notifications] if attributes.key?(:internal_contact_notifications)

  self.service_status = attributes[:service_status] if attributes.key?(:service_status)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def _info
  @_info
end

#body ⇒ Object

Returns the value of attribute body.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def body
  @body
end

#copy_sender_flag ⇒ Object

Returns the value of attribute copy_sender_flag.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

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. Max length: 100;



25
26
27
 
# File 'lib/connect_wise/models/service_email_template.rb', line 25

def email_address
  @email_address
end

#external_contact_notifications ⇒ Object

Returns the value of attribute external_contact_notifications.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

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. Max length: 100;



19
20
21
 
# File 'lib/connect_wise/models/service_email_template.rb', line 19

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def id
  @id
end

#internal_contact_notifications ⇒ Object

Returns the value of attribute internal_contact_notifications.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

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. Max length: 100;



22
23
24
 
# File 'lib/connect_wise/models/service_email_template.rb', line 22

def last_name
  @last_name
end

#resource_records_flag ⇒ Object

Returns the value of attribute resource_records_flag.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def resource_records_flag
  @resource_records_flag
end

#service_board ⇒ Object

Returns the value of attribute service_board.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def service_board
  @service_board
end

#service_status ⇒ Object

Returns the value of attribute service_status.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def service_status
  @service_status
end

#service_survey ⇒ Object

Returns the value of attribute service_survey.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def service_survey
  @service_survey
end

#subject ⇒ Object

Max length: 200;



28
29
30
 
# File 'lib/connect_wise/models/service_email_template.rb', line 28

def subject
  @subject
end

#tasks_flag ⇒ Object

Returns the value of attribute tasks_flag.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def tasks_flag
  @tasks_flag
end

#type ⇒ Object

Returns the value of attribute type.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def type
  @type
end

#use_sender_flag ⇒ Object

Returns the value of attribute use_sender_flag.



16
17
18
 
# File 'lib/connect_wise/models/service_email_template.rb', line 16

def use_sender_flag
  @use_sender_flag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/connect_wise/models/service_email_template.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/connect_wise/models/service_email_template.rb', line 52

def self.attribute_map
  {
    type: :type,
    id: :id,
    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

.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



229
230
231
 
# File 'lib/connect_wise/models/service_email_template.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/connect_wise/models/service_email_template.rb', line 103

def self.openapi_nullable
  Set.new(%i[
            type
            use_sender_flag
            copy_sender_flag
            tasks_flag
            resource_records_flag
            external_contact_notifications
            internal_contact_notifications
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/connect_wise/models/service_email_template.rb', line 80

def self.openapi_types
  {
    type: :String,
    id: :Integer,
    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: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/connect_wise/models/service_email_template.rb', line 191

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    id == other.id &&
    service_survey == other.service_survey &&
    service_board == other.service_board &&
    use_sender_flag == other.use_sender_flag &&
    first_name == other.first_name &&
    last_name == other.last_name &&
    email_address == other.email_address &&
    subject == other.subject &&
    body == other.body &&
    copy_sender_flag == other.copy_sender_flag &&
    tasks_flag == other.tasks_flag &&
    resource_records_flag == other.resource_records_flag &&
    external_contact_notifications == other.external_contact_notifications &&
    internal_contact_notifications == other.internal_contact_notifications &&
    service_status == other.service_status &&
    _info == other._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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/connect_wise/models/service_email_template.rb', line 259

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/connect_wise/models/service_email_template.rb', line 330

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/connect_wise/models/service_email_template.rb', line 236

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/connect_wise/models/service_email_template.rb', line 216

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/connect_wise/models/service_email_template.rb', line 222

def hash
  [type, id, 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 properties with the reasons



167
168
169
 
# File 'lib/connect_wise/models/service_email_template.rb', line 167

def list_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



306
307
308
 
# File 'lib/connect_wise/models/service_email_template.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/connect_wise/models/service_email_template.rb', line 312

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



300
301
302
 
# File 'lib/connect_wise/models/service_email_template.rb', line 300

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



173
174
175
176
177
178
 
# File 'lib/connect_wise/models/service_email_template.rb', line 173

def valid?
  type_validator = EnumAttributeValidator.new('String', %w[Any Closed Invoice New SalesOrder PurchaseOrder RMA Specific])
  return false unless type_validator.valid?(@type)

  true
end