Class: PureCloud::UserSchedule

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

Overview

A schedule for a single user over a given time range

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 46

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?(:'shifts')
    if (value = attributes[:'shifts']).is_a?(Array)
      self.shifts = value
    end
  end

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

end

Instance Attribute Details

#full_day_time_off_markers ⇒ Object

Markers to indicate a full day time off request, relative to the management unit time zone



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 26

def full_day_time_off_markers
  @full_day_time_off_markers
end

#shifts ⇒ Object

The shifts that belong to this schedule



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 23

def shifts
  @shifts
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 29

def self.attribute_map
  {
    :'shifts' => :'shifts',
    :'full_day_time_off_markers' => :'fullDayTimeOffMarkers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 37

def self.swagger_types
  {
    :'shifts' => :'Array<UserScheduleShift>',
    :'full_day_time_off_markers' => :'Array<UserScheduleFullDayTimeOffMarker>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



80
81
82
83
84
85
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 80

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shifts == o.shifts &&
      full_day_time_off_markers == o.full_day_time_off_markers
end

#_deserialize(type, value) ⇒ Object 



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

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



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 179

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 100

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


89
90
91
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 89

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 95

def hash
  [shifts, full_day_time_off_markers].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



68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 68

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



162
163
164
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 162

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



167
168
169
170
171
172
173
174
175
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 167

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 



157
158
159
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 157

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



75
76
 
# File 'lib/purecloudplatformclientv2/models/user_schedule.rb', line 75

def valid?
end