Class: PureCloud::UserScheduleActivity

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/user_schedule_activity.rb

Overview

Represents a single activity in a user’s shift

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserScheduleActivity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 66

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

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

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 41

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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 53

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 112

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
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 155

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 215

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 136

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


125
126
127
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 131

def hash
  [activity_code_id, start_date, length_in_minutes, description, counts_as_paid_time, is_dst_fallback].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



100
101
102
103
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 100

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))



198
199
200
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 198

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 203

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 



193
194
195
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 193

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



107
108
 
# File 'lib/purecloudplatformclientv2/models/user_schedule_activity.rb', line 107

def valid?
end