Renamed issue token to get token (#16773)

Author: jbeauregardb

sdk/communication/azure-communication-identity/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+## 1.0.0-beta.5 (Unreleased)
+
+### Breaking
+- CommunicationIdentityClient's (synchronous and asynchronous) `issue_token` function is now renamed to `get_token`.
+
 ## 1.0.0b4 (2021-02-09)
 
 ### Added

sdk/communication/azure-communication-identity/README.md

@@ -65,13 +65,13 @@ print("Token issued with value: " + tokenresponse.token)
 
 ### Issuing or Refreshing an access token for a user
 
-Use the `issue_token` method to issue or refresh a scoped access token for the user. \
+Use the `get_token` method to issue or refresh a scoped access token for the user. \
 Pass in the user object as a parameter, and a list of `CommunicationTokenScope`. Scope options are:
 - `CHAT` (Chat)
 - `VOIP` (VoIP)
 
 ```python
-tokenresponse = identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
+tokenresponse = identity_client.get_token(user, scopes=[CommunicationTokenScope.CHAT])
 print("Token issued with value: " + tokenresponse.token)
 ```
 

sdk/communication/azure-communication-identity/azure/communication/identity/_communication_identity_client.py

@@ -129,7 +129,7 @@ def delete_user(
             communication_user.identifier, **kwargs)
 
     @distributed_trace
-    def issue_token(
+    def get_token(
             self,
             user, # type: CommunicationUserIdentifier
             scopes, # List[Union[str, "_model.CommunicationTokenScope"]]

sdk/communication/azure-communication-identity/azure/communication/identity/aio/_communication_identity_client_async.py

@@ -130,7 +130,7 @@ async def delete_user(
             communication_user.identifier, **kwargs)
 
     @distributed_trace_async
-    async def issue_token(
+    async def get_token(
             self,
             user, # type: CommunicationUserIdentifier
             scopes, # type: List[Union[str, "_model.CommunicationTokenScope"]]

sdk/communication/azure-communication-identity/samples/identity_samples.py

@@ -28,7 +28,7 @@ def __init__(self):
         self.client_secret = os.getenv('AZURE_CLIENT_SECRET')
         self.tenant_id = os.getenv('AZURE_TENANT_ID')
 
-    def issue_token(self):
+    def get_token(self):
         from azure.communication.identity import (
             CommunicationIdentityClient,
             CommunicationTokenScope
@@ -40,8 +40,8 @@ def issue_token(self):
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         user = identity_client.create_user()
-        print("Issuing token for: " + user.identifier)
-        tokenresponse = identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
+        print("Getting token for: " + user.identifier)
+        tokenresponse = identity_client.get_token(user, scopes=[CommunicationTokenScope.CHAT])
         print("Token issued with value: " + tokenresponse.token)
 
     def revoke_tokens(self):
@@ -56,7 +56,7 @@ def revoke_tokens(self):
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         user = identity_client.create_user()
-        tokenresponse = identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
+        tokenresponse = identity_client.get_token(user, scopes=[CommunicationTokenScope.CHAT])
         print("Revoking token: " + tokenresponse.token)
         identity_client.revoke_tokens(user)
         print(tokenresponse.token + " revoked successfully")
@@ -105,6 +105,6 @@ def delete_user(self):
     sample = CommunicationIdentityClientSamples()
     sample.create_user()
     sample.create_user_with_token()
-    sample.issue_token()
+    sample.get_token()
     sample.revoke_tokens()
     sample.delete_user()

sdk/communication/azure-communication-identity/samples/identity_samples_async.py

@@ -31,7 +31,7 @@ def __init__(self):
         self.client_secret = os.getenv('AZURE_CLIENT_SECRET')
         self.tenant_id = os.getenv('AZURE_TENANT_ID')
 
-    async def issue_token(self):
+    async def get_token(self):
         from azure.communication.identity.aio import CommunicationIdentityClient
         from azure.communication.identity import CommunicationTokenScope
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
@@ -43,7 +43,7 @@ async def issue_token(self):
         async with identity_client:
             user = await identity_client.create_user()
             print("Issuing token for: " + user.identifier)
-            tokenresponse = await identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
+            tokenresponse = await identity_client.get_token(user, scopes=[CommunicationTokenScope.CHAT])
             print("Token issued with value: " + tokenresponse.token)
 
     async def revoke_tokens(self):
@@ -57,7 +57,7 @@ async def revoke_tokens(self):
 
         async with identity_client:
             user = await identity_client.create_user()
-            tokenresponse = await identity_client.issue_token(user, scopes=[CommunicationTokenScope.CHAT])
+            tokenresponse = await identity_client.get_token(user, scopes=[CommunicationTokenScope.CHAT])
             print("Revoking token: " + tokenresponse.token)
             await identity_client.revoke_tokens(user)
             print(tokenresponse.token + " revoked successfully")
@@ -108,7 +108,7 @@ async def main():
     sample = CommunicationIdentityClientSamples()
     await sample.create_user()
     await sample.create_user_with_token()
-    await sample.issue_token()
+    await sample.get_token()
     await sample.revoke_tokens()
     await sample.delete_user()