Class: ConnectWise::ScheduleEntry

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

Raises:

  • (ArgumentError)


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

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ScheduleEntry` 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::ScheduleEntry`. 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.id = attributes[:id] if attributes.key?(:id)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  self._info = value
end

Instance Attribute Details

#_infoObject

Returns the value of attribute _info.



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

def _info
  @_info
end

#acknowledged_dateObject

Returns the value of attribute acknowledged_date.



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

def acknowledged_date
  @acknowledged_date
end

#acknowledged_flagObject

Returns the value of attribute acknowledged_flag.



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

def acknowledged_flag
  @acknowledged_flag
end

#add_member_to_project_flagObject

Returns the value of attribute add_member_to_project_flag.



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

def add_member_to_project_flag
  @add_member_to_project_flag
end

#allow_schedule_conflicts_flagObject

Returns the value of attribute allow_schedule_conflicts_flag.



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

def allow_schedule_conflicts_flag
  @allow_schedule_conflicts_flag
end

#close_dateObject

Returns the value of attribute close_date.



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

def close_date
  @close_date
end

#date_endObject

Returns the value of attribute date_end.



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

def date_end
  @date_end
end

#date_startObject

Returns the value of attribute date_start.



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

def date_start
  @date_start
end

#done_flagObject

Returns the value of attribute done_flag.



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

def done_flag
  @done_flag
end

#hoursObject

Returns the value of attribute hours.



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

def hours
  @hours
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#meeting_flagObject

Returns the value of attribute meeting_flag.



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

def meeting_flag
  @meeting_flag
end

#memberObject

Returns the value of attribute member.



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

def member
  @member
end

#mobile_guidObject

Returns the value of attribute mobile_guid.



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

def mobile_guid
  @mobile_guid
end

#nameObject

Max length: 250;



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

def name
  @name
end

#object_idObject

Returns the value of attribute object_id.



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

def object_id
  @object_id
end

#owner_flagObject

Returns the value of attribute owner_flag.



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

def owner_flag
  @owner_flag
end

#project_role_idObject

Returns the value of attribute project_role_id.



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

def project_role_id
  @project_role_id
end

#reminderObject

Returns the value of attribute reminder.



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

def reminder
  @reminder
end

#spanObject

Returns the value of attribute span.



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

def span
  @span
end

#statusObject

Returns the value of attribute status.



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

def status
  @status
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

#whereObject

Returns the value of attribute where.



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

def where
  @where
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



51
52
53
# File 'lib/connect_wise/models/schedule_entry.rb', line 51

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/connect_wise/models/schedule_entry.rb', line 22

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,
    meeting_flag: :meetingFlag,
    allow_schedule_conflicts_flag: :allowScheduleConflictsFlag,
    add_member_to_project_flag: :addMemberToProjectFlag,
    project_role_id: :projectRoleId,
    mobile_guid: :mobileGuid,
    acknowledged_date: :acknowledgedDate,
    close_date: :closeDate,
    hours: :hours,
    _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



220
221
222
# File 'lib/connect_wise/models/schedule_entry.rb', line 220

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

.openapi_nullableObject

List of attributes with nullable: true



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/connect_wise/models/schedule_entry.rb', line 85

def self.openapi_nullable
  Set.new(i[
            object_id
            done_flag
            acknowledged_flag
            owner_flag
            meeting_flag
            allow_schedule_conflicts_flag
            add_member_to_project_flag
            project_role_id
            mobile_guid
            hours
          ])
end

.openapi_typesObject

Attribute type mapping.



56
57
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
# File 'lib/connect_wise/models/schedule_entry.rb', line 56

def self.openapi_types
  {
    id: :Integer,
    object_id: :Integer,
    name: :String,
    member: :MemberReference,
    where: :ServiceLocationReference,
    date_start: :Time,
    date_end: :Time,
    reminder: :ReminderReference,
    status: :ScheduleStatusReference,
    type: :ScheduleTypeReference,
    span: :ScheduleSpanReference,
    done_flag: :Boolean,
    acknowledged_flag: :Boolean,
    owner_flag: :Boolean,
    meeting_flag: :Boolean,
    allow_schedule_conflicts_flag: :Boolean,
    add_member_to_project_flag: :Boolean,
    project_role_id: :Integer,
    mobile_guid: :String,
    acknowledged_date: :Time,
    close_date: :Time,
    hours: :Float,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

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

  self.class == other.class &&
    id == other.id &&
    object_id == other.object_id &&
    name == other.name &&
    member == other.member &&
    where == other.where &&
    date_start == other.date_start &&
    date_end == other.date_end &&
    reminder == other.reminder &&
    status == other.status &&
    type == other.type &&
    span == other.span &&
    done_flag == other.done_flag &&
    acknowledged_flag == other.acknowledged_flag &&
    owner_flag == other.owner_flag &&
    meeting_flag == other.meeting_flag &&
    allow_schedule_conflicts_flag == other.allow_schedule_conflicts_flag &&
    add_member_to_project_flag == other.add_member_to_project_flag &&
    project_role_id == other.project_role_id &&
    mobile_guid == other.mobile_guid &&
    acknowledged_date == other.acknowledged_date &&
    close_date == other.close_date &&
    hours == other.hours &&
    _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



250
251
252
253
254
255
256
257
258
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
# File 'lib/connect_wise/models/schedule_entry.rb', line 250

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



321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/connect_wise/models/schedule_entry.rb', line 321

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/connect_wise/models/schedule_entry.rb', line 227

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


207
208
209
# File 'lib/connect_wise/models/schedule_entry.rb', line 207

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



213
214
215
# File 'lib/connect_wise/models/schedule_entry.rb', line 213

def hash
  [id, object_id, name, member, where, date_start, date_end, reminder, status, type, span, done_flag, acknowledged_flag, owner_flag, meeting_flag, allow_schedule_conflicts_flag, add_member_to_project_flag, project_role_id, mobile_guid, acknowledged_date, close_date, hours, _info].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



164
165
166
# File 'lib/connect_wise/models/schedule_entry.rb', line 164

def list_invalid_properties
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



297
298
299
# File 'lib/connect_wise/models/schedule_entry.rb', line 297

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/connect_wise/models/schedule_entry.rb', line 303

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



291
292
293
# File 'lib/connect_wise/models/schedule_entry.rb', line 291

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



170
171
172
# File 'lib/connect_wise/models/schedule_entry.rb', line 170

def valid?
  true
end