feat(specs): add authentications to ingestion transformations (generated)

algolia/api-clients-automation#3494

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

algoliasearch/Clients/IngestionClient.cs

@@ -1314,7 +1314,7 @@ public interface IIngestionClient
   SourceWatchResponse TriggerDockerSourceDiscover(string sourceID, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Try a transformation.
+  /// Try a transformation before creating it.
   /// </summary>
   /// <param name="transformationTry"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -1326,7 +1326,7 @@ public interface IIngestionClient
   Task<TransformationTryResponse> TryTransformationAsync(TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Try a transformation. (Synchronous version)
+  /// Try a transformation before creating it. (Synchronous version)
   /// </summary>
   /// <param name="transformationTry"></param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -1337,6 +1337,32 @@ public interface IIngestionClient
   /// <returns>TransformationTryResponse</returns>
   TransformationTryResponse TryTransformation(TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default);
 
+  /// <summary>
+  /// Try a transformation before updating it.
+  /// </summary>
+  /// <param name="transformationID">Unique identifier of a transformation.</param>
+  /// <param name="transformationTry"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>Task of TransformationTryResponse</returns>
+  Task<TransformationTryResponse> TryTransformationBeforeUpdateAsync(string transformationID, TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default);
+
+  /// <summary>
+  /// Try a transformation before updating it. (Synchronous version)
+  /// </summary>
+  /// <param name="transformationID">Unique identifier of a transformation.</param>
+  /// <param name="transformationTry"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>TransformationTryResponse</returns>
+  TransformationTryResponse TryTransformationBeforeUpdate(string transformationID, TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default);
+
   /// <summary>
   /// Updates an authentication resource.
   /// </summary>
@@ -4009,7 +4035,7 @@ public SourceWatchResponse TriggerDockerSourceDiscover(string sourceID, RequestO
 
 
   /// <summary>
-  /// Try a transformation.
+  /// Try a transformation before creating it.
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -4038,7 +4064,7 @@ public async Task<TransformationTryResponse> TryTransformationAsync(Transformati
 
 
   /// <summary>
-  /// Try a transformation. (Synchronous version)
+  /// Try a transformation before creating it. (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -4056,6 +4082,61 @@ public TransformationTryResponse TryTransformation(TransformationTry transformat
     AsyncHelper.RunSync(() => TryTransformationAsync(transformationTry, options, cancellationToken));
 
 
+  /// <summary>
+  /// Try a transformation before updating it.
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - addObject
+  ///   - deleteIndex
+  ///   - editSettings
+  /// <param name="transformationID">Unique identifier of a transformation.</param>
+  /// <param name="transformationTry"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>Task of TransformationTryResponse</returns>
+  public async Task<TransformationTryResponse> TryTransformationBeforeUpdateAsync(string transformationID, TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default)
+  {
+
+    if (transformationID == null)
+      throw new ArgumentException("Parameter `transformationID` is required when calling `TryTransformationBeforeUpdate`.");
+
+
+    if (transformationTry == null)
+      throw new ArgumentException("Parameter `transformationTry` is required when calling `TryTransformationBeforeUpdate`.");
+
+    var requestOptions = new InternalRequestOptions(options);
+
+    requestOptions.PathParameters.Add("transformationID", QueryStringHelper.ParameterToString(transformationID));
+
+    requestOptions.Data = transformationTry;
+    return await _transport.ExecuteRequestAsync<TransformationTryResponse>(new HttpMethod("POST"), "/1/transformations/{transformationID}/try", requestOptions, cancellationToken).ConfigureAwait(false);
+  }
+
+
+  /// <summary>
+  /// Try a transformation before updating it. (Synchronous version)
+  /// </summary>
+  ///
+  /// Required API Key ACLs:
+  ///   - addObject
+  ///   - deleteIndex
+  ///   - editSettings
+  /// <param name="transformationID">Unique identifier of a transformation.</param>
+  /// <param name="transformationTry"></param>
+  /// <param name="options">Add extra http header or query parameters to Algolia.</param>
+  /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
+  /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>TransformationTryResponse</returns>
+  public TransformationTryResponse TryTransformationBeforeUpdate(string transformationID, TransformationTry transformationTry, RequestOptions options = null, CancellationToken cancellationToken = default) =>
+    AsyncHelper.RunSync(() => TryTransformationBeforeUpdateAsync(transformationID, transformationTry, options, cancellationToken));
+
+
   /// <summary>
   /// Updates an authentication resource.
   /// </summary>

algoliasearch/Models/Ingestion/Transformation.cs

@@ -43,6 +43,13 @@ public Transformation(string transformationID, string code, string name, string
   [JsonPropertyName("transformationID")]
   public string TransformationID { get; set; }
 
+  /// <summary>
+  /// The authentications associated for the current transformation.
+  /// </summary>
+  /// <value>The authentications associated for the current transformation.</value>
+  [JsonPropertyName("authenticationIDs")]
+  public List<string> AuthenticationIDs { get; set; }
+
   /// <summary>
   /// The source code of the transformation.
   /// </summary>
@@ -87,6 +94,7 @@ public override string ToString()
     StringBuilder sb = new StringBuilder();
     sb.Append("class Transformation {\n");
     sb.Append("  TransformationID: ").Append(TransformationID).Append("\n");
+    sb.Append("  AuthenticationIDs: ").Append(AuthenticationIDs).Append("\n");
     sb.Append("  Code: ").Append(Code).Append("\n");
     sb.Append("  Name: ").Append(Name).Append("\n");
     sb.Append("  Description: ").Append(Description).Append("\n");
@@ -119,6 +127,7 @@ public override bool Equals(object obj)
 
     return
         (TransformationID == input.TransformationID || (TransformationID != null && TransformationID.Equals(input.TransformationID))) &&
+        (AuthenticationIDs == input.AuthenticationIDs || AuthenticationIDs != null && input.AuthenticationIDs != null && AuthenticationIDs.SequenceEqual(input.AuthenticationIDs)) &&
         (Code == input.Code || (Code != null && Code.Equals(input.Code))) &&
         (Name == input.Name || (Name != null && Name.Equals(input.Name))) &&
         (Description == input.Description || (Description != null && Description.Equals(input.Description))) &&
@@ -139,6 +148,10 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + TransformationID.GetHashCode();
       }
+      if (AuthenticationIDs != null)
+      {
+        hashCode = (hashCode * 59) + AuthenticationIDs.GetHashCode();
+      }
       if (Code != null)
       {
         hashCode = (hashCode * 59) + Code.GetHashCode();

algoliasearch/Models/Ingestion/TransformationCreate.cs

@@ -53,6 +53,13 @@ public TransformationCreate(string code, string name)
   [JsonPropertyName("description")]
   public string Description { get; set; }
 
+  /// <summary>
+  /// The authentications associated for the current transformation.
+  /// </summary>
+  /// <value>The authentications associated for the current transformation.</value>
+  [JsonPropertyName("authenticationIDs")]
+  public List<string> AuthenticationIDs { get; set; }
+
   /// <summary>
   /// Returns the string presentation of the object
   /// </summary>
@@ -64,6 +71,7 @@ public override string ToString()
     sb.Append("  Code: ").Append(Code).Append("\n");
     sb.Append("  Name: ").Append(Name).Append("\n");
     sb.Append("  Description: ").Append(Description).Append("\n");
+    sb.Append("  AuthenticationIDs: ").Append(AuthenticationIDs).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -92,7 +100,8 @@ public override bool Equals(object obj)
     return
         (Code == input.Code || (Code != null && Code.Equals(input.Code))) &&
         (Name == input.Name || (Name != null && Name.Equals(input.Name))) &&
-        (Description == input.Description || (Description != null && Description.Equals(input.Description)));
+        (Description == input.Description || (Description != null && Description.Equals(input.Description))) &&
+        (AuthenticationIDs == input.AuthenticationIDs || AuthenticationIDs != null && input.AuthenticationIDs != null && AuthenticationIDs.SequenceEqual(input.AuthenticationIDs));
   }
 
   /// <summary>
@@ -116,6 +125,10 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + Description.GetHashCode();
       }
+      if (AuthenticationIDs != null)
+      {
+        hashCode = (hashCode * 59) + AuthenticationIDs.GetHashCode();
+      }
       return hashCode;
     }
   }

algoliasearch/Models/Ingestion/TransformationTry.cs

@@ -46,6 +46,12 @@ public TransformationTry(string code, object sampleRecord)
   [JsonPropertyName("sampleRecord")]
   public object SampleRecord { get; set; }
 
+  /// <summary>
+  /// Gets or Sets Authentications
+  /// </summary>
+  [JsonPropertyName("authentications")]
+  public List<AuthenticationCreate> Authentications { get; set; }
+
   /// <summary>
   /// Returns the string presentation of the object
   /// </summary>
@@ -56,6 +62,7 @@ public override string ToString()
     sb.Append("class TransformationTry {\n");
     sb.Append("  Code: ").Append(Code).Append("\n");
     sb.Append("  SampleRecord: ").Append(SampleRecord).Append("\n");
+    sb.Append("  Authentications: ").Append(Authentications).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -83,7 +90,8 @@ public override bool Equals(object obj)
 
     return
         (Code == input.Code || (Code != null && Code.Equals(input.Code))) &&
-        (SampleRecord == input.SampleRecord || (SampleRecord != null && SampleRecord.Equals(input.SampleRecord)));
+        (SampleRecord == input.SampleRecord || (SampleRecord != null && SampleRecord.Equals(input.SampleRecord))) &&
+        (Authentications == input.Authentications || Authentications != null && input.Authentications != null && Authentications.SequenceEqual(input.Authentications));
   }
 
   /// <summary>
@@ -103,6 +111,10 @@ public override int GetHashCode()
       {
         hashCode = (hashCode * 59) + SampleRecord.GetHashCode();
       }
+      if (Authentications != null)
+      {
+        hashCode = (hashCode * 59) + Authentications.GetHashCode();
+      }
       return hashCode;
     }
   }