Class: PureCloud::ResponseSubstitution

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

Overview

Contains information about the substitutions associated with a response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseSubstitution

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 51

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

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

  if attributes.has_key?(:'defaultValue')
    self.default_value = attributes[:'defaultValue']
  end

end

Instance Attribute Details

#default_value ⇒ Object

Response substitution default value.



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

def default_value
  @default_value
end

#description ⇒ Object

Response substitution description.



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

def description
  @description
end

#id ⇒ Object

Response substitution identifier.



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

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 32

def self.attribute_map
  {
    :'id' => :'id',
    :'description' => :'description',
    :'default_value' => :'defaultValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 41

def self.swagger_types
  {
    :'id' => :'String',
    :'description' => :'String',
    :'default_value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      description == o.description &&
      default_value == o.default_value
end

#_deserialize(type, value) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 129

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



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 189

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 110

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


99
100
101
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 99

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 105

def hash
  [id, description, default_value].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



73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 73

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



172
173
174
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 172

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 177

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 



167
168
169
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 167

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



80
81
82
83
84
85
 
# File 'lib/purecloudplatformclientv2/models/response_substitution.rb', line 80

def valid?
  if @id.nil?
    return false
  end

end