Class: ConnectWise::CampaignAudit

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignAudit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 58

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#campaign_id ⇒ Object

Returns the value of attribute campaign_id.



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

def campaign_id
  @campaign_id
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#date_created ⇒ Object

Returns the value of attribute date_created.



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

def date_created
  @date_created
end

#documents_created ⇒ Object

Returns the value of attribute documents_created.



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

def documents_created
  @documents_created
end

#email_subject ⇒ Object

Returns the value of attribute email_subject.



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

def email_subject
  @email_subject
end

#emails_sent ⇒ Object

Returns the value of attribute emails_sent.



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

def emails_sent
  @emails_sent
end

#emails_unsent ⇒ Object

Returns the value of attribute emails_unsent.



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

def emails_unsent
  @emails_unsent
end

#group ⇒ Object

Returns the value of attribute group.



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

def group
  @group
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 27

def self.attribute_map
  {
    :'id' => :'id',
    :'emails_sent' => :'emailsSent',
    :'emails_unsent' => :'emailsUnsent',
    :'documents_created' => :'documentsCreated',
    :'email_subject' => :'emailSubject',
    :'group' => :'group',
    :'campaign_id' => :'campaignId',
    :'created_by' => :'createdBy',
    :'date_created' => :'dateCreated'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 42

def self.swagger_types
  {
    :'id' => :'Integer',
    :'emails_sent' => :'Integer',
    :'emails_unsent' => :'Integer',
    :'documents_created' => :'Integer',
    :'email_subject' => :'String',
    :'group' => :'GroupReference',
    :'campaign_id' => :'Integer',
    :'created_by' => :'String',
    :'date_created' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      emails_sent == o.emails_sent &&
      emails_unsent == o.emails_unsent &&
      documents_created == o.documents_created &&
      email_subject == o.email_subject &&
      group == o.group &&
      campaign_id == o.campaign_id &&
      created_by == o.created_by &&
      date_created == o.date_created
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



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
297
298
299
300
301
302
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 266

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 332

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



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

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


232
233
234
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 238

def hash
  [id, emails_sent, emails_unsent, documents_created, email_subject, group, campaign_id, created_by, date_created].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



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
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  if @emails_sent.nil?
    invalid_properties.push("invalid value for 'emails_sent', emails_sent cannot be nil.")
  end

  if @emails_sent > 2147483647
    invalid_properties.push("invalid value for 'emails_sent', must be smaller than or equal to 2147483647.")
  end

  if @emails_sent < 0
    invalid_properties.push("invalid value for 'emails_sent', must be greater than or equal to 0.")
  end

  if !@emails_unsent.nil? && @emails_unsent > 2147483647
    invalid_properties.push("invalid value for 'emails_unsent', must be smaller than or equal to 2147483647.")
  end

  if !@emails_unsent.nil? && @emails_unsent < 0
    invalid_properties.push("invalid value for 'emails_unsent', must be greater than or equal to 0.")
  end

  if !@documents_created.nil? && @documents_created > 2147483647
    invalid_properties.push("invalid value for 'documents_created', must be smaller than or equal to 2147483647.")
  end

  if !@documents_created.nil? && @documents_created < 0
    invalid_properties.push("invalid value for 'documents_created', must be greater than or equal to 0.")
  end

  if !@email_subject.nil? && @email_subject.to_s.length > 1000
    invalid_properties.push("invalid value for 'email_subject', the character length must be smaller than or equal to 1000.")
  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



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

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 318

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



306
307
308
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 306

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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/connectwise-ruby-sdk/models/campaign_audit.rb', line 143

def valid?
  return false if @emails_sent.nil?
  return false if @emails_sent > 2147483647
  return false if @emails_sent < 0
  return false if !@emails_unsent.nil? && @emails_unsent > 2147483647
  return false if !@emails_unsent.nil? && @emails_unsent < 0
  return false if !@documents_created.nil? && @documents_created > 2147483647
  return false if !@documents_created.nil? && @documents_created < 0
  return false if !@email_subject.nil? && @email_subject.to_s.length > 1000
  return true
end