[Communication] - Common - Adding Identifier Suffix to all Identifier types (Azure#17608)

* Adding Identifier Suffix to all Identifier types

* Update generated files

* Fix minor issues

* Update changelog

Co-authored-by: Minnie Liu <peiliu@microsoft.com>

Author: minnieliu

sdk/communication/Azure.Communication.Administration/README.md

@@ -48,8 +48,8 @@ var client = new CommunicationIdentityClient(connectionString);
 
 ### Create a new identity
 ```C# Snippet:CreateCommunicationUserAsync
-Response<CommunicationUser> userResponse = await client.CreateUserAsync();
-CommunicationUser user = userResponse.Value;
+Response<CommunicationUserIdentifier> userResponse = await client.CreateUserAsync();
+CommunicationUserIdentifier user = userResponse.Value;
 Console.WriteLine($"User id: {user.Id}");
 ```
 
@@ -85,7 +85,7 @@ var client = new CommunicationIdentityClient(connectionString);
 
 try
 {
-    Response<CommunicationUser> response = await client.CreateUserAsync();
+    Response<CommunicationUserIdentifier> response = await client.CreateUserAsync();
 }
 catch (RequestFailedException ex)
 {

sdk/communication/Azure.Communication.Administration/api/Azure.Communication.Administration.netstandard2.0.cs

@@ -20,8 +20,8 @@ var client = new CommunicationIdentityClient(connectionString);
 The `CommunicationIdentityClient` can be used to create users and issue tokens.
 
 ```C# Snippet:CreateCommunicationUser
-Response<CommunicationUser> userResponse = client.CreateUser();
-CommunicationUser user = userResponse.Value;
+Response<CommunicationUserIdentifier> userResponse = client.CreateUser();
+CommunicationUserIdentifier user = userResponse.Value;
 Console.WriteLine($"User id: {user.Id}");
 ```
 

sdk/communication/Azure.Communication.Administration/samples/Sample1_CommunicationIdentityClient.md

@@ -20,8 +20,8 @@ var client = new CommunicationIdentityClient(connectionString);
 The `CommunicationIdentityClient` can be used to create users and issue tokens.
 
 ```C# Snippet:CreateCommunicationUserAsync
-Response<CommunicationUser> userResponse = await client.CreateUserAsync();
-CommunicationUser user = userResponse.Value;
+Response<CommunicationUserIdentifier> userResponse = await client.CreateUserAsync();
+CommunicationUserIdentifier user = userResponse.Value;
 Console.WriteLine($"User id: {user.Id}");
 ```
 

sdk/communication/Azure.Communication.Administration/samples/Sample1_CommunicationIdentityClientAsync.md

@@ -189,7 +189,7 @@ If you no longer need a phone number you can release it.
 
 ```C# Snippet:ReleasePhoneNumbers
 var acquiredPhoneNumber = "<acquired_phone_number>";
-var releaseOperation = client.StartReleasePhoneNumber(new PhoneNumber(acquiredPhoneNumber));
+var releaseOperation = client.StartReleasePhoneNumber(new PhoneNumberIdentifier(acquiredPhoneNumber));
 
 while (!releaseOperation.HasCompleted)
 {

sdk/communication/Azure.Communication.Administration/samples/Sample2_PhoneNumberAdministrationClient.md

@@ -171,6 +171,6 @@ If you no longer need a phone number you can release it.
 
 ```C# Snippet:ReleasePhoneNumbersAsync
 var acquiredPhoneNumber = "<acquired_phone_number>";
-var releaseOperation = client.StartReleasePhoneNumber(new PhoneNumber(acquiredPhoneNumber));
+var releaseOperation = client.StartReleasePhoneNumber(new PhoneNumberIdentifier(acquiredPhoneNumber));
 await releaseOperation.WaitForCompletionAsync();
 ```

sdk/communication/Azure.Communication.Administration/samples/Sample2_PhoneNumberAdministrationClientAsync.md

@@ -64,16 +64,16 @@ protected CommunicationIdentityClient()
             RestClient = null!;
         }
 
-        /// <summary>Asynchronously creates a new <see cref="CommunicationUser"/>.</summary>
+        /// <summary>Asynchronously creates a new <see cref="CommunicationUserIdentifier"/>.</summary>
         /// <param name="cancellationToken">The cancellation token to use.</param>
-        public virtual async Task<Response<CommunicationUser>> CreateUserAsync(CancellationToken cancellationToken = default)
+        public virtual async Task<Response<CommunicationUserIdentifier>> CreateUserAsync(CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(CreateUser)}");
             scope.Start();
             try
             {
                 Response<CommunicationIdentity> response = await RestClient.CreateAsync(cancellationToken).ConfigureAwait(false);
-                return Response.FromValue(new CommunicationUser(response.Value.Id), response.GetRawResponse());
+                return Response.FromValue(new CommunicationUserIdentifier(response.Value.Id), response.GetRawResponse());
             }
             catch (Exception ex)
             {
@@ -82,18 +82,18 @@ public virtual async Task<Response<CommunicationUser>> CreateUserAsync(Cancellat
             }
         }
 
-        /// <summary>Creates a new <see cref="CommunicationUser"/>.</summary>
-        /// <returns>A <see cref="Response{CommunicationUser}"/>.</returns>
+        /// <summary>Creates a new <see cref="CommunicationUserIdentifier"/>.</summary>
+        /// <returns>A <see cref="Response{CommunicationUserIdentifier}"/>.</returns>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
-        public virtual Response<CommunicationUser> CreateUser(CancellationToken cancellationToken = default)
+        public virtual Response<CommunicationUserIdentifier> CreateUser(CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(CreateUser)}");
             scope.Start();
             try
             {
                 Response<CommunicationIdentity> response = RestClient.Create(cancellationToken);
-                return Response.FromValue(new CommunicationUser(response.Value.Id), response.GetRawResponse());
+                return Response.FromValue(new CommunicationUserIdentifier(response.Value.Id), response.GetRawResponse());
             }
             catch (Exception ex)
             {
@@ -102,10 +102,10 @@ public virtual Response<CommunicationUser> CreateUser(CancellationToken cancella
             }
         }
 
-        /// <summary>Asynchronously deletes a <see cref="CommunicationUser"/>, revokes its tokens and deletes its data.</summary>
+        /// <summary>Asynchronously deletes a <see cref="CommunicationUserIdentifier"/>, revokes its tokens and deletes its data.</summary>
         /// <param name="communicationUser"> The user to be deleted.</param>
         /// <param name="cancellationToken"> The cancellation token to use.</param>
-        public virtual async Task<Response> DeleteUserAsync(CommunicationUser communicationUser, CancellationToken cancellationToken = default)
+        public virtual async Task<Response> DeleteUserAsync(CommunicationUserIdentifier communicationUser, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(DeleteUser)}");
             scope.Start();
@@ -120,11 +120,11 @@ public virtual async Task<Response> DeleteUserAsync(CommunicationUser communicat
             }
         }
 
-        /// <summary>Asynchronously deletes a <see cref="CommunicationUser"/>, revokes its tokens and deletes its data.</summary>
+        /// <summary>Asynchronously deletes a <see cref="CommunicationUserIdentifier"/>, revokes its tokens and deletes its data.</summary>
         /// <param name="communicationUser"> The user to be deleted.</param>
         /// <param name="cancellationToken"> The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
-        public virtual Response DeleteUser(CommunicationUser communicationUser, CancellationToken cancellationToken = default)
+        public virtual Response DeleteUser(CommunicationUserIdentifier communicationUser, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(DeleteUser)}");
             scope.Start();
@@ -139,11 +139,11 @@ public virtual Response DeleteUser(CommunicationUser communicationUser, Cancella
             }
         }
 
-        /// <summary>Asynchronously revokes all the tokens created for a <see cref="CommunicationUser"/>.</summary>
-        /// <param name="communicationUser">The <see cref="CommunicationUser"/> whose tokens should get revoked.</param>
+        /// <summary>Asynchronously revokes all the tokens created for a <see cref="CommunicationUserIdentifier"/>.</summary>
+        /// <param name="communicationUser">The <see cref="CommunicationUserIdentifier"/> whose tokens should get revoked.</param>
         /// <param name="issuedBefore">All tokens that are issued prior to this time will be revoked.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
-        public virtual async Task<Response> RevokeTokensAsync(CommunicationUser communicationUser, DateTimeOffset? issuedBefore = default, CancellationToken cancellationToken = default)
+        public virtual async Task<Response> RevokeTokensAsync(CommunicationUserIdentifier communicationUser, DateTimeOffset? issuedBefore = default, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(RevokeTokens)}");
             scope.Start();
@@ -159,11 +159,11 @@ public virtual async Task<Response> RevokeTokensAsync(CommunicationUser communic
         }
 
         /// <summary>Revokes all the tokens created for a user.</summary>
-        /// <param name="communicationUser">The <see cref="CommunicationUser"/> whose tokens will be revoked.</param>
+        /// <param name="communicationUser">The <see cref="CommunicationUserIdentifier"/> whose tokens will be revoked.</param>
         /// <param name="issuedBefore">All tokens that are issued prior to this time should get revoked.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
-        public virtual Response RevokeTokens(CommunicationUser communicationUser, DateTimeOffset? issuedBefore = default, CancellationToken cancellationToken = default)
+        public virtual Response RevokeTokens(CommunicationUserIdentifier communicationUser, DateTimeOffset? issuedBefore = default, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(RevokeTokens)}");
             scope.Start();
@@ -178,11 +178,11 @@ public virtual Response RevokeTokens(CommunicationUser communicationUser, DateTi
             }
         }
 
-        /// <summary>Asynchronously issues a token for a <see cref="CommunicationUser"/>.</summary>
+        /// <summary>Asynchronously issues a token for a <see cref="CommunicationUserIdentifier"/>.</summary>
         /// <param name="scopes">The scopes that the token should have.</param>
-        /// <param name="communicationUser">The <see cref="CommunicationUser"/> for whom to issue a token.</param>
+        /// <param name="communicationUser">The <see cref="CommunicationUserIdentifier"/> for whom to issue a token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
-        public virtual async Task<Response<CommunicationUserToken>> IssueTokenAsync(CommunicationUser communicationUser, IEnumerable<CommunicationTokenScope> scopes, CancellationToken cancellationToken = default)
+        public virtual async Task<Response<CommunicationUserToken>> IssueTokenAsync(CommunicationUserIdentifier communicationUser, IEnumerable<CommunicationTokenScope> scopes, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(IssueToken)}");
             scope.Start();
@@ -197,12 +197,12 @@ public virtual async Task<Response<CommunicationUserToken>> IssueTokenAsync(Comm
             }
         }
 
-        /// <summary>Issues a token for a <see cref="CommunicationUser"/>.</summary>
+        /// <summary>Issues a token for a <see cref="CommunicationUserIdentifier"/>.</summary>
         /// <param name="scopes">The scopes that the token should have.</param>
-        /// <param name="communicationUser">The <see cref="CommunicationUser"/> for whom to issue a token.</param>
+        /// <param name="communicationUser">The <see cref="CommunicationUserIdentifier"/> for whom to issue a token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
-        public virtual Response<CommunicationUserToken> IssueToken(CommunicationUser communicationUser, IEnumerable<CommunicationTokenScope> scopes, CancellationToken cancellationToken = default)
+        public virtual Response<CommunicationUserToken> IssueToken(CommunicationUserIdentifier communicationUser, IEnumerable<CommunicationTokenScope> scopes, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(IssueToken)}");
             scope.Start();

sdk/communication/Azure.Communication.Administration/src/CommunicationIdentityClient.cs

@@ -12,15 +12,15 @@ public partial class CommunicationUserToken
         internal CommunicationUserToken(string id, string token, DateTimeOffset expiresOn)
         {
             Id = id;
-            User = new CommunicationUser(id);
+            User = new CommunicationUserIdentifier(id);
             Token = token;
             ExpiresOn = expiresOn;
         }
 
         /// <summary>
-        /// The <see cref="CommunicationUser" /> for which the token is being issued.
+        /// The <see cref="CommunicationUserIdentifier" /> for which the token is being issued.
         /// </summary>
-        public CommunicationUser User { get; }
+        public CommunicationUserIdentifier User { get; }
         internal string Id { get; }
     }
 }