From 59cd09a4a8eb2ee2bfc9fc4c339e14fb2ed54b42 Mon Sep 17 00:00:00 2001 From: radzhome Date: Fri, 15 Jan 2016 22:51:24 -0500 Subject: [PATCH] generate updated documentation using epydoc --- docs/2.2.0/api-objects.txt | 230 ++++++ docs/2.2.0/class-tree.html | 199 ++++++ docs/2.2.0/crarr.png | Bin 0 -> 340 bytes docs/2.2.0/epydoc.css | 322 +++++++++ docs/2.2.0/epydoc.js | 293 ++++++++ docs/2.2.0/fedex-module.html | 255 +++++++ docs/2.2.0/fedex-pysrc.html | 165 +++++ docs/2.2.0/fedex.base_service-module.html | 205 ++++++ docs/2.2.0/fedex.base_service-pysrc.html | 430 ++++++++++++ ...x.base_service.FedexBaseService-class.html | 660 ++++++++++++++++++ ...rvice.FedexBaseServiceException-class.html | 339 +++++++++ .../fedex.base_service.FedexError-class.html | 203 ++++++ ...fedex.base_service.FedexFailure-class.html | 197 ++++++ ....base_service.GeneralSudsPlugin-class.html | 319 +++++++++ ...e_service.SchemaValidationError-class.html | 257 +++++++ docs/2.2.0/fedex.config-module.html | 168 +++++ docs/2.2.0/fedex.config-pysrc.html | 185 +++++ .../2.2.0/fedex.config.FedexConfig-class.html | 361 ++++++++++ docs/2.2.0/fedex.printers-module.html | 168 +++++ docs/2.2.0/fedex.printers-pysrc.html | 121 ++++ docs/2.2.0/fedex.printers.unix-module.html | 160 +++++ docs/2.2.0/fedex.printers.unix-pysrc.html | 175 +++++ ...inters.unix.DirectDevicePrinter-class.html | 372 ++++++++++ docs/2.2.0/fedex.services-module.html | 165 +++++ docs/2.2.0/fedex.services-pysrc.html | 116 +++ ...ces.address_validation_service-module.html | 163 +++++ ...ices.address_validation_service-pysrc.html | 209 ++++++ ...e.FedexAddressValidationRequest-class.html | 425 +++++++++++ ...vailability_commitment_service-module.html | 162 +++++ ...availability_commitment_service-pysrc.html | 225 ++++++ ...exAvailabilityCommitmentRequest-class.html | 420 +++++++++++ ...fedex.services.country_service-module.html | 162 +++++ .../fedex.services.country_service-pysrc.html | 213 ++++++ ...vice.FedexValidatePostalRequest-class.html | 411 +++++++++++ ...edex.services.package_movement-module.html | 178 +++++ ...fedex.services.package_movement-pysrc.html | 229 ++++++ ...nt.FedexInvalidPostalCodeFormat-class.html | 199 ++++++ ...ovement.FedexPostalCodeNotFound-class.html | 199 ++++++ ...vement.PostalCodeInquiryRequest-class.html | 415 +++++++++++ .../fedex.services.rate_service-module.html | 162 +++++ .../fedex.services.rate_service-pysrc.html | 250 +++++++ ...service.FedexRateServiceRequest-class.html | 429 ++++++++++++ .../fedex.services.ship_service-module.html | 171 +++++ .../fedex.services.ship_service-pysrc.html | 355 ++++++++++ ...vice.FedexDeleteShipmentRequest-class.html | 386 ++++++++++ ...ice.FedexProcessShipmentRequest-class.html | 509 ++++++++++++++ .../fedex.services.track_service-module.html | 171 +++++ .../fedex.services.track_service-pysrc.html | 233 +++++++ ...vice.FedexInvalidTrackingNumber-class.html | 199 ++++++ ...track_service.FedexTrackRequest-class.html | 434 ++++++++++++ docs/2.2.0/frames.html | 17 + docs/2.2.0/help.html | 268 +++++++ docs/2.2.0/identifier-index.html | 511 ++++++++++++++ docs/2.2.0/index.html | 17 + docs/2.2.0/module-tree.html | 139 ++++ docs/2.2.0/redirect.html | 38 + docs/2.2.0/toc-everything.html | 64 ++ docs/2.2.0/toc-fedex-module.html | 32 + docs/2.2.0/toc-fedex.base_service-module.html | 38 + docs/2.2.0/toc-fedex.config-module.html | 33 + docs/2.2.0/toc-fedex.printers-module.html | 31 + .../2.2.0/toc-fedex.printers.unix-module.html | 33 + docs/2.2.0/toc-fedex.services-module.html | 31 + ...ces.address_validation_service-module.html | 33 + ...vailability_commitment_service-module.html | 33 + ...fedex.services.country_service-module.html | 33 + ...edex.services.package_movement-module.html | 35 + ...oc-fedex.services.rate_service-module.html | 33 + ...oc-fedex.services.ship_service-module.html | 34 + ...c-fedex.services.track_service-module.html | 34 + docs/2.2.0/toc.html | 45 ++ 71 files changed, 14506 insertions(+) create mode 100644 docs/2.2.0/api-objects.txt create mode 100644 docs/2.2.0/class-tree.html create mode 100644 docs/2.2.0/crarr.png create mode 100644 docs/2.2.0/epydoc.css create mode 100644 docs/2.2.0/epydoc.js create mode 100644 docs/2.2.0/fedex-module.html create mode 100644 docs/2.2.0/fedex-pysrc.html create mode 100644 docs/2.2.0/fedex.base_service-module.html create mode 100644 docs/2.2.0/fedex.base_service-pysrc.html create mode 100644 docs/2.2.0/fedex.base_service.FedexBaseService-class.html create mode 100644 docs/2.2.0/fedex.base_service.FedexBaseServiceException-class.html create mode 100644 docs/2.2.0/fedex.base_service.FedexError-class.html create mode 100644 docs/2.2.0/fedex.base_service.FedexFailure-class.html create mode 100644 docs/2.2.0/fedex.base_service.GeneralSudsPlugin-class.html create mode 100644 docs/2.2.0/fedex.base_service.SchemaValidationError-class.html create mode 100644 docs/2.2.0/fedex.config-module.html create mode 100644 docs/2.2.0/fedex.config-pysrc.html create mode 100644 docs/2.2.0/fedex.config.FedexConfig-class.html create mode 100644 docs/2.2.0/fedex.printers-module.html create mode 100644 docs/2.2.0/fedex.printers-pysrc.html create mode 100644 docs/2.2.0/fedex.printers.unix-module.html create mode 100644 docs/2.2.0/fedex.printers.unix-pysrc.html create mode 100644 docs/2.2.0/fedex.printers.unix.DirectDevicePrinter-class.html create mode 100644 docs/2.2.0/fedex.services-module.html create mode 100644 docs/2.2.0/fedex.services-pysrc.html create mode 100644 docs/2.2.0/fedex.services.address_validation_service-module.html create mode 100644 docs/2.2.0/fedex.services.address_validation_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html create mode 100644 docs/2.2.0/fedex.services.availability_commitment_service-module.html create mode 100644 docs/2.2.0/fedex.services.availability_commitment_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html create mode 100644 docs/2.2.0/fedex.services.country_service-module.html create mode 100644 docs/2.2.0/fedex.services.country_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.country_service.FedexValidatePostalRequest-class.html create mode 100644 docs/2.2.0/fedex.services.package_movement-module.html create mode 100644 docs/2.2.0/fedex.services.package_movement-pysrc.html create mode 100644 docs/2.2.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html create mode 100644 docs/2.2.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html create mode 100644 docs/2.2.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html create mode 100644 docs/2.2.0/fedex.services.rate_service-module.html create mode 100644 docs/2.2.0/fedex.services.rate_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.rate_service.FedexRateServiceRequest-class.html create mode 100644 docs/2.2.0/fedex.services.ship_service-module.html create mode 100644 docs/2.2.0/fedex.services.ship_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html create mode 100644 docs/2.2.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html create mode 100644 docs/2.2.0/fedex.services.track_service-module.html create mode 100644 docs/2.2.0/fedex.services.track_service-pysrc.html create mode 100644 docs/2.2.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html create mode 100644 docs/2.2.0/fedex.services.track_service.FedexTrackRequest-class.html create mode 100644 docs/2.2.0/frames.html create mode 100644 docs/2.2.0/help.html create mode 100644 docs/2.2.0/identifier-index.html create mode 100644 docs/2.2.0/index.html create mode 100644 docs/2.2.0/module-tree.html create mode 100644 docs/2.2.0/redirect.html create mode 100644 docs/2.2.0/toc-everything.html create mode 100644 docs/2.2.0/toc-fedex-module.html create mode 100644 docs/2.2.0/toc-fedex.base_service-module.html create mode 100644 docs/2.2.0/toc-fedex.config-module.html create mode 100644 docs/2.2.0/toc-fedex.printers-module.html create mode 100644 docs/2.2.0/toc-fedex.printers.unix-module.html create mode 100644 docs/2.2.0/toc-fedex.services-module.html create mode 100644 docs/2.2.0/toc-fedex.services.address_validation_service-module.html create mode 100644 docs/2.2.0/toc-fedex.services.availability_commitment_service-module.html create mode 100644 docs/2.2.0/toc-fedex.services.country_service-module.html create mode 100644 docs/2.2.0/toc-fedex.services.package_movement-module.html create mode 100644 docs/2.2.0/toc-fedex.services.rate_service-module.html create mode 100644 docs/2.2.0/toc-fedex.services.ship_service-module.html create mode 100644 docs/2.2.0/toc-fedex.services.track_service-module.html create mode 100644 docs/2.2.0/toc.html diff --git a/docs/2.2.0/api-objects.txt b/docs/2.2.0/api-objects.txt new file mode 100644 index 0000000..481e5c8 --- /dev/null +++ b/docs/2.2.0/api-objects.txt @@ -0,0 +1,230 @@ +fedex fedex-module.html +fedex.VERSION fedex-module.html#VERSION +fedex.__package__ fedex-module.html#__package__ +fedex.base_service fedex.base_service-module.html +fedex.base_service.__package__ fedex.base_service-module.html#__package__ +fedex.config fedex.config-module.html +fedex.config.__package__ fedex.config-module.html#__package__ +fedex.printers fedex.printers-module.html +fedex.printers.__package__ fedex.printers-module.html#__package__ +fedex.printers.unix fedex.printers.unix-module.html +fedex.printers.unix.__package__ fedex.printers.unix-module.html#__package__ +fedex.services fedex.services-module.html +fedex.services.__package__ fedex.services-module.html#__package__ +fedex.services.address_validation_service fedex.services.address_validation_service-module.html +fedex.services.address_validation_service.__package__ fedex.services.address_validation_service-module.html#__package__ +fedex.services.availability_commitment_service fedex.services.availability_commitment_service-module.html +fedex.services.availability_commitment_service.__package__ fedex.services.availability_commitment_service-module.html#__package__ +fedex.services.country_service fedex.services.country_service-module.html +fedex.services.country_service.__package__ fedex.services.country_service-module.html#__package__ +fedex.services.package_movement fedex.services.package_movement-module.html +fedex.services.package_movement.__package__ fedex.services.package_movement-module.html#__package__ +fedex.services.rate_service fedex.services.rate_service-module.html +fedex.services.rate_service.__package__ fedex.services.rate_service-module.html#__package__ +fedex.services.ship_service fedex.services.ship_service-module.html +fedex.services.ship_service.__package__ fedex.services.ship_service-module.html#__package__ +fedex.services.track_service fedex.services.track_service-module.html +fedex.services.track_service.__package__ fedex.services.track_service-module.html#__package__ +fedex.base_service.FedexBaseService fedex.base_service.FedexBaseService-class.html +fedex.base_service.FedexBaseService.__check_response_for_fedex_error fedex.base_service.FedexBaseService-class.html#__check_response_for_fedex_error +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService.__set_web_authentication_detail fedex.base_service.FedexBaseService-class.html#__set_web_authentication_detail +fedex.base_service.FedexBaseService._prepare_wsdl_objects fedex.base_service.FedexBaseService-class.html#_prepare_wsdl_objects +fedex.base_service.FedexBaseService.__init__ fedex.base_service.FedexBaseService-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.base_service.FedexBaseService._assemble_and_send_request fedex.base_service.FedexBaseService-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.base_service.FedexBaseService.__set_client_detail fedex.base_service.FedexBaseService-class.html#__set_client_detail +fedex.base_service.FedexBaseService.__set_version_id fedex.base_service.FedexBaseService-class.html#__set_version_id +fedex.base_service.FedexBaseService.__set_transaction_detail fedex.base_service.FedexBaseService-class.html#__set_transaction_detail +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.base_service.FedexBaseServiceException fedex.base_service.FedexBaseServiceException-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.base_service.FedexError fedex.base_service.FedexError-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.base_service.FedexFailure fedex.base_service.FedexFailure-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.base_service.GeneralSudsPlugin fedex.base_service.GeneralSudsPlugin-class.html +fedex.base_service.GeneralSudsPlugin.sending fedex.base_service.GeneralSudsPlugin-class.html#sending +fedex.base_service.GeneralSudsPlugin.marshalled fedex.base_service.GeneralSudsPlugin-class.html#marshalled +fedex.base_service.GeneralSudsPlugin.received fedex.base_service.GeneralSudsPlugin-class.html#received +fedex.base_service.GeneralSudsPlugin.__init__ fedex.base_service.GeneralSudsPlugin-class.html#__init__ +fedex.base_service.SchemaValidationError fedex.base_service.SchemaValidationError-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.SchemaValidationError.__init__ fedex.base_service.SchemaValidationError-class.html#__init__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.config.FedexConfig fedex.config.FedexConfig-class.html +fedex.config.FedexConfig.use_test_server fedex.config.FedexConfig-class.html#use_test_server +fedex.config.FedexConfig.express_region_code fedex.config.FedexConfig-class.html#express_region_code +fedex.config.FedexConfig.__init__ fedex.config.FedexConfig-class.html#__init__ +fedex.config.FedexConfig.integrator_id fedex.config.FedexConfig-class.html#integrator_id +fedex.config.FedexConfig.meter_number fedex.config.FedexConfig-class.html#meter_number +fedex.config.FedexConfig.key fedex.config.FedexConfig-class.html#key +fedex.config.FedexConfig.freight_account_number fedex.config.FedexConfig-class.html#freight_account_number +fedex.config.FedexConfig.password fedex.config.FedexConfig-class.html#password +fedex.config.FedexConfig.account_number fedex.config.FedexConfig-class.html#account_number +fedex.printers.unix.DirectDevicePrinter fedex.printers.unix.DirectDevicePrinter-class.html +fedex.printers.unix.DirectDevicePrinter.print_label fedex.printers.unix.DirectDevicePrinter-class.html#print_label +fedex.printers.unix.DirectDevicePrinter.shipment fedex.printers.unix.DirectDevicePrinter-class.html#shipment +fedex.printers.unix.DirectDevicePrinter.device fedex.printers.unix.DirectDevicePrinter-class.html#device +fedex.printers.unix.DirectDevicePrinter._print_base64 fedex.printers.unix.DirectDevicePrinter-class.html#_print_base64 +fedex.printers.unix.DirectDevicePrinter.__init__ fedex.printers.unix.DirectDevicePrinter-class.html#__init__ +fedex.services.address_validation_service.FedexAddressValidationRequest fedex.services.address_validation_service.FedexAddressValidationRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.address_validation_service.FedexAddressValidationRequest._prepare_wsdl_objects fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_prepare_wsdl_objects +fedex.services.address_validation_service.FedexAddressValidationRequest.__init__ fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.address_validation_service.FedexAddressValidationRequest._assemble_and_send_request fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_assemble_and_send_request +fedex.services.address_validation_service.FedexAddressValidationRequest.AddressesToValidate fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#AddressesToValidate +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.services.address_validation_service.FedexAddressValidationRequest.add_address fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#add_address +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Service fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Service +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Destination fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Destination +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.CarrierCode fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#CarrierCode +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._prepare_wsdl_objects fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_prepare_wsdl_objects +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.__init__ fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#__init__ +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._assemble_and_send_request fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.ShipDate fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#ShipDate +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Origin fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Origin +fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Packaging fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Packaging +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.country_service.FedexValidatePostalRequest fedex.services.country_service.FedexValidatePostalRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.country_service.FedexValidatePostalRequest.CarrierCode fedex.services.country_service.FedexValidatePostalRequest-class.html#CarrierCode +fedex.services.country_service.FedexValidatePostalRequest._prepare_wsdl_objects fedex.services.country_service.FedexValidatePostalRequest-class.html#_prepare_wsdl_objects +fedex.services.country_service.FedexValidatePostalRequest.__init__ fedex.services.country_service.FedexValidatePostalRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.country_service.FedexValidatePostalRequest._assemble_and_send_request fedex.services.country_service.FedexValidatePostalRequest-class.html#_assemble_and_send_request +fedex.services.country_service.FedexValidatePostalRequest.RoutingCode fedex.services.country_service.FedexValidatePostalRequest-class.html#RoutingCode +fedex.services.country_service.FedexValidatePostalRequest.ShipDateTime fedex.services.country_service.FedexValidatePostalRequest-class.html#ShipDateTime +fedex.services.country_service.FedexValidatePostalRequest.Address fedex.services.country_service.FedexValidatePostalRequest-class.html#Address +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.services.country_service.FedexValidatePostalRequest.CheckForMismatch fedex.services.country_service.FedexValidatePostalRequest-class.html#CheckForMismatch +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.package_movement.FedexInvalidPostalCodeFormat fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.services.package_movement.FedexPostalCodeNotFound fedex.services.package_movement.FedexPostalCodeNotFound-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.services.package_movement.PostalCodeInquiryRequest fedex.services.package_movement.PostalCodeInquiryRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.package_movement.PostalCodeInquiryRequest._prepare_wsdl_objects fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_prepare_wsdl_objects +fedex.services.package_movement.PostalCodeInquiryRequest.__init__ fedex.services.package_movement.PostalCodeInquiryRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.package_movement.PostalCodeInquiryRequest._assemble_and_send_request fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.services.package_movement.PostalCodeInquiryRequest._check_response_for_request_errors fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_check_response_for_request_errors +fedex.services.rate_service.FedexRateServiceRequest fedex.services.rate_service.FedexRateServiceRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.rate_service.FedexRateServiceRequest._prepare_wsdl_objects fedex.services.rate_service.FedexRateServiceRequest-class.html#_prepare_wsdl_objects +fedex.services.rate_service.FedexRateServiceRequest.__init__ fedex.services.rate_service.FedexRateServiceRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.rate_service.FedexRateServiceRequest._assemble_and_send_request fedex.services.rate_service.FedexRateServiceRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.services.rate_service.FedexRateServiceRequest.RequestedShipment fedex.services.rate_service.FedexRateServiceRequest-class.html#RequestedShipment +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.services.rate_service.FedexRateServiceRequest.add_package fedex.services.rate_service.FedexRateServiceRequest-class.html#add_package +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.ship_service.FedexDeleteShipmentRequest fedex.services.ship_service.FedexDeleteShipmentRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.ship_service.FedexDeleteShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_prepare_wsdl_objects +fedex.services.ship_service.FedexDeleteShipmentRequest.__init__ fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.ship_service.FedexDeleteShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.services.ship_service.FedexDeleteShipmentRequest.DeletionControlType fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#DeletionControlType +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.services.ship_service.FedexDeleteShipmentRequest.TrackingId fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#TrackingId +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.ship_service.FedexProcessShipmentRequest fedex.services.ship_service.FedexProcessShipmentRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.ship_service.FedexProcessShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_prepare_wsdl_objects +fedex.services.ship_service.FedexProcessShipmentRequest.__init__ fedex.services.ship_service.FedexProcessShipmentRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.services.ship_service.FedexProcessShipmentRequest.send_validation_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#send_validation_request +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_validation_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_validation_request +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.services.ship_service.FedexProcessShipmentRequest.RequestedShipment fedex.services.ship_service.FedexProcessShipmentRequest-class.html#RequestedShipment +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.services.ship_service.FedexProcessShipmentRequest.add_package fedex.services.ship_service.FedexProcessShipmentRequest-class.html#add_package +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.track_service.FedexInvalidTrackingNumber fedex.services.track_service.FedexInvalidTrackingNumber-class.html +fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ +fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ +fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__ +fedex.services.track_service.FedexTrackRequest fedex.services.track_service.FedexTrackRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.services.track_service.FedexTrackRequest._prepare_wsdl_objects fedex.services.track_service.FedexTrackRequest-class.html#_prepare_wsdl_objects +fedex.services.track_service.FedexTrackRequest.__init__ fedex.services.track_service.FedexTrackRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.track_service.FedexTrackRequest._assemble_and_send_request fedex.services.track_service.FedexTrackRequest-class.html#_assemble_and_send_request +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.services.track_service.FedexTrackRequest.SelectionDetails fedex.services.track_service.FedexTrackRequest-class.html#SelectionDetails +fedex.services.track_service.FedexTrackRequest.ProcessingOptions fedex.services.track_service.FedexTrackRequest-class.html#ProcessingOptions +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.services.track_service.FedexTrackRequest._check_response_for_request_errors fedex.services.track_service.FedexTrackRequest-class.html#_check_response_for_request_errors diff --git a/docs/2.2.0/class-tree.html b/docs/2.2.0/class-tree.html new file mode 100644 index 0000000..eb3afb7 --- /dev/null +++ b/docs/2.2.0/class-tree.html @@ -0,0 +1,199 @@ + + + + + Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+
+ [ Module Hierarchy + | Class Hierarchy ] +

