Class: ConnectWise::ScheduleEntry

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduleEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity


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

def _info
  @_info
end

#acknowledged_flag ⇒ Object

Returns the value of attribute acknowledged_flag.


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

def acknowledged_flag
  @acknowledged_flag
end

#add_member_to_project_flag ⇒ Object

Returns the value of attribute add_member_to_project_flag.


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

def add_member_to_project_flag
  @add_member_to_project_flag
end

#allow_schedule_conflicts_flag ⇒ Object

Returns the value of attribute allow_schedule_conflicts_flag.


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

def allow_schedule_conflicts_flag
  @allow_schedule_conflicts_flag
end

#close_date ⇒ Object

Returns the value of attribute close_date.


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

def close_date
  @close_date
end

#date_end ⇒ Object

Returns the value of attribute date_end.


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

def date_end
  @date_end
end

#date_start ⇒ Object

Returns the value of attribute date_start.


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

def date_start
  @date_start
end

#done_flag ⇒ Object

Returns the value of attribute done_flag.


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

def done_flag
  @done_flag
end

#hours ⇒ Object

Returns the value of attribute hours.


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

def hours
  @hours
end

#id ⇒ Object

Returns the value of attribute id.


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

def id
  @id
end

#member ⇒ Object

Activity schedule requires a member


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

def member
  @member
end

#mobile_guid ⇒ Object

Returns the value of attribute mobile_guid.


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

def mobile_guid
  @mobile_guid
end

#name ⇒ Object

Returns the value of attribute name.


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

def name
  @name
end

#object_id ⇒ Object

Returns the value of attribute object_id.


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

def object_id
  @object_id
end

#owner_flag ⇒ Object

Returns the value of attribute owner_flag.


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

def owner_flag
  @owner_flag
end

#project_role_id ⇒ Object

Returns the value of attribute project_role_id.


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

def project_role_id
  @project_role_id
end

#reminder ⇒ Object

Returns the value of attribute reminder.


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

def reminder
  @reminder
end

#span ⇒ Object

Returns the value of attribute span.


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

def span
  @span
end

#status ⇒ Object

Returns the value of attribute status.


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

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.


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

def type
  @type
end

#where ⇒ Object

Returns the value of attribute where.


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

def where
  @where
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'object_id' => :'objectId',
    :'name' => :'name',
    :'member' => :'member',
    :'where' => :'where',
    :'date_start' => :'dateStart',
    :'date_end' => :'dateEnd',
    :'reminder' => :'reminder',
    :'status' => :'status',
    :'type' => :'type',
    :'span' => :'span',
    :'done_flag' => :'doneFlag',
    :'acknowledged_flag' => :'acknowledgedFlag',
    :'owner_flag' => :'ownerFlag',
    :'allow_schedule_conflicts_flag' => :'allowScheduleConflictsFlag',
    :'add_member_to_project_flag' => :'addMemberToProjectFlag',
    :'project_role_id' => :'projectRoleId',
    :'mobile_guid' => :'mobileGuid',
    :'close_date' => :'closeDate',
    :'hours' => :'hours',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'object_id' => :'Integer',
    :'name' => :'String',
    :'member' => :'MemberReference',
    :'where' => :'ServiceLocationReference',
    :'date_start' => :'DateTime',
    :'date_end' => :'DateTime',
    :'reminder' => :'ReminderReference',
    :'status' => :'ScheduleStatusReference',
    :'type' => :'ScheduleTypeReference',
    :'span' => :'ScheduleSpanReference',
    :'done_flag' => :'BOOLEAN',
    :'acknowledged_flag' => :'BOOLEAN',
    :'owner_flag' => :'BOOLEAN',
    :'allow_schedule_conflicts_flag' => :'BOOLEAN',
    :'add_member_to_project_flag' => :'BOOLEAN',
    :'project_role_id' => :'Integer',
    :'mobile_guid' => :'Guid',
    :'close_date' => :'DateTime',
    :'hours' => :'Float',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object_id == o.object_id &&
      name == o.name &&
      member == o.member &&
      where == o.where &&
      date_start == o.date_start &&
      date_end == o.date_end &&
      reminder == o.reminder &&
      status == o.status &&
      type == o.type &&
      span == o.span &&
      done_flag == o.done_flag &&
      acknowledged_flag == o.acknowledged_flag &&
      owner_flag == o.owner_flag &&
      allow_schedule_conflicts_flag == o.allow_schedule_conflicts_flag &&
      add_member_to_project_flag == o.add_member_to_project_flag &&
      project_role_id == o.project_role_id &&
      mobile_guid == o.mobile_guid &&
      close_date == o.close_date &&
      hours == o.hours &&
      _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

[View source]

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
331
332
333
334
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 298

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

[View source]

364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 364

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

[View source]

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 277

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
[View source]

264
265
266
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

270
271
272
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 270

def hash
  [id, object_id, name, member, where, date_start, date_end, reminder, status, type, span, done_flag, acknowledged_flag, owner_flag, allow_schedule_conflicts_flag, add_member_to_project_flag, project_role_id, mobile_guid, close_date, hours, _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

[View source]

202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 202

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

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

[View source]

344
345
346
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 344

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

[View source]

350
351
352
353
354
355
356
357
358
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 350

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

[View source]

338
339
340
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 338

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

[View source]

217
218
219
220
221
 
# File 'lib/connectwise-ruby-sdk/models/schedule_entry.rb', line 217

def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  return false if @type.nil?
  return true
end