Class: OCI::OspGateway::Models::VerifyAddressReceipt

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osp_gateway/models/verify_address_receipt.rb

Overview

Address verficiation result

Constant Summary collapse

QUALITY_ENUM = 
[
  QUALITY_EXCELLENT = 'EXCELLENT'.freeze,
  QUALITY_GOOD = 'GOOD'.freeze,
  QUALITY_AVERAGE = 'AVERAGE'.freeze,
  QUALITY_POOR = 'POOR'.freeze,
  QUALITY_BAD = 'BAD'.freeze,
  QUALITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VERIFICATION_CODE_ENUM = 
[
  VERIFICATION_CODE_VERIFIED = 'VERIFIED'.freeze,
  VERIFICATION_CODE_PARTIALLY_VERIFIED = 'PARTIALLY_VERIFIED'.freeze,
  VERIFICATION_CODE_AMBIGUOUS = 'AMBIGUOUS'.freeze,
  VERIFICATION_CODE_REVERTED = 'REVERTED'.freeze,
  VERIFICATION_CODE_UNVERIFIED = 'UNVERIFIED'.freeze,
  VERIFICATION_CODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VerifyAddressReceipt

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 73

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 }

  self.address = attributes[:'address'] if attributes[:'address']

  self.quality = attributes[:'quality'] if attributes[:'quality']

  self.verification_code = attributes[:'verificationCode'] if attributes[:'verificationCode']

  raise 'You cannot provide both :verificationCode and :verification_code' if attributes.key?(:'verificationCode') && attributes.key?(:'verification_code')

  self.verification_code = attributes[:'verification_code'] if attributes[:'verification_code']
end

Instance Attribute Details

#address ⇒ OCI::OspGateway::Models::Address

This attribute is required.

Returns:



32
33
34
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 32

def address
  @address
end

#quality ⇒ String

[Required] Address quality type.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 36

def quality
  @quality
end

#verification_code ⇒ String

[Required] Address verification code.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 40

def verification_code
  @verification_code
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'address',
    'quality': :'quality',
    'verification_code': :'verificationCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'OCI::OspGateway::Models::Address',
    'quality': :'String',
    'verification_code': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



123
124
125
126
127
128
129
130
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 123

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    address == other.address &&
    quality == other.quality &&
    verification_code == other.verification_code
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 155

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
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


135
136
137
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 144

def hash
  [address, quality, verification_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 188

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



182
183
184
 
# File 'lib/oci/osp_gateway/models/verify_address_receipt.rb', line 182

def to_s
  to_hash.to_s
end