+

Class Hierarchy

+ + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/crarr.png b/docs/2.2.0/crarr.png new file mode 100644 index 0000000000000000000000000000000000000000..26b43c52433b71e72a9a478c52d446278335f0e4 GIT binary patch literal 340 zcmeAS@N?(olHy`uVBq!ia0vp^f?NMQuI$%1#8??M1uoZK z0}62#ctjR6FvuMOVaB`*rFK9;mUKs7M+SzC{oH>NS%G}l0G|-o|NsA=J-p%i`2!7U zCdJ_j4{u-SDsoA1U`TRixpVcz%O`iHHAYk?=&YaLkmD!Pp6~GW^M_S4D^grJKD>P~ zuPf!ku`N^TLavn`Edv_JSQ6wH%;50sMjDXg>*?YcQgJIe!GUqln>_|<+Os&OOUQS1 zY~Wzutud*iVS#|PHMc&?2WHoZpEo8l+6!Oc$x~=%U)469Gl^f?nq7UBw#1AXkrEde cmFKWBXcRFE*(?@T0vgQV>FVdQ&MBb@0LpZ4r2qf` literal 0 HcmV?d00001 diff --git a/docs/2.2.0/epydoc.css b/docs/2.2.0/epydoc.css new file mode 100644 index 0000000..86d4170 --- /dev/null +++ b/docs/2.2.0/epydoc.css @@ -0,0 +1,322 @@ + + +/* Epydoc CSS Stylesheet + * + * This stylesheet can be used to customize the appearance of epydoc's + * HTML output. + * + */ + +/* Default Colors & Styles + * - Set the default foreground & background color with 'body'; and + * link colors with 'a:link' and 'a:visited'. + * - Use bold for decision list terms. + * - The heading styles defined here are used for headings *within* + * docstring descriptions. All headings used by epydoc itself use + * either class='epydoc' or class='toc' (CSS styles for both + * defined below). + */ +body { background: #ffffff; color: #000000; } +p { margin-top: 0.5em; margin-bottom: 0.5em; } +a:link { color: #0000ff; } +a:visited { color: #204080; } +dt { font-weight: bold; } +h1 { font-size: +140%; font-style: italic; + font-weight: bold; } +h2 { font-size: +125%; font-style: italic; + font-weight: bold; } +h3 { font-size: +110%; font-style: italic; + font-weight: normal; } +code { font-size: 100%; } +/* N.B.: class, not pseudoclass */ +a.link { font-family: monospace; } + +/* Page Header & Footer + * - The standard page header consists of a navigation bar (with + * pointers to standard pages such as 'home' and 'trees'); a + * breadcrumbs list, which can be used to navigate to containing + * classes or modules; options links, to show/hide private + * variables and to show/hide frames; and a page title (using + *

). The page title may be followed by a link to the + * corresponding source code (using 'span.codelink'). + * - The footer consists of a navigation bar, a timestamp, and a + * pointer to epydoc's homepage. + */ +h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; } +h2.epydoc { font-size: +130%; font-weight: bold; } +h3.epydoc { font-size: +115%; font-weight: bold; + margin-top: 0.2em; } +td h3.epydoc { font-size: +115%; font-weight: bold; + margin-bottom: 0; } +table.navbar { background: #a0c0ff; color: #000000; + border: 2px groove #c0d0d0; } +table.navbar table { color: #000000; } +th.navbar-select { background: #70b0ff; + color: #000000; } +table.navbar a { text-decoration: none; } +table.navbar a:link { color: #0000ff; } +table.navbar a:visited { color: #204080; } +span.breadcrumbs { font-size: 85%; font-weight: bold; } +span.options { font-size: 70%; } +span.codelink { font-size: 85%; } +td.footer { font-size: 85%; } + +/* Table Headers + * - Each summary table and details section begins with a 'header' + * row. This row contains a section title (marked by + * 'span.table-header') as well as a show/hide private link + * (marked by 'span.options', defined above). + * - Summary tables that contain user-defined groups mark those + * groups using 'group header' rows. + */ +td.table-header { background: #70b0ff; color: #000000; + border: 1px solid #608090; } +td.table-header table { color: #000000; } +td.table-header table a:link { color: #0000ff; } +td.table-header table a:visited { color: #204080; } +span.table-header { font-size: 120%; font-weight: bold; } +th.group-header { background: #c0e0f8; color: #000000; + text-align: left; font-style: italic; + font-size: 115%; + border: 1px solid #608090; } + +/* Summary Tables (functions, variables, etc) + * - Each object is described by a single row of the table with + * two cells. The left cell gives the object's type, and is + * marked with 'code.summary-type'. The right cell gives the + * object's name and a summary description. + * - CSS styles for the table's header and group headers are + * defined above, under 'Table Headers' + */ +table.summary { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin-bottom: 0.5em; } +td.summary { border: 1px solid #608090; } +code.summary-type { font-size: 85%; } +table.summary a:link { color: #0000ff; } +table.summary a:visited { color: #204080; } + + +/* Details Tables (functions, variables, etc) + * - Each object is described in its own div. + * - A single-row summary table w/ table-header is used as + * a header for each details section (CSS style for table-header + * is defined above, under 'Table Headers'). + */ +table.details { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin: .2em 0 0 0; } +table.details table { color: #000000; } +table.details a:link { color: #0000ff; } +table.details a:visited { color: #204080; } + +/* Fields */ +dl.fields { margin-left: 2em; margin-top: 1em; + margin-bottom: 1em; } +dl.fields dd ul { margin-left: 0em; padding-left: 0em; } +dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; } +div.fields { margin-left: 2em; } +div.fields p { margin-bottom: 0.5em; } + +/* Index tables (identifier index, term index, etc) + * - link-index is used for indices containing lists of links + * (namely, the identifier index & term index). + * - index-where is used in link indices for the text indicating + * the container/source for each link. + * - metadata-index is used for indices containing metadata + * extracted from fields (namely, the bug index & todo index). + */ +table.link-index { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; } +td.link-index { border-width: 0px; } +table.link-index a:link { color: #0000ff; } +table.link-index a:visited { color: #204080; } +span.index-where { font-size: 70%; } +table.metadata-index { border-collapse: collapse; + background: #e8f0f8; color: #000000; + border: 1px solid #608090; + margin: .2em 0 0 0; } +td.metadata-index { border-width: 1px; border-style: solid; } +table.metadata-index a:link { color: #0000ff; } +table.metadata-index a:visited { color: #204080; } + +/* Function signatures + * - sig* is used for the signature in the details section. + * - .summary-sig* is used for the signature in the summary + * table, and when listing property accessor functions. + * */ +.sig-name { color: #006080; } +.sig-arg { color: #008060; } +.sig-default { color: #602000; } +.summary-sig { font-family: monospace; } +.summary-sig-name { color: #006080; font-weight: bold; } +table.summary a.summary-sig-name:link + { color: #006080; font-weight: bold; } +table.summary a.summary-sig-name:visited + { color: #006080; font-weight: bold; } +.summary-sig-arg { color: #006040; } +.summary-sig-default { color: #501800; } + +/* Subclass list + */ +ul.subclass-list { display: inline; } +ul.subclass-list li { display: inline; } + +/* To render variables, classes etc. like functions */ +table.summary .summary-name { color: #006080; font-weight: bold; + font-family: monospace; } +table.summary + a.summary-name:link { color: #006080; font-weight: bold; + font-family: monospace; } +table.summary + a.summary-name:visited { color: #006080; font-weight: bold; + font-family: monospace; } + +/* Variable values + * - In the 'variable details' sections, each varaible's value is + * listed in a 'pre.variable' box. The width of this box is + * restricted to 80 chars; if the value's repr is longer than + * this it will be wrapped, using a backslash marked with + * class 'variable-linewrap'. If the value's repr is longer + * than 3 lines, the rest will be ellided; and an ellipsis + * marker ('...' marked with 'variable-ellipsis') will be used. + * - If the value is a string, its quote marks will be marked + * with 'variable-quote'. + * - If the variable is a regexp, it is syntax-highlighted using + * the re* CSS classes. + */ +pre.variable { padding: .5em; margin: 0; + background: #dce4ec; color: #000000; + border: 1px solid #708890; } +.variable-linewrap { color: #604000; font-weight: bold; } +.variable-ellipsis { color: #604000; font-weight: bold; } +.variable-quote { color: #604000; font-weight: bold; } +.variable-group { color: #008000; font-weight: bold; } +.variable-op { color: #604000; font-weight: bold; } +.variable-string { color: #006030; } +.variable-unknown { color: #a00000; font-weight: bold; } +.re { color: #000000; } +.re-char { color: #006030; } +.re-op { color: #600000; } +.re-group { color: #003060; } +.re-ref { color: #404040; } + +/* Base tree + * - Used by class pages to display the base class hierarchy. + */ +pre.base-tree { font-size: 80%; margin: 0; } + +/* Frames-based table of contents headers + * - Consists of two frames: one for selecting modules; and + * the other listing the contents of the selected module. + * - h1.toc is used for each frame's heading + * - h2.toc is used for subheadings within each frame. + */ +h1.toc { text-align: center; font-size: 105%; + margin: 0; font-weight: bold; + padding: 0; } +h2.toc { font-size: 100%; font-weight: bold; + margin: 0.5em 0 0 -0.3em; } + +/* Syntax Highlighting for Source Code + * - doctest examples are displayed in a 'pre.py-doctest' block. + * If the example is in a details table entry, then it will use + * the colors specified by the 'table pre.py-doctest' line. + * - Source code listings are displayed in a 'pre.py-src' block. + * Each line is marked with 'span.py-line' (used to draw a line + * down the left margin, separating the code from the line + * numbers). Line numbers are displayed with 'span.py-lineno'. + * The expand/collapse block toggle button is displayed with + * 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not + * modify the font size of the text.) + * - If a source code page is opened with an anchor, then the + * corresponding code block will be highlighted. The code + * block's header is highlighted with 'py-highlight-hdr'; and + * the code block's body is highlighted with 'py-highlight'. + * - The remaining py-* classes are used to perform syntax + * highlighting (py-string for string literals, py-name for names, + * etc.) + */ +pre.py-doctest { padding: .5em; margin: 1em; + background: #e8f0f8; color: #000000; + border: 1px solid #708890; } +table pre.py-doctest { background: #dce4ec; + color: #000000; } +pre.py-src { border: 2px solid #000000; + background: #f0f0f0; color: #000000; } +.py-line { border-left: 2px solid #000000; + margin-left: .2em; padding-left: .4em; } +.py-lineno { font-style: italic; font-size: 90%; + padding-left: .5em; } +a.py-toggle { text-decoration: none; } +div.py-highlight-hdr { border-top: 2px solid #000000; + border-bottom: 2px solid #000000; + background: #d8e8e8; } +div.py-highlight { border-bottom: 2px solid #000000; + background: #d0e0e0; } +.py-prompt { color: #005050; font-weight: bold;} +.py-more { color: #005050; font-weight: bold;} +.py-string { color: #006030; } +.py-comment { color: #003060; } +.py-keyword { color: #600000; } +.py-output { color: #404040; } +.py-name { color: #000050; } +.py-name:link { color: #000050 !important; } +.py-name:visited { color: #000050 !important; } +.py-number { color: #005000; } +.py-defname { color: #000060; font-weight: bold; } +.py-def-name { color: #000060; font-weight: bold; } +.py-base-class { color: #000060; } +.py-param { color: #000060; } +.py-docstring { color: #006030; } +.py-decorator { color: #804020; } +/* Use this if you don't want links to names underlined: */ +/*a.py-name { text-decoration: none; }*/ + +/* Graphs & Diagrams + * - These CSS styles are used for graphs & diagrams generated using + * Graphviz dot. 'img.graph-without-title' is used for bare + * diagrams (to remove the border created by making the image + * clickable). + */ +img.graph-without-title { border: none; } +img.graph-with-title { border: 1px solid #000000; } +span.graph-title { font-weight: bold; } +span.graph-caption { } + +/* General-purpose classes + * - 'p.indent-wrapped-lines' defines a paragraph whose first line + * is not indented, but whose subsequent lines are. + * - The 'nomargin-top' class is used to remove the top margin (e.g. + * from lists). The 'nomargin' class is used to remove both the + * top and bottom margin (but not the left or right margin -- + * for lists, that would cause the bullets to disappear.) + */ +p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em; + margin: 0; } +.nomargin-top { margin-top: 0; } +.nomargin { margin-top: 0; margin-bottom: 0; } + +/* HTML Log */ +div.log-block { padding: 0; margin: .5em 0 .5em 0; + background: #e8f0f8; color: #000000; + border: 1px solid #000000; } +div.log-error { padding: .1em .3em .1em .3em; margin: 4px; + background: #ffb0b0; color: #000000; + border: 1px solid #000000; } +div.log-warning { padding: .1em .3em .1em .3em; margin: 4px; + background: #ffffb0; color: #000000; + border: 1px solid #000000; } +div.log-info { padding: .1em .3em .1em .3em; margin: 4px; + background: #b0ffb0; color: #000000; + border: 1px solid #000000; } +h2.log-hdr { background: #70b0ff; color: #000000; + margin: 0; padding: 0em 0.5em 0em 0.5em; + border-bottom: 1px solid #000000; font-size: 110%; } +p.log { font-weight: bold; margin: .5em 0 .5em 0; } +tr.opt-changed { color: #000000; font-weight: bold; } +tr.opt-default { color: #606060; } +pre.log { margin: 0; padding: 0; padding-left: 1em; } diff --git a/docs/2.2.0/epydoc.js b/docs/2.2.0/epydoc.js new file mode 100644 index 0000000..e787dbc --- /dev/null +++ b/docs/2.2.0/epydoc.js @@ -0,0 +1,293 @@ +function toggle_private() { + // Search for any private/public links on this page. Store + // their old text in "cmd," so we will know what action to + // take; and change their text to the opposite action. + var cmd = "?"; + var elts = document.getElementsByTagName("a"); + for(var i=0; i...
"; + elt.innerHTML = s; + } +} + +function toggle(id) { + elt = document.getElementById(id+"-toggle"); + if (elt.innerHTML == "-") + collapse(id); + else + expand(id); + return false; +} + +function highlight(id) { + var elt = document.getElementById(id+"-def"); + if (elt) elt.className = "py-highlight-hdr"; + var elt = document.getElementById(id+"-expanded"); + if (elt) elt.className = "py-highlight"; + var elt = document.getElementById(id+"-collapsed"); + if (elt) elt.className = "py-highlight"; +} + +function num_lines(s) { + var n = 1; + var pos = s.indexOf("\n"); + while ( pos > 0) { + n += 1; + pos = s.indexOf("\n", pos+1); + } + return n; +} + +// Collapse all blocks that mave more than `min_lines` lines. +function collapse_all(min_lines) { + var elts = document.getElementsByTagName("div"); + for (var i=0; i 0) + if (elt.id.substring(split, elt.id.length) == "-expanded") + if (num_lines(elt.innerHTML) > min_lines) + collapse(elt.id.substring(0, split)); + } +} + +function expandto(href) { + var start = href.indexOf("#")+1; + if (start != 0 && start != href.length) { + if (href.substring(start, href.length) != "-") { + collapse_all(4); + pos = href.indexOf(".", start); + while (pos != -1) { + var id = href.substring(start, pos); + expand(id); + pos = href.indexOf(".", pos+1); + } + var id = href.substring(start, href.length); + expand(id); + highlight(id); + } + } +} + +function kill_doclink(id) { + var parent = document.getElementById(id); + parent.removeChild(parent.childNodes.item(0)); +} +function auto_kill_doclink(ev) { + if (!ev) var ev = window.event; + if (!this.contains(ev.toElement)) { + var parent = document.getElementById(this.parentID); + parent.removeChild(parent.childNodes.item(0)); + } +} + +function doclink(id, name, targets_id) { + var elt = document.getElementById(id); + + // If we already opened the box, then destroy it. + // (This case should never occur, but leave it in just in case.) + if (elt.childNodes.length > 1) { + elt.removeChild(elt.childNodes.item(0)); + } + else { + // The outer box: relative + inline positioning. + var box1 = document.createElement("div"); + box1.style.position = "relative"; + box1.style.display = "inline"; + box1.style.top = 0; + box1.style.left = 0; + + // A shadow for fun + var shadow = document.createElement("div"); + shadow.style.position = "absolute"; + shadow.style.left = "-1.3em"; + shadow.style.top = "-1.3em"; + shadow.style.background = "#404040"; + + // The inner box: absolute positioning. + var box2 = document.createElement("div"); + box2.style.position = "relative"; + box2.style.border = "1px solid #a0a0a0"; + box2.style.left = "-.2em"; + box2.style.top = "-.2em"; + box2.style.background = "white"; + box2.style.padding = ".3em .4em .3em .4em"; + box2.style.fontStyle = "normal"; + box2.onmouseout=auto_kill_doclink; + box2.parentID = id; + + // Get the targets + var targets_elt = document.getElementById(targets_id); + var targets = targets_elt.getAttribute("targets"); + var links = ""; + target_list = targets.split(","); + for (var i=0; i" + + target[0] + ""; + } + + // Put it all together. + elt.insertBefore(box1, elt.childNodes.item(0)); + //box1.appendChild(box2); + box1.appendChild(shadow); + shadow.appendChild(box2); + box2.innerHTML = + "Which "+name+" do you want to see documentation for?" + + ""; + } + return false; +} + +function get_anchor() { + var href = location.href; + var start = href.indexOf("#")+1; + if ((start != 0) && (start != href.length)) + return href.substring(start, href.length); + } +function redirect_url(dottedName) { + // Scan through each element of the "pages" list, and check + // if "name" matches with any of them. + for (var i=0; i-m" or "-c"; + // extract the portion & compare it to dottedName. + var pagename = pages[i].substring(0, pages[i].length-2); + if (pagename == dottedName.substring(0,pagename.length)) { + + // We've found a page that matches `dottedName`; + // construct its URL, using leftover `dottedName` + // content to form an anchor. + var pagetype = pages[i].charAt(pages[i].length-1); + var url = pagename + ((pagetype=="m")?"-module.html": + "-class.html"); + if (dottedName.length > pagename.length) + url += "#" + dottedName.substring(pagename.length+1, + dottedName.length); + return url; + } + } + } diff --git a/docs/2.2.0/fedex-module.html b/docs/2.2.0/fedex-module.html new file mode 100644 index 0000000..fed35b4 --- /dev/null +++ b/docs/2.2.0/fedex-module.html @@ -0,0 +1,255 @@ + + + + + fedex + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Package fedex

source code

+

python-fedex API Documentation

+

The python-fedex module is a light wrapper around Fedex's Web + Services SOAP API. Using the excellent suds SOAP + client, the Fedex requests and responses are trivial to work with.

+

What python-fedex is

+
    +
  • + A light wrapper around Fedex Web Services SOAP API. +
    • +
  • + Simple and easy to use. +
    • +
  • + Minimal by design. +
    • +
+

What python-fedex is not

+
    +
  • + An abstraction layer. python-fedex only assembles the needed SOAP + calls and returns a SOAP response through suds. This is easy + enough to work with that no abstraction is needed. Doing so would + limit your use of the data. +
    • +
  • + Anything more than a light wrapper. +
    • +
+

A note on completeness

+

python-fedex was created for use with various internal projects + over the years. Not all services are implemented but only those + needed at the time were implemented. If there is missing + functionality, please report an issue so that this module can be made more useful + to others. Likewise, feel free to submit patches and service + implementations as well if you would like to help.

+

Getting Started

+

The best place to get started is by viewing the examples in the + 'examples' directory. These should be very self-explanatory. For + further details, you may review the API here, or get support by + reading the instructions in the appropriately named section + below.

+

The services + module is also a good place to start looking at the different objects + used for issuing Fedex requests.

+

As a general tip, the best way to see which attributes are + available on WSDL objects is to simply print them, hitting their + __str__() method.

+

Fedex Documentation

+

If you are wondering what attributes or variables are present, + you'll want to refer to the Fedex Web Services documentation at + http://fedex.com/developer/. Complete specification documents are + there, which correspond very closely with what you'll be able to do + with python-fedex.

+

Getting Support

+

If you have any questions, problems, ideas, or patch submissions, + please visit our Github project and enter an issue in the Issue Tracker.

+ +
+

Version: + 2.2.0 +

+
+ + + + + + +
+ + + + + +
Submodules[hide private]
+
+
+ +
+ + + + + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + VERSION = '2.2.0' +
+   + + __package__ = None +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex-pysrc.html b/docs/2.2.0/fedex-pysrc.html new file mode 100644 index 0000000..0aaf642 --- /dev/null +++ b/docs/2.2.0/fedex-pysrc.html @@ -0,0 +1,165 @@ + + + + + fedex + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Package fedex

+
+ 1  """ 
+ 2  python-fedex API Documentation 
+ 3  ============================== 
+ 4  The python-fedex module is a light wrapper around Fedex's Web Services SOAP API. 
+ 5  Using the excellent U{suds<https://fedorahosted.org/suds/>} SOAP client, 
+ 6  the Fedex requests and responses are trivial to work with. 
+ 7   
+ 8  What python-fedex is 
+ 9  -------------------- 
+10      - A light wrapper around Fedex Web Services SOAP API. 
+11      - Simple and easy to use. 
+12      - Minimal by design. 
+13   
+14  What python-fedex is not 
+15  ------------------------ 
+16      - An abstraction layer. python-fedex only assembles the needed SOAP calls 
+17          and returns a SOAP response through suds. This is easy enough to work with 
+18          that no abstraction is needed. Doing so would limit your use of the data. 
+19      - Anything more than a light wrapper. 
+20       
+21  A note on completeness 
+22  ---------------------- 
+23  python-fedex was created for use with various internal projects over the years. 
+24  Not all services are implemented but only those needed at the time were implemented. 
+25  If there is missing functionality, please report an U{issue<http://code.google.com/p/python-fedex/issues/list>} 
+26  so that this module can be made more useful to others. Likewise, feel free to 
+27  submit patches and service implementations as well if you would like to help. 
+28   
+29  Getting Started 
+30  --------------- 
+31  The best place to get started is by viewing the examples in the 'examples' 
+32  directory. These should be very self-explanatory. For further details, you 
+33  may review the API here, or get support by reading the instructions in the 
+34  appropriately named section below. 
+35   
+36  The L{services} module is also a good place to start looking at the different 
+37  objects used for issuing Fedex requests. 
+38   
+39  As a general tip, the best way to see which attributes are available on WSDL 
+40  objects is to simply print them, hitting their __str__() method. 
+41   
+42  Fedex Documentation 
+43  ------------------- 
+44  If you are wondering what attributes or variables are present, you'll want to 
+45  refer to the Fedex Web Services documentation at http://fedex.com/developer/. 
+46  Complete specification documents are there, which correspond very closely with 
+47  what you'll be able to do with python-fedex. 
+48       
+49  Getting Support 
+50  --------------- 
+51  If you have any questions, problems, ideas, or patch submissions, please visit 
+52  our U{Github project<http://github.com/gtaylor/python-fedex/>} and enter 
+53  an issue in the U{Issue Tracker<http://github.com/gtaylor/python-fedex/issues>}. 
+54  """ 
+55  VERSION = __version__ = '2.2.0' 
+56   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service-module.html b/docs/2.2.0/fedex.base_service-module.html new file mode 100644 index 0000000..e5bff39 --- /dev/null +++ b/docs/2.2.0/fedex.base_service-module.html @@ -0,0 +1,205 @@ + + + + + fedex.base_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module base_service

source code

+

The base_service module contains classes that form the low + level foundations of the Web Service API. Things that many different + kinds of requests have in common may be found here.

+

In particular, the FedexBaseService class handles most of the basic, + repetitive setup work that most requests do.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + GeneralSudsPlugin +
+   + + FedexBaseServiceException
+ Exception: Serves as the base exception that other service-related + exception objects are sub-classed from. +
+   + + FedexFailure
+ Exception: The request could not be handled at this time. +
+   + + FedexError
+ Exception: These are generally problems with the client-provided + data. +
+   + + SchemaValidationError
+ Exception: There is probably a problem in the data you provided. +
+   + + FedexBaseService
+ This class is the master class for all Fedex request objects. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service-pysrc.html b/docs/2.2.0/fedex.base_service-pysrc.html new file mode 100644 index 0000000..444b05e --- /dev/null +++ b/docs/2.2.0/fedex.base_service-pysrc.html @@ -0,0 +1,430 @@ + + + + + fedex.base_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.base_service

+
+  1  """ 
+  2  The L{base_service} module contains classes that form the low level foundations 
+  3  of the Web Service API. Things that many different kinds of requests have in 
+  4  common may be found here. 
+  5   
+  6  In particular, the L{FedexBaseService} class handles most of the basic, 
+  7  repetitive setup work that most requests do. 
+  8  """ 
+  9   
+ 10  import os 
+ 11  import logging 
+ 12   
+ 13  import suds 
+ 14  from suds.client import Client 
+ 15  from suds.plugin import MessagePlugin 
+ 16   
+ 17   
+
 18 -class GeneralSudsPlugin(MessagePlugin): 
+
 19 -    def __init__(self, **kwargs): 
+
 20          self.kwargs = kwargs 
+
 21   
+
 22 -    def marshalled(self, context): 
+
 23          context.envelope = context.envelope.prune() 
+
 24   
+
 25 -    def sending(self, context): 
+
 26          logging.info("FedEx Request {}".format(context.envelope)) 
+
 27   
+
 28 -    def received(self, context): 
+
 29          logging.info("FedEx Response {}".format(context.reply)) 
+
 30   
+ 31   
+
 32 -class FedexBaseServiceException(Exception): 
+
 33      """ 
+ 34      Exception: Serves as the base exception that other service-related 
+ 35      exception objects are sub-classed from. 
+ 36      """ 
+ 37   
+
 38 -    def __init__(self, error_code, value): 
+
 39          self.error_code = error_code 
+ 40          self.value = value 
+
 41   
+
 42 -    def __unicode__(self): 
+
 43          return "%s (Error code: %s)" % (repr(self.value), self.error_code) 
+
 44   
+
 45 -    def __str__(self): 
+
 46          return self.__unicode__() 
+
 47   
+ 48   
+
 49 -class FedexFailure(FedexBaseServiceException): 
+
 50      """ 
+ 51      Exception: The request could not be handled at this time. This is generally 
+ 52      a server problem. 
+ 53      """ 
+ 54   
+ 55      pass 
+
 56   
+ 57   
+
 58 -class FedexError(FedexBaseServiceException): 
+
 59      """ 
+ 60      Exception: These are generally problems with the client-provided data. 
+ 61      """ 
+ 62   
+ 63      pass 
+
 64   
+ 65   
+
 66 -class SchemaValidationError(FedexBaseServiceException): 
+
 67      """ 
+ 68      Exception: There is probably a problem in the data you provided. 
+ 69      """ 
+ 70   
+
 71 -    def __init__(self, fault): 
+
 72          self.error_code = -1 
+ 73          self.value = "suds encountered an error validating your data against this service's WSDL schema. " \ 
+ 74                       "Please double-check for missing or invalid values, filling all required fields." 
+ 75          try: 
+ 76              self.value += ' Details: {}'.format(fault) 
+ 77          except AttributeError: 
+ 78              pass 
+
 79   
+ 80   
+
 81 -class FedexBaseService(object): 
+
 82      """ 
+ 83      This class is the master class for all Fedex request objects. It gets all 
+ 84      of the common SOAP objects created via suds and populates them with 
+ 85      values from a L{FedexConfig} object, along with keyword arguments 
+ 86      via L{__init__}. 
+ 87   
+ 88      @note: This object should never be used directly, use one of the included 
+ 89          sub-classes. 
+ 90      """ 
+ 91   
+
 92 -    def __init__(self, config_obj, wsdl_name, *args, **kwargs): 
+
 93          """ 
+ 94          This constructor should only be called by children of the class. As is 
+ 95          such, only the optional keyword arguments caught by C{**kwargs} will 
+ 96          be documented. 
+ 97   
+ 98          @type customer_transaction_id: L{str} 
+ 99          @keyword customer_transaction_id: A user-specified identifier to 
+100              differentiate this transaction from others. This value will be 
+101              returned with the response from Fedex. 
+102          """ 
+103   
+104          self.logger = logging.getLogger('fedex') 
+105          """@ivar: Python logger instance with name 'fedex'.""" 
+106          self.config_obj = config_obj 
+107          """@ivar: The FedexConfig object to pull auth info from.""" 
+108   
+109          # If the config object is set to use the test server, point 
+110          # suds at the test server WSDL directory. 
+111          if config_obj.use_test_server: 
+112              self.logger.info("Using test server.") 
+113              self.wsdl_path = os.path.join(config_obj.wsdl_path, 
+114                                            'test_server_wsdl', wsdl_name) 
+115          else: 
+116              self.logger.info("Using production server.") 
+117              self.wsdl_path = os.path.join(config_obj.wsdl_path, wsdl_name) 
+118   
+119          self.client = Client('file:///%s' % self.wsdl_path.lstrip('/'), plugins=[GeneralSudsPlugin()]) 
+120          # self.client.options.cache.clear()  # Clear the cache, then re-init client when changing wsdl file. 
+121   
+122          self.VersionId = None 
+123          """@ivar: Holds details on the version numbers of the WSDL.""" 
+124          self.WebAuthenticationDetail = None 
+125          """@ivar: WSDL object that holds authentication info.""" 
+126          self.ClientDetail = None 
+127          """@ivar: WSDL object that holds client account details.""" 
+128          self.response = None 
+129          """@ivar: The response from Fedex. You will want to pick what you 
+130              want out here here. This object does have a __str__() method, 
+131              you'll want to print or log it to see what possible values 
+132              you can pull.""" 
+133          self.TransactionDetail = None 
+134          """@ivar: Holds customer-specified transaction IDs.""" 
+135   
+136          self.__set_web_authentication_detail() 
+137          self.__set_client_detail(*args, **kwargs) 
+138          self.__set_version_id() 
+139          self.__set_transaction_detail(*args, **kwargs) 
+140          self._prepare_wsdl_objects() 
+
141   
+
142 -    def __set_web_authentication_detail(self): 
+
143          """ 
+144          Sets up the WebAuthenticationDetail node. This is required for all 
+145          requests. 
+146          """ 
+147   
+148          # Start of the authentication stuff. 
+149          WebAuthenticationCredential = self.client.factory.create('WebAuthenticationCredential') 
+150          WebAuthenticationCredential.Key = self.config_obj.key 
+151          WebAuthenticationCredential.Password = self.config_obj.password 
+152   
+153          # Encapsulates the auth credentials. 
+154          WebAuthenticationDetail = self.client.factory.create('WebAuthenticationDetail') 
+155          WebAuthenticationDetail.UserCredential = WebAuthenticationCredential 
+156   
+157          # Set Default ParentCredential 
+158          if hasattr(WebAuthenticationDetail, 'ParentCredential'): 
+159              WebAuthenticationDetail.ParentCredential = WebAuthenticationCredential 
+160   
+161          self.WebAuthenticationDetail = WebAuthenticationDetail 
+
162   
+
163 -    def __set_client_detail(self, *args, **kwargs): 
+
164          """ 
+165          Sets up the ClientDetail node, which is required for all shipping 
+166          related requests. 
+167          """ 
+168   
+169          ClientDetail = self.client.factory.create('ClientDetail') 
+170          ClientDetail.AccountNumber = self.config_obj.account_number 
+171          ClientDetail.MeterNumber = self.config_obj.meter_number 
+172          ClientDetail.IntegratorId = self.config_obj.integrator_id 
+173          if hasattr(ClientDetail, 'Region'): 
+174              ClientDetail.Region = self.config_obj.express_region_code 
+175   
+176          client_language_code = kwargs.get('client_language_code', None) 
+177          client_locale_code = kwargs.get('client_locale_code', None) 
+178   
+179          if hasattr(ClientDetail, 'Localization') and (client_language_code or client_locale_code): 
+180              Localization = self.client.factory.create('Localization') 
+181   
+182              if client_language_code: 
+183                  Localization.LanguageCode = client_language_code 
+184   
+185              if client_locale_code: 
+186                  Localization.LocaleCode = client_locale_code 
+187   
+188              ClientDetail.Localization = Localization 
+189   
+190          self.ClientDetail = ClientDetail 
+
191   
+
192 -    def __set_transaction_detail(self, *args, **kwargs): 
+
193          """ 
+194          Checks kwargs for 'customer_transaction_id' and sets it if present. 
+195          """ 
+196   
+197          customer_transaction_id = kwargs.get('customer_transaction_id', None) 
+198          if customer_transaction_id: 
+199              TransactionDetail = self.client.factory.create('TransactionDetail') 
+200              TransactionDetail.CustomerTransactionId = customer_transaction_id 
+201              self.logger.debug(TransactionDetail) 
+202              self.TransactionDetail = TransactionDetail 
+
203   
+
204 -    def __set_version_id(self): 
+
205          """ 
+206          Pulles the versioning info for the request from the child request. 
+207          """ 
+208   
+209          VersionId = self.client.factory.create('VersionId') 
+210          VersionId.ServiceId = self._version_info['service_id'] 
+211          VersionId.Major = self._version_info['major'] 
+212          VersionId.Intermediate = self._version_info['intermediate'] 
+213          VersionId.Minor = self._version_info['minor'] 
+214          self.logger.debug(VersionId) 
+215          self.VersionId = VersionId 
+
216   
+
217 -    def _prepare_wsdl_objects(self): 
+
218          """ 
+219          This method should be over-ridden on each sub-class. It instantiates 
+220          any of the required WSDL objects so the user can just print their 
+221          __str__() methods and see what they need to fill in. 
+222          """ 
+223   
+224          pass 
+
225   
+
226 -    def __check_response_for_fedex_error(self): 
+
227          """ 
+228          This checks the response for general Fedex errors that aren't related 
+229          to any one WSDL. 
+230          """ 
+231   
+232          if self.response.HighestSeverity == "FAILURE": 
+233              for notification in self.response.Notifications: 
+234                  if notification.Severity == "FAILURE": 
+235                      raise FedexFailure(notification.Code, 
+236                                         notification.Message) 
+
237   
+
239          """ 
+240          Override this in each service module to check for errors that are 
+241          specific to that module. For example, invalid tracking numbers in 
+242          a Tracking request. 
+243          """ 
+244   
+245          if self.response.HighestSeverity == "ERROR": 
+246              for notification in self.response.Notifications: 
+247                  if notification.Severity == "ERROR": 
+248                      raise FedexError(notification.Code, 
+249                                       notification.Message) 
+
250   
+
251 -    def create_wsdl_object_of_type(self, type_name): 
+
252          """ 
+253          Creates and returns a WSDL object of the specified type. 
+254          """ 
+255   
+256          return self.client.factory.create(type_name) 
+
257   
+
258 -    def _assemble_and_send_request(self): 
+
259          """ 
+260          This method should be over-ridden on each sub-class. It assembles all required objects 
+261          into the specific request object and calls send_request. 
+262          """ 
+263   
+264          pass 
+
265   
+
266 -    def send_request(self, send_function=None): 
+
267          """ 
+268          Sends the assembled request on the child object. 
+269          @type send_function: function reference 
+270          @keyword send_function: A function reference (passed without the 
+271              parenthesis) to a function that will send the request. This 
+272              allows for overriding the default function in cases such as 
+273              validation requests. 
+274          """ 
+275   
+276          # Send the request and get the response back. 
+277          try: 
+278              # If the user has overridden the send function, use theirs 
+279              # instead of the default. 
+280              if send_function: 
+281                  # Follow the overridden function. 
+282                  self.response = send_function() 
+283              else: 
+284                  # Default scenario, business as usual. 
+285                  self.response = self._assemble_and_send_request() 
+286          except suds.WebFault as fault: 
+287              # When this happens, throw an informative message reminding the 
+288              # user to check all required variables, making sure they are 
+289              # populated and valid 
+290              raise SchemaValidationError(fault.fault) 
+291   
+292          # Check the response for general Fedex errors/failures that aren't 
+293          # specific to any given WSDL/request. 
+294          self.__check_response_for_fedex_error() 
+295          # Check the response for errors specific to the particular request. 
+296          # This is handled by an overridden method on the child object. 
+297          self._check_response_for_request_errors() 
+298   
+299          # Debug output. 
+300          self.logger.debug("== FEDEX QUERY RESULT ==") 
+301          self.logger.debug(self.response) 
+
302   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.FedexBaseService-class.html b/docs/2.2.0/fedex.base_service.FedexBaseService-class.html new file mode 100644 index 0000000..936e970 --- /dev/null +++ b/docs/2.2.0/fedex.base_service.FedexBaseService-class.html @@ -0,0 +1,660 @@ + + + + + fedex.base_service.FedexBaseService + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class FedexBaseService + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexBaseService

source code

+
+object --+
+         |
+        FedexBaseService
+
+ +
Known Subclasses:
+
+ +
+ +
+

This class is the master class for all Fedex request objects. It gets + all of the common SOAP objects created via suds and populates them with + values from a FedexConfig object, along with keyword arguments via __init__.

+ +
+

Note: + This object should never be used directly, use one of the included + sub-classes. +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__check_response_for_fedex_error(self)
+ This checks the response for general Fedex errors that aren't related + to any one WSDL.		 + source code + +
+ +
+   + + + + + + +
__init__(self, + config_obj, + wsdl_name, + *args, + **kwargs)
+ This constructor should only be called by children of the class.		 + source code + +
+ +
+   + + + + + + +
__set_client_detail(self, + *args, + **kwargs)
+ Sets up the ClientDetail node, which is required for all shipping + related requests.		 + source code + +
+ +
+   + + + + + + +
__set_transaction_detail(self, + *args, + **kwargs)
+ Checks kwargs for 'customer_transaction_id' and sets it if present.		 + source code + +
+ +
+   + + + + + + +
__set_version_id(self)
+ Pulles the versioning info for the request from the child request.		 + source code + +
+ +
+   + + + + + + +
__set_web_authentication_detail(self)
+ Sets up the WebAuthenticationDetail node.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ This method should be over-ridden on each sub-class.		 + source code + +
+ +
+   + + + + + + +
_check_response_for_request_errors(self)
+ Override this in each service module to check for errors that are + specific to that module.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ This method should be over-ridden on each sub-class.		 + source code + +
+ +
+   + + + + + + +
create_wsdl_object_of_type(self, + type_name)
+ Creates and returns a WSDL object of the specified type.		 + source code + +
+ +
+   + + + + + + +
send_request(self, + send_function=None)
+ Sends the assembled request on the child object.		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + ClientDetail
+ WSDL object that holds client account details. +
+   + + TransactionDetail
+ Holds customer-specified transaction IDs. +
+   + + VersionId
+ Holds details on the version numbers of the WSDL. +
+   + + WebAuthenticationDetail
+ WSDL object that holds authentication info. +
+   + + config_obj
+ The FedexConfig object to pull auth info from. +
+   + + logger
+ Python logger instance with name 'fedex'. +
+   + + response
+ The response from Fedex. +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + wsdl_name, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

This constructor should only be called by children of the class. As is + such, only the optional keyword arguments caught by **kwargs + will be documented.

+
+
Parameters:
+
    +
  • customer_transaction_id (str) - A user-specified identifier to differentiate this transaction + from others. This value will be returned with the response from + Fedex.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

__set_web_authentication_detail(self) +

+ 		source code  +
+ +

Sets up the WebAuthenticationDetail node. This is required for all + requests.

+
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

This method should be over-ridden on each sub-class. It assembles all + required objects into the specific request object and calls + send_request.

+
+
+
+
+ +
+ +
+ + +
+

_check_response_for_request_errors(self) +

+ 		source code  +
+ +

Override this in each service module to check for errors that are + specific to that module. For example, invalid tracking numbers in a + Tracking request.

+
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

This method should be over-ridden on each sub-class. It instantiates + any of the required WSDL objects so the user can just print their + __str__() methods and see what they need to fill in.

+
+
+
+
+ +
+ +
+ + +
+

send_request(self, + send_function=None) +

+ 		source code  +
+ +

Sends the assembled request on the child object.

+
+
Parameters:
+
    +
  • send_function (function reference) - A function reference (passed without the parenthesis) to a + function that will send the request. This allows for overriding + the default function in cases such as validation requests.
    • +
+
+
+
+
+ + + + + + +
+ + + + + +
Instance Variable Details[hide private]
+
+ +
+ +
+

response

+ The response from Fedex. You will want to pick what you want out here + here. This object does have a __str__() method, you'll want to print or + log it to see what possible values you can pull. +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.FedexBaseServiceException-class.html b/docs/2.2.0/fedex.base_service.FedexBaseServiceException-class.html new file mode 100644 index 0000000..f219227 --- /dev/null +++ b/docs/2.2.0/fedex.base_service.FedexBaseServiceException-class.html @@ -0,0 +1,339 @@ + + + + + fedex.base_service.FedexBaseServiceException + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class FedexBaseServiceException + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexBaseServiceException

source code

+
+              object --+        
+                       |        
+exceptions.BaseException --+    
+                           |    
+        exceptions.Exception --+
+                               |
+                              FedexBaseServiceException
+
+ +
Known Subclasses:
+
+ +
+ +
+

Exception: Serves as the base exception that other service-related + exception objects are sub-classed from.

+ + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + error_code, + value)
+ x.__init__(...) initializes x; see help(type(x)) for signature		 + source code + +
+ +
+   + + + + + + +
__unicode__(self) + source code + +
+ +
+   + + + + + + +
__str__(self)
+ str(x)		 + source code + +
+ +
+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + error_code, + value) +
(Constructor) +

