[Communication] - PhoneNumbers - Rename API methods (Azure#19408)

* Rename API methods
* Update changelog

Author: pavelprystinka

sdk/communication/Azure.Communication.PhoneNumbers/CHANGELOG.md

@@ -3,6 +3,15 @@
 ## 1.0.0-beta.6 (Unreleased)
 
 
+### Breaking Changes
+- AcquiredPhoneNumber class is renamed to PurchasedPhoneNumber
+- PhoneNumbersClient methods renamed:
+  - GetPhoneNumber -> GetPurchasedPhoneNumber
+  - GetPhoneNumberAsync -> GetPurchasedPhoneNumberAsync
+  - GetPhoneNumbers -> GetPurchasedPhoneNumbers
+  - GetPhoneNumbersAsync -> GetPurchasedPhoneNumbersAsync
+- PhoneNumbersModelFactory static method AcquiredPhoneNumber is renamed to PurchasedPhoneNumber
+
 ## 1.0.0-beta.5 (2021-03-09)
 
 ### Added

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

@@ -116,14 +116,14 @@ var purchaseOperation = await client.StartPurchasePhoneNumbersAsync(searchOperat
 await purchaseOperation.WaitForCompletionAsync();
 ```
 
-## Listing acquired phone numbers
+## Listing purchased phone numbers
 
-You can list all phone numbers that have been acquired for your resource.
+You can list all phone numbers that have been purchased for your resource.
 
-```C# Snippet:ListAcquiredPhoneNumbersAsync
-var acquiredPhoneNumbers = client.GetPhoneNumbersAsync();
+```C# Snippet:GetPurchasedPhoneNumbersAsync
+var purchasedPhoneNumbers = client.GetPurchasedPhoneNumbersAsync();
 
-await foreach (var phoneNumber in acquiredPhoneNumbers)
+await foreach (var phoneNumber in purchasedPhoneNumbers)
 {
     Console.WriteLine($"Phone number: {phoneNumber.PhoneNumber}, monthly cost: {phoneNumber.Cost}");
 }
@@ -134,8 +134,8 @@ await foreach (var phoneNumber in acquiredPhoneNumbers)
 If you no longer need a phone number you can release it.
 
 ```C# Snippet:ReleasePhoneNumbersAsync
-var acquiredPhoneNumber = "<acquired_phone_number>";
-var releaseOperation = client.StartReleasePhoneNumber(acquiredPhoneNumber);
+var purchasedPhoneNumber = "<purchased_phone_number>";
+var releaseOperation = client.StartReleasePhoneNumber(purchasedPhoneNumber);
 await releaseOperation.WaitForCompletionAsync();
 ```
 

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

@@ -7,10 +7,10 @@ public PhoneNumbersClient(string connectionString) { }
         public PhoneNumbersClient(string connectionString, Azure.Communication.PhoneNumbers.PhoneNumbersClientOptions options) { }
         public PhoneNumbersClient(System.Uri endpoint, Azure.AzureKeyCredential keyCredential, Azure.Communication.PhoneNumbers.PhoneNumbersClientOptions options = null) { }
         public PhoneNumbersClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential, Azure.Communication.PhoneNumbers.PhoneNumbersClientOptions options = null) { }
-        public virtual Azure.Response<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber> GetPhoneNumber(string phoneNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber>> GetPhoneNumberAsync(string phoneNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Pageable<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber> GetPhoneNumbers(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.AsyncPageable<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber> GetPhoneNumbersAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber> GetPurchasedPhoneNumber(string phoneNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber>> GetPurchasedPhoneNumberAsync(string phoneNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Pageable<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber> GetPurchasedPhoneNumbers(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AsyncPageable<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber> GetPurchasedPhoneNumbersAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Communication.PhoneNumbers.PurchasePhoneNumbersOperation StartPurchasePhoneNumbers(string searchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Communication.PhoneNumbers.PurchasePhoneNumbersOperation> StartPurchasePhoneNumbersAsync(string searchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Communication.PhoneNumbers.ReleasePhoneNumberOperation StartReleasePhoneNumber(string phoneNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
@@ -73,34 +73,22 @@ internal SearchAvailablePhoneNumbersOperation() { }
         public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.PhoneNumberSearchResult>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.PhoneNumberSearchResult>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
-    public partial class UpdatePhoneNumberCapabilitiesOperation : Azure.Operation<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber>
+    public partial class UpdatePhoneNumberCapabilitiesOperation : Azure.Operation<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber>
     {
         internal UpdatePhoneNumberCapabilitiesOperation() { }
         public override bool HasCompleted { get { throw null; } }
         public override bool HasValue { get { throw null; } }
         public override string Id { get { throw null; } }
-        public override Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber Value { get { throw null; } }
+        public override Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber Value { get { throw null; } }
         public override Azure.Response GetRawResponse() { throw null; }
         public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public override System.Threading.Tasks.ValueTask<Azure.Response> UpdateStatusAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
 }
 namespace Azure.Communication.PhoneNumbers.Models
 {
-    public partial class AcquiredPhoneNumber
-    {
-        internal AcquiredPhoneNumber() { }
-        public Azure.Communication.PhoneNumbers.Models.PhoneNumberAssignmentType AssignmentType { get { throw null; } }
-        public Azure.Communication.PhoneNumbers.Models.PhoneNumberCapabilities Capabilities { get { throw null; } }
-        public Azure.Communication.PhoneNumbers.Models.PhoneNumberCost Cost { get { throw null; } }
-        public string CountryCode { get { throw null; } }
-        public string Id { get { throw null; } }
-        public string PhoneNumber { get { throw null; } }
-        public Azure.Communication.PhoneNumbers.Models.PhoneNumberType PhoneNumberType { get { throw null; } }
-        public System.DateTimeOffset PurchaseDate { get { throw null; } }
-    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct BillingFrequency : System.IEquatable<Azure.Communication.PhoneNumbers.Models.BillingFrequency>
     {
@@ -222,8 +210,8 @@ internal PhoneNumberSearchResult() { }
     }
     public static partial class PhoneNumbersModelFactory
     {
-        public static Azure.Communication.PhoneNumbers.Models.AcquiredPhoneNumber AcquiredPhoneNumber(string id, string phoneNumber, string countryCode, Azure.Communication.PhoneNumbers.Models.PhoneNumberType phoneNumberType, Azure.Communication.PhoneNumbers.Models.PhoneNumberCapabilities capabilities, Azure.Communication.PhoneNumbers.Models.PhoneNumberAssignmentType assignmentType, System.DateTimeOffset purchaseDate, Azure.Communication.PhoneNumbers.Models.PhoneNumberCost cost) { throw null; }
         public static Azure.Communication.PhoneNumbers.Models.PhoneNumberCost PhoneNumberCost(double amount, string currencyCode, string billingFrequency) { throw null; }
+        public static Azure.Communication.PhoneNumbers.Models.PurchasedPhoneNumber PurchasedPhoneNumber(string id, string phoneNumber, string countryCode, Azure.Communication.PhoneNumbers.Models.PhoneNumberType phoneNumberType, Azure.Communication.PhoneNumbers.Models.PhoneNumberCapabilities capabilities, Azure.Communication.PhoneNumbers.Models.PhoneNumberAssignmentType assignmentType, System.DateTimeOffset purchaseDate, Azure.Communication.PhoneNumbers.Models.PhoneNumberCost cost) { throw null; }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct PhoneNumberType : System.IEquatable<Azure.Communication.PhoneNumbers.Models.PhoneNumberType>
@@ -243,4 +231,16 @@ public static partial class PhoneNumbersModelFactory
         public static bool operator !=(Azure.Communication.PhoneNumbers.Models.PhoneNumberType left, Azure.Communication.PhoneNumbers.Models.PhoneNumberType right) { throw null; }
         public override string ToString() { throw null; }
     }
+    public partial class PurchasedPhoneNumber
+    {
+        internal PurchasedPhoneNumber() { }
+        public Azure.Communication.PhoneNumbers.Models.PhoneNumberAssignmentType AssignmentType { get { throw null; } }
+        public Azure.Communication.PhoneNumbers.Models.PhoneNumberCapabilities Capabilities { get { throw null; } }
+        public Azure.Communication.PhoneNumbers.Models.PhoneNumberCost Cost { get { throw null; } }
+        public string CountryCode { get { throw null; } }
+        public string Id { get { throw null; } }
+        public string PhoneNumber { get { throw null; } }
+        public Azure.Communication.PhoneNumbers.Models.PhoneNumberType PhoneNumberType { get { throw null; } }
+        public System.DateTimeOffset PurchaseDate { get { throw null; } }
+    }
 }

sdk/communication/Azure.Communication.PhoneNumbers/samples/Sample_PhoneNumbersClient.md

@@ -45,14 +45,14 @@ while (!purchaseOperation.HasCompleted)
 }
 ```
 
-## Listing acquired phone numbers
+## Listing purchased phone numbers
 
 You can list all phone numbers that have been acquired for your resource.
 
-```C# Snippet:ListAcquiredPhoneNumbers
-var acquiredPhoneNumbers = client.GetPhoneNumbers();
+```C# Snippet:GetPurchasedPhoneNumbers
+var purchasedPhoneNumbers = client.GetPurchasedPhoneNumbers();
 
-foreach (var phoneNumber in acquiredPhoneNumbers)
+foreach (var phoneNumber in purchasedPhoneNumbers)
 {
     Console.WriteLine($"Phone number: {phoneNumber.PhoneNumber}, monthly cost: {phoneNumber.Cost}");
 }
@@ -63,7 +63,7 @@ foreach (var phoneNumber in acquiredPhoneNumbers)
 Phone number's capabilities can be updated by started by `StartUpdateCapabilities` function.
 
 ```C# Snippet:UpdateCapabilitiesNumbers
-var updateCapabilitiesOperation = client.StartUpdateCapabilities(acquiredPhoneNumber, calling:PhoneNumberCapabilityType.Outbound, sms:PhoneNumberCapabilityType.InboundOutbound);
+var updateCapabilitiesOperation = client.StartUpdateCapabilities(purchasedPhoneNumber, calling:PhoneNumberCapabilityType.Outbound, sms:PhoneNumberCapabilityType.InboundOutbound);
 
 while (!updateCapabilitiesOperation.HasCompleted)
 {
@@ -77,8 +77,8 @@ while (!updateCapabilitiesOperation.HasCompleted)
 If you no longer need a phone number you can release it.
 
 ```C# Snippet:ReleasePhoneNumbers
-var acquiredPhoneNumber = "<acquired_phone_number>";
-var releaseOperation = client.StartReleasePhoneNumber(acquiredPhoneNumber);
+var purchasedPhoneNumber = "<purchased_phone_number>";
+var releaseOperation = client.StartReleasePhoneNumber(purchasedPhoneNumber);
 
 while (!releaseOperation.HasCompleted)
 {

sdk/communication/Azure.Communication.PhoneNumbers/samples/Sample_PhoneNumbersClientAsync.md

@@ -35,14 +35,14 @@ var purchaseOperation = await client.StartPurchasePhoneNumbersAsync(searchOperat
 await purchaseOperation.WaitForCompletionAsync();
 ```
 
-## Listing acquired phone numbers
+## Listing purchased phone numbers
 
 You can list all phone numbers that have been acquired for your resource.
 
-```C# Snippet:ListAcquiredPhoneNumbersAsync
-var acquiredPhoneNumbers = client.GetPhoneNumbersAsync();
+```C# Snippet:GetPurchasedPhoneNumbersAsync
+var purchasedPhoneNumbers = client.GetPurchasedPhoneNumbersAsync();
 
-await foreach (var phoneNumber in acquiredPhoneNumbers)
+await foreach (var phoneNumber in purchasedPhoneNumbers)
 {
     Console.WriteLine($"Phone number: {phoneNumber.PhoneNumber}, monthly cost: {phoneNumber.Cost}");
 }
@@ -53,7 +53,7 @@ await foreach (var phoneNumber in acquiredPhoneNumbers)
 Phone number's capabilities can be updated by started by `StartUpdateCapabilities` function.
 
 ```C# Snippet:UpdateCapabilitiesNumbersAsync
-var updateCapabilitiesOperation = client.StartUpdateCapabilities(acquiredPhoneNumber, calling: PhoneNumberCapabilityType.Outbound, sms: PhoneNumberCapabilityType.InboundOutbound);
+var updateCapabilitiesOperation = client.StartUpdateCapabilities(purchasedPhoneNumber, calling: PhoneNumberCapabilityType.Outbound, sms: PhoneNumberCapabilityType.InboundOutbound);
 
 await updateCapabilitiesOperation.WaitForCompletionAsync();
 ```
@@ -63,7 +63,7 @@ await updateCapabilitiesOperation.WaitForCompletionAsync();
 If you no longer need a phone number you can release it.
 
 ```C# Snippet:ReleasePhoneNumbersAsync
-var acquiredPhoneNumber = "<acquired_phone_number>";
-var releaseOperation = client.StartReleasePhoneNumber(acquiredPhoneNumber);
+var purchasedPhoneNumber = "<purchased_phone_number>";
+var releaseOperation = client.StartReleasePhoneNumber(purchasedPhoneNumber);
 await releaseOperation.WaitForCompletionAsync();
 ```