Class: UspsApi::AdditionalInformation

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

Overview

AdditionalInformation Model.

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(mail_classes: SKIP, additional_properties: nil) ⇒ AdditionalInformation

Returns a new instance of AdditionalInformation.



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

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

  @mail_classes = mail_classes unless mail_classes == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#mail_classes ⇒ Array[String]

The list of mail classes that are supported for the Hold for Pickup service at a given facility.

Returns:

  • (Array[String]) 


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

def mail_classes
  @mail_classes
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  mail_classes = hash.key?('mailClasses') ? hash['mailClasses'] : 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.
  AdditionalInformation.new(mail_classes: mail_classes,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/usps_api/models/additional_information.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



32
33
34
 
# File 'lib/usps_api/models/additional_information.rb', line 32

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
28
29
 
# File 'lib/usps_api/models/additional_information.rb', line 25

def self.optionals
  %w[
    mail_classes
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



71
72
73
74
75
 
# File 'lib/usps_api/models/additional_information.rb', line 71

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



64
65
66
67
68
 
# File 'lib/usps_api/models/additional_information.rb', line 64

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