Class: UspsApi::ZipCode8482Response

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/usps_api/models/zip_code8482_response.rb

Overview

The address to validate the ZIP Code™ for.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(firm: SKIP, address: SKIP) ⇒ ZipCode8482Response

Returns a new instance of ZipCode8482Response.



41
42
43
44
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 41

def initialize(firm: SKIP, address: SKIP)
  @firm = firm unless firm == SKIP
  @address = address unless address == SKIP
end

Instance Attribute Details

#address ⇒ AddressesDomesticAddress

Address fields for US locations

Returns:



18
19
20
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 18

def address
  @address
end

#firm ⇒ String

This is the firm/business name at the address.

Returns:

  • (String) 


14
15
16
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 14

def firm
  @firm
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  firm = hash.key?('firm') ? hash['firm'] : SKIP
  address = AddressesDomesticAddress.from_hash(hash['address']) if hash['address']

  # Create object from extracted values.
  ZipCode8482Response.new(firm: firm,
                          address: address)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['firm'] = 'firm'
  @_hash['address'] = 'address'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 29

def self.optionals
  %w[
    firm
    address
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



66
67
68
69
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 66

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} firm: #{@firm.inspect}, address: #{@address.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



60
61
62
63
 
# File 'lib/usps_api/models/zip_code8482_response.rb', line 60

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} firm: #{@firm}, address: #{@address}>"
end