Class: UPS::Builders::TrackBuilder

Inherits:
BuilderBase show all
Includes:
Ox
Defined in:
lib/ups/builders/track_builder.rb

Overview

The TrackBuilder class builds UPS XML Track Objects.

Author:

  • Stephan van Diepen

Since:

  • 0.17.1

Instance Attribute Summary

Attributes inherited from BuilderBase

#access_request, #document, #license_number, #password, #root, #shipment_root, #user_id

Instance Method Summary collapse

Methods inherited from BuilderBase

#add_access_request, #add_insurance_charge, #add_itemized_payment_information, #add_master_carton_id, #add_master_carton_indicator, #add_package, #add_payment_information, #add_rate_information, #add_request, #add_ship_from, #add_ship_to, #add_shipment_delivery_confirmation, #add_shipment_direct_delivery_only, #add_shipper, #add_sold_to, #to_xml

Constructor Details

#initialize ⇒ TrackBuilder

Initializes a new UPS::Builders::TrackBuilder object

Since:

  • 0.17.1



14
15
16
 
# File 'lib/ups/builders/track_builder.rb', line 14

def initialize
  super 'TrackRequest'
end

Instance Method Details

#add_option_code(option_code) ⇒ void

This method returns an undefined value.

Adds an OptionCode to the XML document being built according to user inputs

Since:

  • 0.17.1



30
31
32
33
34
 
# File 'lib/ups/builders/track_builder.rb', line 30

def add_option_code(option_code)
  root << Element.new('Request').tap do |request|
    request << element_with_value('RequestOption', option_code)
  end
end

#add_tracking_number(number) ⇒ void

This method returns an undefined value.

Adds an TrackingNumber to the XML document being built according to user inputs

Since:

  • 0.17.1



22
23
24
 
# File 'lib/ups/builders/track_builder.rb', line 22

def add_tracking_number(number)
  root << element_with_value('TrackingNumber', number)
end