Change channel id of GetTemplates operation to GUID (#41909)

* change channel id of getTemplate operation to uuid * rerun Export-API.ps1 * update version
Azure · Feb 13, 2024 · f6407d9 · f6407d9
1 parent f74a4ba
commit f6407d9
Show file tree

Hide file tree

Showing 14 changed files with 87 additions and 133 deletions.
diff --git a/sdk/communication/Azure.Communication.Messages/CHANGELOG.md b/sdk/communication/Azure.Communication.Messages/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
+## 1.0.0 (Unreleased)
 
 ### Features Added
 

diff --git a/...unication/Azure.Communication.Messages/api/Azure.Communication.Messages.netstandard2.0.cs b/...unication/Azure.Communication.Messages/api/Azure.Communication.Messages.netstandard2.0.cs
@@ -80,10 +80,10 @@ public MessageTemplateClient(System.Uri endpoint, Azure.AzureKeyCredential crede
         public MessageTemplateClient(System.Uri endpoint, Azure.Core.TokenCredential credential) { }
         public MessageTemplateClient(System.Uri endpoint, Azure.Core.TokenCredential credential, Azure.Communication.Messages.CommunicationMessagesClientOptions options) { }
         public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } }
-        public virtual Azure.Pageable<System.BinaryData> GetTemplates(string channelId, int? maxpagesize, Azure.RequestContext context) { throw null; }
-        public virtual Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplates(string channelId, int? maxpagesize = default(int?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.AsyncPageable<System.BinaryData> GetTemplatesAsync(string channelId, int? maxpagesize, Azure.RequestContext context) { throw null; }
-        public virtual Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync(string channelId, int? maxpagesize = default(int?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Pageable<System.BinaryData> GetTemplates(System.Guid channelId, int? maxpagesize, Azure.RequestContext context) { throw null; }
+        public virtual Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplates(System.Guid channelId, int? maxpagesize = default(int?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AsyncPageable<System.BinaryData> GetTemplatesAsync(System.Guid channelId, int? maxpagesize, Azure.RequestContext context) { throw null; }
+        public virtual Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync(System.Guid channelId, int? maxpagesize = default(int?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class MessageTemplateDocument : Azure.Communication.Messages.MessageTemplateValue, System.ClientModel.Primitives.IJsonModel<Azure.Communication.Messages.MessageTemplateDocument>, System.ClientModel.Primitives.IPersistableModel<Azure.Communication.Messages.MessageTemplateDocument>
     {

diff --git a/sdk/communication/Azure.Communication.Messages/src/Azure.Communication.Messages.csproj b/sdk/communication/Azure.Communication.Messages/src/Azure.Communication.Messages.csproj
@@ -5,7 +5,7 @@
       This client library enables working with the Microsoft Azure Communication Messages service.
     </Description>
     <AssemblyTitle>Azure Communication Messages Service</AssemblyTitle>
-    <Version>1.0.0-beta.2</Version>
+    <Version>1.0.0</Version>
     <PackageTags>Microsoft Azure Communication Messages Service;Microsoft;Azure;Azure Communication Service;Azure Communication Messages Service;Messages;Communication</PackageTags>
     <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
     <IncludeOperationsSharedSource>true</IncludeOperationsSharedSource>

diff --git a/sdk/communication/Azure.Communication.Messages/src/Generated/Docs/MessageTemplateClient.xml b/sdk/communication/Azure.Communication.Messages/src/Generated/Docs/MessageTemplateClient.xml
@@ -1,51 +1,51 @@
 <?xml version="1.0" encoding="utf-8"?>
 <doc>
   <members>
-    <member name="GetTemplatesAsync(string,int?,CancellationToken)">
+    <member name="GetTemplatesAsync(Guid,int?,CancellationToken)">
       <example>
 This sample shows how to call GetTemplatesAsync.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-await foreach (MessageTemplateItem item in client.GetTemplatesAsync("<channelId>"))
+await foreach (MessageTemplateItem item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a")))
 {
 }
 ]]></code>
 This sample shows how to call GetTemplatesAsync with all parameters.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-await foreach (MessageTemplateItem item in client.GetTemplatesAsync("<channelId>", maxpagesize: 1234))
+await foreach (MessageTemplateItem item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), maxpagesize: 1234))
 {
 }
 ]]></code></example>
     </member>
-    <member name="GetTemplates(string,int?,CancellationToken)">
+    <member name="GetTemplates(Guid,int?,CancellationToken)">
       <example>
 This sample shows how to call GetTemplates.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-foreach (MessageTemplateItem item in client.GetTemplates("<channelId>"))
+foreach (MessageTemplateItem item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a")))
 {
 }
 ]]></code>
 This sample shows how to call GetTemplates with all parameters.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-foreach (MessageTemplateItem item in client.GetTemplates("<channelId>", maxpagesize: 1234))
+foreach (MessageTemplateItem item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), maxpagesize: 1234))
 {
 }
 ]]></code></example>
     </member>
