Class: UspsApi::Passports

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

Overview

Facility information for passport services.

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(phone: SKIP, photo_cost: SKIP, appointment_required: SKIP, additional_properties: nil) ⇒ Passports

Returns a new instance of Passports.



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

def initialize(phone: SKIP, photo_cost: SKIP, appointment_required: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @phone = phone unless phone == SKIP
  @photo_cost = photo_cost unless photo_cost == SKIP
  @appointment_required = appointment_required unless appointment_required == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#appointment_required ⇒ TrueClass | FalseClass

Whether appointments are required to take passport photos at the location.

Returns:

  • (TrueClass | FalseClass) 


23
24
25
 
# File 'lib/usps_api/models/passports.rb', line 23

def appointment_required
  @appointment_required
end

#phone ⇒ String

The phone number, including the country extension and area code, with no punctuation.

Returns:

  • (String) 


15
16
17
 
# File 'lib/usps_api/models/passports.rb', line 15

def phone
  @phone
end

#photo_cost ⇒ Float

The cost of passport photos at the location in dollars.

Returns:

  • (Float) 


19
20
21
 
# File 'lib/usps_api/models/passports.rb', line 19

def photo_cost
  @photo_cost
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/usps_api/models/passports.rb', line 60

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  phone = hash.key?('phone') ? hash['phone'] : SKIP
  photo_cost = hash.key?('photoCost') ? hash['photoCost'] : SKIP
  appointment_required =
    hash.key?('appointmentRequired') ? hash['appointmentRequired'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Passports.new(phone: phone,
                photo_cost: photo_cost,
                appointment_required: appointment_required,
                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/usps_api/models/passports.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['phone'] = 'phone'
  @_hash['photo_cost'] = 'photoCost'
  @_hash['appointment_required'] = 'appointmentRequired'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/usps_api/models/passports.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
40
41
 
# File 'lib/usps_api/models/passports.rb', line 35

def self.optionals
  %w[
    phone
    photo_cost
    appointment_required
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



91
92
93
94
95
96
 
# File 'lib/usps_api/models/passports.rb', line 91

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} phone: #{@phone.inspect}, photo_cost: #{@photo_cost.inspect},"\
  " appointment_required: #{@appointment_required.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
88
 
# File 'lib/usps_api/models/passports.rb', line 84

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} phone: #{@phone}, photo_cost: #{@photo_cost}, appointment_required:"\
  " #{@appointment_required}, additional_properties: #{@additional_properties}>"
end