Skip to content

Commit b2ec87d

Browse files
committed
added sortDetail object, added doc
* Sort detail was added to be able to sort the query results for locations. * Added missing variable documentation.
1 parent 77bac4d commit b2ec87d

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

fedex/services/location_service.py

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
Location Service Module
3-
=================================
3+
44
This package contains the shipping methods defined by Fedex's
55
LocationService WSDL file. Each is encapsulated in a class for
66
easy access. For more details on each, refer to the respective class's
@@ -13,8 +13,9 @@
1313
class FedexSearchLocationRequest(FedexBaseService):
1414
"""
1515
This class allows you to figure out a FedEx location closest
16-
to a specified location, based on location type. The response includes
17-
location details like operating times, directions and a map link.
16+
to a specified location criteria, based on location type.
17+
The response includes location details like operating times,
18+
directions and a map link and more.
1819
"""
1920

2021
def __init__(self, config_obj, *args, **kwargs):
@@ -32,14 +33,24 @@ def __init__(self, config_obj, *args, **kwargs):
3233
'minor': '0'
3334
}
3435

35-
"""@ivar: set default objects."""
36+
# Set default objects.
3637
self.Address = None
38+
"""@ivar: Holds the Address WSDL object."""
39+
3740
self.PhoneNumber = None
41+
"""@ivar: Holds the PhoneNumber string object."""
42+
3843
self.MultipleMatchesAction = None
44+
"""@ivar: Holds the MultipleMatchesActionType WSDL object."""
45+
3946
self.Constraints = []
47+
"""@ivar: Holds a list of SearchLocationConstraints WSDL objects."""
48+
4049
self.LocationsSearchCriterion = None
50+
"""@ivar: Holds the LocationsSearchCriteriaType WSDL object."""
4151

42-
"""@ivar: Holds the WSDL object."""
52+
self.SortDetail = None
53+
"""@ivar: Holds the LocationSortDetail WSDL object."""
4354

4455
super(FedexSearchLocationRequest, self).__init__(
4556
self._config_obj, 'LocationsService_v3.wsdl', *args, **kwargs)
@@ -48,9 +59,13 @@ def _prepare_wsdl_objects(self):
4859
"""
4960
Create the data structure and get it ready for the WSDL request.
5061
"""
62+
63+
# Service defaults for objects that are required.
5164
self.MultipleMatchesAction = 'RETURN_ALL'
5265
self.Constraints = self.create_wsdl_object_of_type('SearchLocationConstraints')
5366
self.Address = self.create_wsdl_object_of_type('Address')
67+
self.LocationsSearchCriterion = 'ADDRESS'
68+
self.SortDetail = self.create_wsdl_object_of_type('LocationSortDetail')
5469

5570
def _assemble_and_send_request(self):
5671
"""
@@ -78,4 +93,5 @@ def _assemble_and_send_request(self):
7893
PhoneNumber=self.PhoneNumber,
7994
MultipleMatchesAction=self.MultipleMatchesAction,
8095
Constraints=self.Constraints,
81-
Address=self.Address)
96+
Address=self.Address,
97+
SortDetail=self.SortDetail)

0 commit comments

Comments
 (0)