Merge pull request softlayer#646 from sudorandom/promote-call

underscorephil · underscorephil · commit bae7b57d2e07 · 2015-12-01T09:54:39.000-06:00
Change docs to use Client.call instead of hash accessors
diff --git a/SoftLayer/API.py b/SoftLayer/API.py
@@ -72,7 +72,7 @@ def create_client_from_env(username=None,
 
         >>> import SoftLayer
         >>> client = SoftLayer.create_client_from_env()
-        >>> resp = client['Account'].getObject()
+        >>> resp = client.call('Account', 'getObject')
         >>> resp['companyName']
         'Your Company'
 
@@ -151,11 +151,11 @@ def authenticate_with_password(self, username, password,
 
         """
         self.auth = None
-        res = self['User_Customer'].getPortalLoginToken(
-            username,
-            password,
-            security_question_id,
-            security_question_answer)
+        res = self.call('User_Customer', 'getPortalLoginToken',
+                        username,
+                        password,
+                        security_question_id,
+                        security_question_answer)
         self.auth = slauth.TokenAuthentication(res['userId'], res['hash'])
         return res['userId'], res['hash']
 
@@ -187,7 +187,7 @@ def call(self, service, method, *args, **kwargs):
         Usage:
             >>> import SoftLayer
             >>> client = SoftLayer.create_client_from_env()
-            >>> client['Account'].getVirtualGuests(mask="id", limit=10)
+            >>> client.call('Account', 'getVirtualGuests', mask="id", limit=10)
             [...]
 
         """
@@ -354,7 +354,7 @@ def iter_call(self, name, *args, **kwargs):
         Usage:
             >>> import SoftLayer
             >>> client = SoftLayer.create_client_from_env()
-            >>> gen = client['Account'].getVirtualGuests(iter=True)
+            >>> gen = client.call('Account', 'getVirtualGuests', iter=True)
             >>> for virtual_guest in gen:
             ...     virtual_guest['id']
             ...
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -15,7 +15,7 @@ that will help to use the SoftLayer API.
 
 	>>> import SoftLayer
 	>>> client = SoftLayer.create_client_from_env(username="username", api_key="api_key")
-	>>> resp = client['Account'].getObject()
+	>>> resp = client.call('Account', 'getObject')
 	>>> resp['companyName']
 	'Your Company'
 
@@ -92,7 +92,7 @@ method on the
 service.
 ::
 
-    client['Account'].getObject()
+    client.call('Account', 'getObject')
 
 For a more complex example we'll retrieve a support ticket with id 123456 along
 with the ticket's updates, the user it's assigned to, the servers attached to
@@ -102,7 +102,7 @@ using an `object mask <http://developer.softlayer.com/article/Extended-Object-Ma
 Retrieve a ticket using object masks.
 ::
 
-    ticket = client['Ticket'].getObject(
+    ticket = client.call('Ticket', 'getObject',
         id=123456, mask="updates, assignedUser, attachedHardware.datacenter")
 
 
@@ -112,19 +112,19 @@ This uses a parameter, which translate to positional arguments in the order
 that they appear in the API docs.
 ::
 
-    update = client['Ticket'].addUpdate({'entry' : 'Hello!'}, id=123456)
+    update = client.call('Ticket', 'addUpdate', {'entry' : 'Hello!'}, id=123456)
 
 Let's get a listing of virtual guests using the domain example.com
 ::
 
-    client['Account'].getVirtualGuests(
+    client.call('Account', 'getVirtualGuests',
         filter={'virtualGuests': {'domain': {'operation': 'example.com'}}})
 
 This call gets tickets created between the beginning of March 1, 2013 and
 March 15, 2013.
 ::
 
-    client['Account'].getTickets(
+    client.call('Account', 'getTickets',
         filter={
             'tickets': {
                 'createDate': {
@@ -141,16 +141,16 @@ March 15, 2013.
 SoftLayer's XML-RPC API also allows for pagination.
 ::
 
-    client['Account'].getVirtualGuests(limit=10, offset=0)  # Page 1
-    client['Account'].getVirtualGuests(limit=10, offset=10)  # Page 2
+    client.call('Account', 'getVirtualGuests', limit=10, offset=0)  # Page 1
+    client.call('Account', 'getVirtualGuests', limit=10, offset=10)  # Page 2
 
 Here's how to create a new Cloud Compute Instance using
 `SoftLayer_Virtual_Guest.createObject <http://developer.softlayer.com/reference/services/SoftLayer_Virtual_Guest/createObject>`_.
 Be warned, this call actually creates an hourly virtual server so this will
 have billing implications.
 ::
 
-    client['Virtual_Guest'].createObject({
+    client.call('Virtual_Guest', 'createObject', {
             'hostname': 'myhostname',
             'domain': 'example.com',
             'startCpus': 1,
