Skip to content

Commit 39ea616

Browse files
author
Greg Taylor
committed
Some documentation tweaks and improvements across the board, and in the new services contributed by yathib. This will become 1.0.6.
1 parent aa7917b commit 39ea616

File tree

76 files changed

+2589
-2261
lines changed

Some content is hidden

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

76 files changed

+2589
-2261
lines changed

docs/api-objects.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ fedex.services fedex.services-module.html
1313
fedex.services.__package__ fedex.services-module.html#__package__
1414
fedex.services.address_validation_service fedex.services.address_validation_service-module.html
1515
fedex.services.address_validation_service.__package__ fedex.services.address_validation_service-module.html#__package__
16+
fedex.services.package_movement fedex.services.package_movement-module.html
17+
fedex.services.package_movement.__package__ fedex.services.package_movement-module.html#__package__
18+
fedex.services.rate_service fedex.services.rate_service-module.html
19+
fedex.services.rate_service.__package__ fedex.services.rate_service-module.html#__package__
1620
fedex.services.ship_service fedex.services.ship_service-module.html
1721
fedex.services.ship_service.__package__ fedex.services.ship_service-module.html#__package__
1822
fedex.services.track_service fedex.services.track_service-module.html
@@ -37,16 +41,20 @@ fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseServic
3741
fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
3842
fedex.base_service.FedexBaseServiceException fedex.base_service.FedexBaseServiceException-class.html
3943
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
44+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
4045
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
4146
fedex.base_service.FedexError fedex.base_service.FedexError-class.html
4247
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
48+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
4349
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
4450
fedex.base_service.FedexFailure fedex.base_service.FedexFailure-class.html
4551
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
52+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
4653
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
4754
fedex.base_service.SchemaValidationError fedex.base_service.SchemaValidationError-class.html
4855
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
4956
fedex.base_service.SchemaValidationError.__init__ fedex.base_service.SchemaValidationError-class.html#__init__
57+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
5058
fedex.config.FedexConfig fedex.config.FedexConfig-class.html
5159
fedex.config.FedexConfig.meter_number fedex.config.FedexConfig-class.html#meter_number
5260
fedex.config.FedexConfig.integrator_id fedex.config.FedexConfig-class.html#integrator_id
@@ -78,6 +86,44 @@ fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_servic
7886
fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
7987
fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
8088
fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
89+
fedex.services.package_movement.FedexInvalidPostalCodeFormat fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html
90+
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
91+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
92+
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
93+
fedex.services.package_movement.FedexPostalCodeNotFound fedex.services.package_movement.FedexPostalCodeNotFound-class.html
94+
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
95+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
96+
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
97+
fedex.services.package_movement.PostalCodeInquiryRequest fedex.services.package_movement.PostalCodeInquiryRequest-class.html
98+
fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
99+
fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
100+
fedex.services.package_movement.PostalCodeInquiryRequest._prepare_wsdl_objects fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_prepare_wsdl_objects
101+
fedex.services.package_movement.PostalCodeInquiryRequest.__init__ fedex.services.package_movement.PostalCodeInquiryRequest-class.html#__init__
102+
fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
103+
fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
104+
fedex.services.package_movement.PostalCodeInquiryRequest._assemble_and_send_request fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_assemble_and_send_request
105+
fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
106+
fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
107+
fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
108+
fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
109+
fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
110+
fedex.services.package_movement.PostalCodeInquiryRequest._check_response_for_request_errors fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_check_response_for_request_errors
111+
fedex.services.rate_service.FedexRateServiceRequest fedex.services.rate_service.FedexRateServiceRequest-class.html
112+
fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
113+
fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
114+
fedex.services.rate_service.FedexRateServiceRequest._prepare_wsdl_objects fedex.services.rate_service.FedexRateServiceRequest-class.html#_prepare_wsdl_objects
115+
fedex.services.rate_service.FedexRateServiceRequest.__init__ fedex.services.rate_service.FedexRateServiceRequest-class.html#__init__
116+
fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
117+
fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
118+
fedex.services.rate_service.FedexRateServiceRequest._assemble_and_send_request fedex.services.rate_service.FedexRateServiceRequest-class.html#_assemble_and_send_request
119+
fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
120+
fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
121+
fedex.services.rate_service.FedexRateServiceRequest.RequestedShipment fedex.services.rate_service.FedexRateServiceRequest-class.html#RequestedShipment
122+
fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
123+
fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
124+
fedex.services.rate_service.FedexRateServiceRequest.add_package fedex.services.rate_service.FedexRateServiceRequest-class.html#add_package
125+
fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
126+
fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
81127
fedex.services.ship_service.FedexDeleteShipmentRequest fedex.services.ship_service.FedexDeleteShipmentRequest-class.html
82128
fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
83129
fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
@@ -114,6 +160,7 @@ fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseServic
114160
fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
115161
fedex.services.track_service.FedexInvalidTrackingNumber fedex.services.track_service.FedexInvalidTrackingNumber-class.html
116162
fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
163+
fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
117164
fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
118165
fedex.services.track_service.FedexTrackRequest fedex.services.track_service.FedexTrackRequest-class.html
119166
fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail

