Class: Lob::UsVerification

Inherits:
Object
  • Object
show all
Defined in:
lib/lob/models/us_verification.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsVerification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/lob/models/us_verification.rb', line 127

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerification` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'recipient')
    self.recipient = attributes[:'recipient']
  end

  if attributes.key?(:'primary_line')
    self.primary_line = attributes[:'primary_line']
  end

  if attributes.key?(:'secondary_line')
    self.secondary_line = attributes[:'secondary_line']
  end

  if attributes.key?(:'urbanization')
    self.urbanization = attributes[:'urbanization']
  end

  if attributes.key?(:'last_line')
    self.last_line = attributes[:'last_line']
  end

  if attributes.key?(:'deliverability')
    self.deliverability = attributes[:'deliverability']
  end

  if attributes.key?(:'valid_address')
    self.valid_address = attributes[:'valid_address']
  end

  if attributes.key?(:'components')
    self.components = attributes[:'components']
  end

  if attributes.key?(:'deliverability_analysis')
    self.deliverability_analysis = attributes[:'deliverability_analysis']
  end

  if attributes.key?(:'lob_confidence_score')
    self.lob_confidence_score = attributes[:'lob_confidence_score']
  end

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'us_verification'
  end

  if attributes.key?(:'transient_id')
    self.transient_id = attributes[:'transient_id']
  end
end

Instance Attribute Details

#components ⇒ Object

Returns the value of attribute components.



42
43
44
 
# File 'lib/lob/models/us_verification.rb', line 42

def components
  @components
end

#deliverability ⇒ Object

Summarizes the deliverability of the ‘us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building’s default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * ‘deliverable_missing_unit` – The address is deliverable to the building’s default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * ‘undeliverable` – The address is not deliverable according to the USPS.



37
38
39
 
# File 'lib/lob/models/us_verification.rb', line 37

def deliverability
  @deliverability
end

#deliverability_analysis ⇒ Object

Returns the value of attribute deliverability_analysis.



44
45
46
 
# File 'lib/lob/models/us_verification.rb', line 44

def deliverability_analysis
  @deliverability_analysis
end

#id ⇒ Object

Unique identifier prefixed with ‘us_ver_`.



19
20
21
 
# File 'lib/lob/models/us_verification.rb', line 19

def id
  @id
end

#last_line ⇒ Object

Combination of the following applicable ‘components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)



34
35
36
 
# File 'lib/lob/models/us_verification.rb', line 34

def last_line
  @last_line
end

#lob_confidence_score ⇒ Object

Returns the value of attribute lob_confidence_score.



46
47
48
 
# File 'lib/lob/models/us_verification.rb', line 46

def lob_confidence_score
  @lob_confidence_score
end

#object ⇒ Object

Returns the value of attribute object.



48
49
50
 
# File 'lib/lob/models/us_verification.rb', line 48

def object
  @object
end

#primary_line ⇒ Object

The primary delivery line (usually the street address) of the address. Combination of the following applicable ‘components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`



25
26
27
 
# File 'lib/lob/models/us_verification.rb', line 25

def primary_line
  @primary_line
end

#recipient ⇒ Object

The intended recipient, typically a person’s or firm’s name.



22
23
24
 
# File 'lib/lob/models/us_verification.rb', line 22

def recipient
  @recipient
end

#secondary_line ⇒ Object

The secondary delivery line of the address. This field is typically empty but may contain information if ‘primary_line` is too long.



28
29
30
 
# File 'lib/lob/models/us_verification.rb', line 28

def secondary_line
  @secondary_line
end

#transient_id ⇒ Object

ID that is returned in the response body for the verification



51
52
53
 
# File 'lib/lob/models/us_verification.rb', line 51

def transient_id
  @transient_id
end

#urbanization ⇒ Object

Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.



31
32
33
 
# File 'lib/lob/models/us_verification.rb', line 31

def urbanization
  @urbanization
end

#valid_address ⇒ Object

This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address.



40
41
42
 
# File 'lib/lob/models/us_verification.rb', line 40

