fix: Update README / docstring for Authenticating Client (#684)

Author: claudiachua

README.md

@@ -58,15 +58,26 @@ Getting started with the Twilio API couldn't be easier. Create a
 
 ### API Credentials
 
-The `Twilio` needs your Twilio credentials. You can either pass these
+The `Twilio` client needs your Twilio credentials. You can either pass these
 directly to the constructor (see the code below) or via environment variables.
 
+Authenticating with Account SID and Auth Token:
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+account_sid = "ACXXXXXXXXXXXXXXXXX"
+auth_token = "YYYYYYYYYYYYYYYYYY"
+client = Client(account_sid, auth_token)
+```
+
+Authenticating with API Key and API Secret:
+```python
+from twilio.rest import Client
+
+api_key = "XXXXXXXXXXXXXXXXX"
+api_secret = "YYYYYYYYYYYYYYYYYY"
+account_sid = "ACXXXXXXXXXXXXXXXXX"
+client = Client(api_key, api_secret, account_sid)
 ```
 
 Alternatively, a `Client` constructor without these parameters will
@@ -111,9 +122,9 @@ This will result in the `hostname` transforming from `api.twilio.com` to `api.sy
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 call = client.calls.create(to="9991231234",
                            from_="9991231234",
@@ -126,9 +137,9 @@ print(call.sid)
 ```python
 from twilio.rest import Client
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 message = client.messages.create(to="+12316851234", from_="+15555555555",
                                  body="Hello there!")
@@ -143,10 +154,10 @@ from twilio.http.async_http_client import AsyncTwilioHttpClient
 from twilio.rest import Client
 
 async def main():
-    account = "ACXXXXXXXXXXXXXXXXX"
-    token = "YYYYYYYYYYYYYYYYYY"
+    username = "ACXXXXXXXXXXXXXXXXX"
+    password = "YYYYYYYYYYYYYYYYYY"
     http_client = AsyncTwilioHttpClient()
-    client = Client(account, token, http_client=http_client)
+    client = Client(username, password, http_client=http_client)
 
     message = await client.messages.create_async(to="+12316851234", from_="+15555555555",
                                                  body="Hello there!")
@@ -161,7 +172,7 @@ Log the API request and response data to the console:
 ```python
 import logging
 
-client = Client(account, token)
+client = Client(username, password)
 logging.basicConfig()
 client.http_client.logger.setLevel(logging.INFO)
 ```
@@ -171,7 +182,7 @@ Log the API request and response data to a file:
 ```python
 import logging
 
-client = Client(account, token)
+client = Client(username, password)
 logging.basicConfig(filename='./log.txt')
 client.http_client.logger.setLevel(logging.INFO)
 ```
@@ -182,9 +193,9 @@ client.http_client.logger.setLevel(logging.INFO)
 from twilio.rest import Client
 from twilio.base.exceptions import TwilioRestException
 
-account = "ACXXXXXXXXXXXXXXXXX"
-token = "YYYYYYYYYYYYYYYYYY"
-client = Client(account, token)
+username = "ACXXXXXXXXXXXXXXXXX"
+password = "YYYYYYYYYYYYYYYYYY"
+client = Client(username, password)
 
 try:
   message = client.messages.create(to="+12316851234", from_="+15555555555",

twilio/rest/__init__.py

@@ -28,9 +28,9 @@ def __init__(
         """
         Initializes the Twilio Client
 
-        :param str username: Username to authenticate with
-        :param str password: Password to authenticate with
-        :param str account_sid: Account SID, defaults to Username
+        :param str username: Username to authenticate with, either account_sid or api_key
+        :param str password: Password to authenticate with, auth_token (if using account_sid) or api_secret (if using api_key)
+        :param str account_sid: Account SID, required if using api_key to authenticate.
         :param str region: Twilio Region to make requests to, defaults to 'us1' if an edge is provided
         :param HttpClient http_client: HttpClient, defaults to TwilioHttpClient
         :param dict environment: Environment to look for auth details, defaults to os.environ