Class: Shippinglogic::FedEx::Signature

Inherits:
Service show all
Defined in:
lib/shippinglogic/fedex/signature.rb

Overview

An interface to the signature proof of delivery services provided by FedEx. Allows you to get an image of the signature, or you can tell fedex to fax it to a fax number.

Accessor methods / options

  • tracking_number - the tracking number

  • image_type - one of Enumerations::SIGNATURE_IMAGE_TYPES. (default: LETTER)

  • image_file_type - one of Enumerations::LABEL_FILE_TYPES. (default: PDF)

  • fax_number - if image_type is set to FAX you must provide a fax number here. (default: nil)

Simple Example

Here is a very simple example:

fedex = Shippinglogic::FedEx.new(key, password, , meter)
signature = fedex.signature(:tracking_number => "my number")

signature.inspect
# => #<Shippinglogic::FedEx::Signature::Signature image:string(base64 decoded) >

signature.image
# => "a bunch of garble (write this to a file and save it)"

Defined Under Namespace

Classes: Signature

Constant Summary collapse

VERSION =
{:major => 3, :intermediate => 0, :minor => 0}

Constants included from Response

Response::SUCCESSFUL_SEVERITIES

Instance Attribute Summary

Attributes inherited from Service

#base

Method Summary

Methods inherited from Service

#initialize

Methods included from Validation

#errors, #valid?

Methods included from Attributes

included

Methods inherited from Proxy

#initialize

Constructor Details

This class inherits a constructor from Shippinglogic::Service

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Shippinglogic::Proxy