[Communication] - SMS - API Design and Implementation 03-07 (Azure#19073)

* Initial commit of new SMS API

* Fix build

* Resolve PR comments and implement SmsModelFactory

* Fix build

* Regenerate export api

* Address review comments

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

Author: minnieliu

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

@@ -4,8 +4,15 @@
 
 ### Added
 - Added support to create SmsClient with AzureKeyCredential.
-- Support for creating SmsClient with TokenCredential
-
+- Support for creating SmsClient with TokenCredential.
+- Added support for 1:N SMS messaging.
+- Added support for tagging SMS messages.
+- Send method series in SmsClient are idempotent under retry policy.
+
+### Breaking
+- Updated `Task<Response<SendSmsResponse>> SendAsync(PhoneNumberIdentifier from, PhoneNumberIdentifier to, string message, SendSmsOptions sendSmsOptions = null, CancellationToken cancellationToken = default)`
+to `Task<Response<SmsSendResult>> SendAsync(string from, string to, string message, Models.SmsSendOptions options = default)`
+- Replaced `SendSmsResponse` with `SmsSendResult`
 
 ## 1.0.0-beta.3 (2020-11-16)
 

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

@@ -1,6 +1,6 @@
 # Azure Communication SMS client library for .NET
 > Server Version: 
-Chat client: 2020-07-20-preview1
+Sms client: 2021-03-07
 
 This package contains a C# SDK for Azure Communication Services for SMS and Telephony.
 
@@ -11,7 +11,7 @@ This package contains a C# SDK for Azure Communication Services for SMS and Tele
 Install the Azure Communication SMS client library for .NET with [NuGet][nuget]:
 
 ```PowerShell
-dotnet add package Azure.Communication.Sms --version 1.0.0-beta.3
+dotnet add package Azure.Communication.Sms --version 1.0.0-beta.4
 ``` 
 
 ### Prerequisites
@@ -25,6 +25,7 @@ To create a new Communication Service, you can use the [Azure Portal][communicat
 ### Using statements
 ```C# Snippet:Azure_Communication_Sms_Tests_UsingStatements
 using System;
+using System.Collections.Generic;
 using Azure.Communication.Sms;
 ```
 
@@ -45,40 +46,43 @@ TokenCredential tokenCredential = new DefaultAzureCredential();
 SmsClient client = new SmsClient(new Uri(endpoint), tokenCredential);
 ```
 
-### Thread safety
-We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
-
-### Additional concepts
-<!-- CLIENT COMMON BAR -->
-[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
-[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
-[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
-[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
-[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) |
-[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) |
-[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
-<!-- CLIENT COMMON BAR -->
-
 ## Examples
 ### Send a SMS Message
 To send a SMS message, call the `Send` or `SendAsync` function from the `SmsClient`.
 ```C# Snippet:Azure_Communication_Sms_Tests_SendAsync
-SendSmsResponse result = await client.SendAsync(
-   from: new PhoneNumber("+18001230000"), // Phone number acquired on your Azure Communication resource
-   to: new PhoneNumber("+18005670000"),
+SmsSendResult result = await client.SendAsync(
+   from: "+18001230000" // Phone number acquired on your Azure Communication resource
+   to: "+18005670000",
    message: "Hi");
 Console.WriteLine($"Sms id: {result.MessageId}");
 ```
-
+### Send a Group SMS Message
+To send a SMS message to a list of recipients, call the `Send` or `SendAsync` function from the `SmsClient` with a list of recipient's phone numbers.
+You may also add pass in an options object to specify whether the delivery report should be enabled and set custom tags.
+```C# Snippet:Azure_Communication_SmsClient_Send_GroupSmsWithOptions
+Response<IEnumerable<SmsSendResult>> response = await client.SendAsync(
+   from: "+18001230000" // Phone number acquired on your Azure Communication resource
+   to: new string[] {"+18005670000", "+18008900000}",
+   message: "Hi",
+   options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
+   {
+       Tag = "marketing", // custom tags
+   });
+IEnumerable<SmsSendResult> results = response.Value;
+foreach (SmsSendResult result in results)
+{
+    Console.WriteLine($"Sms id: {result.MessageId}");
+}
+```
 ## Troubleshooting
 All SMS operations will throw a RequestFailedException on failure.
 
 ```C# Snippet:Azure_Communication_Sms_Tests_Troubleshooting
 try
 {
-    SendSmsResponse result = await client.SendAsync(
-       from: new PhoneNumber("+18001230000"), // Phone number acquired on your Azure Communication resource
-       to: new PhoneNumber("+18005670000"),
+    SmsSendResult result = await client.SendAsync(
+       from: "+18001230000" // Phone number acquired on your Azure Communication resource
+       to: "+18005670000",
        message: "Hi");
     Console.WriteLine($"Sms id: {result.MessageId}");
 }
@@ -112,4 +116,3 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
 [nextsteps]:https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-csharp
 [nuget]: https://www.nuget.org/
 [source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/communication/Azure.Communication.Sms/src
-

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

@@ -1,41 +1,45 @@
 namespace Azure.Communication.Sms
 {
-    public partial class SendSmsOptions
-    {
-        public SendSmsOptions() { }
-        public bool? EnableDeliveryReport { get { throw null; } set { } }
-    }
-    public partial class SendSmsResponse
-    {
-        internal SendSmsResponse() { }
-        public string MessageId { get { throw null; } }
-    }
     public partial class SmsClient
     {
         protected SmsClient() { }
         public SmsClient(string connectionString) { }
         public SmsClient(string connectionString, Azure.Communication.Sms.SmsClientOptions options) { }
         public SmsClient(System.Uri endpoint, Azure.AzureKeyCredential keyCredential, Azure.Communication.Sms.SmsClientOptions options = null) { }
         public SmsClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential, Azure.Communication.Sms.SmsClientOptions options = null) { }
-        public virtual Azure.Response<Azure.Communication.Sms.SendSmsResponse> Send(Azure.Communication.PhoneNumberIdentifier from, Azure.Communication.PhoneNumberIdentifier to, string message, Azure.Communication.Sms.SendSmsOptions sendSmsOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Response<Azure.Communication.Sms.SendSmsResponse> Send(Azure.Communication.PhoneNumberIdentifier from, System.Collections.Generic.IEnumerable<Azure.Communication.PhoneNumberIdentifier> to, string message, Azure.Communication.Sms.SendSmsOptions sendSmsOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Sms.SendSmsResponse>> SendAsync(Azure.Communication.PhoneNumberIdentifier from, Azure.Communication.PhoneNumberIdentifier to, string message, Azure.Communication.Sms.SendSmsOptions sendSmsOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Sms.SendSmsResponse>> SendAsync(Azure.Communication.PhoneNumberIdentifier from, System.Collections.Generic.IEnumerable<Azure.Communication.PhoneNumberIdentifier> to, string message, Azure.Communication.Sms.SendSmsOptions sendSmsOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<System.Collections.Generic.IEnumerable<Azure.Communication.Sms.SmsSendResult>> Send(string from, System.Collections.Generic.IEnumerable<string> to, string message, Azure.Communication.Sms.SmsSendOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Communication.Sms.SmsSendResult> Send(string from, string to, string message, Azure.Communication.Sms.SmsSendOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IEnumerable<Azure.Communication.Sms.SmsSendResult>>> SendAsync(string from, System.Collections.Generic.IEnumerable<string> to, string message, Azure.Communication.Sms.SmsSendOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Sms.SmsSendResult>> SendAsync(string from, string to, string message, Azure.Communication.Sms.SmsSendOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class SmsClientOptions : Azure.Core.ClientOptions
     {
-        public const Azure.Communication.Sms.SmsClientOptions.ServiceVersion LatestVersion = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V1;
-        public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V1, Azure.Core.RetryOptions retryOptions = null, Azure.Core.Pipeline.HttpPipelineTransport transport = null) { }
+        public SmsClientOptions(Azure.Communication.Sms.SmsClientOptions.ServiceVersion version = Azure.Communication.Sms.SmsClientOptions.ServiceVersion.V2021_03_07) { }
         public enum ServiceVersion
         {
-            V1 = 1,
+            V2021_03_07 = 1,
         }
     }
+    public partial class SmsSendOptions
+    {
+        public SmsSendOptions(bool enableDeliveryReport) { }
+        public bool EnableDeliveryReport { get { throw null; } }
+        public string Tag { get { throw null; } set { } }
+    }
+    public partial class SmsSendResult
+    {
+        internal SmsSendResult() { }
+        public string ErrorMessage { get { throw null; } }
+        public int HttpStatusCode { get { throw null; } }
+        public string MessageId { get { throw null; } }
+        public bool Successful { get { throw null; } }
+        public string To { get { throw null; } }
+    }
 }
 namespace Azure.Communication.Sms.Models
 {
     public static partial class SmsModelFactory
     {
-        public static Azure.Communication.Sms.SendSmsResponse SendSmsResponse(string messageId) { throw null; }
+        public static Azure.Communication.Sms.SmsSendResult SmsSendResult(string to, int httpStatusCode, bool successful) { throw null; }
     }
 }