docs/class-tree.html

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,22 +70,29 @@ <h1 class="epydoc">Class Hierarchy</h1>
7070
<em class="summary">Common base class for all non-exit exceptions.</em>
7171
<ul>
7272
<li> <strong class="uidlink"><a href="fedex.base_service.FedexBaseServiceException-class.html">fedex.base_service.FedexBaseServiceException</a></strong>:
73-
<em class="summary">Serves as the base exception that other service-related exception
74-
objects are sub-classed from.</em>
73+
<em class="summary">Exception: Serves as the base exception that other service-related
74+
exception objects are sub-classed from.</em>
7575
<ul>
7676
<li> <strong class="uidlink"><a href="fedex.base_service.FedexError-class.html">fedex.base_service.FedexError</a></strong>:
77-
<em class="summary">These are generally problems with the client-provided data.</em>
77+
<em class="summary">Exception: These are generally problems with the client-provided
78+
data.</em>
7879
<ul>
80+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html">fedex.services.package_movement.FedexInvalidPostalCodeFormat</a></strong>:
81+
<em class="summary">Exception: Sent when the postal code is invalid</em>
82+
</li>
7983
<li> <strong class="uidlink"><a href="fedex.services.track_service.FedexInvalidTrackingNumber-class.html">fedex.services.track_service.FedexInvalidTrackingNumber</a></strong>:
80-
<em class="summary">Sent when a bad tracking number is provided.</em>
84+
<em class="summary">Exception: Sent when a bad tracking number is provided.</em>
85+
</li>
86+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.FedexPostalCodeNotFound-class.html">fedex.services.package_movement.FedexPostalCodeNotFound</a></strong>:
87+
<em class="summary">Exception: Sent when the postalcode is missing.</em>
8188
</li>
8289
</ul>
8390
</li>
8491
<li> <strong class="uidlink"><a href="fedex.base_service.FedexFailure-class.html">fedex.base_service.FedexFailure</a></strong>:
85-
<em class="summary">The request could not be handled at this time.</em>
92+
<em class="summary">Exception: The request could not be handled at this time.</em>
8693
</li>
8794
<li> <strong class="uidlink"><a href="fedex.base_service.SchemaValidationError-class.html">fedex.base_service.SchemaValidationError</a></strong>:
88-
<em class="summary">There is probably a problem in the data you provided.</em>
95+
<em class="summary">Exception: There is probably a problem in the data you provided.</em>
8996
</li>
9097
</ul>
9198
</li>
@@ -110,10 +117,18 @@ <h1 class="epydoc">Class Hierarchy</h1>
110117
<li> <strong class="uidlink"><a href="fedex.services.ship_service.FedexProcessShipmentRequest-class.html">fedex.services.ship_service.FedexProcessShipmentRequest</a></strong>:
111118
<em class="summary">This class allows you to process (create) a new FedEx shipment.</em>
112119
</li>
120+
<li> <strong class="uidlink"><a href="fedex.services.rate_service.FedexRateServiceRequest-class.html">fedex.services.rate_service.FedexRateServiceRequest</a></strong>:
121+
<em class="summary">This class allows you to get the shipping charges for a particular
122+
address.</em>
123+
</li>
113124
<li> <strong class="uidlink"><a href="fedex.services.track_service.FedexTrackRequest-class.html">fedex.services.track_service.FedexTrackRequest</a></strong>:
114125
<em class="summary">This class allows you to track shipments by providing a tracking
115126
number or other identifying features.</em>
116127
</li>
128+
<li> <strong class="uidlink"><a href="fedex.services.package_movement.PostalCodeInquiryRequest-class.html">fedex.services.package_movement.PostalCodeInquiryRequest</a></strong>:
129+
<em class="summary">The postal code inquiry enables customers to validate postal codes
130+
and service commitments.</em>
131+
</li>
117132
</ul>
118133
</li>
119134
<li> <strong class="uidlink"><a href="fedex.config.FedexConfig-class.html">fedex.config.FedexConfig</a></strong>:
@@ -154,7 +169,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
154169
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
155170
<tr>
156171
<td align="left" class="footer">
157-
Generated by Epydoc 3.0.1 on Thu Mar 25 14:56:28 2010
172+
Generated by Epydoc 3.0.1 on Wed Mar 31 09:46:46 2010
158173
</td>
159174
<td align="right" class="footer">
160175
<a target="mainFrame" href="http://epydoc.sourceforge.net"

