Class: PureCloud::LockInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LockInfo

Initializes the object



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 53

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

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

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

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

end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 29

def action
  @action
end

#date_created ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 24

def date_created
  @date_created
end

#date_expires ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 27

def date_expires
  @date_expires
end

#locked_by ⇒ Object

Returns the value of attribute locked_by.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 21

def locked_by
  @locked_by
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 32

def self.attribute_map
  {
    :'locked_by' => :'lockedBy',
    :'date_created' => :'dateCreated',
    :'date_expires' => :'dateExpires',
    :'action' => :'action'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'locked_by' => :'UriReference',
    :'date_created' => :'DateTime',
    :'date_expires' => :'DateTime',
    :'action' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



105
106
107
108
109
110
111
112
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 105

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      locked_by == o.locked_by &&
      date_created == o.date_created &&
      date_expires == o.date_expires &&
      action == o.action
end

#_deserialize(type, value) ⇒ Object 



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

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 206

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 127

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

See Also:

  • `==` method


116
117
118
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 116

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



122
123
124
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 122

def hash
  [locked_by, date_created, date_expires, action].hash
end

#list_invalid_properties ⇒ Object

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



79
80
81
82
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 79

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



189
190
191
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 189

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



194
195
196
197
198
199
200
201
202
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 194

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 



184
185
186
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 184

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



86
87
88
89
90
91
 
# File 'lib/purecloudplatformclientv2/models/lock_info.rb', line 86

def valid?
  allowed_values = ["UPDATE", "DELETE", "COPY", "MOVE", "REPLACE", "THUMBNAIL", "TEXT_EXTRACTION"]
  if @action && !allowed_values.include?(@action)
    return false
  end
end