feat(discovery-v1): document status & query aggregation update

DocumentStatus: documentID, status, and statusDescription are now optional. QueryAggregation:
BREAKING QueryAggregation subclasses changed.

BREAKING CHANGE: QueryAggregation: BREAKING QueryAggregation subclasses changed.

Author: kevinkowa

src/IBM.Watson.Discovery.v1/DiscoveryService.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2021.
+* (C) Copyright IBM Corp. 2022.
 *
 * 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-07189efd-20210907-091205
+* IBM OpenAPI SDK Code Generator Version: 3.46.0-a4e29da0-20220224-210428
 */
 
 using System.Collections.Generic;
@@ -245,8 +245,8 @@ public DetailedResponse<Environment> GetEnvironment(string environmentId)
         /// <param name="environmentId">The ID of the environment.</param>
         /// <param name="name">Name that identifies the environment. (optional, default to )</param>
         /// <param name="description">Description of the environment. (optional, default to )</param>
-        /// <param name="size">Size that the environment should be increased to. Environment size cannot be modified
-        /// when using a Lite plan. Environment size can only increased and not decreased. (optional)</param>
+        /// <param name="size">Size to change the environment to. **Note:** Lite plan users cannot change the
+        /// environment size. (optional)</param>
         /// <returns><see cref="Environment" />Environment</returns>
         public DetailedResponse<Environment> UpdateEnvironment(string environmentId, string name = null, string description = null, string size = null)
         {

src/IBM.Watson.Discovery.v1/IBM.Watson.Discovery.v1.csproj

@@ -34,7 +34,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="IBM.Cloud.SDK.Core" Version="1.2.0" />
+        <PackageReference Include="IBM.Cloud.SDK.Core" Version="1.3.1" />
         <PackageReference Include="IBM.Watson.Common" Version="5.3.0" />
         <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
         <PackageReference Include="JsonSubTypes" Version="1.6.0" />

src/IBM.Watson.Discovery.v1/Model/Enrichment.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2021.
+* (C) Copyright IBM Corp. 2022.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -51,15 +51,10 @@ public class Enrichment
         [JsonProperty("overwrite", NullValueHandling = NullValueHandling.Ignore)]
         public bool? Overwrite { get; set; }
         /// <summary>
-        /// Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`.
+        /// Name of the enrichment service to call. The only supported option is `natural_language_understanding`. The
+        /// `elements` option is deprecated and support ended on 10 July 2020.
         ///
-        ///  When using `natual_language_understanding`, the **options** object must contain Natural Language
-        /// Understanding options.
-        ///
-        /// When using `elements` the **options** object must contain Element Classification options. Additionally, when
-        /// using the `elements` enrichment the configuration specified and files ingested must meet all the criteria
-        /// specified in [the
-        /// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification).
+        ///  The **options** object must contain Natural Language Understanding options.
         /// </summary>
         [JsonProperty("enrichment", NullValueHandling = NullValueHandling.Ignore)]
         public string _Enrichment { get; set; }
@@ -70,7 +65,11 @@ public class Enrichment
         [JsonProperty("ignore_downstream_errors", NullValueHandling = NullValueHandling.Ignore)]
         public bool? IgnoreDownstreamErrors { get; set; }
         /// <summary>
-        /// Options which are specific to a particular enrichment.
+        /// Options that are specific to a particular enrichment.
+        ///
+        /// The `elements` enrichment type is deprecated. Use the [Create a
+        /// project](https://cloud.ibm.com/apidocs/discovery-data#createproject) method of the Discovery v2 API to
+        /// create a `content_intelligence` project type instead.
         /// </summary>
         [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)]
         public EnrichmentOptions Options { get; set; }

