Skip to content

Commit 59cd09a

Browse files
committed
generate updated documentation using epydoc
1 parent 6a43a71 commit 59cd09a

File tree

71 files changed

+14506
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+14506
-0
lines changed

Diff for: docs/2.2.0/api-objects.txt

+230
Large diffs are not rendered by default.

Diff for: docs/2.2.0/class-tree.html

+199
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
<?xml version="1.0" encoding="ascii"?>
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5+
<head>
6+
<title>Class Hierarchy</title>
7+
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8+
<script type="text/javascript" src="epydoc.js"></script>
9+
</head>
10+
11+
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12+
alink="#204080">
13+
<!-- ==================== NAVIGATION BAR ==================== -->
14+
<table class="navbar" border="0" width="100%" cellpadding="0"
15+
bgcolor="#a0c0ff" cellspacing="0">
16+
<tr valign="middle">
17+
<!-- Home link -->
18+
<th>&nbsp;&nbsp;&nbsp;<a
19+
href="fedex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20+
21+
<!-- Tree link -->
22+
<th bgcolor="#70b0f0" class="navbar-select"
23+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
24+
25+
<!-- Index link -->
26+
<th>&nbsp;&nbsp;&nbsp;<a
27+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28+
29+
<!-- Help link -->
30+
<th>&nbsp;&nbsp;&nbsp;<a
31+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32+
33+
<th class="navbar" width="100%"></th>
34+
</tr>
35+
</table>
36+
<table width="100%" cellpadding="0" cellspacing="0">
37+
<tr valign="top">
38+
<td width="100%">&nbsp;</td>
39+
<td>
40+
<table cellpadding="0" cellspacing="0">
41+
<!-- hide/show private -->
42+
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
43+
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
44+
<tr><td align="right"><span class="options"
45+
>[<a href="frames.html" target="_top">frames</a
46+
>]&nbsp;|&nbsp;<a href="class-tree.html"
47+
target="_top">no&nbsp;frames</a>]</span></td></tr>
48+
</table>
49+
</td>
50+
</tr>
51+
</table>
52+
<center><b>
53+
[ <a href="module-tree.html">Module Hierarchy</a>
54+
| <a href="class-tree.html">Class Hierarchy</a> ]
55+
</b></center><br />
56+
<h1 class="epydoc">Class Hierarchy</h1>
57+
<ul class="nomargin-top">
58+
<li> <strong class="uidlink">suds.plugin.Plugin</strong>:
59+
<em class="summary">Plugin base.</em>
60+
<ul>
61+
<li> <strong class="uidlink">suds.plugin.MessagePlugin</strong>:
62+
<em class="summary">The base class for suds <i>soap message</i> plugins.</em>
63+
<ul>
64+
<li> <strong class="uidlink"><a href="fedex.base_service.GeneralSudsPlugin-class.html">fedex.base_service.GeneralSudsPlugin</a></strong>
65+
</li>
66+
</ul>
67+
</li>
68+
</ul>
69+
</li>
70+
<li> <strong class="uidlink">object</strong>:
71+
<em class="summary">The most base type</em>
72+
<ul>
73+
<li> <strong class="uidlink">exceptions.BaseException</strong>:
74+
<em class="summary">Common base class for all exceptions</em>
75+
<ul>
76+
<li> <strong class="uidlink">exceptions.Exception</strong>:
77+
<em class="summary">Common base class for all non-exit exceptions.</em>
78+
<ul>
79+
<li> <strong class="uidlink"><a href="fedex.base_service.FedexBaseServiceException-class.html">fedex.base_service.FedexBaseServiceException</a></strong>:
80+
<em class="summary">Exception: Serves as the base exception that other service-related
81+
exception objects are sub-classed from.</em>
82+
<ul>
83+
<li> <strong class="uidlink"><a href="fedex.base_service.FedexError-class.html">fedex.base_service.FedexError</a></strong>:
84+
<em class="summary">Exception: These are generally problems with the client-provided
85+
data.</em>
86+
<ul>
87+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html">fedex.services.package_movement.FedexInvalidPostalCodeFormat</a></strong>:
88+
<em class="summary">Exception: Sent when the postal code is invalid</em>
89+
</li>
90+
<li> <strong class="uidlink"><a href="fedex.services.track_service.FedexInvalidTrackingNumber-class.html">fedex.services.track_service.FedexInvalidTrackingNumber</a></strong>:
91+
<em class="summary">Exception: Sent when a bad tracking number is provided.</em>
92+
</li>
93+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.FedexPostalCodeNotFound-class.html">fedex.services.package_movement.FedexPostalCodeNotFound</a></strong>:
94+
<em class="summary">Exception: Sent when the postalcode is missing.</em>
95+
</li>
96+
</ul>
97+
</li>
98+
<li> <strong class="uidlink"><a href="fedex.base_service.FedexFailure-class.html">fedex.base_service.FedexFailure</a></strong>:
99+
<em class="summary">Exception: The request could not be handled at this time.</em>
100+
</li>
101+
<li> <strong class="uidlink"><a href="fedex.base_service.SchemaValidationError-class.html">fedex.base_service.SchemaValidationError</a></strong>:
102+
<em class="summary">Exception: There is probably a problem in the data you provided.</em>
103+
</li>
104+
</ul>
105+
</li>
106+
</ul>
107+
</li>
108+
</ul>
109+
</li>
110+
<li> <strong class="uidlink"><a href="fedex.printers.unix.DirectDevicePrinter-class.html">fedex.printers.unix.DirectDevicePrinter</a></strong>:
111+
<em class="summary">This class pipes the label data directly through a /dev/* entry.</em>
112+
</li>
113+
<li> <strong class="uidlink"><a href="fedex.base_service.FedexBaseService-class.html">fedex.base_service.FedexBaseService</a></strong>:
114+
<em class="summary">This class is the master class for all Fedex request objects.</em>
115+
<ul>
116+
<li> <strong class="uidlink"><a href="fedex.services.address_validation_service.FedexAddressValidationRequest-class.html">fedex.services.address_validation_service.FedexAddressValidationRequest</a></strong>:
117+
<em class="summary">This class allows you validate anywhere from one to a hundred
118+
addresses in one go.</em>
119+
</li>
120+
<li> <strong class="uidlink"><a href="fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html">fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest</a></strong>:
121+
<em class="summary">This class allows you validate service availability</em>
122+
</li>
123+
<li> <strong class="uidlink"><a href="fedex.services.ship_service.FedexDeleteShipmentRequest-class.html">fedex.services.ship_service.FedexDeleteShipmentRequest</a></strong>:
124+
<em class="summary">This class allows you to delete a shipment, given a tracking
125+
number.</em>
126+
</li>
127+
<li> <strong class="uidlink"><a href="fedex.services.ship_service.FedexProcessShipmentRequest-class.html">fedex.services.ship_service.FedexProcessShipmentRequest</a></strong>:
128+
<em class="summary">This class allows you to process (create) a new FedEx shipment.</em>
129+
</li>
130+
<li> <strong class="uidlink"><a href="fedex.services.rate_service.FedexRateServiceRequest-class.html">fedex.services.rate_service.FedexRateServiceRequest</a></strong>:
131+
<em class="summary">This class allows you to get the shipping charges for a particular
132+
address.</em>
133+
</li>
134+
<li> <strong class="uidlink"><a href="fedex.services.track_service.FedexTrackRequest-class.html">fedex.services.track_service.FedexTrackRequest</a></strong>:
135+
<em class="summary">This class allows you to track shipments by providing a tracking
136+
number or other identifying features.</em>
137+
</li>
138+
<li> <strong class="uidlink"><a href="fedex.services.country_service.FedexValidatePostalRequest-class.html">fedex.services.country_service.FedexValidatePostalRequest</a></strong>:
139+
<em class="summary">This class allows you validate an address.</em>
140+
</li>
141+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.PostalCodeInquiryRequest-class.html">fedex.services.package_movement.PostalCodeInquiryRequest</a></strong>:
142+
<em class="summary">The postal code inquiry enables customers to validate postal codes
143+
and service commitments.</em>
144+
</li>
145+
</ul>
146+
</li>
147+
<li> <strong class="uidlink"><a href="fedex.config.FedexConfig-class.html">fedex.config.FedexConfig</a></strong>:
148+
<em class="summary">Base configuration class that is used for the different Fedex SOAP
149+
calls.</em>
150+
</li>
151+
</ul>
152+
</li>
153+
</ul>
154+
<!-- ==================== NAVIGATION BAR ==================== -->
155+
<table class="navbar" border="0" width="100%" cellpadding="0"
156+
bgcolor="#a0c0ff" cellspacing="0">
157+
<tr valign="middle">
158+
<!-- Home link -->
159+
<th>&nbsp;&nbsp;&nbsp;<a
160+
href="fedex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
161+
162+
<!-- Tree link -->
163+
<th bgcolor="#70b0f0" class="navbar-select"
164+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
165+
166+
<!-- Index link -->
167+
<th>&nbsp;&nbsp;&nbsp;<a
168+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
169+
170+
<!-- Help link -->
171+
<th>&nbsp;&nbsp;&nbsp;<a
172+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
173+
174+
<th class="navbar" width="100%"></th>
175+
</tr>
176+
</table>
177+
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
178+
<tr>
179+
<td align="left" class="footer">
180+
Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016
181+
</td>
182+
<td align="right" class="footer">
183+
<a target="mainFrame" href="http://epydoc.sourceforge.net"
184+
>http://epydoc.sourceforge.net</a>
185+
</td>
186+
</tr>
187+
</table>
188+
189+
<script type="text/javascript">
190+
<!--
191+
// Private objects are initially displayed (because if
192+
// javascript is turned off then we want them to be
193+
// visible); but by default, we want to hide them. So hide
194+
// them unless we have a cookie that says to show them.
195+
checkCookie();
196+
// -->
197+
</script>
198+
</body>
199+
</html>

Diff for: docs/2.2.0/crarr.png

340 Bytes
Loading

0 commit comments

Comments
 (0)