Class: PureCloud::Library

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Library

Returns a new instance of Library.



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
97
98
99
100
# File 'lib/purecloud/models/library.rb', line 69

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[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#created_byObject

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#date_createdObject

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



32
33
34
# File 'lib/purecloud/models/library.rb', line 32

def date_created
  @date_created
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#nameObject

The library name.



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

def name
  @name
end

#self_uriObject

The URI for this object



35
36
37
# File 'lib/purecloud/models/library.rb', line 35

def self_uri
  @self_uri
end

#versionObject

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/purecloud/models/library.rb', line 38

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

.swagger_typesObject

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
# File 'lib/purecloud/models/library.rb', line 57

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



103
104
105
106
107
108
109
110
111
112
# File 'lib/purecloud/models/library.rb', line 103

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

#_deserialize(type, value) ⇒ Object



144
145
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
# File 'lib/purecloud/models/library.rb', line 144

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



204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/purecloud/models/library.rb', line 204

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/purecloud/models/library.rb', line 125

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


115
116
117
# File 'lib/purecloud/models/library.rb', line 115

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



120
121
122
# File 'lib/purecloud/models/library.rb', line 120

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

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



187
188
189
# File 'lib/purecloud/models/library.rb', line 187

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



192
193
194
195
196
197
198
199
200
# File 'lib/purecloud/models/library.rb', line 192

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_sObject



182
183
184
# File 'lib/purecloud/models/library.rb', line 182

def to_s
  to_hash.to_s
end