src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2021.
+* (C) Copyright IBM Corp. 2022.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -20,7 +20,11 @@
 namespace IBM.Watson.Discovery.v1.Model
 {
     /// <summary>
-    /// Options which are specific to a particular enrichment.
+    /// Options that are specific to a particular enrichment.
+    ///
+    /// The `elements` enrichment type is deprecated. Use the [Create a
+    /// project](https://cloud.ibm.com/apidocs/discovery-data#createproject) method of the Discovery v2 API to create a
+    /// `content_intelligence` project type instead.
     /// </summary>
     public class EnrichmentOptions
     {
@@ -86,8 +90,7 @@ public class LanguageEnumValue
         [JsonProperty("features", NullValueHandling = NullValueHandling.Ignore)]
         public NluEnrichmentFeatures Features { get; set; }
         /// <summary>
-        /// For use with `elements` enrichments only. The element extraction model to use. The only model available is
-        /// `contract`.
+        /// The element extraction model to use, which can be `contract` only. The `elements` enrichment is deprecated.
         /// </summary>
         [JsonProperty("model", NullValueHandling = NullValueHandling.Ignore)]
         public string Model { get; set; }

src/IBM.Watson.Discovery.v1/Model/QueryAggregation.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2020.
+* (C) Copyright IBM Corp. 2022.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 *
 */
 
-using System.Collections.Generic;
 using JsonSubTypes;
 using Newtonsoft.Json;
 
@@ -25,39 +24,24 @@ namespace IBM.Watson.Discovery.v1.Model
     /// An aggregation produced by  Discovery to analyze the input provided.
     /// </summary>
     [JsonConverter(typeof(JsonSubtypes), "type")]
-    [JsonSubtypes.KnownSubType(typeof(Histogram), "histogram")]
-    [JsonSubtypes.KnownSubType(typeof(Calculation), "max")]
-    [JsonSubtypes.KnownSubType(typeof(Calculation), "min")]
-    [JsonSubtypes.KnownSubType(typeof(Calculation), "average")]
-    [JsonSubtypes.KnownSubType(typeof(Calculation), "sum")]
-    [JsonSubtypes.KnownSubType(typeof(Calculation), "unique_count")]
-    [JsonSubtypes.KnownSubType(typeof(Term), "term")]
-    [JsonSubtypes.KnownSubType(typeof(Filter), "filter")]
-    [JsonSubtypes.KnownSubType(typeof(Nested), "nested")]
-    [JsonSubtypes.KnownSubType(typeof(Timeslice), "timeslice")]
-    [JsonSubtypes.KnownSubType(typeof(TopHits), "top_hits")]
+    [JsonSubtypes.KnownSubType(typeof(QueryHistogramAggregation), "histogram")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "max")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "min")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "average")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "sum")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "unique_count")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTermAggregation), "term")]
+    [JsonSubtypes.KnownSubType(typeof(QueryFilterAggregation), "filter")]
+    [JsonSubtypes.KnownSubType(typeof(QueryNestedAggregation), "nested")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTimesliceAggregation), "timeslice")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTopHitsAggregation), "top_hits")]
     public class QueryAggregation
     {
         /// <summary>
         /// The type of aggregation command used. For example: term, filter, max, min, etc.
         /// </summary>
         [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)]
         public string Type { get; set; }
-        /// <summary>
-        /// Array of aggregation results.
-        /// </summary>
-        [JsonProperty("results", NullValueHandling = NullValueHandling.Ignore)]
-        public List<AggregationResult> Results { get; set; }
-        /// <summary>
-        /// Number of matching results.
-        /// </summary>
-        [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)]
-        public long? MatchingResults { get; set; }
-        /// <summary>
-        /// Aggregations returned by Discovery.
-        /// </summary>
-        [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)]
-        public List<QueryAggregation> Aggregations { get; set; }
     }
 
 }

src/IBM.Watson.Discovery.v1/Model/QueryCalculationAggregation.cs