def valid_address
  @valid_address
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/lob/models/us_verification.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/lob/models/us_verification.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'recipient' => :'recipient',
    :'primary_line' => :'primary_line',
    :'secondary_line' => :'secondary_line',
    :'urbanization' => :'urbanization',
    :'last_line' => :'last_line',
    :'deliverability' => :'deliverability',
    :'valid_address' => :'valid_address',
    :'components' => :'components',
    :'deliverability_analysis' => :'deliverability_analysis',
    :'lob_confidence_score' => :'lob_confidence_score',
    :'object' => :'object',
    :'transient_id' => :'transient_id'
  }
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



345
346
347
 
# File 'lib/lob/models/us_verification.rb', line 345

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
 
# File 'lib/lob/models/us_verification.rb', line 119

def self.openapi_nullable
  Set.new([
    :'recipient',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'recipient' => :'String',
    :'primary_line' => :'String',
    :'secondary_line' => :'String',
    :'urbanization' => :'String',
    :'last_line' => :'String',
    :'deliverability' => :'String',
    :'valid_address' => :'Boolean',
    :'components' => :'UsComponents',
    :'deliverability_analysis' => :'DeliverabilityAnalysis',
    :'lob_confidence_score' => :'LobConfidenceScore',
    :'object' => :'String',
    :'transient_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/lob/models/us_verification.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      recipient == o.recipient &&
      primary_line == o.primary_line &&
      secondary_line == o.secondary_line &&
      urbanization == o.urbanization &&
      last_line == o.last_line &&
      deliverability == o.deliverability &&
      valid_address == o.valid_address &&
      components == o.components &&
      deliverability_analysis == o.deliverability_analysis &&
      lob_confidence_score == o.lob_confidence_score &&
      object == o.object &&
      transient_id == o.transient_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/lob/models/us_verification.rb', line 384

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = Lob.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/lob/models/us_verification.rb', line 455

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/lob/models/us_verification.rb', line 352

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil) # // guardrails-disable-line
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
      end
    elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
      for base_type in type do
        res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
        if !res.nil?
          self.send("#{key}=", res) # // guardrails-disable-line
          break
        end
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


331
332
333
 
# File 'lib/lob/models/us_verification.rb', line 331

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



337
338
339
 
# File 'lib/lob/models/us_verification.rb', line 337

def hash
  [id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, valid_address, components, deliverability_analysis, lob_confidence_score, object, transient_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/lob/models/us_verification.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^us_ver_[a-zA-Z0-9_]+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

  if !@recipient.nil? && @recipient.to_s.length > 500
    invalid_properties.push('invalid value for "recipient", the character length must be smaller than or equal to 500.')
  end

  if !@primary_line.nil? && @primary_line.to_s.length > 500
    invalid_properties.push('invalid value for "primary_line", the character length must be smaller than or equal to 500.')
  end

  if !@secondary_line.nil? && @secondary_line.to_s.length > 500
    invalid_properties.push('invalid value for "secondary_line", the character length must be smaller than or equal to 500.')
  end

  if !@urbanization.nil? && @urbanization.to_s.length > 500
    invalid_properties.push('invalid value for "urbanization", the character length must be smaller than or equal to 500.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



431
432
433
 
# File 'lib/lob/models/us_verification.rb', line 431

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/lob/models/us_verification.rb', line 437

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr) # // guardrails-disable-line
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



425
426
427
 
# File 'lib/lob/models/us_verification.rb', line 425

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



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/lob/models/us_verification.rb', line 225

def valid?
  return false if !@id.nil? && @id !~ Regexp.new(/^us_ver_[a-zA-Z0-9_]+$/)
  return false if !@recipient.nil? && @recipient.to_s.length > 500
  return false if !@primary_line.nil? && @primary_line.to_s.length > 500
  return false if !@secondary_line.nil? && @secondary_line.to_s.length > 500
  return false if !@urbanization.nil? && @urbanization.to_s.length > 500
  deliverability_validator = EnumAttributeValidator.new('String', ["deliverable", "deliverable_unnecessary_unit", "deliverable_incorrect_unit", "deliverable_missing_unit", "undeliverable"])
  return false unless deliverability_validator.valid?(@deliverability)
  object_validator = EnumAttributeValidator.new('String', ["us_verification"])
  return false unless object_validator.valid?(@object)
  true
end