Class: ConnectWise::Activity

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Activity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'customFields')
    if (value = attributes[:'customFields']).is_a?(Array)
      self.custom_fields = value
    end
  end

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



54
55
56
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 54

def _info
  @_info
end

#agreement ⇒ Object

Returns the value of attribute agreement.



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

def agreement
  @agreement
end

#assign_to ⇒ Object

Returns the value of attribute assign_to.



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

def assign_to
  @assign_to
end

#assigned_by ⇒ Object

Returns the value of attribute assigned_by.



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

def assigned_by
  @assigned_by
end

#campaign ⇒ Object

Returns the value of attribute campaign.



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

def campaign
  @campaign
end

#company ⇒ Object

Returns the value of attribute company.



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

def company
  @company
end

#contact ⇒ Object

Returns the value of attribute contact.



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

def contact
  @contact
end

#currency ⇒ Object

Returns the value of attribute currency.



51
52
53
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 51

def currency
  @currency
end

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



56
57
58
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 56

def custom_fields
  @custom_fields
end

#date_end ⇒ Object

Returns the value of attribute date_end.



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

def date_end
  @date_end
end

#date_start ⇒ Object

Returns the value of attribute date_start.



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

def date_start
  @date_start
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#mobile_guid ⇒ Object

Returns the value of attribute mobile_guid.



49
50
51
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 49

def mobile_guid
  @mobile_guid
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes.



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

def notes
  @notes
end

#notify_flag ⇒ Object

Returns the value of attribute notify_flag.



47
48
49
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 47

def notify_flag
  @notify_flag
end

#opportunity ⇒ Object

Returns the value of attribute opportunity.



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

def opportunity
  @opportunity
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#reminder ⇒ Object

Returns the value of attribute reminder.



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

def reminder
  @reminder
end

#schedule_status ⇒ Object

Returns the value of attribute schedule_status.



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

def schedule_status
  @schedule_status
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#ticket ⇒ Object

Returns the value of attribute ticket.



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

def ticket
  @ticket
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#where ⇒ Object

Returns the value of attribute where.



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

def where
  @where
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'company' => :'company',
    :'contact' => :'contact',
    :'phone_number' => :'phoneNumber',
    :'email' => :'email',
    :'status' => :'status',
    :'opportunity' => :'opportunity',
    :'ticket' => :'ticket',
    :'agreement' => :'agreement',
    :'campaign' => :'campaign',
    :'notes' => :'notes',
    :'date_start' => :'dateStart',
    :'date_end' => :'dateEnd',
    :'assigned_by' => :'assignedBy',
    :'assign_to' => :'assignTo',
    :'schedule_status' => :'scheduleStatus',
    :'reminder' => :'reminder',
    :'where' => :'where',
    :'notify_flag' => :'notifyFlag',
    :'mobile_guid' => :'mobileGuid',
    :'currency' => :'currency',
    :'_info' => :'_info',
    :'custom_fields' => :'customFields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 91

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'type' => :'ActivityTypeReference',
    :'company' => :'CompanyReference',
    :'contact' => :'ContactReference',
    :'phone_number' => :'String',
    :'email' => :'String',
    :'status' => :'ActivityStatusReference',
    :'opportunity' => :'OpportunityReference',
    :'ticket' => :'TicketReference',
    :'agreement' => :'AgreementReference',
    :'campaign' => :'CampaignReference',
    :'notes' => :'String',
    :'date_start' => :'DateTime',
    :'date_end' => :'DateTime',
    :'assigned_by' => :'MemberReference',
    :'assign_to' => :'MemberReference',
    :'schedule_status' => :'ScheduleStatusReference',
    :'reminder' => :'ReminderReference',
    :'where' => :'ServiceLocationReference',
    :'notify_flag' => :'BOOLEAN',
    :'mobile_guid' => :'Guid',
    :'currency' => :'CurrencyReference',
    :'_info' => :'Metadata',
    :'custom_fields' => :'Array<CustomFieldValue>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      company == o.company &&
      contact == o.contact &&
      phone_number == o.phone_number &&
      email == o.email &&
      status == o.status &&
      opportunity == o.opportunity &&
      ticket == o.ticket &&
      agreement == o.agreement &&
      campaign == o.campaign &&
      notes == o.notes &&
      date_start == o.date_start &&
      date_end == o.date_end &&
      assigned_by == o.assigned_by &&
      assign_to == o.assign_to &&
      schedule_status == o.schedule_status &&
      reminder == o.reminder &&
      where == o.where &&
      notify_flag == o.notify_flag &&
      mobile_guid == o.mobile_guid &&
      currency == o.currency &&
      _info == o._info &&
      custom_fields == o.custom_fields
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 375

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 441

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 354

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



347
348
349
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 347

def hash
  [id, name, type, company, contact, phone_number, email, status, opportunity, ticket, agreement, campaign, notes, date_start, date_end, assigned_by, assign_to, schedule_status, reminder, where, notify_flag, mobile_guid, currency, _info, custom_fields].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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 235

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

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

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

  if @assign_to.nil?
    invalid_properties.push("invalid value for 'assign_to', assign_to cannot be nil.")
  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



421
422
423
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 421

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



427
428
429
430
431
432
433
434
435
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 427

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



415
416
417
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 415

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



262
263
264
265
266
267
268
269
 
# File 'lib/connectwise-ruby-sdk/models/activity.rb', line 262

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if !@phone_number.nil? && @phone_number.to_s.length > 30
  return false if !@email.nil? && @email.to_s.length > 250
  return false if @assign_to.nil?
  return true
end