class FriendlyShipping::Services::Ups::LabelPackageOptions
Package properties relevant for generating a UPS shipping label
@option reference_numbers
[Hash] a Hash where keys are _reference number codes_ and
values are _reference number values_. Example: `{ reference_numbers: { xn: 'my_reference_1 }`
@option delivery_confirmation
[Symbol] Can be set to any key from PACKAGE_DELIVERY_CONFIRMATION_CODES
.
Only possible for domestic shipments or shipments between the US and Puerto Rico.
@option shipper_release
[Boolean] Indicates that the package may be released by driver without a signature from the
consignee. Default: false
Constants
- PACKAGE_DELIVERY_CONFIRMATION_CODES
Attributes
delivery_confirmation[R]
reference_numbers[R]
shipper_release[R]
Public Class Methods
new( reference_numbers: {}, delivery_confirmation: nil, shipper_release: false, **kwargs )
click to toggle source
Calls superclass method
FriendlyShipping::PackageOptions::new
# File lib/friendly_shipping/services/ups/label_package_options.rb, line 25 def initialize( reference_numbers: {}, delivery_confirmation: nil, shipper_release: false, **kwargs ) @reference_numbers = reference_numbers @delivery_confirmation = delivery_confirmation @shipper_release = shipper_release super(**kwargs.merge(item_options_class: LabelItemOptions)) end
Public Instance Methods
delivery_confirmation_code()
click to toggle source
# File lib/friendly_shipping/services/ups/label_package_options.rb, line 37 def delivery_confirmation_code PACKAGE_DELIVERY_CONFIRMATION_CODES[delivery_confirmation] end