Class: PureCloud::ResponseConfig

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

Overview

Defines response components of the Action Request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
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
111
112
113
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 66

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

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

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

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

  
end

Instance Attribute Details

#success_template ⇒ Object

Velocity template to build response to return from Action.



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

def success_template
  @success_template
end

#success_template_uri ⇒ Object

URI to retrieve success template.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 32

def success_template_uri
  @success_template_uri
end

#translation_map ⇒ Object

Map ‘attribute name’ and ‘JSON path’ pairs used to extract data from REST response.



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

def translation_map
  @translation_map
end

#translation_map_defaults ⇒ Object

Map ‘attribute name’ and ‘default value’ pairs used as fallback values if JSON path extraction fails for specified key.



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

def translation_map_defaults
  @translation_map_defaults
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 35

def self.attribute_map
  {
    
    :'translation_map' => :'translationMap',
    
    :'translation_map_defaults' => :'translationMapDefaults',
    
    :'success_template' => :'successTemplate',
    
    :'success_template_uri' => :'successTemplateUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 50

def self.swagger_types
  {
    
    :'translation_map' => :'Hash<String, String>',
    
    :'translation_map_defaults' => :'Hash<String, String>',
    
    :'success_template' => :'String',
    
    :'success_template_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      translation_map == o.translation_map &&
      translation_map_defaults == o.translation_map_defaults &&
      success_template == o.success_template &&
      success_template_uri == o.success_template_uri
end

#_deserialize(type, value) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 210

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 270

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 191

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


180
181
182
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 186

def hash
  [translation_map, translation_map_defaults, success_template, success_template_uri].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



117
118
119
120
121
122
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 117

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



253
254
255
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 253

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



258
259
260
261
262
263
264
265
266
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 258

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 



248
249
250
 
# File 'lib/purecloudplatformclientv2/models/response_config.rb', line 248

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end