-    <member name="GetTemplatesAsync(string,int?,RequestContext)">
+    <member name="GetTemplatesAsync(Guid,int?,RequestContext)">
       <example>
 This sample shows how to call GetTemplatesAsync and parse the result.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-await foreach (BinaryData item in client.GetTemplatesAsync("<channelId>", null, null))
+await foreach (BinaryData item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null, null))
 {
     JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
     Console.WriteLine(result.GetProperty("name").ToString());
@@ -58,7 +58,7 @@ This sample shows how to call GetTemplatesAsync with all parameters and parse th
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-await foreach (BinaryData item in client.GetTemplatesAsync("<channelId>", 1234, null))
+await foreach (BinaryData item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), 1234, null))
 {
     JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
     Console.WriteLine(result.GetProperty("name").ToString());
@@ -68,13 +68,13 @@ await foreach (BinaryData item in client.GetTemplatesAsync("<channelId>", 1234,
 }
 ]]></code></example>
     </member>
-    <member name="GetTemplates(string,int?,RequestContext)">
+    <member name="GetTemplates(Guid,int?,RequestContext)">
       <example>
 This sample shows how to call GetTemplates and parse the result.
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-foreach (BinaryData item in client.GetTemplates("<channelId>", null, null))
+foreach (BinaryData item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null, null))
 {
     JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
     Console.WriteLine(result.GetProperty("name").ToString());
@@ -87,7 +87,7 @@ This sample shows how to call GetTemplates with all parameters and parse the res
 <code><![CDATA[
 MessageTemplateClient client = new MessageTemplateClient((string)null);
 
-foreach (BinaryData item in client.GetTemplates("<channelId>", 1234, null))
+foreach (BinaryData item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), 1234, null))
 {
     JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
     Console.WriteLine(result.GetProperty("name").ToString());

diff --git a/sdk/communication/Azure.Communication.Messages/src/Generated/MessageTemplateClient.cs b/sdk/communication/Azure.Communication.Messages/src/Generated/MessageTemplateClient.cs
diff --git a/sdk/communication/Azure.Communication.Messages/src/Generated/tspCodeModel.json b/sdk/communication/Azure.Communication.Messages/src/Generated/tspCodeModel.json
@@ -519,7 +519,7 @@
      "Type": {
       "$id": "64",
       "Kind": "Primitive",
-      "Name": "String",
+      "Name": "Guid",
       "IsNullable": false
      },
      "IsRequired": true,
@@ -1736,7 +1736,7 @@
      "$id": "199",
      "Name": "getTemplates",
      "ResourceName": "MessageTemplateItem",
-     "Description": "List all templates for given ACS channel",
+     "Description": "List all templates for given Azure Communication Services channel",
      "Parameters": [
       {
        "$ref": "155"
@@ -1773,7 +1773,7 @@
        "Type": {
         "$id": "203",
         "Kind": "Primitive",
-        "Name": "String",
+        "Name": "Guid",
         "IsNullable": false
        },
        "Location": "Path",