Class: PureCloud::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/attribute.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Attribute

Returns a new instance of Attribute.



85
86
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
 
# File 'lib/purecloud/models/attribute.rb', line 85

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#created_by ⇒ Object

Returns the value of attribute created_by.



31
32
33
 
# File 'lib/purecloud/models/attribute.rb', line 31

def created_by
  @created_by
end

#date_created ⇒ Object

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



34
35
36
 
# File 'lib/purecloud/models/attribute.rb', line 34

def date_created
  @date_created
end

#date_modified ⇒ Object

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



39
40
41
 
# File 'lib/purecloud/models/attribute.rb', line 39

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



29
30
31
 
# File 'lib/purecloud/models/attribute.rb', line 29

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/attribute.rb', line 22

def id
  @id
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



36
37
38
 
# File 'lib/purecloud/models/attribute.rb', line 36

def modified_by
  @modified_by
end

#name ⇒ Object

The attribute name.



25
26
27
 
# File 'lib/purecloud/models/attribute.rb', line 25

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



42
43
44
 
# File 'lib/purecloud/models/attribute.rb', line 42

def self_uri
  @self_uri
end

#version ⇒ Object

Returns the value of attribute version.



27
28
29
 
# File 'lib/purecloud/models/attribute.rb', line 27

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloud/models/attribute.rb', line 45

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'version' => :'version',
    
    :'description' => :'description',
    
    :'created_by' => :'createdBy',
    
    :'date_created' => :'dateCreated',
    
    :'modified_by' => :'modifiedBy',
    
    :'date_modified' => :'dateModified',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloud/models/attribute.rb', line 70

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'version' => :'Integer',
    :'description' => :'String',
    :'created_by' => :'UriReference',
    :'date_created' => :'DateTime',
    :'modified_by' => :'UriReference',
    :'date_modified' => :'DateTime',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/purecloud/models/attribute.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      version == o.version &&
      description == o.description &&
      created_by == o.created_by &&
      date_created == o.date_created &&
      modified_by == o.modified_by &&
      date_modified == o.date_modified &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloud/models/attribute.rb', line 175

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/purecloud/models/attribute.rb', line 235

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/purecloud/models/attribute.rb', line 156

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

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/purecloud/models/attribute.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



151
152
153
 
# File 'lib/purecloud/models/attribute.rb', line 151

def hash
  [id, name, version, description, created_by, date_created, modified_by, date_modified, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



218
219
220
 
# File 'lib/purecloud/models/attribute.rb', line 218

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



223
224
225
226
227
228
229
230
231
 
# File 'lib/purecloud/models/attribute.rb', line 223

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 



213
214
215
 
# File 'lib/purecloud/models/attribute.rb', line 213

def to_s
  to_hash.to_s
end