@@ -0,0 +1,40 @@
+/**
+* (C) Copyright IBM Corp. 2022.
+*
+* 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.Discovery.v1.Model
+{
+    /// <summary>
+    /// Returns a scalar calculation across all documents for the field specified. Possible calculations include min,
+    /// max, sum, average, and unique_count.
+    /// </summary>
+    public class QueryCalculationAggregation : QueryAggregation
+    {
+        /// <summary>
+        /// The field to perform the calculation on.
+        /// </summary>
+        [JsonProperty("field", NullValueHandling = NullValueHandling.Ignore)]
+        public string Field { get; set; }
+        /// <summary>
+        /// The value of the calculation.
+        /// </summary>
+        [JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
+        public double? Value { get; set; }
+    }
+
+}

src/IBM.Watson.Discovery.v1/Model/QueryFilterAggregation.cs

@@ -0,0 +1,46 @@
+/**
+* (C) Copyright IBM Corp. 2022.
+*
+* 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.Discovery.v1.Model
+{
+    /// <summary>
+    /// A modifier that narrows the document set of the sub-aggregations it precedes.
+    /// </summary>
+    public class QueryFilterAggregation : QueryAggregation
+    {
+        /// <summary>
+        /// The filter that is written in Discovery Query Language syntax and is applied to the documents before
+        /// sub-aggregations are run.
+        /// </summary>
+        [JsonProperty("match", NullValueHandling = NullValueHandling.Ignore)]
+        public string Match { get; set; }
+        /// <summary>
+        /// Number of documents that match the filter.
+        /// </summary>
+        [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)]
+        public long? MatchingResults { get; set; }
+        /// <summary>
+        /// An array of sub-aggregations.
+        /// </summary>
+        [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)]
+        public List<QueryAggregation> Aggregations { get; set; }
+    }
+
+}

src/IBM.Watson.Discovery.v1/Model/QueryHistogramAggregation.cs

@@ -0,0 +1,51 @@
+/**
+* (C) Copyright IBM Corp. 2022.
+*
+* 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.Discovery.v1.Model
+{
+    /// <summary>
+    /// Numeric interval segments to categorize documents by using field values from a single numeric field to describe
+    /// the category.
+    /// </summary>
+    public class QueryHistogramAggregation : QueryAggregation
+    {
+        /// <summary>
+        /// The numeric field name used to create the histogram.
+        /// </summary>
+        [JsonProperty("field", NullValueHandling = NullValueHandling.Ignore)]
+        public string Field { get; set; }
+        /// <summary>
+        /// The size of the sections that the results are split into.
+        /// </summary>
+        [JsonProperty("interval", NullValueHandling = NullValueHandling.Ignore)]
+        public long? Interval { get; set; }
+        /// <summary>
+        /// Identifier specified in the query request of this aggregation.
+        /// </summary>
+        [JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)]
+        public string Name { get; set; }
+        /// <summary>
+        /// Array of numeric intervals.
+        /// </summary>
+        [JsonProperty("results", NullValueHandling = NullValueHandling.Ignore)]
+        public List<QueryHistogramAggregationResult> Results { get; set; }
+    }
+
+}

src/IBM.Watson.Discovery.v1/Model/QueryHistogramAggregationResult.cs

@@ -0,0 +1,45 @@
+/**
+* (C) Copyright IBM Corp. 2022.
+*
+* 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.Discovery.v1.Model
+{
+    /// <summary>
+    /// Histogram numeric interval result.
+    /// </summary>
+    public class QueryHistogramAggregationResult
+    {
+        /// <summary>
+        /// The value of the upper bound for the numeric segment.
+        /// </summary>
+        [JsonProperty("key", NullValueHandling = NullValueHandling.Ignore)]
+        public long? Key { get; set; }
+        /// <summary>
+        /// Number of documents with the specified key as the upper bound.
+        /// </summary>
+        [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)]
+        public long? MatchingResults { get; set; }
+        /// <summary>
+        /// An array of sub-aggregations.
+        /// </summary>
+        [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)]
+        public List<QueryAggregation> Aggregations { get; set; }
+    }
+
+}