Class: UspsApi::TrackingNumberSuccessResponse

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

Overview

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

Returns a new instance of TrackingNumberSuccessResponse.



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

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

  @tracking_numbers = tracking_numbers unless tracking_numbers == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#tracking_numbers ⇒ Array[TrackingNumber]

TODO: Write general description for this method

Returns:



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

def tracking_numbers
  @tracking_numbers
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 44

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  tracking_numbers = nil
  unless hash['trackingNumbers'].nil?
    tracking_numbers = []
    hash['trackingNumbers'].each do |structure|
      tracking_numbers << (TrackingNumber.from_hash(structure) if structure)
    end
  end

  tracking_numbers = SKIP unless hash.key?('trackingNumbers')

  # 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.
  TrackingNumberSuccessResponse.new(tracking_numbers: tracking_numbers,
                                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 31

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 24

def self.optionals
  %w[
    tracking_numbers
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



79
80
81
82
83
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 79

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



72
73
74
75
76
 
# File 'lib/usps_api/models/tracking_number_success_response.rb', line 72

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