Class: UspsApi::ServiceStandardsResponse

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

Overview

ServiceStandardsResponse 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(metadata: SKIP, publish_date: SKIP, effective_date: SKIP, standards: SKIP, messages: SKIP, unsupported_zip_codes: SKIP, exempt_origin_zip_codes: SKIP, exempt_destination_zip_codes: SKIP, additional_properties: nil) ⇒ ServiceStandardsResponse

Returns a new instance of ServiceStandardsResponse.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/usps_api/models/service_standards_response.rb', line 81

def initialize(metadata: SKIP, publish_date: SKIP, effective_date: SKIP,
               standards: SKIP, messages: SKIP, unsupported_zip_codes: SKIP,
               exempt_origin_zip_codes: SKIP,
               exempt_destination_zip_codes: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @metadata = metadata unless metadata == SKIP
  @publish_date = publish_date unless publish_date == SKIP
  @effective_date = effective_date unless effective_date == SKIP
  @standards = standards unless standards == SKIP
  @messages = messages unless messages == SKIP
  @unsupported_zip_codes = unsupported_zip_codes unless unsupported_zip_codes == SKIP
  @exempt_origin_zip_codes = exempt_origin_zip_codes unless exempt_origin_zip_codes == SKIP
  unless exempt_destination_zip_codes == SKIP
    @exempt_destination_zip_codes =
      exempt_destination_zip_codes
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#effective_date ⇒ Date

Effective date of data (YYYY-MM-DD)

Returns:

  • (Date) 


22
23
24
 
# File 'lib/usps_api/models/service_standards_response.rb', line 22

def effective_date
  @effective_date
end

#exempt_destination_zip_codes ⇒ Array[String]

List of all exempt destination ZIP codes provided in the ‘destinationZIPCode` parameter. ZIP codes can be exempt on origin, destination, or both.

Returns:

  • (Array[String]) 


46
47
48
 
# File 'lib/usps_api/models/service_standards_response.rb', line 46

def exempt_destination_zip_codes
  @exempt_destination_zip_codes
end

#exempt_origin_zip_codes ⇒ Array[String]

List of all exempt origin ZIP codes provided in the ‘originZIPCode` parameter. ZIP codes can be exempt on origin, destination, or both.

Returns:

  • (Array[String]) 


40
41
42
 
# File 'lib/usps_api/models/service_standards_response.rb', line 40

def exempt_origin_zip_codes
  @exempt_origin_zip_codes
end

#messages ⇒ Array[Message]

Extra information provided to provide context to the response.

Returns:



30
31
32
 
# File 'lib/usps_api/models/service_standards_response.rb', line 30

def messages
  @messages
end

#metadata ⇒ Metadata1

Metadata containing information for pagination

Returns:



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

def metadata
  @metadata
end

#publish_date ⇒ Date

Publish date of data (YYYY-MM-DD)

Returns:

  • (Date) 


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

def publish_date
  @publish_date
end

#standards ⇒ Array[Standard1]

service standards

Returns:



26
27
28
 
# File 'lib/usps_api/models/service_standards_response.rb', line 26

def standards
  @standards
end

#unsupported_zip_codes ⇒ Array[String]

List of all unsupported ZIP codes provided in the ‘originZIPCode` and `destinationZIPCode` parameters.

Returns:

  • (Array[String]) 


35
36
37
 
# File 'lib/usps_api/models/service_standards_response.rb', line 35

def unsupported_zip_codes
  @unsupported_zip_codes
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
 
# File 'lib/usps_api/models/service_standards_response.rb', line 104

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  metadata = Metadata1.from_hash(hash['metadata']) if hash['metadata']
  publish_date = hash.key?('publishDate') ? hash['publishDate'] : SKIP
  effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
  # Parameter is an array, so we need to iterate through it
  standards = nil
  unless hash['standards'].nil?
    standards = []
    hash['standards'].each do |structure|
      standards << (Standard1.from_hash(structure) if structure)
    end
  end

  standards = SKIP unless hash.key?('standards')
  # Parameter is an array, so we need to iterate through it
  messages = nil
  unless hash['messages'].nil?
    messages = []
    hash['messages'].each do |structure|
      messages << (Message.from_hash(structure) if structure)
    end
  end

  messages = SKIP unless hash.key?('messages')
  unsupported_zip_codes =
    hash.key?('unsupportedZIPCodes') ? hash['unsupportedZIPCodes'] : SKIP
  exempt_origin_zip_codes =
    hash.key?('exemptOriginZIPCodes') ? hash['exemptOriginZIPCodes'] : SKIP
  exempt_destination_zip_codes =
    hash.key?('exemptDestinationZIPCodes') ? hash['exemptDestinationZIPCodes'] : 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.
  ServiceStandardsResponse.new(metadata: metadata,
                               publish_date: publish_date,
                               effective_date: effective_date,
                               standards: standards,
                               messages: messages,
                               unsupported_zip_codes: unsupported_zip_codes,
                               exempt_origin_zip_codes: exempt_origin_zip_codes,
                               exempt_destination_zip_codes: exempt_destination_zip_codes,
                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/usps_api/models/service_standards_response.rb', line 49

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['metadata'] = 'metadata'
  @_hash['publish_date'] = 'publishDate'
  @_hash['effective_date'] = 'effectiveDate'
  @_hash['standards'] = 'standards'
  @_hash['messages'] = 'messages'
  @_hash['unsupported_zip_codes'] = 'unsupportedZIPCodes'
  @_hash['exempt_origin_zip_codes'] = 'exemptOriginZIPCodes'
  @_hash['exempt_destination_zip_codes'] = 'exemptDestinationZIPCodes'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



77
78
79
 
# File 'lib/usps_api/models/service_standards_response.rb', line 77

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/usps_api/models/service_standards_response.rb', line 63

def self.optionals
  %w[
    metadata
    publish_date
    effective_date
    standards
    messages
    unsupported_zip_codes
    exempt_origin_zip_codes
    exempt_destination_zip_codes
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



168
169
170
171
172
173
174
175
176
 
# File 'lib/usps_api/models/service_standards_response.rb', line 168

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} metadata: #{@metadata.inspect}, publish_date: #{@publish_date.inspect},"\
  " effective_date: #{@effective_date.inspect}, standards: #{@standards.inspect}, messages:"\
  " #{@messages.inspect}, unsupported_zip_codes: #{@unsupported_zip_codes.inspect},"\
  " exempt_origin_zip_codes: #{@exempt_origin_zip_codes.inspect},"\
  " exempt_destination_zip_codes: #{@exempt_destination_zip_codes.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



158
159
160
161
162
163
164
165
 
# File 'lib/usps_api/models/service_standards_response.rb', line 158

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} metadata: #{@metadata}, publish_date: #{@publish_date}, effective_date:"\
  " #{@effective_date}, standards: #{@standards}, messages: #{@messages},"\
  " unsupported_zip_codes: #{@unsupported_zip_codes}, exempt_origin_zip_codes:"\
  " #{@exempt_origin_zip_codes}, exempt_destination_zip_codes:"\
  " #{@exempt_destination_zip_codes}, additional_properties: #{@additional_properties}>"
end