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

lib/Api/IngestionClient.php

@@ -309,6 +309,7 @@ public function createTaskV1($taskCreate, $requestOptions = [])
      *                                    - $transformationCreate['code'] => (string) The source code of the transformation. (required)
      *                                    - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
      *                                    - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
+     *                                    - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
      *
      * @see TransformationCreate
      *
@@ -2275,7 +2276,7 @@ public function triggerDockerSourceDiscover($sourceID, $requestOptions = [])
     }
 
     /**
-     * Try a transformation.
+     * Try a transformation before creating it.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2285,6 +2286,7 @@ public function triggerDockerSourceDiscover($sourceID, $requestOptions = [])
      * @param array $transformationTry transformationTry (required)
      *                                 - $transformationTry['code'] => (string) The source code of the transformation. (required)
      *                                 - $transformationTry['sampleRecord'] => (array) The record to apply the given code to. (required)
+     *                                 - $transformationTry['authentications'] => (array)
      *
      * @see TransformationTry
      *
@@ -2309,6 +2311,58 @@ public function tryTransformation($transformationTry, $requestOptions = [])
         return $this->sendRequest('POST', $resourcePath, $headers, $queryParameters, $httpBody, $requestOptions);
     }
 
+    /**
+     * Try a transformation before updating it.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
+     * @param string $transformationID  Unique identifier of a transformation. (required)
+     * @param array  $transformationTry transformationTry (required)
+     *                                  - $transformationTry['code'] => (string) The source code of the transformation. (required)
+     *                                  - $transformationTry['sampleRecord'] => (array) The record to apply the given code to. (required)
+     *                                  - $transformationTry['authentications'] => (array)
+     *
+     * @see TransformationTry
+     *
+     * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
+     *
+     * @return \Algolia\AlgoliaSearch\Model\Ingestion\TransformationTryResponse|array<string, mixed>
+     */
+    public function tryTransformationBeforeUpdate($transformationID, $transformationTry, $requestOptions = [])
+    {
+        // verify the required parameter 'transformationID' is set
+        if (!isset($transformationID)) {
+            throw new \InvalidArgumentException(
+                'Parameter `transformationID` is required when calling `tryTransformationBeforeUpdate`.'
+            );
+        }
+        // verify the required parameter 'transformationTry' is set
+        if (!isset($transformationTry)) {
+            throw new \InvalidArgumentException(
+                'Parameter `transformationTry` is required when calling `tryTransformationBeforeUpdate`.'
+            );
+        }
+
+        $resourcePath = '/1/transformations/{transformationID}/try';
+        $queryParameters = [];
+        $headers = [];
+        $httpBody = $transformationTry;
+
+        // path params
+        if (null !== $transformationID) {
+            $resourcePath = str_replace(
+                '{transformationID}',
+                ObjectSerializer::toPathValue($transformationID),
+                $resourcePath
+            );
+        }
+
+        return $this->sendRequest('POST', $resourcePath, $headers, $queryParameters, $httpBody, $requestOptions);
+    }
+
     /**
      * Updates an authentication resource.
      *
@@ -2574,6 +2628,7 @@ public function updateTaskV1($taskID, $taskUpdate, $requestOptions = [])
      *                                     - $transformationCreate['code'] => (string) The source code of the transformation. (required)
      *                                     - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
      *                                     - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does.
+     *                                     - $transformationCreate['authenticationIDs'] => (array) The authentications associated for the current transformation.
      *
      * @see TransformationCreate
      *

lib/Model/Ingestion/Transformation.php

@@ -20,6 +20,7 @@ class Transformation extends AbstractModel implements ModelInterface, \ArrayAcce
      */
     protected static $modelTypes = [
         'transformationID' => 'string',
+        'authenticationIDs' => 'string[]',
         'code' => 'string',
         'name' => 'string',
         'description' => 'string',
@@ -34,6 +35,7 @@ class Transformation extends AbstractModel implements ModelInterface, \ArrayAcce
      */
     protected static $modelFormats = [
         'transformationID' => null,
+        'authenticationIDs' => null,
         'code' => null,
         'name' => null,
         'description' => null,
@@ -49,6 +51,7 @@ class Transformation extends AbstractModel implements ModelInterface, \ArrayAcce
      */
     protected static $attributeMap = [
         'transformationID' => 'transformationID',
+        'authenticationIDs' => 'authenticationIDs',
         'code' => 'code',
         'name' => 'name',
         'description' => 'description',
@@ -63,6 +66,7 @@ class Transformation extends AbstractModel implements ModelInterface, \ArrayAcce
      */
     protected static $setters = [
         'transformationID' => 'setTransformationID',
+        'authenticationIDs' => 'setAuthenticationIDs',
         'code' => 'setCode',
         'name' => 'setName',
         'description' => 'setDescription',
@@ -77,6 +81,7 @@ class Transformation extends AbstractModel implements ModelInterface, \ArrayAcce
      */
     protected static $getters = [
         'transformationID' => 'getTransformationID',
+        'authenticationIDs' => 'getAuthenticationIDs',
         'code' => 'getCode',
         'name' => 'getName',
         'description' => 'getDescription',
@@ -101,6 +106,9 @@ public function __construct(?array $data = null)
         if (isset($data['transformationID'])) {
             $this->container['transformationID'] = $data['transformationID'];
         }
+        if (isset($data['authenticationIDs'])) {
+            $this->container['authenticationIDs'] = $data['authenticationIDs'];
+        }
         if (isset($data['code'])) {
             $this->container['code'] = $data['code'];
         }
@@ -229,6 +237,30 @@ public function setTransformationID($transformationID)
         return $this;
     }
 
+    /**
+     * Gets authenticationIDs.
+     *
+     * @return null|string[]
+     */
+    public function getAuthenticationIDs()
+    {
+        return $this->container['authenticationIDs'] ?? null;
+    }
+
+    /**
+     * Sets authenticationIDs.
+     *
+     * @param null|string[] $authenticationIDs the authentications associated for the current transformation
+     *
+     * @return self
+     */
+    public function setAuthenticationIDs($authenticationIDs)
+    {
+        $this->container['authenticationIDs'] = $authenticationIDs;
+
+        return $this;
+    }
+
     /**
      * Gets code.
      *

lib/Model/Ingestion/TransformationCreate.php

@@ -24,6 +24,7 @@ class TransformationCreate extends AbstractModel implements ModelInterface, \Arr
         'code' => 'string',
         'name' => 'string',
         'description' => 'string',
+        'authenticationIDs' => 'string[]',
     ];
 
     /**
@@ -35,6 +36,7 @@ class TransformationCreate extends AbstractModel implements ModelInterface, \Arr
         'code' => null,
         'name' => null,
         'description' => null,
+        'authenticationIDs' => null,
     ];
 
     /**
@@ -47,6 +49,7 @@ class TransformationCreate extends AbstractModel implements ModelInterface, \Arr
         'code' => 'code',
         'name' => 'name',
         'description' => 'description',
+        'authenticationIDs' => 'authenticationIDs',
     ];
 
     /**
@@ -58,6 +61,7 @@ class TransformationCreate extends AbstractModel implements ModelInterface, \Arr
         'code' => 'setCode',
         'name' => 'setName',
         'description' => 'setDescription',
+        'authenticationIDs' => 'setAuthenticationIDs',
     ];
 
     /**
@@ -69,6 +73,7 @@ class TransformationCreate extends AbstractModel implements ModelInterface, \Arr
         'code' => 'getCode',
         'name' => 'getName',
         'description' => 'getDescription',
+        'authenticationIDs' => 'getAuthenticationIDs',
     ];
 
     /**
@@ -94,6 +99,9 @@ public function __construct(?array $data = null)
         if (isset($data['description'])) {
             $this->container['description'] = $data['description'];
         }
+        if (isset($data['authenticationIDs'])) {
+            $this->container['authenticationIDs'] = $data['authenticationIDs'];
+        }
     }
 
     /**
@@ -249,6 +257,30 @@ public function setDescription($description)
         return $this;
     }
 
+    /**
+     * Gets authenticationIDs.
+     *
+     * @return null|string[]
+     */
+    public function getAuthenticationIDs()
+    {
+        return $this->container['authenticationIDs'] ?? null;
+    }
+
+    /**
+     * Sets authenticationIDs.
+     *
+     * @param null|string[] $authenticationIDs the authentications associated for the current transformation
+     *
+     * @return self
+     */
+    public function setAuthenticationIDs($authenticationIDs)
+    {
+        $this->container['authenticationIDs'] = $authenticationIDs;
+
+        return $this;
+    }
+
     /**
      * Returns true if offset exists. False otherwise.
      *

lib/Model/Ingestion/TransformationTry.php

@@ -21,6 +21,7 @@ class TransformationTry extends AbstractModel implements ModelInterface, \ArrayA
     protected static $modelTypes = [
         'code' => 'string',
         'sampleRecord' => 'object',
+        'authentications' => '\Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationCreate[]',
     ];
 
     /**
@@ -31,6 +32,7 @@ class TransformationTry extends AbstractModel implements ModelInterface, \ArrayA
     protected static $modelFormats = [
         'code' => null,
         'sampleRecord' => null,
+        'authentications' => null,
     ];
 
     /**
@@ -42,6 +44,7 @@ class TransformationTry extends AbstractModel implements ModelInterface, \ArrayA
     protected static $attributeMap = [
         'code' => 'code',
         'sampleRecord' => 'sampleRecord',
+        'authentications' => 'authentications',
     ];
 
     /**
@@ -52,6 +55,7 @@ class TransformationTry extends AbstractModel implements ModelInterface, \ArrayA
     protected static $setters = [
         'code' => 'setCode',
         'sampleRecord' => 'setSampleRecord',
+        'authentications' => 'setAuthentications',
     ];
 
     /**
@@ -62,6 +66,7 @@ class TransformationTry extends AbstractModel implements ModelInterface, \ArrayA
     protected static $getters = [
         'code' => 'getCode',
         'sampleRecord' => 'getSampleRecord',
+        'authentications' => 'getAuthentications',
     ];
 
     /**
@@ -84,6 +89,9 @@ public function __construct(?array $data = null)
         if (isset($data['sampleRecord'])) {
             $this->container['sampleRecord'] = $data['sampleRecord'];
         }
+        if (isset($data['authentications'])) {
+            $this->container['authentications'] = $data['authentications'];
+        }
     }
 
     /**
@@ -215,6 +223,30 @@ public function setSampleRecord($sampleRecord)
         return $this;
     }
 
+    /**
+     * Gets authentications.
+     *
+     * @return null|\Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationCreate[]
+     */
+    public function getAuthentications()
+    {
+        return $this->container['authentications'] ?? null;
+    }
+
+    /**
+     * Sets authentications.
+     *
+     * @param null|\Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationCreate[] $authentications authentications
+     *
+     * @return self
+     */
+    public function setAuthentications($authentications)
+    {
+        $this->container['authentications'] = $authentications;
+
+        return $this;
+    }
+
     /**
      * Returns true if offset exists. False otherwise.
      *