+ 		source code  +
+ +

x.__init__(...) initializes x; see help(type(x)) for signature

+
+
Overrides: + object.__init__ +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

__unicode__(self) +

+ 		source code  +
+ + +
+
Overrides: + exceptions.BaseException.__unicode__ +
+
+
+
+ +
+ +
+ + +
+

__str__(self) +
(Informal representation operator) +

+ 		source code  +
+ +

str(x)

+
+
Overrides: + object.__str__ +
(inherited documentation)
+ +
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.FedexError-class.html b/docs/2.2.0/fedex.base_service.FedexError-class.html new file mode 100644 index 0000000..e476f72 --- /dev/null +++ b/docs/2.2.0/fedex.base_service.FedexError-class.html @@ -0,0 +1,203 @@ + + + + + fedex.base_service.FedexError + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class FedexError + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexError

source code

+
+              object --+            
+                       |            
+exceptions.BaseException --+        
+                           |        
+        exceptions.Exception --+    
+                               |    
+       FedexBaseServiceException --+
+                                   |
+                                  FedexError
+
+ +
Known Subclasses:
+
+ +
+ +
+

Exception: These are generally problems with the client-provided + data.

+ + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+

Inherited from FedexBaseServiceException: + __init__, + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.FedexFailure-class.html b/docs/2.2.0/fedex.base_service.FedexFailure-class.html new file mode 100644 index 0000000..551dc5d --- /dev/null +++ b/docs/2.2.0/fedex.base_service.FedexFailure-class.html @@ -0,0 +1,197 @@ + + + + + fedex.base_service.FedexFailure + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class FedexFailure + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexFailure

