Merge pull request #466 from watson-developer-cloud/release-may

feat(generation): generated using api def sdk-2021-05-11 & gen 3.31.0

Author: kevinkowa

src/IBM.Watson.Assistant.v1/AssistantService.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2020.
+* (C) Copyright IBM Corp. 2018, 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 */
 
 /**
-* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-123423
+* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138
 */
 
 using System.Collections.Generic;
@@ -81,10 +81,19 @@ public AssistantService(string version, string serviceName, IAuthenticator authe
         /// the previous response. (optional)</param>
         /// <param name="output">An output object that includes the response to the user, the dialog nodes that were
         /// triggered, and messages from the log. (optional)</param>
+        /// <param name="userId">A string value that identifies the user who is interacting with the workspace. The
+        /// client must provide a unique identifier for each individual end user who accesses the application. For
+        /// user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot
+        /// contain carriage return, newline, or tab characters. If no value is specified in the input, **user_id** is
+        /// automatically set to the value of **context.conversation_id**.
+        ///
+        /// **Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is
+        /// specified in both locations in a message request, the value specified at the root is used.
+        /// (optional)</param>
         /// <param name="nodesVisitedDetails">Whether to include additional diagnostic information about the dialog
         /// nodes that were visited during processing of the message. (optional, default to false)</param>
         /// <returns><see cref="MessageResponse" />MessageResponse</returns>
-        public DetailedResponse<MessageResponse> Message(string workspaceId, MessageInput input = null, List<RuntimeIntent> intents = null, List<RuntimeEntity> entities = null, bool? alternateIntents = null, Context context = null, OutputData output = null, bool? nodesVisitedDetails = null)
+        public DetailedResponse<MessageResponse> Message(string workspaceId, MessageInput input = null, List<RuntimeIntent> intents = null, List<RuntimeEntity> entities = null, bool? alternateIntents = null, Context context = null, OutputData output = null, bool? nodesVisitedDetails = null, string userId = null)
         {
             if (string.IsNullOrEmpty(workspaceId))
             {
@@ -143,6 +152,10 @@ public DetailedResponse<MessageResponse> Message(string workspaceId, MessageInpu
                 {
                     bodyObject["output"] = JToken.FromObject(output);
                 }
+                if (!string.IsNullOrEmpty(userId))
+                {
+                    bodyObject["user_id"] = userId;
+                }
                 var httpContent = new StringContent(JsonConvert.SerializeObject(bodyObject), Encoding.UTF8, HttpMediaType.APPLICATION_JSON);
                 restRequest.WithBodyContent(httpContent);
 
@@ -170,7 +183,7 @@ public DetailedResponse<MessageResponse> Message(string workspaceId, MessageInpu
         /// entities recognized in each input. This method is useful for testing and comparing the performance of
         /// different workspaces.
         ///
-        /// This method is available only with Premium plans.
+        /// This method is available only with Enterprise with Data Isolation plans.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
         /// <param name="input">An array of input utterances to classify. (optional)</param>
@@ -3713,26 +3726,31 @@ public class SortValue
         /// workspace](#update-workspace)** method instead.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
-        /// <param name="dialogNode">The dialog node ID. This string must conform to the following restrictions:
-        /// - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.</param>
+        /// <param name="dialogNode">The unique ID of the dialog node. This is an internal identifier used to refer to
+        /// the dialog node from other dialog nodes and in the diagnostic information included with message responses.
+        ///
+        /// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.</param>
         /// <param name="description">The description of the dialog node. This string cannot contain carriage return,
         /// newline, or tab characters. (optional)</param>
         /// <param name="conditions">The condition that will trigger the dialog node. This string cannot contain
         /// carriage return, newline, or tab characters. (optional)</param>
-        /// <param name="parent">The ID of the parent dialog node. This property is omitted if the dialog node has no
-        /// parent. (optional)</param>
-        /// <param name="previousSibling">The ID of the previous sibling dialog node. This property is omitted if the
-        /// dialog node has no previous sibling. (optional)</param>
+        /// <param name="parent">The unique ID of the parent dialog node. This property is omitted if the dialog node
+        /// has no parent. (optional)</param>
+        /// <param name="previousSibling">The unique ID of the previous sibling dialog node. This property is omitted if
+        /// the dialog node has no previous sibling. (optional)</param>
         /// <param name="output">The output of the dialog node. For more information about how to specify dialog node
         /// output, see the
         /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
         /// (optional)</param>
         /// <param name="context">The context for the dialog node. (optional)</param>
         /// <param name="metadata">The metadata for the dialog node. (optional)</param>
         /// <param name="nextStep">The next step to execute following this dialog node. (optional)</param>
-        /// <param name="title">The alias used to identify the dialog node. This string must conform to the following
-        /// restrictions:
-        /// - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
+        /// <param name="title">A human-readable name for the dialog node. If the node is included in disambiguation,
+        /// this title is used to populate the **label** property of the corresponding suggestion in the `suggestion`
+        /// response type (unless it is overridden by the **user_label** property). The title is also used to populate
+        /// the **topic** property in the `connect_to_agent` response type.
+        ///
+        /// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
         /// (optional)</param>
         /// <param name="type">How the dialog node is processed. (optional)</param>
         /// <param name="eventName">How an `event_handler` node is processed. (optional)</param>
@@ -3744,7 +3762,8 @@ public class SortValue
         /// <param name="digressOutSlots">Whether the user can digress to top-level nodes while filling out slots.
         /// (optional)</param>
         /// <param name="userLabel">A label that can be displayed externally to describe the purpose of the node to
-        /// users. (optional)</param>
+        /// users. If set, this label is used to identify the node in disambiguation responses (overriding the value of
+        /// the **title** property). (optional)</param>
         /// <param name="disambiguationOptOut">Whether the dialog node should be excluded from disambiguation
         /// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
         /// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
@@ -3892,7 +3911,7 @@ public DetailedResponse<DialogNode> CreateDialogNode(string workspaceId, string
         /// Get information about a dialog node.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
-        /// <param name="dialogNode">The dialog node ID (for example, `get_order`).</param>
+        /// <param name="dialogNode">The dialog node ID (for example, `node_1_1479323581900`).</param>
         /// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
         /// the response. (optional, default to false)</param>
         /// <returns><see cref="DialogNode" />DialogNode</returns>
@@ -3964,28 +3983,34 @@ public DetailedResponse<DialogNode> GetDialogNode(string workspaceId, string dia
         /// workspace](#update-workspace)** method instead.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
-        /// <param name="dialogNode">The dialog node ID (for example, `get_order`).</param>
-        /// <param name="newDialogNode">The dialog node ID. This string must conform to the following restrictions:
-        /// - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
+        /// <param name="dialogNode">The dialog node ID (for example, `node_1_1479323581900`).</param>
+        /// <param name="newDialogNode">The unique ID of the dialog node. This is an internal identifier used to refer
+        /// to the dialog node from other dialog nodes and in the diagnostic information included with message
+        /// responses.
+        ///
+        /// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
         /// (optional)</param>
         /// <param name="newDescription">The description of the dialog node. This string cannot contain carriage return,
         /// newline, or tab characters. (optional)</param>
         /// <param name="newConditions">The condition that will trigger the dialog node. This string cannot contain
         /// carriage return, newline, or tab characters. (optional)</param>
-        /// <param name="newParent">The ID of the parent dialog node. This property is omitted if the dialog node has no
-        /// parent. (optional)</param>
-        /// <param name="newPreviousSibling">The ID of the previous sibling dialog node. This property is omitted if the
-        /// dialog node has no previous sibling. (optional)</param>
+        /// <param name="newParent">The unique ID of the parent dialog node. This property is omitted if the dialog node
+        /// has no parent. (optional)</param>
+        /// <param name="newPreviousSibling">The unique ID of the previous sibling dialog node. This property is omitted
+        /// if the dialog node has no previous sibling. (optional)</param>
         /// <param name="newOutput">The output of the dialog node. For more information about how to specify dialog node
         /// output, see the
         /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).
         /// (optional)</param>
         /// <param name="newContext">The context for the dialog node. (optional)</param>
         /// <param name="newMetadata">The metadata for the dialog node. (optional)</param>
         /// <param name="newNextStep">The next step to execute following this dialog node. (optional)</param>
-        /// <param name="newTitle">The alias used to identify the dialog node. This string must conform to the following
-        /// restrictions:
-        /// - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
+        /// <param name="newTitle">A human-readable name for the dialog node. If the node is included in disambiguation,
+        /// this title is used to populate the **label** property of the corresponding suggestion in the `suggestion`
+        /// response type (unless it is overridden by the **user_label** property). The title is also used to populate
+        /// the **topic** property in the `connect_to_agent` response type.
+        ///
+        /// This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
         /// (optional)</param>
         /// <param name="newType">How the dialog node is processed. (optional)</param>
         /// <param name="newEventName">How an `event_handler` node is processed. (optional)</param>
@@ -3998,7 +4023,8 @@ public DetailedResponse<DialogNode> GetDialogNode(string workspaceId, string dia
         /// <param name="newDigressOutSlots">Whether the user can digress to top-level nodes while filling out slots.
         /// (optional)</param>
         /// <param name="newUserLabel">A label that can be displayed externally to describe the purpose of the node to
-        /// users. (optional)</param>
+        /// users. If set, this label is used to identify the node in disambiguation responses (overriding the value of
+        /// the **title** property). (optional)</param>
         /// <param name="newDisambiguationOptOut">Whether the dialog node should be excluded from disambiguation
         /// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
         /// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
@@ -4150,7 +4176,7 @@ public DetailedResponse<DialogNode> UpdateDialogNode(string workspaceId, string
         /// Delete a dialog node from a workspace.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
-        /// <param name="dialogNode">The dialog node ID (for example, `get_order`).</param>
+        /// <param name="dialogNode">The dialog node ID (for example, `node_1_1479323581900`).</param>
         /// <returns><see cref="object" />object</returns>
         public DetailedResponse<object> DeleteDialogNode(string workspaceId, string dialogNode)
         {
@@ -4210,6 +4236,8 @@ public DetailedResponse<object> DeleteDialogNode(string workspaceId, string dial
         /// List log events in a workspace.
         ///
         /// List the events from the log of a specific workspace.
+        ///
+        /// This method requires Manager access.
         /// </summary>
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
         /// <param name="sort">How to sort the returned log events. You can sort by **request_timestamp**. To reverse
@@ -4366,6 +4394,11 @@ public DetailedResponse<LogCollection> ListAllLogs(string filter, string sort =
         /// 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).
+        ///
+        /// **Note:** This operation is intended only for deleting data associated with a single specific customer, not
+        /// for deleting data associated with multiple customers or for any other purpose. For more information, see
+        /// [Labeling and deleting data in Watson
+        /// Assistant](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security-gdpr-wa).
         /// </summary>
         /// <param name="customerId">The customer ID for which all data is to be deleted.</param>
         /// <returns><see cref="object" />object</returns>

src/IBM.Watson.Assistant.v1/IAssistantService.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2020.
+* (C) Copyright IBM Corp. 2018, 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Assistant.v1
 {
     public partial interface IAssistantService
     {
-        DetailedResponse<MessageResponse> Message(string workspaceId, MessageInput input = null, List<RuntimeIntent> intents = null, List<RuntimeEntity> entities = null, bool? alternateIntents = null, Context context = null, OutputData output = null, bool? nodesVisitedDetails = null);
+        DetailedResponse<MessageResponse> Message(string workspaceId, MessageInput input = null, List<RuntimeIntent> intents = null, List<RuntimeEntity> entities = null, bool? alternateIntents = null, Context context = null, OutputData output = null, bool? nodesVisitedDetails = null, string userId = null);
         DetailedResponse<BulkClassifyResponse> BulkClassify(string workspaceId, List<BulkClassifyUtterance> input = null);
         DetailedResponse<WorkspaceCollection> ListWorkspaces(long? pageLimit = null, bool? includeCount = null, string sort = null, string cursor = null, bool? includeAudit = null);
         DetailedResponse<Workspace> CreateWorkspace(string name = null, string description = null, string language = null, List<DialogNode> dialogNodes = null, List<Counterexample> counterexamples = null, Dictionary<string, object> metadata = null, bool? learningOptOut = null, WorkspaceSystemSettings systemSettings = null, List<Webhook> webhooks = null, List<CreateIntent> intents = null, List<CreateEntity> entities = null, bool? includeAudit = null);

src/IBM.Watson.Assistant.v1/IBM.Watson.Assistant.v1.csproj

@@ -35,8 +35,9 @@
 
     <ItemGroup>
         <PackageReference Include="IBM.Cloud.SDK.Core" Version="1.2.0" />
-        <PackageReference Include="IBM.Watson.Common" Version="5.1.0" />
+        <PackageReference Include="IBM.Watson.Common" Version="5.2.0" />
         <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
         <PackageReference Include="JsonSubTypes" Version="1.6.0" />
     </ItemGroup>
+
 </Project>

src/IBM.Watson.Assistant.v1/Model/ChannelTransferInfo.cs

@@ -0,0 +1,36 @@
+/**
+* (C) Copyright IBM Corp. 2021.
+*
+* 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.v1.Model
+{
+    /// <summary>
+    /// Information used by an integration to transfer the conversation to a different channel.
+    /// </summary>
+    public class ChannelTransferInfo
+    {
+        /// <summary>
+        /// An object specifying target channels available for the transfer. Each property of this object represents an
+        /// available transfer target. Currently, the only supported property is **chat**, representing the web chat
+        /// integration.
+        /// </summary>
+        [JsonProperty("target", NullValueHandling = NullValueHandling.Ignore)]
+        public ChannelTransferTarget Target { get; set; }
+    }
+
+}