Class: PureCloud::UserScheduleActivity
- Inherits:
-
Object
- Object
- PureCloud::UserScheduleActivity
- Defined in:
- lib/purecloudplatformclientv2/models/user_schedule_activity.rb
Overview
Represents a single activity in a user’s shift
Instance Attribute Summary collapse
-
#activity_code_id ⇒ Object
The id for the activity code.
-
#counts_as_paid_time ⇒ Object
Whether this activity is paid.
-
#description ⇒ Object
Description for this activity.
-
#is_dst_fallback ⇒ Object
Whether this activity spans a DST fallback.
-
#length_in_minutes ⇒ Object
Length in minutes for this activity.
-
#start_date ⇒ Object
Start time in UTC for this activity, in ISO-8601 format.
-
#time_off_request_id ⇒ Object
Time off request id of this activity.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
- #_deserialize(type, value) ⇒ Object
-
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
build the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserScheduleActivity
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility)).
-
#to_hash ⇒ Object
return the object in the form of hash.
- #to_s ⇒ Object
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ UserScheduleActivity
Initializes the object
87 88 89 90 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 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 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 87 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?(:'activityCodeId') self.activity_code_id = attributes[:'activityCodeId'] end if attributes.has_key?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'lengthInMinutes') self.length_in_minutes = attributes[:'lengthInMinutes'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'countsAsPaidTime') self.counts_as_paid_time = attributes[:'countsAsPaidTime'] end if attributes.has_key?(:'isDstFallback') self.is_dst_fallback = attributes[:'isDstFallback'] end if attributes.has_key?(:'timeOffRequestId') self.time_off_request_id = attributes[:'timeOffRequestId'] end end |
Instance Attribute Details
#activity_code_id ⇒ Object
The id for the activity code. Look up a map of activity codes with the activities route
23 24 25 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 23 def activity_code_id @activity_code_id end |
#counts_as_paid_time ⇒ Object
Whether this activity is paid
35 36 37 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 35 def counts_as_paid_time @counts_as_paid_time end |
#description ⇒ Object
Description for this activity
32 33 34 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 32 def description @description end |
#is_dst_fallback ⇒ Object
Whether this activity spans a DST fallback
38 39 40 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 38 def is_dst_fallback @is_dst_fallback end |
#length_in_minutes ⇒ Object
Length in minutes for this activity
29 30 31 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 29 def length_in_minutes @length_in_minutes end |
#start_date ⇒ Object
Start time in UTC for this activity, in ISO-8601 format
26 27 28 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 26 def start_date @start_date end |
#time_off_request_id ⇒ Object
Time off request id of this activity
41 42 43 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 41 def time_off_request_id @time_off_request_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 44 def self.attribute_map { :'activity_code_id' => :'activityCodeId', :'start_date' => :'startDate', :'length_in_minutes' => :'lengthInMinutes', :'description' => :'description', :'counts_as_paid_time' => :'countsAsPaidTime', :'is_dst_fallback' => :'isDstFallback', :'time_off_request_id' => :'timeOffRequestId' } end |
.swagger_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 65 def self.swagger_types { :'activity_code_id' => :'String', :'start_date' => :'DateTime', :'length_in_minutes' => :'Integer', :'description' => :'String', :'counts_as_paid_time' => :'BOOLEAN', :'is_dst_fallback' => :'BOOLEAN', :'time_off_request_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 240 def ==(o) return true if self.equal?(o) self.class == o.class && activity_code_id == o.activity_code_id && start_date == o.start_date && length_in_minutes == o.length_in_minutes && description == o.description && counts_as_paid_time == o.counts_as_paid_time && is_dst_fallback == o.is_dst_fallback && time_off_request_id == o.time_off_request_id end |
#_deserialize(type, value) ⇒ Object
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 284 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 344 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
build the object from hash
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 265 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end |
#eql?(o) ⇒ Boolean
254 255 256 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 254 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
260 261 262 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 260 def hash [activity_code_id, start_date, length_in_minutes, description, counts_as_paid_time, is_dst_fallback, time_off_request_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
161 162 163 164 165 166 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 161 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility))
327 328 329 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 327 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
332 333 334 335 336 337 338 339 340 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 332 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 ⇒ Object
322 323 324 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 322 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
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 |
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 170 def valid? end |