source code

+
+              object --+            
+                       |            
+exceptions.BaseException --+        
+                           |        
+        exceptions.Exception --+    
+                               |    
+       FedexBaseServiceException --+
+                                   |
+                                  FedexFailure
+
+ +
+

Exception: The request could not be handled at this time. This is + generally a server problem.

+ + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+

Inherited from FedexBaseServiceException: + __init__, + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.GeneralSudsPlugin-class.html b/docs/2.2.0/fedex.base_service.GeneralSudsPlugin-class.html new file mode 100644 index 0000000..5c69618 --- /dev/null +++ b/docs/2.2.0/fedex.base_service.GeneralSudsPlugin-class.html @@ -0,0 +1,319 @@ + + + + + fedex.base_service.GeneralSudsPlugin + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class GeneralSudsPlugin + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class GeneralSudsPlugin

source code

+
+   suds.plugin.Plugin --+    
+                        |    
+suds.plugin.MessagePlugin --+
+                            |
+                           GeneralSudsPlugin
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + **kwargs) + source code + +
+ +
+   + + + + + + +
marshalled(self, + context)
+ Suds will send the specified soap envelope.		 + source code + +
+ +
+   + + + + + + +
sending(self, + context)
+ Suds will send the specified soap envelope.		 + source code + +
+ +
+   + + + + + + +
received(self, + context)
+ Suds has received the specified reply.		 + source code + +
+ +
+

Inherited from suds.plugin.MessagePlugin: + parsed, + unmarshalled +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

marshalled(self, + context) +

+ 		source code  +
+ +

Suds will send the specified soap envelope. Provides the plugin with + the opportunity to inspect/modify the envelope Document before it is + sent.

+
+
Parameters:
+
    +
  • context - The send context. The envelope is the envelope docuemnt.
    • +
+
Overrides: + suds.plugin.MessagePlugin.marshalled +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

sending(self, + context) +

+ 		source code  +
+ +

Suds will send the specified soap envelope. Provides the plugin with + the opportunity to inspect/modify the message text it is sent.

+
+
Parameters:
+
    +
  • context - The send context. The envelope is the envelope text.
    • +
+
Overrides: + suds.plugin.MessagePlugin.sending +
(inherited documentation)
+ +
+
+
+ +
+ +
+ + +
+

received(self, + context) +

+ 		source code  +
+ +

Suds has received the specified reply. Provides the plugin with the + opportunity to inspect/modify the received XML text before it is SAX + parsed.

+
+
Parameters:
+
    +
  • context - The reply context. The reply is the raw text.
    • +
+
Overrides: + suds.plugin.MessagePlugin.received +
(inherited documentation)
+ +
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.base_service.SchemaValidationError-class.html b/docs/2.2.0/fedex.base_service.SchemaValidationError-class.html new file mode 100644 index 0000000..f4fb8b6 --- /dev/null +++ b/docs/2.2.0/fedex.base_service.SchemaValidationError-class.html @@ -0,0 +1,257 @@ + + + + + fedex.base_service.SchemaValidationError + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module base_service :: + Class SchemaValidationError + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class SchemaValidationError

source code

+
+              object --+            
+                       |            
+exceptions.BaseException --+        
+                           |        
+        exceptions.Exception --+    
+                               |    
+       FedexBaseServiceException --+
+                                   |
+                                  SchemaValidationError
+
+ +
+

Exception: There is probably a problem in the data you provided.

+ + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + fault)
+ x.__init__(...) initializes x; see help(type(x)) for signature		 + source code + +
+ +
+

Inherited from FedexBaseServiceException: + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + fault) +
(Constructor) +

+ 		source code  +
+ +

x.__init__(...) initializes x; see help(type(x)) for signature

+
+
Overrides: + object.__init__ +
(inherited documentation)
+ +
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.config-module.html b/docs/2.2.0/fedex.config-module.html new file mode 100644 index 0000000..d825e5e --- /dev/null +++ b/docs/2.2.0/fedex.config-module.html @@ -0,0 +1,168 @@ + + + + + fedex.config + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module config + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module config

source code

+

The config module + contains the FedexConfig class, which is passed to the Fedex API + calls. It stores useful information such as your Web Services account + numbers and keys.

+

It is strongly suggested that you create a single FedexConfig + object in your project and pass that to the various API calls, rather + than create new FedexConfig objects haphazardly. This is merely a design + suggestion, treat it as such.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexConfig
+ Base configuration class that is used for the different Fedex SOAP + calls. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.config-pysrc.html b/docs/2.2.0/fedex.config-pysrc.html new file mode 100644 index 0000000..5ca5837 --- /dev/null +++ b/docs/2.2.0/fedex.config-pysrc.html @@ -0,0 +1,185 @@ + + + + + fedex.config + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module config + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.config

+
+ 1  """ 
+ 2  The L{config} module contains the L{FedexConfig} class, which is passed to 
+ 3  the Fedex API calls. It stores useful information such as your Web Services 
+ 4  account numbers and keys. 
+ 5   
+ 6  It is strongly suggested that you create a single L{FedexConfig} object in 
+ 7  your project and pass that to the various API calls, rather than create new 
+ 8  L{FedexConfig} objects haphazardly. This is merely a design suggestion, 
+ 9  treat it as such. 
+10  """ 
+11  import os 
+12   
+13   
+
14 -class FedexConfig(object): 
+
15      """ 
+16      Base configuration class that is used for the different Fedex SOAP calls. 
+17      These are generally passed to the Fedex request classes as arguments. 
+18      You may instantiate a L{FedexConfig} object with the minimal C{key} and 
+19      C{password} arguments and set the instance variables documented below 
+20      at a later time if you must. 
+21      """ 
+22   
+
23 -    def __init__(self, key, password, account_number=None, meter_number=None, freight_account_number=None, 
+24                   integrator_id=None, wsdl_path=None, express_region_code=None, use_test_server=False): 
+
25          """ 
+26          @type key: L{str} 
+27          @param key: Developer test key. 
+28          @type password: L{str} 
+29          @param password: The Fedex-generated password for your Web Systems 
+30              account. This is generally emailed to you after registration. 
+31          @type account_number: L{str} 
+32          @keyword account_number: The account number sent to you by Fedex after 
+33              registering for Web Services. 
+34          @type meter_number: L{str} 
+35          @keyword meter_number: The meter number sent to you by Fedex after 
+36              registering for Web Services. 
+37          @type freight_account_number: L{str} 
+38          @keyword freight_account_number: The freight account number sent to you 
+39              by Fedex after registering for Web Services. 
+40          @type integrator_id: L{str} 
+41          @keyword integrator_id: The integrator string sent to you by Fedex after 
+42              registering for Web Services. 
+43          @type wsdl_path: L{str} 
+44          @keyword wsdl_path: In the event that you want to override the path to 
+45              your WSDL directory, do so with this argument. 
+46          @type use_test_server: L{bool} 
+47          @keyword use_test_server: When this is True, test server WSDLs are used 
+48              instead of the production server. You will also need to make sure 
+49              that your L{FedexConfig} object has a production account number, 
+50              meter number, authentication key, and password. 
+51          """ 
+52          self.key = key 
+53          """@ivar: Developer test key.""" 
+54          self.password = password 
+55          """@ivar: Fedex Web Services password.""" 
+56          self.account_number = account_number 
+57          """@ivar: Web Services account number.""" 
+58          self.meter_number = meter_number 
+59          """@ivar: Web services meter number.""" 
+60          self.freight_account_number = freight_account_number 
+61          """@ivar: Web Services freight accountnumber.""" 
+62          self.integrator_id = integrator_id 
+63          """@ivar: Web services integrator ID.""" 
+64          self.express_region_code = express_region_code 
+65          """@ivar: Web services ExpressRegionCode""" 
+66          self.use_test_server = use_test_server 
+67          """@ivar: When True, point to the test server.""" 
+68   
+69          # Allow overriding of the WDSL path. 
+70          if wsdl_path is None: 
+71              self.wsdl_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 
+72                                            'wsdl') 
+73          else:  # pragma: no cover 
+74              self.wsdl_path = wsdl_path 
+
75   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.config.FedexConfig-class.html b/docs/2.2.0/fedex.config.FedexConfig-class.html new file mode 100644 index 0000000..6e6ad8b --- /dev/null +++ b/docs/2.2.0/fedex.config.FedexConfig-class.html @@ -0,0 +1,361 @@ + + + + + fedex.config.FedexConfig + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Module config :: + Class FedexConfig + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexConfig

source code

+
+object --+
+         |
+        FedexConfig
+
+ +
+

Base configuration class that is used for the different Fedex SOAP + calls. These are generally passed to the Fedex request classes as + arguments. You may instantiate a FedexConfig + object with the minimal key and password + arguments and set the instance variables documented below at a later time + if you must.

+ + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + key, + password, + account_number=None, + meter_number=None, + freight_account_number=None, + integrator_id=None, + wsdl_path=None, + express_region_code=None, + use_test_server=False)
+ x.__init__(...) initializes x; see help(type(x)) for signature		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + key
+ Developer test key. +
+   + + password
+ Fedex Web Services password. +
+   + + account_number
+ Web Services account number. +
+   + + meter_number
+ Web services meter number. +
+   + + freight_account_number
+ Web Services freight accountnumber. +
+   + + integrator_id
+ Web services integrator ID. +
+   + + express_region_code
+ Web services ExpressRegionCode +
+   + + use_test_server
+ When True, point to the test server. +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + key, + password, + account_number=None, + meter_number=None, + freight_account_number=None, + integrator_id=None, + wsdl_path=None, + express_region_code=None, + use_test_server=False) +
(Constructor) +

+ 		source code  +
+ +

x.__init__(...) initializes x; see help(type(x)) for signature

+
+
Parameters:
+
    +
  • key (str) - Developer test key.
    • +
  • password (str) - The Fedex-generated password for your Web Systems account. This + is generally emailed to you after registration.
    • +
  • account_number (str) - The account number sent to you by Fedex after registering for Web + Services.
    • +
  • meter_number (str) - The meter number sent to you by Fedex after registering for Web + Services.
    • +
  • freight_account_number (str) - The freight account number sent to you by Fedex after registering + for Web Services.
    • +
  • integrator_id (str) - The integrator string sent to you by Fedex after registering for + Web Services.
    • +
  • wsdl_path (str) - In the event that you want to override the path to your WSDL + directory, do so with this argument.
    • +
  • use_test_server (bool) - When this is True, test server WSDLs are used instead of the + production server. You will also need to make sure that your FedexConfig object has a production account + number, meter number, authentication key, and password.
    • +
+
Overrides: + object.__init__ +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.printers-module.html b/docs/2.2.0/fedex.printers-module.html new file mode 100644 index 0000000..a1d4d71 --- /dev/null +++ b/docs/2.2.0/fedex.printers-module.html @@ -0,0 +1,168 @@ + + + + + fedex.printers + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package printers + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Package printers

source code

+

Optional classes used for the convenient printing of FedEx labels from + FedexProcessShipmentRequest objects. Each printer class + is more or less the same, following the pattern seen below (unless + otherwise documented).:

+
+   from fedex.printers.unix import DirectDevicePrinter
+   # Where shipment is an existing L{FedexProcessShipmentRequest} object.
+   shipment.send_request()
+   device = DirectDevicePrinter(shipment)
+   device.print_label()
+
+ + + + + + + + +
+ + + + + +
Submodules[hide private]
+
+
    +
  • fedex.printers.unix: This module provides a label printing wrapper class for Unix-based + installations.
    • +
+ +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = None +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.printers-pysrc.html b/docs/2.2.0/fedex.printers-pysrc.html new file mode 100644 index 0000000..fbaf950 --- /dev/null +++ b/docs/2.2.0/fedex.printers-pysrc.html @@ -0,0 +1,121 @@ + + + + + fedex.printers + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package printers + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Package fedex.printers

+
+ 1  """ 
+ 2  Optional classes used for the convenient printing of FedEx labels from 
+ 3  L{FedexProcessShipmentRequest} objects. Each printer class is more or less 
+ 4  the same, following the pattern seen below (unless otherwise documented).:: 
+ 5      from fedex.printers.unix import DirectDevicePrinter 
+ 6      # Where shipment is an existing L{FedexProcessShipmentRequest} object. 
+ 7      shipment.send_request() 
+ 8      device = DirectDevicePrinter(shipment) 
+ 9      device.print_label() 
+10  """ 
+11   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.printers.unix-module.html b/docs/2.2.0/fedex.printers.unix-module.html new file mode 100644 index 0000000..2cf5f77 --- /dev/null +++ b/docs/2.2.0/fedex.printers.unix-module.html @@ -0,0 +1,160 @@ + + + + + fedex.printers.unix + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package printers :: + Module unix + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module unix

source code

+

