Merge branch 'master' into master

Author: radzhome

.gitignore

@@ -15,3 +15,4 @@ doc_src/_static/*
 doc_src/*.html
 doc_src/_build/*
 .python-version
+/venv

examples/create_pickup.py

@@ -1,12 +1,14 @@
 #!/usr/bin/env python
 """
-This example shows how to create a pickup request
+This example shows how to create a pickup request and then cancel it
 """
 import datetime
 
 from example_config import CONFIG_OBJ
 from fedex.services.pickup_service import FedexCreatePickupRequest
 
+pickup_date = datetime.datetime.now().replace(microsecond=0)
+
 customer_transaction_id = "*** PickupService Request v11 using Python ***"  # Optional transaction_id
 pickup_service = FedexCreatePickupRequest(CONFIG_OBJ, customer_transaction_id)
 
@@ -29,7 +31,7 @@
 # pickup_service.OriginDetail.BuildingPart = 'SUITE'
 
 # Identifies the date and time the package will be ready for pickup by FedEx.
-pickup_service.OriginDetail.ReadyTimestamp = datetime.datetime.now().replace(microsecond=0).isoformat()
+pickup_service.OriginDetail.ReadyTimestamp = pickup_date.isoformat()
 
 # Identifies the latest time at which the driver can gain access to pick up the package(s)
 pickup_service.OriginDetail.CompanyCloseTime = '23:00:00'
@@ -51,5 +53,29 @@
 
 pickup_service.send_request()
 
+print('Pickup request sent:')
 print pickup_service.response.HighestSeverity == 'SUCCESS'
 print pickup_service.response.Notifications[0].Message
+
+# Cancel the pickup request that we just got confirmation for
+cancel_pickup = FedexCancelPickupRequest(CONFIG_OBJ)
+
+cancel_pickup.PickupConfirmationNumber = pickup_service.response.PickupConfirmationNumber
+# the date for the pickup (eg. '2016-09-26')
+cancel_pickup.ScheduledDate = pickup_date.strftime('%Y-%m-%d')
+cancel_pickup.EndDate = pickup_date.strftime('%Y-%m-%d')
+cancel_pickup.Location = pickup_service.response.Location
+cancel_pickup.Remarks = None
+cancel_pickup.ShippingChargesPayment =  None
+cancel_pickup.Reason = ''
+cancel_pickup.ContactName = 'Sender Name'
+cancel_pickup.PhoneNumber = '9012638716'
+cancel_pickup.PhoneExtension = ''
+
+cancel_pickup.CarrierCode = 'FDXE'
+
+cancel_pickup.send_request()
+
+print('Cancel pickup request sent:')
+print('Highest severity:',cancel_pickup.response.HighestSeverity)
+print('Message:',cancel_pickup.response.Notifications[0].Message)

examples/estimate_ground_transit_time.py

@@ -0,0 +1,36 @@
+import logging
+import sys
+
+from example_config import CONFIG_OBJ
+from fedex.services.availability_commitment_service import FedexAvailabilityCommitmentRequest
+from fedex.tools.conversion import sobject_to_dict
+
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ)
+
+# .StateOrProvinceCode available as well
+avc_request.Origin.PostalCode = '60634'
+avc_request.Origin.CountryCode = 'US'
+avc_request.Destination.PostalCode = '19106'
+avc_request.Destination.CountryCode = 'US'
+avc_request.Service = 'FEDEX_GROUND'
+
+avc_request.send_request()
+response_dict = sobject_to_dict(avc_request.response)
+
+# output display formatting
+origin_str = '%s, %s' % (
+    avc_request.Origin.PostalCode,
+    avc_request.Origin.CountryCode)
+destination_str = '%s, %s' % (
+    avc_request.Destination.PostalCode,
+    avc_request.Destination.CountryCode)
+
+logging.info('origin: %s' % origin_str)
+logging.info('destination: %s' % destination_str)
+for option in response_dict['Options']:
+    if option['Service'] == 'FEDEX_GROUND':
+        logging.info('TransitTime: %s' % option['TransitTime'])
+    else:
+        logging.warning('No Fedex Ground Service found.')

examples/rate_request.py

@@ -41,11 +41,13 @@
 rate_request.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
 
 # Shipper's address
+rate_request.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'SC'
 rate_request.RequestedShipment.Shipper.Address.PostalCode = '29631'
 rate_request.RequestedShipment.Shipper.Address.CountryCode = 'US'
 rate_request.RequestedShipment.Shipper.Address.Residential = False
 
 # Recipient address
+rate_request.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'NC'
 rate_request.RequestedShipment.Recipient.Address.PostalCode = '27577'
 rate_request.RequestedShipment.Recipient.Address.CountryCode = 'US'
 # This is needed to ensure an accurate rate quote with the response.

fedex/services/document_service.py

@@ -70,6 +70,16 @@ def _assemble_and_send_request(self):
                     OriginCountryCode = self.OriginCountryCode,
                     DestinationCountryCode = self.DestinationCountryCode,
                 )
+                
+        def enable_post_shipment(self,trackingnumber):
+            """
+            Enable post shipment upload - when uploading docs after the shipment has been processed
+            or confirmed, you must provide the tracking number.
+            The shipment also must have been processed with the POST_SHIPMENT_UPLOAD_REQUESTED ETD attribute.
+            """
+            self.ProcessingOptions.Options = ["POST_SHIPMENT_UPLOAD"]
+            self.ProcessingOptions.PostShipmentUploadDetail.TrackingNumber = trackingnumber            
+            
         def get_document(self, line_number,customer_reference,
             document_type , file_name, document_content, expiration_date =None
             ):
@@ -81,5 +91,59 @@ def get_document(self, line_number,customer_reference,
             document_item.DocumentContent = document_content
             document_item.ExpirationDate = expiration_date
             return document_item
+            
         def add_documents(self, document_item):
             self.Documents.append(document_item)
+
+
+class FedexUploadImagesRequest(FedexBaseService):
+        """
+        This class allows you to submit images.
+        You will need to add images to self.Images,
+        then send the request.
+        """
+
+        def __init__(self, config_obj, *args, **kwargs):
+            """
+            The optional keyword args detailed on L{FedexBaseService}
+            apply here as well.
+            @type config_obj: L{FedexConfig}
+            @param config_obj: A valid FedexConfig object.
+            """
+
+            self._config_obj = config_obj
+
+            # Holds version info for the VersionId SOAP object.
+            self._version_info = {'service_id': 'cdus', 'major': '11',
+                                  'intermediate': '0', 'minor': '0'}
+
+            super(FedexUploadImagesRequest, self).__init__(
+                    self._config_obj, 'UploadDocumentService_v11.wsdl', *args, **kwargs)
+
+        def _prepare_wsdl_objects(self):
+            """
+            This is the data that will be used to create your shipment. Create
+            the data structure and get it ready for the WSDL request.
+            """
+            self.Images = []
+
+        def _assemble_and_send_request(self):
+            """
+            Fires off the Fedex request.
+
+            @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+                WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+            """
+
+            # Fire off the query.
+            return self.client.service.uploadImages(
+                    WebAuthenticationDetail=self.WebAuthenticationDetail,
+                    ClientDetail=self.ClientDetail,
+                    TransactionDetail=self.TransactionDetail,
+                    Version=self.VersionId,
+                    Images=self.Images,
+                )
+
+        def add_image(self, image_item):
+            self.Images.append(image_item)
+

fedex/services/pickup_service.py

@@ -143,3 +143,70 @@ def _assemble_and_send_request(self):
             ShipmentAttributes=self.ShipmentAttributes,
             PackageDetails=self.PackageDetails
         )
+
+class FedexCancelPickupRequest(FedexBaseService):
+    """
+    This class allows you to cancel a pickup request, given a dispatch confirmation number.
+    """
+
+    def __init__(self, config_obj, *args, **kwargs):
+        """
+        Cancels a pickup request via a dispatch confirmation number.
+        """
+
+        self._config_obj = config_obj
+
+        # Holds version info for the VersionId SOAP object.
+        self._version_info = {'service_id': 'disp', 'major': '17',
+                              'intermediate': '0', 'minor': '0'}
+        self.CarrierCode = None
+        self.PickupConfirmationNumber = None
+        self.ScheduledDate = None
+        self.EndDate = None
+        self.Location = None
+        self.Remarks = None
+        self.ShippingChargesPayment = None
+        self.Reason = None
+        self.ContactName = None
+        self.PhoneNumber = None
+        self.PhoneExtension = None
+        # Call the parent FedexBaseService class for basic setup work.
+        super(FedexCancelPickupRequest, self).__init__(self._config_obj,
+                                                         'PickupService_v17.wsdl',
+                                                         *args, **kwargs)
+
+    def _prepare_wsdl_objects(self):
+        """
+        Preps the WSDL data structures for the user.
+        """
+
+        self.CarrierCode = self.client.factory.create('CarrierCodeType')
+        self.ShippingChargesPayment = self.client.factory.create('Payment')
+
+    def _assemble_and_send_request(self):
+        """
+        Fires off the Fedex request.
+        
+        @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+            ON FedexBaseService AND IS INHERITED.
+        """
+
+        # Fire off the query.
+        return self.client.service.cancelPickup(
+            WebAuthenticationDetail=self.WebAuthenticationDetail,
+            ClientDetail=self.ClientDetail,
+            TransactionDetail=self.TransactionDetail,
+            Version=self.VersionId,
+            CarrierCode=self.CarrierCode,
+            PickupConfirmationNumber=self.PickupConfirmationNumber,
+            ScheduledDate=self.ScheduledDate,
+            EndDate=self.EndDate,
+            Location=self.Location,
+            Remarks=self.Remarks,
+            ShippingChargesPayment=self.ShippingChargesPayment,
+            Reason=self.Reason,
+            ContactName=self.ContactName,
+            PhoneNumber=self.PhoneNumber,
+            PhoneExtension=self.PhoneExtension
+        )
+