Class: PureCloud::Response

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

Overview

Contains information about a response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Response

Returns a new instance of Response.



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/purecloud/models/response.rb', line 67

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

User that created the response



21
22
23
 
# File 'lib/purecloud/models/response.rb', line 21

def created_by
  @created_by
end

#date_created ⇒ Object

The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



24
25
26
 
# File 'lib/purecloud/models/response.rb', line 24

def date_created
  @date_created
end

#id ⇒ Object

The globally unique identifier for the object.



7
8
9
 
# File 'lib/purecloud/models/response.rb', line 7

def id
  @id
end

#libraries ⇒ Object

One or more libraries response is associated with.



15
16
17
 
# File 'lib/purecloud/models/response.rb', line 15

def libraries
  @libraries
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/purecloud/models/response.rb', line 9

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#texts ⇒ Object

One or more texts associated with the response.



18
19
20
 
# File 'lib/purecloud/models/response.rb', line 18

def texts
  @texts
end

#version ⇒ Object

Version number required for updates.



12
13
14
 
# File 'lib/purecloud/models/response.rb', line 12

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/purecloud/models/response.rb', line 30

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

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloud/models/response.rb', line 53

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'version' => :'Integer',
    :'libraries' => :'Array<UriReference>',
    :'texts' => :'Array<ResponseText>',
    :'created_by' => :'User',
    :'date_created' => :'DateTime',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/purecloud/models/response.rb', line 113

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

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/response.rb', line 156

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/purecloud/models/response.rb', line 213

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



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

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


127
128
129
 
# File 'lib/purecloud/models/response.rb', line 127

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



132
133
134
 
# File 'lib/purecloud/models/response.rb', line 132

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



196
197
198
 
# File 'lib/purecloud/models/response.rb', line 196

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



201
202
203
204
205
206
207
208
209
 
# File 'lib/purecloud/models/response.rb', line 201

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 



191
192
193
 
# File 'lib/purecloud/models/response.rb', line 191

def to_s
  to_hash.to_s
end