This module provides a label printing wrapper class for Unix-based + installations. By "Unix", we mean Linux, Mac OS, BSD, and + various flavors of Unix.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + DirectDevicePrinter
+ This class pipes the label data directly through a /dev/* entry. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.printers' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.printers.unix-pysrc.html b/docs/2.2.0/fedex.printers.unix-pysrc.html new file mode 100644 index 0000000..8a2c9b8 --- /dev/null +++ b/docs/2.2.0/fedex.printers.unix-pysrc.html @@ -0,0 +1,175 @@ + + + + + fedex.printers.unix + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package printers :: + Module unix + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.printers.unix

+
+ 1  """ 
+ 2  This module provides a label printing wrapper class for Unix-based 
+ 3  installations. By "Unix", we mean Linux, Mac OS, BSD, and various flavors 
+ 4  of Unix. 
+ 5  """ 
+ 6   
+ 7  import binascii 
+ 8   
+ 9   
+
10 -class DirectDevicePrinter(object): 
+
11      """ 
+12      This class pipes the label data directly through a /dev/* entry. 
+13      Consequently, this is very Unix/Linux specific. It *MAY* work on Mac too. 
+14      """ 
+15   
+
16 -    def __init__(self, shipment, device="/dev/ttyS0"): 
+
17          """ 
+18          Instantiates from a shipment object. You may optionally specify 
+19          a path to a /dev/ device. Defaults to /dev/ttyS0. 
+20           
+21          @type shipment: L{FedexProcessShipmentRequest} 
+22          @param shipment: A Fedex ProcessShipmentRequest object to pull the 
+23                           printed label data from. 
+24          """ 
+25   
+26          self.device = device 
+27          """@ivar: A string with the path to the device to print to.""" 
+28          self.shipment = shipment 
+29          """@ivar: A reference to the L{FedexProcessShipmentRequest} to print.""" 
+
30   
+
31 -    def print_label(self, package_num=None): 
+
32          """ 
+33          Prints all of a shipment's labels, or optionally just one. 
+34           
+35          @type package_num: L{int} 
+36          @param package_num: 0-based index of the package to print. This is 
+37                              only useful for shipments with more than one package. 
+38          """ 
+39   
+40          if package_num: 
+41              packages = [ 
+42                  self.shipment.response.CompletedShipmentDetail.CompletedPackageDetails[package_num] 
+43              ] 
+44          else: 
+45              packages = self.shipment.response.CompletedShipmentDetail.CompletedPackageDetails 
+46   
+47          for package in packages: 
+48              label_binary = binascii.a2b_base64(package.Label.Parts[0].Image) 
+49              self._print_base64(label_binary) 
+
50   
+
51 -    def _print_base64(self, base64_data): 
+
52          """ 
+53          Pipe the binary directly to the label printer. Works under Linux 
+54          without requiring PySerial. This is not typically something you 
+55          should call directly, unless you have special needs. 
+56           
+57          @type base64_data: L{str} 
+58          @param base64_data: The base64 encoded string for the label to print. 
+59          """ 
+60   
+61          label_file = open(self.device, "w") 
+62          label_file.write(base64_data) 
+63          label_file.close() 
+
64   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.printers.unix.DirectDevicePrinter-class.html b/docs/2.2.0/fedex.printers.unix.DirectDevicePrinter-class.html new file mode 100644 index 0000000..337b96b --- /dev/null +++ b/docs/2.2.0/fedex.printers.unix.DirectDevicePrinter-class.html @@ -0,0 +1,372 @@ + + + + + fedex.printers.unix.DirectDevicePrinter + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package printers :: + Module unix :: + Class DirectDevicePrinter + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class DirectDevicePrinter

source code

+
+object --+
+         |
+        DirectDevicePrinter
+
+ +
+

This class pipes the label data directly through a /dev/* entry. + Consequently, this is very Unix/Linux specific. It *MAY* work on Mac + too.

+ + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + shipment, + device='/dev/ttyS0')
+ Instantiates from a shipment object.		 + source code + +
+ +
+   + + + + + + +
print_label(self, + package_num=None)
+ Prints all of a shipment's labels, or optionally just one.		 + source code + +
+ +
+   + + + + + + +
_print_base64(self, + base64_data)
+ Pipe the binary directly to the label printer.		 + source code + +
+ +
+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + device
+ A string with the path to the device to print to. +
+   + + shipment
+ A reference to the FedexProcessShipmentRequest to print. +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + shipment, + device='/dev/ttyS0') +
(Constructor) +

+ 		source code  +
+ +

Instantiates from a shipment object. You may optionally specify a path + to a /dev/ device. Defaults to /dev/ttyS0.

+
+
Parameters:
+
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

print_label(self, + package_num=None) +

+ 		source code  +
+ +

Prints all of a shipment's labels, or optionally just one.

+
+
Parameters:
+
    +
  • package_num (int) - 0-based index of the package to print. This is only useful for + shipments with more than one package.
    • +
+
+
+
+ +
+ +
+ + +
+

_print_base64(self, + base64_data) +

+ 		source code  +
+ +

Pipe the binary directly to the label printer. Works under Linux + without requiring PySerial. This is not typically something you should + call directly, unless you have special needs.

+
+
Parameters:
+
    +
  • base64_data (str) - The base64 encoded string for the label to print.
    • +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services-module.html b/docs/2.2.0/fedex.services-module.html new file mode 100644 index 0000000..a5dc935 --- /dev/null +++ b/docs/2.2.0/fedex.services-module.html @@ -0,0 +1,165 @@ + + + + + fedex.services + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Package services

source code

+

This module contains the wrappers around Fedex Web Service requests + which you will want to instantiate and use with a FedexConfig + object supplying your static details. Each module here corresponds to a + Fedex WSDL.

+ + + + + + + + +
+ + + + + +
Submodules[hide private]
+
+
+ +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = None +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services-pysrc.html b/docs/2.2.0/fedex.services-pysrc.html new file mode 100644 index 0000000..71e7793 --- /dev/null +++ b/docs/2.2.0/fedex.services-pysrc.html @@ -0,0 +1,116 @@ + + + + + fedex.services + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Package fedex.services

+
+1  """ 
+2  This module contains the wrappers around Fedex Web Service requests which you 
+3  will want to instantiate and use with a L{FedexConfig} object supplying 
+4  your static details. Each module here corresponds to a Fedex WSDL. 
+5  """ 
+6   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.address_validation_service-module.html b/docs/2.2.0/fedex.services.address_validation_service-module.html new file mode 100644 index 0000000..22ee084 --- /dev/null +++ b/docs/2.2.0/fedex.services.address_validation_service-module.html @@ -0,0 +1,163 @@ + + + + + fedex.services.address_validation_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module address_validation_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module address_validation_service

source code

+

Address Validation Service Module

+

This package contains the shipping methods defined by Fedex's + AddressValidationService WSDL file. Each is encapsulated in a class for + easy access. For more details on each, refer to the respective class's + documentation.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexAddressValidationRequest
+ This class allows you validate anywhere from one to a hundred + addresses in one go. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.address_validation_service-pysrc.html b/docs/2.2.0/fedex.services.address_validation_service-pysrc.html new file mode 100644 index 0000000..7fe7590 --- /dev/null +++ b/docs/2.2.0/fedex.services.address_validation_service-pysrc.html @@ -0,0 +1,209 @@ + + + + + fedex.services.address_validation_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module address_validation_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.address_validation_service

+
+ 1  """ 
+ 2  Address Validation Service Module 
+ 3   
+ 4  This package contains the shipping methods defined by Fedex's  
+ 5  AddressValidationService WSDL file. Each is encapsulated in a class for  
+ 6  easy access. For more details on each, refer to the respective class's  
+ 7  documentation. 
+ 8  """ 
+ 9   
+10  import datetime 
+11  from ..base_service import FedexBaseService 
+12   
+13   
+
14 -class FedexAddressValidationRequest(FedexBaseService): 
+
15      """ 
+16      This class allows you validate anywhere from one to a hundred addresses 
+17      in one go. Create AddressToValidate WSDL objects and add them to each 
+18      instance of this request using add_address(). 
+19      """ 
+20   
+
21 -    def __init__(self, config_obj, *args, **kwargs): 
+
22          """ 
+23          @type config_obj: L{FedexConfig} 
+24          @param config_obj: A valid FedexConfig object.         
+25          """ 
+26   
+27          self._config_obj = config_obj 
+28          # Holds version info for the VersionId SOAP object. 
+29          self._version_info = { 
+30              'service_id': 'aval', 
+31              'major': '4', 
+32              'intermediate': '0', 
+33              'minor': '0' 
+34          } 
+35   
+36          self.AddressesToValidate = [] 
+37          """@ivar: Holds the AddressToValidate WSDL object.""" 
+38          # Call the parent FedexBaseService class for basic setup work. 
+39          super(FedexAddressValidationRequest, self).__init__( 
+40              self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs) 
+
41   
+
42 -    def _prepare_wsdl_objects(self): 
+
43          """ 
+44          Create the data structure and get it ready for the WSDL request. 
+45          """ 
+46          pass 
+
47   
+
49          """ 
+50          Fires off the Fedex request. 
+51           
+52          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),  
+53              WHICH RESIDES ON FedexBaseService AND IS INHERITED. 
+54          """ 
+55   
+56          # We get an exception like this when specifying an IntegratorId: 
+57          # suds.TypeNotFound: Type not found: 'IntegratorId' 
+58          # Setting it to None does not seem to appease it. 
+59          del self.ClientDetail.IntegratorId 
+60          self.logger.debug(self.WebAuthenticationDetail) 
+61          self.logger.debug(self.ClientDetail) 
+62          self.logger.debug(self.TransactionDetail) 
+63          self.logger.debug(self.VersionId) 
+64          # Fire off the query. 
+65          return self.client.service.addressValidation( 
+66              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+67              ClientDetail=self.ClientDetail, 
+68              TransactionDetail=self.TransactionDetail, 
+69              Version=self.VersionId, 
+70              InEffectAsOfTimestamp=datetime.datetime.now(), 
+71              AddressesToValidate=self.AddressesToValidate) 
+
72   
+
73 -    def add_address(self, address_item): 
+
74          """ 
+75          Adds an address to self.AddressesToValidate. 
+76           
+77          @type address_item: WSDL object, type of AddressToValidate WSDL object. 
+78          @keyword address_item: A AddressToValidate, created by 
+79              calling create_wsdl_object_of_type('AddressToValidate') on 
+80              this FedexAddressValidationRequest object.  
+81              See examples/create_shipment.py for more details. 
+82          """ 
+83   
+84          self.AddressesToValidate.append(address_item) 
+
85   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html b/docs/2.2.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html new file mode 100644 index 0000000..893ab21 --- /dev/null +++ b/docs/2.2.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html @@ -0,0 +1,425 @@ + + + + + fedex.services.address_validation_service.FedexAddressValidationRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module address_validation_service :: + Class FedexAddressValidationRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexAddressValidationRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexAddressValidationRequest
+
+ +
+

This class allows you validate anywhere from one to a hundred + addresses in one go. Create AddressToValidate WSDL objects and add them + to each instance of this request using add_address().

+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ This constructor should only be called by children of the class.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ Create the data structure and get it ready for the WSDL request.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+   + + + + + + +
add_address(self, + address_item)
+ Adds an address to self.AddressesToValidate.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + AddressesToValidate
+ Holds the AddressToValidate WSDL object. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

This constructor should only be called by children of the class. As is + such, only the optional keyword arguments caught by **kwargs + will be documented.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

Create the data structure and get it ready for the WSDL request.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+ +
+ +
+ + +
+

add_address(self, + address_item) +

+ 		source code  +
+ +

Adds an address to self.AddressesToValidate.

+
+
Parameters:
+
    +
  • address_item (WSDL object, type of AddressToValidate WSDL object.) - A AddressToValidate, created by calling + create_wsdl_object_of_type('AddressToValidate') on this + FedexAddressValidationRequest object. See + examples/create_shipment.py for more details.
    • +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.availability_commitment_service-module.html b/docs/2.2.0/fedex.services.availability_commitment_service-module.html new file mode 100644 index 0000000..c4bba57 --- /dev/null +++ b/docs/2.2.0/fedex.services.availability_commitment_service-module.html @@ -0,0 +1,162 @@ + + + + + fedex.services.availability_commitment_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module availability_commitment_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module availability_commitment_service

source code

+

Service Availability and Commitment Module

+

This package contains the shipping methods defined by Fedex's + ValidationAvailabilityAndCommitmentService WSDL file. Each is + encapsulated in a class for easy access. For more details on each, refer + to the respective class's documentation.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexAvailabilityCommitmentRequest
+ This class allows you validate service availability +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.availability_commitment_service-pysrc.html b/docs/2.2.0/fedex.services.availability_commitment_service-pysrc.html new file mode 100644 index 0000000..42f95ee --- /dev/null +++ b/docs/2.2.0/fedex.services.availability_commitment_service-pysrc.html @@ -0,0 +1,225 @@ + + + + + fedex.services.availability_commitment_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module availability_commitment_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.availability_commitment_service

+
+  1  """ 
+  2  Service Availability and Commitment Module 
+  3   
+  4  This package contains the shipping methods defined by Fedex's  
+  5  ValidationAvailabilityAndCommitmentService WSDL file. Each is encapsulated in a class for 
+  6  easy access. For more details on each, refer to the respective class's  
+  7  documentation. 
+  8  """ 
+  9   
+ 10  import datetime 
+ 11  from ..base_service import FedexBaseService 
+ 12   
+ 13   
+
 14 -class FedexAvailabilityCommitmentRequest(FedexBaseService): 
+
 15      """ 
+ 16      This class allows you validate service availability 
+ 17      """ 
+ 18   
+
 19 -    def __init__(self, config_obj, *args, **kwargs): 
+
 20          """ 
+ 21          @type config_obj: L{FedexConfig} 
+ 22          @param config_obj: A valid FedexConfig object.         
+ 23          """ 
+ 24   
+ 25          self._config_obj = config_obj 
+ 26          # Holds version info for the VersionId SOAP object. 
+ 27          self._version_info = { 
+ 28              'service_id': 'vacs', 
+ 29              'major': '4', 
+ 30              'intermediate': '0', 
+ 31              'minor': '0' 
+ 32          } 
+ 33   
+ 34          self.CarrierCode = None 
+ 35          """ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG.""" 
+ 36   
+ 37          self.Origin = None 
+ 38          """@ivar: Holds Origin Address WSDL object.""" 
+ 39   
+ 40          self.Destination = None 
+ 41          """@ivar: Holds Destination Address WSDL object.""" 
+ 42   
+ 43          self.ShipDate = None 
+ 44          """@ivar: Ship Date date WSDL object.""" 
+ 45   
+ 46          self.Service = None 
+ 47          """@ivar: Service type, if set to None will get all available service information.""" 
+ 48   
+ 49          self.Packaging = None 
+ 50          """@ivar: Type of packaging to narrow down available shipping options or defaults to YOUR_PACKAGING.""" 
+ 51   
+ 52          # Call the parent FedexBaseService class for basic setup work. 
+ 53          # Shortened the name of the wsdl, otherwise suds did not load it properly. 
+ 54          # Suds throws the following error when using the long file name from FedEx: 
+ 55          # 
+ 56          # File "/Library/Python/2.7/site-packages/suds/wsdl.py", line 878, in resolve 
+ 57          # raise Exception("binding '%s', not-found" % p.binding) 
+ 58          # Exception: binding 'ns:ValidationAvailabilityAndCommitmentServiceSoapBinding', not-found 
+ 59   
+ 60          super(FedexAvailabilityCommitmentRequest, self).__init__( 
+ 61              self._config_obj, 'AvailabilityAndCommitmentService_v4.wsdl', *args, **kwargs) 
+
 62   
+
 63 -    def _prepare_wsdl_objects(self): 
+
 64          """ 
+ 65          Create the data structure and get it ready for the WSDL request. 
+ 66          """ 
+ 67          self.CarrierCode = 'FDXE' 
+ 68          self.Origin = self.Destination = self.client.factory.create('Address') 
+ 69          self.ShipDate = datetime.date.today().isoformat() 
+ 70          self.Service = None 
+ 71          self.Packaging = 'YOUR_PACKAGING' 
+
 72   
+
 73 -    def _assemble_and_send_request(self): 
+
 74          """ 
+ 75          Fires off the Fedex request. 
+ 76           
+ 77          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),  
+ 78              WHICH RESIDES ON FedexBaseService AND IS INHERITED. 
+ 79          """ 
+ 80   
+ 81          # We get an exception like this when specifying an IntegratorId: 
+ 82          # suds.TypeNotFound: Type not found: 'IntegratorId' 
+ 83          # Setting it to None does not seem to appease it. 
+ 84          del self.ClientDetail.IntegratorId 
+ 85          self.logger.debug(self.WebAuthenticationDetail) 
+ 86          self.logger.debug(self.ClientDetail) 
+ 87          self.logger.debug(self.TransactionDetail) 
+ 88          self.logger.debug(self.VersionId) 
+ 89          # Fire off the query. 
+ 90          return self.client.service.serviceAvailability( 
+ 91              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+ 92              ClientDetail=self.ClientDetail, 
+ 93              TransactionDetail=self.TransactionDetail, 
+ 94              Version=self.VersionId, 
+ 95              Origin=self.Origin, 
+ 96              Destination=self.Destination, 
+ 97              ShipDate=self.ShipDate, 
+ 98              CarrierCode=self.CarrierCode, 
+ 99              Service=self.Service, 
+100              Packaging=self.Packaging) 
+
101   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html b/docs/2.2.0/fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html new file mode 100644 index 0000000..6bcc57b --- /dev/null +++ b/docs/2.2.0/fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html @@ -0,0 +1,420 @@ + + + + + fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module availability_commitment_service :: + Class FedexAvailabilityCommitmentRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexAvailabilityCommitmentRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexAvailabilityCommitmentRequest
+
+ +
+

This class allows you validate service availability

+ + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ This constructor should only be called by children of the class.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ Create the data structure and get it ready for the WSDL request.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + CarrierCode
+ ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG. +
+   + + Origin
+ Holds Origin Address WSDL object. +
+   + + Destination
+ Holds Destination Address WSDL object. +
+   + + ShipDate
+ Ship Date date WSDL object. +
+   + + Service
+ Service type, if set to None will get all available service + information. +
+   + + Packaging
+ Type of packaging to narrow down available shipping options or + defaults to YOUR_PACKAGING. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

This constructor should only be called by children of the class. As is + such, only the optional keyword arguments caught by **kwargs + will be documented.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

Create the data structure and get it ready for the WSDL request.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.country_service-module.html b/docs/2.2.0/fedex.services.country_service-module.html new file mode 100644 index 0000000..890c8c5 --- /dev/null +++ b/docs/2.2.0/fedex.services.country_service-module.html @@ -0,0 +1,162 @@ + + + + + fedex.services.country_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module country_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module country_service

source code

+

Country Service Module

+

This package contains the shipping methods defined by Fedex's + CountryService WSDL file. Each is encapsulated in a class for easy + access. For more details on each, refer to the respective class's + documentation.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexValidatePostalRequest
+ This class allows you validate an address. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.country_service-pysrc.html b/docs/2.2.0/fedex.services.country_service-pysrc.html new file mode 100644 index 0000000..e9b855f --- /dev/null +++ b/docs/2.2.0/fedex.services.country_service-pysrc.html @@ -0,0 +1,213 @@ + + + + + fedex.services.country_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module country_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.country_service

+
+ 1  """ 
+ 2  Country Service Module 
+ 3   
+ 4  This package contains the shipping methods defined by Fedex's  
+ 5  CountryService WSDL file. Each is encapsulated in a class for 
+ 6  easy access. For more details on each, refer to the respective class's  
+ 7  documentation. 
+ 8  """ 
+ 9   
+10  import datetime 
+11  from ..base_service import FedexBaseService 
+12   
+13   
+
14 -class FedexValidatePostalRequest(FedexBaseService): 
+
15      """ 
+16      This class allows you validate an address. 
+17      https://www.fedex.com/us/developer/WebHelp/ws/2015/html/WebServicesHelp/WSDVG/47_Country_Service.htm 
+18      """ 
+19   
+
20 -    def __init__(self, config_obj, *args, **kwargs): 
+
21          """ 
+22          @type config_obj: L{FedexConfig} 
+23          @param config_obj: A valid FedexConfig object.         
+24          """ 
+25   
+26          self._config_obj = config_obj 
+27          # Holds version info for the VersionId SOAP object. 
+28          self._version_info = { 
+29              'service_id': 'cnty', 
+30              'major': '4', 
+31              'intermediate': '0', 
+32              'minor': '0' 
+33          } 
+34   
+35          self.CarrierCode = None 
+36          """ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG.""" 
+37   
+38          self.RoutingCode = None 
+39          """ivar: Routing Code Default to FDSD.""" 
+40   
+41          self.Address = None 
+42          """@ivar: Holds Address WSDL objects.""" 
+43   
+44          self.ShipDateTime = None 
+45          """@ivar: Holds the ShipDateTime date time objects.""" 
+46   
+47          self.CheckForMismatch = 1 
+48          """@ivar: Holds the CheckForMismatch boolean objects.""" 
+49   
+50          super(FedexValidatePostalRequest, self).__init__( 
+51              self._config_obj, 'CountryService_v4.wsdl', *args, **kwargs) 
+
52   
+
53 -    def _prepare_wsdl_objects(self): 
+
54          """ 
+55          Create the data structure and get it ready for the WSDL request. 
+56          """ 
+57          self.CarrierCode = 'FDXE' 
+58          self.RoutingCode = 'FDSD' 
+59          self.Address = self.client.factory.create('Address') 
+60          self.ShipDateTime = datetime.datetime.now().isoformat() 
+
61   
+
63          """ 
+64          Fires off the Fedex request. 
+65           
+66          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),  
+67              WHICH RESIDES ON FedexBaseService AND IS INHERITED. 
+68          """ 
+69   
+70          # We get an exception like this when specifying an IntegratorId: 
+71          # suds.TypeNotFound: Type not found: 'IntegratorId' 
+72          # Setting it to None does not seem to appease it. 
+73          del self.ClientDetail.IntegratorId 
+74          self.logger.debug(self.WebAuthenticationDetail) 
+75          self.logger.debug(self.ClientDetail) 
+76          self.logger.debug(self.TransactionDetail) 
+77          self.logger.debug(self.VersionId) 
+78          # Fire off the query. 
+79          return self.client.service.validatePostal( 
+80              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+81              ClientDetail=self.ClientDetail, 
+82              TransactionDetail=self.TransactionDetail, 
+83              Version=self.VersionId, 
+84              Address=self.Address, 
+85              ShipDateTime=self.ShipDateTime, 
+86              CarrierCode=self.CarrierCode, 
+87              CheckForMismatch=self.CheckForMismatch, 
+88              RoutingCode=self.RoutingCode) 
+
89   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.country_service.FedexValidatePostalRequest-class.html b/docs/2.2.0/fedex.services.country_service.FedexValidatePostalRequest-class.html new file mode 100644 index 0000000..4201094 --- /dev/null +++ b/docs/2.2.0/fedex.services.country_service.FedexValidatePostalRequest-class.html @@ -0,0 +1,411 @@ + + + + + fedex.services.country_service.FedexValidatePostalRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module country_service :: + Class FedexValidatePostalRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexValidatePostalRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexValidatePostalRequest
+
+ +
+

This class allows you validate an address. + https://www.fedex.com/us/developer/WebHelp/ws/2015/html/WebServicesHelp/WSDVG/47_Country_Service.htm

+ + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ This constructor should only be called by children of the class.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ Create the data structure and get it ready for the WSDL request.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + CarrierCode
+ ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG. +
+   + + RoutingCode
+ ivar: Routing Code Default to FDSD. +
+   + + Address
+ Holds Address WSDL objects. +
+   + + ShipDateTime
+ Holds the ShipDateTime date time objects. +
+   + + CheckForMismatch
+ Holds the CheckForMismatch boolean objects. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

This constructor should only be called by children of the class. As is + such, only the optional keyword arguments caught by **kwargs + will be documented.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

Create the data structure and get it ready for the WSDL request.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.package_movement-module.html b/docs/2.2.0/fedex.services.package_movement-module.html new file mode 100644 index 0000000..c4079e8 --- /dev/null +++ b/docs/2.2.0/fedex.services.package_movement-module.html @@ -0,0 +1,178 @@ + + + + + fedex.services.package_movement + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module package_movement + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module package_movement

source code

+

Package Movement Information Service

+

This package contains classes to check service availability, route, + and postal codes. Defined by the PackageMovementInformationService WSDL + file.

+ + + + + + + + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexPostalCodeNotFound
+ Exception: Sent when the postalcode is missing. +
+   + + FedexInvalidPostalCodeFormat
+ Exception: Sent when the postal code is invalid +
+   + + PostalCodeInquiryRequest
+ The postal code inquiry enables customers to validate postal codes + and service commitments. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.package_movement-pysrc.html b/docs/2.2.0/fedex.services.package_movement-pysrc.html new file mode 100644 index 0000000..7619c89 --- /dev/null +++ b/docs/2.2.0/fedex.services.package_movement-pysrc.html @@ -0,0 +1,229 @@ + + + + + fedex.services.package_movement + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module package_movement + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.package_movement

+
+  1  """ 
+  2  Package Movement Information Service 
+  3   
+  4  This package contains classes to check service availability, route, and postal 
+  5  codes. Defined by the PackageMovementInformationService WSDL file.  
+  6  """ 
+  7  import logging 
+  8  from ..base_service import FedexBaseService, FedexError 
+  9   
+ 10   
+
 11 -class FedexPostalCodeNotFound(FedexError): 
+
 12      """ 
+ 13      Exception: Sent when the postalcode is missing. 
+ 14      """ 
+ 15      pass 
+
 16   
+ 17   
+
 18 -class FedexInvalidPostalCodeFormat(FedexError): 
+
 19      """ 
+ 20      Exception: Sent when the postal code is invalid 
+ 21      """ 
+ 22      pass 
+
 23   
+ 24   
+
 25 -class PostalCodeInquiryRequest(FedexBaseService): 
+
 26      """ 
+ 27      The postal code inquiry enables customers to validate postal codes 
+ 28      and service commitments. 
+ 29      """ 
+ 30   
+
 31 -    def __init__(self, config_obj, postal_code=None, country_code=None, *args, **kwargs): 
+
 32          """ 
+ 33          Sets up an inquiry request. The optional keyword args 
+ 34          detailed on L{FedexBaseService} apply here as well. 
+ 35           
+ 36          @type config_obj: L{FedexConfig} 
+ 37          @param config_obj: A valid FedexConfig object 
+ 38          @param postal_code: a valid postal code 
+ 39          @param country_code: ISO country code to which the postal code belongs to. 
+ 40          """ 
+ 41          self._config_obj = config_obj 
+ 42   
+ 43          # Holds version info for the VersionId SOAP object. 
+ 44          self._version_info = {'service_id': 'pmis', 'major': '4', 
+ 45                                'intermediate': '0', 'minor': '0'} 
+ 46          self.PostalCode = postal_code 
+ 47          self.CountryCode = country_code 
+ 48   
+ 49          # Call the parent FedexBaseService class for basic setup work. 
+ 50          super(PostalCodeInquiryRequest, self).__init__(self._config_obj, 
+ 51                                                         'PackageMovementInformationService_v4.wsdl', 
+ 52                                                         *args, **kwargs) 
+
 53   
+
 55          """ 
+ 56          Checks the response to see if there were any errors specific to 
+ 57          this WSDL. 
+ 58          """ 
+ 59          if self.response.HighestSeverity == "ERROR": 
+ 60              for notification in self.response.Notifications:  # pragma: no cover 
+ 61                  if notification.Severity == "ERROR": 
+ 62                      if "Postal Code Not Found" in notification.Message: 
+ 63                          raise FedexPostalCodeNotFound(notification.Code, 
+ 64                                                        notification.Message) 
+ 65   
+ 66                      elif "Invalid Postal Code Format" in self.response.Notifications: 
+ 67                          raise FedexInvalidPostalCodeFormat(notification.Code, 
+ 68                                                             notification.Message) 
+ 69                      else: 
+ 70                          raise FedexError(notification.Code, 
+ 71                                           notification.Message) 
+
 72   
+
 73 -    def _prepare_wsdl_objects(self): 
+
 74          """ 
+ 75          Preps the WSDL data structures for the user. 
+ 76          """ 
+ 77   
+ 78          self.CarrierCode = 'FDXE' 
+
 79   
+
 80 -    def _assemble_and_send_request(self): 
+
 81          """ 
+ 82          Fires off the Fedex request. 
+ 83           
+ 84          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES 
+ 85              ON FedexBaseService AND IS INHERITED. 
+ 86          """ 
+ 87          client = self.client 
+ 88   
+ 89          # We get an exception like this when specifying an IntegratorId: 
+ 90          # suds.TypeNotFound: Type not found: 'IntegratorId' 
+ 91          # Setting it to None does not seem to appease it. 
+ 92   
+ 93          del self.ClientDetail.IntegratorId 
+ 94   
+ 95          # Fire off the query. 
+ 96          response = client.service.postalCodeInquiry(WebAuthenticationDetail=self.WebAuthenticationDetail, 
+ 97                                                      ClientDetail=self.ClientDetail, 
+ 98                                                      TransactionDetail=self.TransactionDetail, 
+ 99                                                      Version=self.VersionId, 
+100                                                      PostalCode=self.PostalCode, 
+101                                                      CountryCode=self.CountryCode, 
+102                                                      CarrierCode=self.CarrierCode) 
+103   
+104          return response 
+
105   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html b/docs/2.2.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html new file mode 100644 index 0000000..74b1cb0 --- /dev/null +++ b/docs/2.2.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html @@ -0,0 +1,199 @@ + + + + + fedex.services.package_movement.FedexInvalidPostalCodeFormat + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module package_movement :: + Class FedexInvalidPostalCodeFormat + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexInvalidPostalCodeFormat

source code

+
+                    object --+                
+                             |                
+      exceptions.BaseException --+            
+                                 |            
+              exceptions.Exception --+        
+                                     |        
+base_service.FedexBaseServiceException --+    
+                                         |    
+                   base_service.FedexError --+
+                                             |
+                                            FedexInvalidPostalCodeFormat
+
+ +
+

Exception: Sent when the postal code is invalid

+ + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+

Inherited from base_service.FedexBaseServiceException: + __init__, + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html b/docs/2.2.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html new file mode 100644 index 0000000..c982a0b --- /dev/null +++ b/docs/2.2.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html @@ -0,0 +1,199 @@ + + + + + fedex.services.package_movement.FedexPostalCodeNotFound + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module package_movement :: + Class FedexPostalCodeNotFound + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexPostalCodeNotFound

source code

+
+                    object --+                
+                             |                
+      exceptions.BaseException --+            
+                                 |            
+              exceptions.Exception --+        
+                                     |        
+base_service.FedexBaseServiceException --+    
+                                         |    
+                   base_service.FedexError --+
+                                             |
+                                            FedexPostalCodeNotFound
+
+ +
+

Exception: Sent when the postalcode is missing.

+ + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+

Inherited from base_service.FedexBaseServiceException: + __init__, + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html b/docs/2.2.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html new file mode 100644 index 0000000..066d52e --- /dev/null +++ b/docs/2.2.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html @@ -0,0 +1,415 @@ + + + + + fedex.services.package_movement.PostalCodeInquiryRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module package_movement :: + Class PostalCodeInquiryRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class PostalCodeInquiryRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               PostalCodeInquiryRequest
+
+ +
+

The postal code inquiry enables customers to validate postal codes and + service commitments.

+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + postal_code=None, + country_code=None, + *args, + **kwargs)
+ Sets up an inquiry request.		 + source code + +
+ +
+   + + + + + + +
_check_response_for_request_errors(self)
+ Checks the response to see if there were any errors specific to this + WSDL.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ Preps the WSDL data structures for the user.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + postal_code=None, + country_code=None, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

Sets up an inquiry request. The optional keyword args detailed on FedexBaseService apply here as well.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object
    • +
  • postal_code - a valid postal code
    • +
  • country_code - ISO country code to which the postal code belongs to.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_check_response_for_request_errors(self) +

+ 		source code  +
+ +

Checks the response to see if there were any errors specific to this + WSDL.

+
+
Overrides: + base_service.FedexBaseService._check_response_for_request_errors +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

Preps the WSDL data structures for the user.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.rate_service-module.html b/docs/2.2.0/fedex.services.rate_service-module.html new file mode 100644 index 0000000..093efb1 --- /dev/null +++ b/docs/2.2.0/fedex.services.rate_service-module.html @@ -0,0 +1,162 @@ + + + + + fedex.services.rate_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module rate_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module rate_service

source code

+

Rate Service Module

+

This package contains classes to request pre-ship rating information + and to determine estimated or courtesy billing quotes. Time in Transit + can be returned with the rates if it is specified in the request.

+ + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexRateServiceRequest
+ This class allows you to get the shipping charges for a particular + address. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.rate_service-pysrc.html b/docs/2.2.0/fedex.services.rate_service-pysrc.html new file mode 100644 index 0000000..6ee3305 --- /dev/null +++ b/docs/2.2.0/fedex.services.rate_service-pysrc.html @@ -0,0 +1,250 @@ + + + + + fedex.services.rate_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module rate_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.rate_service

+
+  1  """ 
+  2  Rate Service Module 
+  3   
+  4  This package contains classes to request pre-ship rating information and to 
+  5  determine estimated or courtesy billing quotes. Time in Transit can be 
+  6  returned with the rates if it is specified in the request. 
+  7  """ 
+  8   
+  9  import datetime 
+ 10  from ..base_service import FedexBaseService 
+ 11   
+ 12   
+
 13 -class FedexRateServiceRequest(FedexBaseService): 
+
 14      """ 
+ 15      This class allows you to get the shipping charges for a particular address.  
+ 16      You will need to populate the data structures in self.RequestedShipment,  
+ 17      then send the request. 
+ 18      """ 
+ 19   
+
 20 -    def __init__(self, config_obj, *args, **kwargs): 
+
 21          """ 
+ 22          The optional keyword args detailed on L{FedexBaseService}  
+ 23          apply here as well. 
+ 24   
+ 25          @type config_obj: L{FedexConfig} 
+ 26          @param config_obj: A valid FedexConfig object.         
+ 27          """ 
+ 28   
+ 29          self._config_obj = config_obj 
+ 30   
+ 31          # Holds version info for the VersionId SOAP object. 
+ 32          self._version_info = {'service_id': 'crs', 'major': '18', 
+ 33                                'intermediate': '0', 'minor': '0'} 
+ 34   
+ 35          self.RequestedShipment = None 
+ 36          """@ivar: Holds the RequestedShipment WSDL object including the shipper, recipient and shipt time.""" 
+ 37          # Call the parent FedexBaseService class for basic setup work. 
+ 38          super(FedexRateServiceRequest, self).__init__( 
+ 39              self._config_obj, 'RateService_v18.wsdl', *args, **kwargs) 
+ 40          self.ClientDetail.Region = config_obj.express_region_code 
+ 41          """@ivar: Holds the express region code from the config object.""" 
+
 42   
+
 43 -    def _prepare_wsdl_objects(self): 
+
 44          """ 
+ 45          This is the data that will be used to create your shipment. Create 
+ 46          the data structure and get it ready for the WSDL request. 
+ 47          """ 
+ 48   
+ 49          # Default behavior is to not request transit information 
+ 50          self.ReturnTransitAndCommit = False 
+ 51   
+ 52          # This is the primary data structure for processShipment requests. 
+ 53          self.RequestedShipment = self.client.factory.create('RequestedShipment') 
+ 54          self.RequestedShipment.ShipTimestamp = datetime.datetime.now() 
+ 55   
+ 56          # Defaults for TotalWeight wsdl object. 
+ 57          total_weight = self.client.factory.create('Weight') 
+ 58          # Start at nothing. 
+ 59          total_weight.Value = 0.0 
+ 60          # Default to pounds. 
+ 61          total_weight.Units = 'LB' 
+ 62          # This is the total weight of the entire shipment. Shipments may 
+ 63          # contain more than one package. 
+ 64          self.RequestedShipment.TotalWeight = total_weight 
+ 65   
+ 66          # This is the top level data structure for Shipper information. 
+ 67          shipper = self.client.factory.create('Party') 
+ 68          shipper.Address = self.client.factory.create('Address') 
+ 69          shipper.Contact = self.client.factory.create('Contact') 
+ 70   
+ 71          # Link the ShipperParty to our master data structure. 
+ 72          self.RequestedShipment.Shipper = shipper 
+ 73   
+ 74          # This is the top level data structure for Recipient information. 
+ 75          recipient_party = self.client.factory.create('Party') 
+ 76          recipient_party.Contact = self.client.factory.create('Contact') 
+ 77          recipient_party.Address = self.client.factory.create('Address') 
+ 78          # Link the RecipientParty object to our master data structure. 
+ 79          self.RequestedShipment.Recipient = recipient_party 
+ 80   
+ 81          # Make sender responsible for payment by default. 
+ 82          self.RequestedShipment.ShippingChargesPayment = self.create_wsdl_object_of_type('Payment') 
+ 83          self.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER' 
+ 84   
+ 85          # Start with no packages, user must add them. 
+ 86          self.RequestedShipment.PackageCount = 0 
+ 87          self.RequestedShipment.RequestedPackageLineItems = [] 
+ 88   
+ 89          # This is good to review if you'd like to see what the data structure 
+ 90          # looks like. 
+ 91          self.logger.debug(self.RequestedShipment) 
+
 92   
+
 93 -    def _assemble_and_send_request(self): 
+
 94          """ 
+ 95          Fires off the Fedex request. 
+ 96           
+ 97          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),  
+ 98              WHICH RESIDES ON FedexBaseService AND IS INHERITED. 
+ 99          """ 
+100   
+101          # Fire off the query. 
+102          return self.client.service.getRates( 
+103              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+104              ClientDetail=self.ClientDetail, 
+105              TransactionDetail=self.TransactionDetail, 
+106              Version=self.VersionId, 
+107              RequestedShipment=self.RequestedShipment, 
+108              ReturnTransitAndCommit=self.ReturnTransitAndCommit) 
+
109   
+
110 -    def add_package(self, package_item): 
+
111          """ 
+112          Adds a package to the ship request. 
+113           
+114          @type package_item: WSDL object, type of RequestedPackageLineItem  
+115              WSDL object. 
+116          @keyword package_item: A RequestedPackageLineItem, created by 
+117              calling create_wsdl_object_of_type('RequestedPackageLineItem') on 
+118              this ShipmentRequest object. See examples/create_shipment.py for 
+119              more details. 
+120          """ 
+121   
+122          self.RequestedShipment.RequestedPackageLineItems.append(package_item) 
+123          package_weight = package_item.Weight.Value 
+124          self.RequestedShipment.TotalWeight.Value += package_weight 
+125          self.RequestedShipment.PackageCount += 1 
+
126   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.rate_service.FedexRateServiceRequest-class.html b/docs/2.2.0/fedex.services.rate_service.FedexRateServiceRequest-class.html new file mode 100644 index 0000000..07c4b98 --- /dev/null +++ b/docs/2.2.0/fedex.services.rate_service.FedexRateServiceRequest-class.html @@ -0,0 +1,429 @@ + + + + + fedex.services.rate_service.FedexRateServiceRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module rate_service :: + Class FedexRateServiceRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexRateServiceRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexRateServiceRequest
+
+ +
+

This class allows you to get the shipping charges for a particular + address. You will need to populate the data structures in + self.RequestedShipment, then send the request.

+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ The optional keyword args detailed on FedexBaseService apply here as well.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ This is the data that will be used to create your shipment.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+   + + + + + + +
add_package(self, + package_item)
+ Adds a package to the ship request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + RequestedShipment
+ Holds the RequestedShipment WSDL object including the shipper, + recipient and shipt time. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

The optional keyword args detailed on FedexBaseService apply here as well.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

This is the data that will be used to create your shipment. Create the + data structure and get it ready for the WSDL request.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+ +
+ +
+ + +
+

add_package(self, + package_item) +

+ 		source code  +
+ +

Adds a package to the ship request.

+
+
Parameters:
+
    +
  • package_item (WSDL object, type of RequestedPackageLineItem WSDL object.) - A RequestedPackageLineItem, created by calling + create_wsdl_object_of_type('RequestedPackageLineItem') on this + ShipmentRequest object. See examples/create_shipment.py for more + details.
    • +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.ship_service-module.html b/docs/2.2.0/fedex.services.ship_service-module.html new file mode 100644 index 0000000..a972912 --- /dev/null +++ b/docs/2.2.0/fedex.services.ship_service-module.html @@ -0,0 +1,171 @@ + + + + + fedex.services.ship_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module ship_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module ship_service

source code

+

Ship Service Module

+

This package contains the shipping methods defined by Fedex's + ShipService WSDL file. Each is encapsulated in a class for easy access. + For more details on each, refer to the respective class's + documentation.

+ + + + + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexProcessShipmentRequest
+ This class allows you to process (create) a new FedEx shipment. +
+   + + FedexDeleteShipmentRequest
+ This class allows you to delete a shipment, given a tracking + number. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.ship_service-pysrc.html b/docs/2.2.0/fedex.services.ship_service-pysrc.html new file mode 100644 index 0000000..151b29f --- /dev/null +++ b/docs/2.2.0/fedex.services.ship_service-pysrc.html @@ -0,0 +1,355 @@ + + + + + fedex.services.ship_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module ship_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.ship_service

+
+  1  """ 
+  2  Ship Service Module 
+  3   
+  4  This package contains the shipping methods defined by Fedex's  
+  5  ShipService WSDL file. Each is encapsulated in a class for easy access.  
+  6  For more details on each, refer to the respective class's documentation. 
+  7  """ 
+  8   
+  9  import datetime 
+ 10  from ..base_service import FedexBaseService 
+ 11   
+ 12   
+
 13 -class FedexProcessShipmentRequest(FedexBaseService): 
+
 14      """ 
+ 15      This class allows you to process (create) a new FedEx shipment. You will 
+ 16      need to populate the data structures in self.RequestedShipment, then 
+ 17      send the request. Label printing is supported and very configurable, 
+ 18      returning an ASCII representation with the response as well. 
+ 19      """ 
+ 20   
+
 21 -    def __init__(self, config_obj, *args, **kwargs): 
+
 22          """ 
+ 23          The optional keyword args detailed on L{FedexBaseService}  
+ 24          apply here as well. 
+ 25   
+ 26          @type config_obj: L{FedexConfig} 
+ 27          @param config_obj: A valid FedexConfig object.         
+ 28          """ 
+ 29   
+ 30          self._config_obj = config_obj 
+ 31          # Holds version info for the VersionId SOAP object. 
+ 32          self._version_info = { 
+ 33              'service_id': 'ship', 
+ 34              'major': '17', 
+ 35              'intermediate': '0', 
+ 36              'minor': '0' 
+ 37          } 
+ 38          self.RequestedShipment = None 
+ 39          """@ivar: Holds the RequestedShipment WSDL object.""" 
+ 40          # Call the parent FedexBaseService class for basic setup work. 
+ 41          super(FedexProcessShipmentRequest, self).__init__( 
+ 42              self._config_obj, 'ShipService_v17.wsdl', *args, **kwargs) 
+
 43   
+
 44 -    def _prepare_wsdl_objects(self): 
+
 45          """ 
+ 46          This is the data that will be used to create your shipment. Create 
+ 47          the data structure and get it ready for the WSDL request. 
+ 48          """ 
+ 49   
+ 50          # This is the primary data structure for processShipment requests. 
+ 51          self.RequestedShipment = self.client.factory.create('RequestedShipment') 
+ 52          self.RequestedShipment.ShipTimestamp = datetime.datetime.now() 
+ 53   
+ 54          # Defaults for TotalWeight wsdl object. 
+ 55          total_weight = self.client.factory.create('Weight') 
+ 56          # Start at nothing. 
+ 57          total_weight.Value = 0.0 
+ 58          # Default to pounds. 
+ 59          total_weight.Units = 'LB' 
+ 60          # This is the total weight of the entire shipment. Shipments may 
+ 61          # contain more than one package. 
+ 62          self.RequestedShipment.TotalWeight = total_weight 
+ 63   
+ 64          # This is the top level data structure Shipper Party information. 
+ 65          shipper_party = self.client.factory.create('Party') 
+ 66          shipper_party.Address = self.client.factory.create('Address') 
+ 67          shipper_party.Contact = self.client.factory.create('Contact') 
+ 68   
+ 69          # Link the Shipper Party to our master data structure. 
+ 70          self.RequestedShipment.Shipper = shipper_party 
+ 71   
+ 72          # This is the top level data structure for RecipientParty information. 
+ 73          recipient_party = self.client.factory.create('Party') 
+ 74          recipient_party.Contact = self.client.factory.create('Contact') 
+ 75          recipient_party.Address = self.client.factory.create('Address') 
+ 76   
+ 77          # Link the RecipientParty object to our master data structure. 
+ 78          self.RequestedShipment.Recipient = recipient_party 
+ 79   
+ 80          payor = self.client.factory.create('Payor') 
+ 81          # Grab the account number from the FedexConfig object by default. 
+ 82          # Assume US. 
+ 83          payor.ResponsibleParty = self.client.factory.create('Party') 
+ 84          payor.ResponsibleParty.Address = self.client.factory.create('Address') 
+ 85          payor.ResponsibleParty.Address.CountryCode = 'US' 
+ 86   
+ 87          # ShippingChargesPayment WSDL object default values. 
+ 88          shipping_charges_payment = self.client.factory.create('Payment') 
+ 89          shipping_charges_payment.Payor = payor 
+ 90          shipping_charges_payment.PaymentType = 'SENDER' 
+ 91          self.RequestedShipment.ShippingChargesPayment = shipping_charges_payment 
+ 92   
+ 93          self.RequestedShipment.LabelSpecification = self.client.factory.create('LabelSpecification') 
+ 94   
+ 95          # NONE, PREFERRED or LIST 
+ 96          self.RequestedShipment.RateRequestTypes = ['PREFERRED'] 
+ 97   
+ 98          # Start with no packages, user must add them. 
+ 99          self.RequestedShipment.PackageCount = 0 
+100          self.RequestedShipment.RequestedPackageLineItems = [] 
+101   
+102          # This is good to review if you'd like to see what the data structure 
+103          # looks like. 
+104          self.logger.debug(self.RequestedShipment) 
+
105   
+
106 -    def send_validation_request(self): 
+
107          """ 
+108          This is very similar to just sending the shipment via the typical 
+109          send_request() function, but this doesn't create a shipment. It is 
+110          used to make sure "good" values are given by the user or the 
+111          application using the library. 
+112          """ 
+113   
+114          self.send_request(send_function=self._assemble_and_send_validation_request) 
+
115   
+
117          """ 
+118          Fires off the Fedex shipment validation request. 
+119           
+120          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL  
+121              send_validation_request(), WHICH RESIDES ON FedexBaseService  
+122              AND IS INHERITED. 
+123          """ 
+124   
+125          # Fire off the query. 
+126          return self.client.service.validateShipment( 
+127              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+128              ClientDetail=self.ClientDetail, 
+129              TransactionDetail=self.TransactionDetail, 
+130              Version=self.VersionId, 
+131              RequestedShipment=self.RequestedShipment) 
+
132   
+
133 -    def _assemble_and_send_request(self): 
+
134          """ 
+135          Fires off the Fedex request. 
+136           
+137          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),  
+138              WHICH RESIDES ON FedexBaseService AND IS INHERITED. 
+139          """ 
+140   
+141          # Fire off the query. 
+142          return self.client.service.processShipment( 
+143              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+144              ClientDetail=self.ClientDetail, 
+145              TransactionDetail=self.TransactionDetail, 
+146              Version=self.VersionId, 
+147              RequestedShipment=self.RequestedShipment) 
+
148   
+
149 -    def add_package(self, package_item): 
+
150          """ 
+151          Adds a package to the ship request. 
+152           
+153          @type package_item: WSDL object, type of RequestedPackageLineItem  
+154              WSDL object. 
+155          @keyword package_item: A RequestedPackageLineItem, created by 
+156              calling create_wsdl_object_of_type('RequestedPackageLineItem') on 
+157              this ShipmentRequest object. See examples/create_shipment.py for 
+158              more details. 
+159          """ 
+160   
+161          self.RequestedShipment.RequestedPackageLineItems.append(package_item) 
+162          package_weight = package_item.Weight.Value 
+163          self.RequestedShipment.TotalWeight.Value += package_weight 
+164          self.RequestedShipment.PackageCount += 1 
+
165   
+166   
+
167 -class FedexDeleteShipmentRequest(FedexBaseService): 
+
168      """ 
+169      This class allows you to delete a shipment, given a tracking number. 
+170      """ 
+171   
+
172 -    def __init__(self, config_obj, *args, **kwargs): 
+
173          """ 
+174          Deletes a shipment via a tracking number. 
+175          """ 
+176   
+177          self._config_obj = config_obj 
+178   
+179          # Holds version info for the VersionId SOAP object. 
+180          self._version_info = {'service_id': 'ship', 'major': '17', 
+181                                'intermediate': '0', 'minor': '0'} 
+182          self.DeletionControlType = None 
+183          """@ivar: Holds the DeletrionControlType WSDL object.""" 
+184          self.TrackingId = None 
+185          """@ivar: Holds the TrackingId WSDL object.""" 
+186          # Call the parent FedexBaseService class for basic setup work. 
+187          super(FedexDeleteShipmentRequest, self).__init__(self._config_obj, 
+188                                                           'ShipService_v17.wsdl', 
+189                                                           *args, **kwargs) 
+
190   
+
191 -    def _prepare_wsdl_objects(self): 
+
192          """ 
+193          Preps the WSDL data structures for the user. 
+194          """ 
+195   
+196          self.DeletionControlType = self.client.factory.create('DeletionControlType') 
+197          self.TrackingId = self.client.factory.create('TrackingId') 
+198          self.TrackingId.TrackingIdType = self.client.factory.create('TrackingIdType') 
+
199   
+
200 -    def _assemble_and_send_request(self): 
+
201          """ 
+202          Fires off the Fedex request. 
+203           
+204          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES 
+205              ON FedexBaseService AND IS INHERITED. 
+206          """ 
+207   
+208          client = self.client 
+209          # Fire off the query. 
+210          return client.service.deleteShipment( 
+211              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+212              ClientDetail=self.ClientDetail, 
+213              TransactionDetail=self.TransactionDetail, 
+214              Version=self.VersionId, 
+215              ShipTimestamp=datetime.datetime.now(), 
+216              TrackingId=self.TrackingId, 
+217              DeletionControl=self.DeletionControlType) 
+
218   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html b/docs/2.2.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html new file mode 100644 index 0000000..1b031a2 --- /dev/null +++ b/docs/2.2.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html @@ -0,0 +1,386 @@ + + + + + fedex.services.ship_service.FedexDeleteShipmentRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module ship_service :: + Class FedexDeleteShipmentRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexDeleteShipmentRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexDeleteShipmentRequest
+
+ +
+

This class allows you to delete a shipment, given a tracking + number.

+ + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ Deletes a shipment via a tracking number.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ Preps the WSDL data structures for the user.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + DeletionControlType
+ Holds the DeletrionControlType WSDL object. +
+   + + TrackingId
+ Holds the TrackingId WSDL object. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

Deletes a shipment via a tracking number.

+
+
Parameters:
+
    +
  • customer_transaction_id - A user-specified identifier to differentiate this transaction + from others. This value will be returned with the response from + Fedex.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

Preps the WSDL data structures for the user.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html b/docs/2.2.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html new file mode 100644 index 0000000..9f45aa4 --- /dev/null +++ b/docs/2.2.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html @@ -0,0 +1,509 @@ + + + + + fedex.services.ship_service.FedexProcessShipmentRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module ship_service :: + Class FedexProcessShipmentRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexProcessShipmentRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexProcessShipmentRequest
+
+ +
+

This class allows you to process (create) a new FedEx shipment. You + will need to populate the data structures in self.RequestedShipment, then + send the request. Label printing is supported and very configurable, + returning an ASCII representation with the response as well.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ The optional keyword args detailed on FedexBaseService apply here as well.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ This is the data that will be used to create your shipment.		 + source code + +
+ +
+   + + + + + + +
send_validation_request(self)
+ This is very similar to just sending the shipment via the typical + send_request() function, but this doesn't create a shipment.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_validation_request(self)
+ Fires off the Fedex shipment validation request.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+   + + + + + + +
add_package(self, + package_item)
+ Adds a package to the ship request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from base_service.FedexBaseService (private): + _check_response_for_request_errors +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + RequestedShipment
+ Holds the RequestedShipment WSDL object. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

The optional keyword args detailed on FedexBaseService apply here as well.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

This is the data that will be used to create your shipment. Create the + data structure and get it ready for the WSDL request.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

send_validation_request(self) +

+ 		source code  +
+ +

This is very similar to just sending the shipment via the typical + send_request() function, but this doesn't create a shipment. It is used + to make sure "good" values are given by the user or the + application using the library.

+
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_validation_request(self) +

+ 		source code  +
+ +

Fires off the Fedex shipment validation request.

+
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_validation_request(), + WHICH RESIDES ON FedexBaseService AND IS INHERITED. +

+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+ +
+ +
+ + +
+

add_package(self, + package_item) +

+ 		source code  +
+ +

Adds a package to the ship request.

+
+
Parameters:
+
    +
  • package_item (WSDL object, type of RequestedPackageLineItem WSDL object.) - A RequestedPackageLineItem, created by calling + create_wsdl_object_of_type('RequestedPackageLineItem') on this + ShipmentRequest object. See examples/create_shipment.py for more + details.
    • +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.track_service-module.html b/docs/2.2.0/fedex.services.track_service-module.html new file mode 100644 index 0000000..7264a8e --- /dev/null +++ b/docs/2.2.0/fedex.services.track_service-module.html @@ -0,0 +1,171 @@ + + + + + fedex.services.track_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module track_service + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module track_service

source code

+

Tracking Service Module

+

This package contains the shipment tracking methods defined by Fedex's + TrackService WSDL file. Each is encapsulated in a class for easy access. + For more details on each, refer to the respective class's + documentation.

+ + + + + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + FedexInvalidTrackingNumber
+ Exception: Sent when a bad tracking number is provided. +
+   + + FedexTrackRequest
+ This class allows you to track shipments by providing a tracking + number or other identifying features. +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __package__ = 'fedex.services' +
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.track_service-pysrc.html b/docs/2.2.0/fedex.services.track_service-pysrc.html new file mode 100644 index 0000000..7d621bf --- /dev/null +++ b/docs/2.2.0/fedex.services.track_service-pysrc.html @@ -0,0 +1,233 @@ + + + + + fedex.services.track_service + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module track_service + + + + + + +
[hide private]
[frames] | no frames]
+
+

Source Code for Module fedex.services.track_service

+
+  1  """ 
+  2  Tracking Service Module 
+  3   
+  4  This package contains the shipment tracking methods defined by Fedex's  
+  5  TrackService WSDL file. Each is encapsulated in a class for easy access.  
+  6  For more details on each, refer to the respective class's documentation. 
+  7  """ 
+  8   
+  9  from ..base_service import FedexBaseService, FedexError 
+ 10   
+ 11   
+
 12 -class FedexInvalidTrackingNumber(FedexError): 
+
 13      """ 
+ 14      Exception: Sent when a bad tracking number is provided. 
+ 15      """ 
+ 16   
+ 17      pass 
+
 18   
+ 19   
+
 20 -class FedexTrackRequest(FedexBaseService): 
+
 21      """ 
+ 22      This class allows you to track shipments by providing a tracking 
+ 23      number or other identifying features. By default, you 
+ 24      can simply pass a tracking number to the constructor. If you would like 
+ 25      to query shipments based on something other than tracking number, you will 
+ 26      want to read the documentation for the L{__init__} method.  
+ 27      Particularly, the tracking_value and package_identifier arguments. 
+ 28      """ 
+ 29   
+
 30 -    def __init__(self, config_obj, *args, **kwargs): 
+
 31          """ 
+ 32          Sends a shipment tracking request. The optional keyword args 
+ 33          detailed on L{FedexBaseService} apply here as well. 
+ 34           
+ 35          @type config_obj: L{FedexConfig} 
+ 36          @param config_obj: A valid FedexConfig object. 
+ 37          """ 
+ 38   
+ 39          self._config_obj = config_obj 
+ 40   
+ 41          # Holds version info for the VersionId SOAP object. 
+ 42          self._version_info = { 
+ 43              'service_id': 'trck', 
+ 44              'major': '10', 
+ 45              'intermediate': '0', 
+ 46              'minor': '0' 
+ 47          } 
+ 48          self.SelectionDetails = None 
+ 49          """@ivar: Holds the SelectionDetails WSDL object that includes tracking type and value.""" 
+ 50   
+ 51          # Set Default as None. 'INCLUDE_DETAILED_SCANS' or None 
+ 52          self.ProcessingOptions = None 
+ 53          """@ivar: Holds the TrackRequestProcessingOptionType WSDL object that defaults no None.""" 
+ 54   
+ 55          # Call the parent FedexBaseService class for basic setup work. 
+ 56          super(FedexTrackRequest, self).__init__( 
+ 57              self._config_obj, 'TrackService_v10.wsdl', *args, **kwargs) 
+ 58          self.IncludeDetailedScans = False 
+
 59   
+
 60 -    def _prepare_wsdl_objects(self): 
+
 61          """ 
+ 62          This sets the package identifier information. This may be a tracking 
+ 63          number or a few different things as per the Fedex spec. 
+ 64          """ 
+ 65   
+ 66          self.SelectionDetails = self.client.factory.create('TrackSelectionDetail') 
+ 67   
+ 68          # Default to Fedex 
+ 69          self.SelectionDetails.CarrierCode = 'FDXE' 
+ 70   
+ 71          track_package_id = self.client.factory.create('TrackPackageIdentifier') 
+ 72   
+ 73          # Default to tracking number. 
+ 74          track_package_id.Type = 'TRACKING_NUMBER_OR_DOORTAG' 
+ 75   
+ 76          self.SelectionDetails.PackageIdentifier = track_package_id 
+
 77   
+
 79          """ 
+ 80          Checks the response to see if there were any errors specific to 
+ 81          this WSDL. 
+ 82          """ 
+ 83          if self.response.HighestSeverity == "ERROR":  # pragma: no cover 
+ 84              for notification in self.response.Notifications: 
+ 85                  if notification.Severity == "ERROR": 
+ 86                      if "Invalid tracking number" in notification.Message: 
+ 87                          raise FedexInvalidTrackingNumber( 
+ 88                              notification.Code, notification.Message) 
+ 89                      else: 
+ 90                          raise FedexError(notification.Code, notification.Message) 
+
 91   
+
 92 -    def _assemble_and_send_request(self): 
+
 93          """ 
+ 94          Fires off the Fedex request. 
+ 95           
+ 96          @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES 
+ 97              ON FedexBaseService AND IS INHERITED. 
+ 98          """ 
+ 99   
+100          client = self.client 
+101          # Fire off the query. 
+102          return client.service.track( 
+103              WebAuthenticationDetail=self.WebAuthenticationDetail, 
+104              ClientDetail=self.ClientDetail, 
+105              TransactionDetail=self.TransactionDetail, 
+106              Version=self.VersionId, 
+107              SelectionDetails=self.SelectionDetails, 
+108              ProcessingOptions=self.ProcessingOptions) 
+
109   
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html b/docs/2.2.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html new file mode 100644 index 0000000..1c1f172 --- /dev/null +++ b/docs/2.2.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html @@ -0,0 +1,199 @@ + + + + + fedex.services.track_service.FedexInvalidTrackingNumber + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module track_service :: + Class FedexInvalidTrackingNumber + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexInvalidTrackingNumber

source code

+
+                    object --+                
+                             |                
+      exceptions.BaseException --+            
+                                 |            
+              exceptions.Exception --+        
+                                     |        
+base_service.FedexBaseServiceException --+    
+                                         |    
+                   base_service.FedexError --+
+                                             |
+                                            FedexInvalidTrackingNumber
+
+ +
+

Exception: Sent when a bad tracking number is provided.

+ + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+

Inherited from base_service.FedexBaseServiceException: + __init__, + __str__, + __unicode__ +

+

Inherited from exceptions.Exception: + __new__ +

+

Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__ +

+

Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from exceptions.BaseException: + args, + message +

+

Inherited from object: + __class__ +

+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/fedex.services.track_service.FedexTrackRequest-class.html b/docs/2.2.0/fedex.services.track_service.FedexTrackRequest-class.html new file mode 100644 index 0000000..434032a --- /dev/null +++ b/docs/2.2.0/fedex.services.track_service.FedexTrackRequest-class.html @@ -0,0 +1,434 @@ + + + + + fedex.services.track_service.FedexTrackRequest + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ + Package fedex :: + Package services :: + Module track_service :: + Class FedexTrackRequest + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class FedexTrackRequest

source code

+
+                   object --+    
+                            |    
+base_service.FedexBaseService --+
+                                |
+                               FedexTrackRequest
+
+ +
+

This class allows you to track shipments by providing a tracking + number or other identifying features. By default, you can simply pass a + tracking number to the constructor. If you would like to query shipments + based on something other than tracking number, you will want to read the + documentation for the __init__ method. Particularly, the tracking_value and + package_identifier arguments.

+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + config_obj, + *args, + **kwargs)
+ Sends a shipment tracking request.		 + source code + +
+ +
+   + + + + + + +
_prepare_wsdl_objects(self)
+ This sets the package identifier information.		 + source code + +
+ +
+   + + + + + + +
_check_response_for_request_errors(self)
+ Checks the response to see if there were any errors specific to this + WSDL.		 + source code + +
+ +
+   + + + + + + +
_assemble_and_send_request(self)
+ Fires off the Fedex request.		 + source code + +
+ +
+

Inherited from base_service.FedexBaseService: + create_wsdl_object_of_type, + send_request +

+

Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

+
+ + + + + + + + + + + + + + + +
+ + + + + +
Instance Variables[hide private]
+
+   + + SelectionDetails
+ Holds the SelectionDetails WSDL object that includes tracking type + and value. +
+   + + ProcessingOptions
+ Holds the TrackRequestProcessingOptionType WSDL object that defaults + no None. +
+

Inherited from base_service.FedexBaseService: + ClientDetail, + TransactionDetail, + VersionId, + WebAuthenticationDetail, + config_obj, + logger, + response +

+
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + config_obj, + *args, + **kwargs) +
(Constructor) +

+ 		source code  +
+ +

Sends a shipment tracking request. The optional keyword args detailed + on FedexBaseService apply here as well.

+
+
Parameters:
+
    +
  • config_obj (FedexConfig) - A valid FedexConfig object.
    • +
+
Overrides: + object.__init__ +
+
+
+
+ +
+ +
+ + +
+

_prepare_wsdl_objects(self) +

+ 		source code  +
+ +

This sets the package identifier information. This may be a tracking + number or a few different things as per the Fedex spec.

+
+
Overrides: + base_service.FedexBaseService._prepare_wsdl_objects +
+
+
+
+ +
+ +
+ + +
+

_check_response_for_request_errors(self) +

+ 		source code  +
+ +

Checks the response to see if there were any errors specific to this + WSDL.

+
+
Overrides: + base_service.FedexBaseService._check_response_for_request_errors +
+
+
+
+ +
+ +
+ + +
+

_assemble_and_send_request(self) +

+ 		source code  +
+ +

Fires off the Fedex request.

+
+
Overrides: + base_service.FedexBaseService._assemble_and_send_request +
+
+

Warning: + NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES + ON FedexBaseService AND IS INHERITED. +

+
+
+
+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/frames.html b/docs/2.2.0/frames.html new file mode 100644 index 0000000..875cc04 --- /dev/null +++ b/docs/2.2.0/frames.html @@ -0,0 +1,17 @@ + + + + + API Documentation + + + + + + + + + diff --git a/docs/2.2.0/help.html b/docs/2.2.0/help.html new file mode 100644 index 0000000..b6c3a4a --- /dev/null +++ b/docs/2.2.0/help.html @@ -0,0 +1,268 @@ + + + + + Help + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+ +

API Documentation

+ +

This document contains the API (Application Programming Interface) +documentation for this project. Documentation for the Python +objects defined by the project is divided into separate pages for each +package, module, and class. The API documentation also includes two +pages containing information about the project as a whole: a trees +page, and an index page.

+ +

Object Documentation

+ +

Each Package Documentation page contains:

+
    +
  • A description of the package.
    • +
  • A list of the modules and sub-packages contained by the + package.
    • +
  • A summary of the classes defined by the package.
    • +
  • A summary of the functions defined by the package.
    • +
  • A summary of the variables defined by the package.
    • +
  • A detailed description of each function defined by the + package.
    • +
  • A detailed description of each variable defined by the + package.
    • +
+ +

Each Module Documentation page contains:

+
    +
  • A description of the module.
    • +
  • A summary of the classes defined by the module.
    • +
  • A summary of the functions defined by the module.
    • +
  • A summary of the variables defined by the module.
    • +
  • A detailed description of each function defined by the + module.
    • +
  • A detailed description of each variable defined by the + module.
    • +
+ +

Each Class Documentation page contains:

+
    +
  • A class inheritance diagram.
    • +
  • A list of known subclasses.
    • +
  • A description of the class.
    • +
  • A summary of the methods defined by the class.
    • +
  • A summary of the instance variables defined by the class.
    • +
  • A summary of the class (static) variables defined by the + class.
    • +
  • A detailed description of each method defined by the + class.
    • +
  • A detailed description of each instance variable defined by the + class.
    • +
  • A detailed description of each class (static) variable defined + by the class.
    • +
+ +

Project Documentation

+ +

The Trees page contains the module and class hierarchies:

+
    +
  • The module hierarchy lists every package and module, with + modules grouped into packages. At the top level, and within each + package, modules and sub-packages are listed alphabetically.
    • +
  • The class hierarchy lists every class, grouped by base + class. If a class has more than one base class, then it will be + listed under each base class. At the top level, and under each base + class, classes are listed alphabetically.
    • +
+ +

The Index page contains indices of terms and + identifiers:

+
    +
  • The term index lists every term indexed by any object's + documentation. For each term, the index provides links to each + place where the term is indexed.
    • +
  • The identifier index lists the (short) name of every package, + module, class, method, function, variable, and parameter. For each + identifier, the index provides a short description, and a link to + its documentation.
    • +
+ +

The Table of Contents

+ +

The table of contents occupies the two frames on the left side of +the window. The upper-left frame displays the project +contents, and the lower-left frame displays the module +contents:

+ + + + + + + + + +
+ Project
Contents
...		 + API
Documentation
Frame


+
+ Module
Contents
 
...
  +

+ +

The project contents frame contains a list of all packages +and modules that are defined by the project. Clicking on an entry +will display its contents in the module contents frame. Clicking on a +special entry, labeled "Everything," will display the contents of +the entire project.

+ +

The module contents frame contains a list of every +submodule, class, type, exception, function, and variable defined by a +module or package. Clicking on an entry will display its +documentation in the API documentation frame. Clicking on the name of +the module, at the top of the frame, will display the documentation +for the module itself.

+ +

The "frames" and "no frames" buttons below the top +navigation bar can be used to control whether the table of contents is +displayed or not.

+ +

The Navigation Bar

+ +

A navigation bar is located at the top and bottom of every page. +It indicates what type of page you are currently viewing, and allows +you to go to related pages. The following table describes the labels +on the navigation bar. Note that not some labels (such as +[Parent]) are not displayed on all pages.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LabelHighlighted when...Links to...
[Parent](never highlighted) the parent of the current package
[Package]viewing a packagethe package containing the current object +
[Module]viewing a modulethe module containing the current object +
[Class]viewing a class the class containing the current object
[Trees]viewing the trees page the trees page
[Index]viewing the index page the index page
[Help]viewing the help page the help page
+ +

The "show private" and "hide private" buttons below +the top navigation bar can be used to control whether documentation +for private objects is displayed. Private objects are usually defined +as objects whose (short) names begin with a single underscore, but do +not end with an underscore. For example, "_x", +"__pprint", and "epydoc.epytext._tokenize" +are private objects; but "re.sub", +"__init__", and "type_" are not. However, +if a module defines the "__all__" variable, then its +contents are used to decide which objects are private.

+ +

A timestamp below the bottom navigation bar indicates when each +page was last updated.

+ + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/identifier-index.html b/docs/2.2.0/identifier-index.html new file mode 100644 index 0000000..90919e4 --- /dev/null +++ b/docs/2.2.0/identifier-index.html @@ -0,0 +1,511 @@ + + + + + Identifier Index + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+ +
+

Identifier Index

+		 +[ + A + B + C + D + E + F + G + H + I + J + K + L + M + N + O + P + Q + R + S + T + U + V + W + X + Y + Z + _ +] +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

A

 + + + + + + + + + + + +
add_address()
+(in FedexAddressValidationRequest)		add_package()
+(in FedexProcessShipmentRequest)		availability_commitment_service
+(in fedex.services)
add_package()
+(in FedexRateServiceRequest)		address_validation_service
+(in fedex.services)		 
+

B

 + + + + + + + +
base_service
+(in fedex)		  
   
+

C

 + + + + + + + +
config
+(in fedex)		country_service
+(in fedex.services)		create_wsdl_object_of_type()
+(in FedexBaseService)
   
+

D

 + + + + + + + +
DirectDevicePrinter
+(in fedex.printers.unix)		  
   
+

F

 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
fedexFedexDeleteShipmentRequest
+(in fedex.services.ship_service)		FedexProcessShipmentRequest
+(in fedex.services.ship_service)
FedexAddressValidationRequest
+(in fedex.services.address_validation_service)		FedexError
+(in fedex.base_service)		FedexRateServiceRequest
+(in fedex.services.rate_service)
FedexAvailabilityCommitmentRequest
+(in fedex.services.availability_commitment_service)		FedexFailure
+(in fedex.base_service)		FedexTrackRequest
+(in fedex.services.track_service)
FedexBaseService
+(in fedex.base_service)		FedexInvalidPostalCodeFormat
+(in fedex.services.package_movement)		FedexValidatePostalRequest
+(in fedex.services.country_service)
FedexBaseServiceException
+(in fedex.base_service)		FedexInvalidTrackingNumber
+(in fedex.services.track_service)		 
FedexConfig
+(in fedex.config)		FedexPostalCodeNotFound
+(in fedex.services.package_movement)		 
+

G

 + + + + + + + +
GeneralSudsPlugin
+(in fedex.base_service)		  
   
+

M

 + + + + + + + +
marshalled()
+(in GeneralSudsPlugin)		  
   
+

P

 + + + + + + + + + + + +
package_movement
+(in fedex.services)		print_label()
+(in DirectDevicePrinter)		 
PostalCodeInquiryRequest
+(in fedex.services.package_movement)		printers
+(in fedex)		 
+

R

 + + + + + + + +
rate_service
+(in fedex.services)		received()
+(in GeneralSudsPlugin)		 
   
+

S

 + + + + + + + + + + + +
SchemaValidationError
+(in fedex.base_service)		send_validation_request()
+(in FedexProcessShipmentRequest)		services
+(in fedex)
send_request()
+(in FedexBaseService)		sending()
+(in GeneralSudsPlugin)		ship_service
+(in fedex.services)
+

T

 + + + + + + + +
track_service
+(in fedex.services)		  
   
+

U

 + + + + + + + +
unix
+(in fedex.printers)		  
   
+

V

 + + + + + + + +
VERSION
+(in fedex)		  
   
+

_

 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
__check_response_for_fedex_error()
+(in FedexBaseService)		__package__
+(in fedex.printers.unix)		_assemble_and_send_request()
+(in PostalCodeInquiryRequest)
__init__()
+(in FedexBaseService)		__package__
+(in fedex.services)		_assemble_and_send_request()
+(in FedexRateServiceRequest)
__init__()
+(in FedexBaseServiceException)		__package__
+(in fedex.services.address_validation_service)		_assemble_and_send_request()
+(in FedexDeleteShipmentRequest)
__init__()
+(in GeneralSudsPlugin)		__package__
+(in fedex.services.availability_commitment_service)		_assemble_and_send_request()
+(in FedexProcessShipmentRequest)
__init__()
+(in SchemaValidationError)		__package__
+(in fedex.services.country_service)		_assemble_and_send_request()
+(in FedexTrackRequest)
__init__()
+(in FedexConfig)		__package__
+(in fedex.services.package_movement)		_assemble_and_send_validation_request()
+(in FedexProcessShipmentRequest)
__init__()
+(in DirectDevicePrinter)		__package__
+(in fedex.services.rate_service)		_check_response_for_request_errors()
+(in FedexBaseService)
__init__()
+(in FedexAddressValidationRequest)		__package__
+(in fedex.services.ship_service)		_check_response_for_request_errors()
+(in PostalCodeInquiryRequest)
__init__()
+(in FedexAvailabilityCommitmentRequest)		__package__
+(in fedex.services.track_service)		_check_response_for_request_errors()
+(in FedexTrackRequest)
__init__()
+(in FedexValidatePostalRequest)		__set_client_detail()
+(in FedexBaseService)		_prepare_wsdl_objects()
+(in FedexBaseService)
__init__()
+(in PostalCodeInquiryRequest)		__set_transaction_detail()
+(in FedexBaseService)		_prepare_wsdl_objects()
+(in FedexAddressValidationRequest)
__init__()
+(in FedexRateServiceRequest)		__set_version_id()
+(in FedexBaseService)		_prepare_wsdl_objects()
+(in FedexAvailabilityCommitmentRequest)
__init__()
+(in FedexDeleteShipmentRequest)		__set_web_authentication_detail()
+(in FedexBaseService)		_prepare_wsdl_objects()
+(in FedexValidatePostalRequest)
__init__()
+(in FedexProcessShipmentRequest)		__str__()
+(in FedexBaseServiceException)		_prepare_wsdl_objects()
+(in PostalCodeInquiryRequest)
__init__()
+(in FedexTrackRequest)		__unicode__()
+(in FedexBaseServiceException)		_prepare_wsdl_objects()
+(in FedexRateServiceRequest)
__package__
+(in fedex)		_assemble_and_send_request()
+(in FedexBaseService)		_prepare_wsdl_objects()
+(in FedexDeleteShipmentRequest)
__package__
+(in fedex.base_service)		_assemble_and_send_request()
+(in FedexAddressValidationRequest)		_prepare_wsdl_objects()
+(in FedexProcessShipmentRequest)
__package__
+(in fedex.config)		_assemble_and_send_request()
+(in FedexAvailabilityCommitmentRequest)		_prepare_wsdl_objects()
+(in FedexTrackRequest)
__package__
+(in fedex.printers)		_assemble_and_send_request()
+(in FedexValidatePostalRequest)		_print_base64()
+(in DirectDevicePrinter)
+
+

+ + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/index.html b/docs/2.2.0/index.html new file mode 100644 index 0000000..875cc04 --- /dev/null +++ b/docs/2.2.0/index.html @@ -0,0 +1,17 @@ + + + + + API Documentation + + + + + + + + + diff --git a/docs/2.2.0/module-tree.html b/docs/2.2.0/module-tree.html new file mode 100644 index 0000000..6a506c6 --- /dev/null +++ b/docs/2.2.0/module-tree.html @@ -0,0 +1,139 @@ + + + + + Module Hierarchy + + + + + + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
  + + + + +
[hide private]
[frames] | no frames]
+
+
+ [ Module Hierarchy + | Class Hierarchy ] +

+

Module Hierarchy

+ + + + + + + + + + + + + + + + + + +
   Home      Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0.1 on Fri Jan 15 22:43:09 2016 + + http://epydoc.sourceforge.net +
+ + + + diff --git a/docs/2.2.0/redirect.html b/docs/2.2.0/redirect.html new file mode 100644 index 0000000..c44e4f6 --- /dev/null +++ b/docs/2.2.0/redirect.html @@ -0,0 +1,38 @@ +Epydoc Redirect Page + + + + + + + + +

Epydoc Auto-redirect page

+ +

When javascript is enabled, this page will redirect URLs of +the form redirect.html#dotted.name to the +documentation for the object with the given fully-qualified +dotted name.

+

 

+ + + + + diff --git a/docs/2.2.0/toc-everything.html b/docs/2.2.0/toc-everything.html new file mode 100644 index 0000000..6e1df54 --- /dev/null +++ b/docs/2.2.0/toc-everything.html @@ -0,0 +1,64 @@ + + + + + Everything + + + + + +

Everything

+
+

All Classes

+ fedex.base_service.FedexBaseService
fedex.base_service.FedexBaseServiceException
fedex.base_service.FedexError
fedex.base_service.FedexFailure
fedex.base_service.GeneralSudsPlugin
fedex.base_service.SchemaValidationError
fedex.config.FedexConfig
fedex.printers.unix.DirectDevicePrinter
fedex.services.address_validation_service.FedexAddressValidationRequest
fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest
fedex.services.country_service.FedexValidatePostalRequest
fedex.services.package_movement.FedexInvalidPostalCodeFormat
fedex.services.package_movement.FedexPostalCodeNotFound
fedex.services.package_movement.PostalCodeInquiryRequest
fedex.services.rate_service.FedexRateServiceRequest
fedex.services.ship_service.FedexDeleteShipmentRequest
fedex.services.ship_service.FedexProcessShipmentRequest
fedex.services.track_service.FedexInvalidTrackingNumber
fedex.services.track_service.FedexTrackRequest

All Variables

+ fedex.VERSION
fedex.__package__
fedex.base_service.__package__
fedex.config.__package__
fedex.printers.__package__
fedex.printers.unix.__package__
fedex.services.__package__
fedex.services.address_validation_service.__package__
fedex.services.availability_commitment_service.__package__
fedex.services.country_service.__package__
fedex.services.package_movement.__package__
fedex.services.rate_service.__package__
fedex.services.ship_service.__package__
fedex.services.track_service.__package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex-module.html b/docs/2.2.0/toc-fedex-module.html new file mode 100644 index 0000000..6cbdce0 --- /dev/null +++ b/docs/2.2.0/toc-fedex-module.html @@ -0,0 +1,32 @@ + + + + + fedex + + + + + +

Module fedex

+
+

Variables

+ VERSION
__package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.base_service-module.html b/docs/2.2.0/toc-fedex.base_service-module.html new file mode 100644 index 0000000..a7e2fa3 --- /dev/null +++ b/docs/2.2.0/toc-fedex.base_service-module.html @@ -0,0 +1,38 @@ + + + + + base_service + + + + + +

Module base_service

+
+

Classes

+ FedexBaseService
FedexBaseServiceException
FedexError
FedexFailure
GeneralSudsPlugin
SchemaValidationError

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.config-module.html b/docs/2.2.0/toc-fedex.config-module.html new file mode 100644 index 0000000..971e1a8 --- /dev/null +++ b/docs/2.2.0/toc-fedex.config-module.html @@ -0,0 +1,33 @@ + + + + + config + + + + + +

Module config

+
+

Classes

+ FedexConfig

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.printers-module.html b/docs/2.2.0/toc-fedex.printers-module.html new file mode 100644 index 0000000..b7cb717 --- /dev/null +++ b/docs/2.2.0/toc-fedex.printers-module.html @@ -0,0 +1,31 @@ + + + + + printers + + + + + +

Module printers

+
+

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.printers.unix-module.html b/docs/2.2.0/toc-fedex.printers.unix-module.html new file mode 100644 index 0000000..fa0c786 --- /dev/null +++ b/docs/2.2.0/toc-fedex.printers.unix-module.html @@ -0,0 +1,33 @@ + + + + + unix + + + + + +

Module unix

+
+

Classes

+ DirectDevicePrinter

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services-module.html b/docs/2.2.0/toc-fedex.services-module.html new file mode 100644 index 0000000..e690057 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services-module.html @@ -0,0 +1,31 @@ + + + + + services + + + + + +

Module services

+
+

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.address_validation_service-module.html b/docs/2.2.0/toc-fedex.services.address_validation_service-module.html new file mode 100644 index 0000000..7c04215 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.address_validation_service-module.html @@ -0,0 +1,33 @@ + + + + + address_validation_service + + + + + +

Module address_validation_service

+
+

Classes

+ FedexAddressValidationRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.availability_commitment_service-module.html b/docs/2.2.0/toc-fedex.services.availability_commitment_service-module.html new file mode 100644 index 0000000..d29586f --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.availability_commitment_service-module.html @@ -0,0 +1,33 @@ + + + + + availability_commitment_service + + + + + +

Module availability_commitment_service

+
+

Classes

+ FedexAvailabilityCommitmentRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.country_service-module.html b/docs/2.2.0/toc-fedex.services.country_service-module.html new file mode 100644 index 0000000..0dd6383 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.country_service-module.html @@ -0,0 +1,33 @@ + + + + + country_service + + + + + +

Module country_service

+
+

Classes

+ FedexValidatePostalRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.package_movement-module.html b/docs/2.2.0/toc-fedex.services.package_movement-module.html new file mode 100644 index 0000000..ecf43f7 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.package_movement-module.html @@ -0,0 +1,35 @@ + + + + + package_movement + + + + + +

Module package_movement

+
+

Classes

+ FedexInvalidPostalCodeFormat
FedexPostalCodeNotFound
PostalCodeInquiryRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.rate_service-module.html b/docs/2.2.0/toc-fedex.services.rate_service-module.html new file mode 100644 index 0000000..fab6f93 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.rate_service-module.html @@ -0,0 +1,33 @@ + + + + + rate_service + + + + + +

Module rate_service

+
+

Classes

+ FedexRateServiceRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.ship_service-module.html b/docs/2.2.0/toc-fedex.services.ship_service-module.html new file mode 100644 index 0000000..aed242e --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.ship_service-module.html @@ -0,0 +1,34 @@ + + + + + ship_service + + + + + +

Module ship_service

+
+

Classes

+ FedexDeleteShipmentRequest
FedexProcessShipmentRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc-fedex.services.track_service-module.html b/docs/2.2.0/toc-fedex.services.track_service-module.html new file mode 100644 index 0000000..581c135 --- /dev/null +++ b/docs/2.2.0/toc-fedex.services.track_service-module.html @@ -0,0 +1,34 @@ + + + + + track_service + + + + + +

Module track_service

+
+

Classes

+ FedexInvalidTrackingNumber
FedexTrackRequest

Variables

+ __package__
+[hide private] + + + + diff --git a/docs/2.2.0/toc.html b/docs/2.2.0/toc.html new file mode 100644 index 0000000..58ed68e --- /dev/null +++ b/docs/2.2.0/toc.html @@ -0,0 +1,45 @@ + + + + + Table of Contents + + + + + +

Table of Contents

+
+ Everything +
+

Modules

+ fedex
fedex.base_service
fedex.config
fedex.printers
fedex.printers.unix
fedex.services
fedex.services.address_validation_service
fedex.services.availability_commitment_service
fedex.services.country_service
fedex.services.package_movement
fedex.services.rate_service
fedex.services.ship_service
fedex.services.track_service
+ [hide private] + + + +