feat(AssistantV2): add support for ListLogs and DeleteUserData

Author: mamoonraja

Scripts/Services/Assistant/V2/AssistantService.cs

@@ -32,7 +32,7 @@ namespace IBM.Watson.Assistant.V2
     public partial class AssistantService : BaseService
     {
         private const string serviceId = "assistant";
-        private const string defaultServiceUrl = "https://gateway.watsonplatform.net/assistant/api";
+        private const string defaultServiceUrl = "https://api.us-south.assistant.watson.cloud.ibm.com";
 
         #region VersionDate
         private string versionDate;
@@ -246,8 +246,6 @@ private void OnDeleteSessionResponse(RESTConnector.Request req, RESTConnector.Re
         ///
         /// Send user input to an assistant and receive a response, with conversation state (including context data)
         /// stored by Watson Assistant for the duration of the session.
-        ///
-        /// There is no rate limit for this operation.
         /// </summary>
         /// <param name="callback">The callback function that is invoked when the operation completes.</param>
         /// <param name="assistantId">Unique identifier of the assistant. To find the assistant ID in the Watson
@@ -341,8 +339,6 @@ private void OnMessageResponse(RESTConnector.Request req, RESTConnector.Response
         ///
         /// Send user input to an assistant and receive a response, with conversation state (including context data)
         /// managed by your application.
-        ///
-        /// There is no rate limit for this operation.
         /// </summary>
         /// <param name="callback">The callback function that is invoked when the operation completes.</param>
         /// <param name="assistantId">Unique identifier of the assistant. To find the assistant ID in the Watson
@@ -427,5 +423,183 @@ private void OnMessageStatelessResponse(RESTConnector.Request req, RESTConnector
             if (((RequestObject<MessageResponseStateless>)req).Callback != null)
                 ((RequestObject<MessageResponseStateless>)req).Callback(response, resp.Error);
         }
+        /// <summary>
+        /// List log events for an assistant.
+        ///
+        /// List the events from the log of an assistant.
+        ///
+        /// This method is available only with Premium plans.
+        /// </summary>
+        /// <param name="callback">The callback function that is invoked when the operation completes.</param>
+        /// <param name="assistantId">Unique identifier of the assistant. To find the assistant ID in the Watson
+        /// Assistant user interface, open the assistant settings and click **API Details**. For information about
+        /// creating assistants, see the
+        /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
+        ///
+        /// **Note:** Currently, the v2 API does not support creating assistants.</param>
+        /// <param name="sort">How to sort the returned log events. You can sort by **request_timestamp**. To reverse
+        /// the sort order, prefix the parameter value with a minus sign (`-`). (optional)</param>
+        /// <param name="filter">A cacheable parameter that limits the results to those matching the specified filter.
+        /// For more information, see the
+        /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
+        /// (optional)</param>
+        /// <param name="pageLimit">The number of records to return in each page of results. (optional)</param>
+        /// <param name="cursor">A token identifying the page of results to retrieve. (optional)</param>
+        /// <returns><see cref="LogCollection" />LogCollection</returns>
+        public bool ListLogs(Callback<LogCollection> callback, string assistantId, string sort = null, string filter = null, long? pageLimit = null, string cursor = null)
+        {
+            if (callback == null)
+                throw new ArgumentNullException("`callback` is required for `ListLogs`");
+            if (string.IsNullOrEmpty(assistantId))
+                throw new ArgumentNullException("`assistantId` is required for `ListLogs`");
+
+            RequestObject<LogCollection> req = new RequestObject<LogCollection>
+            {
+                Callback = callback,
+                HttpMethod = UnityWebRequest.kHttpVerbGET,
+                DisableSslVerification = DisableSslVerification
+            };
+
+            foreach (KeyValuePair<string, string> kvp in customRequestHeaders)
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            ClearCustomRequestHeaders();
+
+            foreach (KeyValuePair<string, string> kvp in Common.GetSdkHeaders("conversation", "V2", "ListLogs"))
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            req.Parameters["version"] = VersionDate;
+            if (!string.IsNullOrEmpty(sort))
+            {
+                req.Parameters["sort"] = sort;
+            }
+            if (!string.IsNullOrEmpty(filter))
+            {
+                req.Parameters["filter"] = filter;
+            }
+            if (pageLimit != null)
+            {
+                req.Parameters["page_limit"] = pageLimit;
+            }
+            if (!string.IsNullOrEmpty(cursor))
+            {
+                req.Parameters["cursor"] = cursor;
+            }
+
+            req.OnResponse = OnListLogsResponse;
+
+            Connector.URL = GetServiceUrl() + string.Format("/v2/assistants/{0}/logs", assistantId);
+            Authenticator.Authenticate(Connector);
+
+            return Connector.Send(req);
+        }
+
+        private void OnListLogsResponse(RESTConnector.Request req, RESTConnector.Response resp)
+        {
+            DetailedResponse<LogCollection> response = new DetailedResponse<LogCollection>();
+            foreach (KeyValuePair<string, string> kvp in resp.Headers)
+            {
+                response.Headers.Add(kvp.Key, kvp.Value);
+            }
+            response.StatusCode = resp.HttpResponseCode;
+
+            try
+            {
+                string json = Encoding.UTF8.GetString(resp.Data);
+                response.Result = JsonConvert.DeserializeObject<LogCollection>(json);
+                response.Response = json;
+            }
+            catch (Exception e)
+            {
+                Log.Error("AssistantService.OnListLogsResponse()", "Exception: {0}", e.ToString());
+                resp.Success = false;
+            }
+
+            if (((RequestObject<LogCollection>)req).Callback != null)
+                ((RequestObject<LogCollection>)req).Callback(response, resp.Error);
+        }
+        /// <summary>
+        /// Delete labeled data.
+        ///
+        /// Deletes all data associated with a specified customer ID. The method has no effect if no data is associated
+        /// with the customer ID.
+        ///
+        /// You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes
+        /// data. For more information about personal data and customer IDs, see [Information
+        /// security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).
+        ///
+        /// This operation is limited to 4 requests per minute. For more information, see **Rate limiting**.
+        /// </summary>
+        /// <param name="callback">The callback function that is invoked when the operation completes.</param>
+        /// <param name="customerId">The customer ID for which all data is to be deleted.</param>
+        /// <returns><see cref="object" />object</returns>
+        public bool DeleteUserData(Callback<object> callback, string customerId)
+        {
+            if (callback == null)
+                throw new ArgumentNullException("`callback` is required for `DeleteUserData`");
+            if (string.IsNullOrEmpty(customerId))
+                throw new ArgumentNullException("`customerId` is required for `DeleteUserData`");
+
+            RequestObject<object> req = new RequestObject<object>
+            {
+                Callback = callback,
+                HttpMethod = UnityWebRequest.kHttpVerbDELETE,
+                DisableSslVerification = DisableSslVerification
+            };
+
+            foreach (KeyValuePair<string, string> kvp in customRequestHeaders)
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            ClearCustomRequestHeaders();
+
+            foreach (KeyValuePair<string, string> kvp in Common.GetSdkHeaders("conversation", "V2", "DeleteUserData"))
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            req.Parameters["version"] = VersionDate;
+            if (!string.IsNullOrEmpty(customerId))
+            {
+                req.Parameters["customer_id"] = customerId;
+            }
+
+            req.OnResponse = OnDeleteUserDataResponse;
+
+            Connector.URL = GetServiceUrl() + "/v2/user_data";
+            Authenticator.Authenticate(Connector);
+
+            return Connector.Send(req);
+        }
+
+        private void OnDeleteUserDataResponse(RESTConnector.Request req, RESTConnector.Response resp)
+        {
+            DetailedResponse<object> response = new DetailedResponse<object>();
+            foreach (KeyValuePair<string, string> kvp in resp.Headers)
+            {
+                response.Headers.Add(kvp.Key, kvp.Value);
+            }
+            response.StatusCode = resp.HttpResponseCode;
+
+            try
+            {
+                string json = Encoding.UTF8.GetString(resp.Data);
+                response.Result = JsonConvert.DeserializeObject<object>(json);
+                response.Response = json;
+            }
+            catch (Exception e)
+            {
+                Log.Error("AssistantService.OnDeleteUserDataResponse()", "Exception: {0}", e.ToString());
+                resp.Success = false;
+            }
+
+            if (((RequestObject<object>)req).Callback != null)
+                ((RequestObject<object>)req).Callback(response, resp.Error);
+        }
     }
 }

Scripts/Services/Assistant/V2/Model/DialogSuggestion.cs

@@ -1,5 +1,5 @@
 /**
-* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+* (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -26,8 +26,8 @@ namespace IBM.Watson.Assistant.V2.Model
     public class DialogSuggestion
     {
         /// <summary>
-        /// The user-facing label for the disambiguation option. This label is taken from the **title** or
-        /// **user_label** property of the corresponding dialog node, depending on the disambiguation options.
+        /// The user-facing label for the suggestion. This label is taken from the **title** or **user_label** property
+        /// of the corresponding dialog node, depending on the disambiguation options.
         /// </summary>
         [JsonProperty("label", NullValueHandling = NullValueHandling.Ignore)]
         public string Label { get; set; }

Scripts/Services/Assistant/V2/Model/LogCollection.cs

@@ -0,0 +1,39 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// LogCollection.
+    /// </summary>
+    public class LogCollection
+    {
+        /// <summary>
+        /// An array of objects describing log events.
+        /// </summary>
+        [JsonProperty("logs", NullValueHandling = NullValueHandling.Ignore)]
+        public List<ModelLog> Logs { get; set; }
+        /// <summary>
+        /// The pagination data for the returned objects.
+        /// </summary>
+        [JsonProperty("pagination", NullValueHandling = NullValueHandling.Ignore)]
+        public LogPagination Pagination { get; set; }
+    }
+}

Scripts/Services/Assistant/V2/Model/LogCollection.cs.meta

@@ -0,0 +1,43 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// The pagination data for the returned objects.
+    /// </summary>
+    public class LogPagination
+    {
+        /// <summary>
+        /// The URL that will return the next page of results, if any.
+        /// </summary>
+        [JsonProperty("next_url", NullValueHandling = NullValueHandling.Ignore)]
+        public string NextUrl { get; set; }
+        /// <summary>
+        /// Reserved for future use.
+        /// </summary>
+        [JsonProperty("matched", NullValueHandling = NullValueHandling.Ignore)]
+        public long? Matched { get; set; }
+        /// <summary>
+        /// A token identifying the next page of results.
+        /// </summary>
+        [JsonProperty("next_cursor", NullValueHandling = NullValueHandling.Ignore)]
+        public string NextCursor { get; set; }
+    }
+}

Scripts/Services/Assistant/V2/Model/LogPagination.cs

@@ -0,0 +1,41 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// A stateful message request formatted for the Watson Assistant service.
+    /// </summary>
+    public class MessageRequest
+    {
+        /// <summary>
+        /// An input object that includes the input text.
+        /// </summary>
+        [JsonProperty("input", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageInput Input { get; set; }
+        /// <summary>
+        /// Context data for the conversation. You can use this property to set or modify context variables, which can
+        /// also be accessed by dialog nodes. The context is stored by the assistant on a per-session basis.
+        ///
+        /// **Note:** The total size of the context data stored for a stateful session cannot exceed 100KB.
+        /// </summary>
+        [JsonProperty("context", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageContext Context { get; set; }
+    }
+}