Class: PureCloud::ValidateAddressResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ValidateAddressResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 45

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

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

end

Instance Attribute Details

#response ⇒ Object

Subscriber schema



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 25

def response
  @response
end

#valid ⇒ Object

Was the passed in address valid



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 22

def valid
  @valid
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 28

def self.attribute_map
  {
    :'valid' => :'valid',
    :'response' => :'response'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 36

def self.swagger_types
  {
    :'valid' => :'BOOLEAN',
    :'response' => :'SubscriberResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      valid == o.valid &&
      response == o.response
end

#_deserialize(type, value) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
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
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 118

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



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 178

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 99

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


88
89
90
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 88

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



94
95
96
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 94

def hash
  [valid, response].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



63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 63

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



161
162
163
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 161

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 166

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 



156
157
158
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 156

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



70
71
72
73
74
75
 
# File 'lib/purecloudplatformclientv2/models/validate_address_response.rb', line 70

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

end