Class: PureCloud::ActionOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/action_output.rb

Overview

Output definition of Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActionOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 80

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

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

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

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

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

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

  
end

Instance Attribute Details

#error_schema ⇒ Object

JSON schema that defines the body of response when request is not successful. If the ‘flatten’ query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 29

def error_schema
  @error_schema
end

#error_schema_flattened ⇒ Object

JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect’s flattened format. If the ‘flatten’ query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.



38
39
40
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 38

def error_schema_flattened
  @error_schema_flattened
end

#error_schema_uri ⇒ Object

URI to retrieve error schema



32
33
34
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 32

def error_schema_uri
  @error_schema_uri
end

#success_schema ⇒ Object

JSON schema that defines the transformed, successful result that will be sent back to the caller. If the ‘flatten’ query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 23

def success_schema
  @success_schema
end

#success_schema_flattened ⇒ Object

JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect’s flattened format. If the ‘flatten’ query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.



35
36
37
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 35

def success_schema_flattened
  @success_schema_flattened
end

#success_schema_uri ⇒ Object

URI to retrieve success schema



26
27
28
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 26

def success_schema_uri
  @success_schema_uri
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 41

def self.attribute_map
  {
    
    :'success_schema' => :'successSchema',
    
    :'success_schema_uri' => :'successSchemaUri',
    
    :'error_schema' => :'errorSchema',
    
    :'error_schema_uri' => :'errorSchemaUri',
    
    :'success_schema_flattened' => :'successSchemaFlattened',
    
    :'error_schema_flattened' => :'errorSchemaFlattened'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 60

def self.swagger_types
  {
    
    :'success_schema' => :'JsonSchemaDocument',
    
    :'success_schema_uri' => :'String',
    
    :'error_schema' => :'JsonSchemaDocument',
    
    :'error_schema_uri' => :'String',
    
    :'success_schema_flattened' => :'JsonSchemaDocument',
    
    :'error_schema_flattened' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success_schema == o.success_schema &&
      success_schema_uri == o.success_schema_uri &&
      error_schema == o.error_schema &&
      error_schema_uri == o.error_schema_uri &&
      success_schema_flattened == o.success_schema_flattened &&
      error_schema_flattened == o.error_schema_flattened
end

#_deserialize(type, value) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 258

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 318

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 239

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


228
229
230
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 234

def hash
  [success_schema, success_schema_uri, error_schema, error_schema_uri, success_schema_flattened, error_schema_flattened].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



145
146
147
148
149
150
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 145

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



301
302
303
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 301

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



306
307
308
309
310
311
312
313
314
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 306

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 



296
297
298
 
# File 'lib/purecloudclient_v2a/models/action_output.rb', line 296

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



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/purecloudclient_v2a/models/action_output.rb', line 154

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end