docs/fedex-module.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ <h2 class="heading">Getting Support</h2>
164164
<ul>
165165
<li> <strong class="uidlink"><a href="fedex.services.address_validation_service-module.html">fedex.services.address_validation_service</a></strong>: <em class="summary">This package contains the shipping methods defined by Fedex's
166166
AddressValidationService WSDL file.</em> </li>
167+
<li> <strong class="uidlink"><a href="fedex.services.package_movement-module.html">fedex.services.package_movement</a></strong>: <em class="summary">This package contains classes to check service availability, route,
168+
and postal codes.</em> </li>
169+
<li> <strong class="uidlink"><a href="fedex.services.rate_service-module.html">fedex.services.rate_service</a></strong>: <em class="summary">This package contains classes to request pre-ship rating
170+
information and to determine estimated or courtesy billing quotes.</em> </li>
167171
<li> <strong class="uidlink"><a href="fedex.services.ship_service-module.html">fedex.services.ship_service</a></strong>: <em class="summary">This package contains the shipping methods defined by Fedex's
168172
ShipService WSDL file.</em> </li>
169173
<li> <strong class="uidlink"><a href="fedex.services.track_service-module.html">fedex.services.track_service</a></strong>: <em class="summary">This package contains the shipment tracking methods defined by
@@ -237,7 +241,7 @@ <h2 class="heading">Getting Support</h2>
237241
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
238242
<tr>
239243
<td align="left" class="footer">
240-
Generated by Epydoc 3.0.1 on Thu Mar 25 14:56:28 2010
244+
Generated by Epydoc 3.0.1 on Wed Mar 31 09:46:46 2010
241245
</td>
242246
<td align="right" class="footer">
243247
<a target="mainFrame" href="http://epydoc.sourceforge.net"

docs/fedex-pysrc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h1 class="epydoc">Source Code for <a href="fedex-module.html">Package fedex</a>
153153
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
154154
<tr>
155155
<td align="left" class="footer">
156-
Generated by Epydoc 3.0.1 on Thu Mar 25 14:56:29 2010
156+
Generated by Epydoc 3.0.1 on Wed Mar 31 09:46:47 2010
157157
</td>
158158
<td align="right" class="footer">
159159
<a target="mainFrame" href="http://epydoc.sourceforge.net"

docs/fedex.base_service-module.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,32 +92,33 @@ <h1 class="epydoc">Module base_service</h1><p class="nomargin-top"><span class="
9292
<span class="summary-type">&nbsp;</span>
9393
</td><td class="summary">
9494
<a href="fedex.base_service.FedexBaseServiceException-class.html" class="summary-name">FedexBaseServiceException</a><br />
95-
Serves as the base exception that other service-related exception
96-
objects are sub-classed from.
95+
Exception: Serves as the base exception that other service-related
96+
exception objects are sub-classed from.
9797
</td>
9898
</tr>
9999
<tr>
100100
<td width="15%" align="right" valign="top" class="summary">
101101
<span class="summary-type">&nbsp;</span>
102102
</td><td class="summary">
103103
<a href="fedex.base_service.FedexFailure-class.html" class="summary-name">FedexFailure</a><br />
104-
The request could not be handled at this time.
104+
Exception: The request could not be handled at this time.
105105
</td>
106106
</tr>
107107
<tr>
108108
<td width="15%" align="right" valign="top" class="summary">
109109
<span class="summary-type">&nbsp;</span>
110110
</td><td class="summary">
111111
<a href="fedex.base_service.FedexError-class.html" class="summary-name">FedexError</a><br />
112-
These are generally problems with the client-provided data.
112+
Exception: These are generally problems with the client-provided
113+
data.
113114
</td>
114115
</tr>
115116
<tr>
116117
<td width="15%" align="right" valign="top" class="summary">
117118
<span class="summary-type">&nbsp;</span>
118119
</td><td class="summary">
119120
<a href="fedex.base_service.SchemaValidationError-class.html" class="summary-name">SchemaValidationError</a><br />
120-
There is probably a problem in the data you provided.
121+
Exception: There is probably a problem in the data you provided.
121122
</td>
122123
</tr>
123124
<tr>
@@ -185,7 +186,7 @@ <h1 class="epydoc">Module base_service</h1><p class="nomargin-top"><span class="
185186
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
186187
<tr>
187188
<td align="left" class="footer">
188-
Generated by Epydoc 3.0.1 on Thu Mar 25 14:56:28 2010
189+
Generated by Epydoc 3.0.1 on Wed Mar 31 09:46:46 2010
189190
</td>
190191
<td align="right" class="footer">
191192
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)