feat(specs): add authentications to ingestion transformations (genera…

…ted) algolia/api-clients-automation#3494 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia · Aug 8, 2024 · 1852d61 · 1852d61
1 parent 7d71353
commit 1852d61
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 1 deletion.
diff --git a/packages/ingestion/model/clientMethodProps.ts b/packages/ingestion/model/clientMethodProps.ts
@@ -24,6 +24,7 @@ import type { TaskSortKeys } from './taskSortKeys';
 import type { TaskUpdate } from './taskUpdate';
 import type { TaskUpdateV1 } from './taskUpdateV1';
 import type { TransformationCreate } from './transformationCreate';
+import type { TransformationTry } from './transformationTry';
 import type { TriggerType } from './triggerType';
 
 /**
@@ -608,6 +609,17 @@ export type TriggerDockerSourceDiscoverProps = {
   sourceID: string;
 };
 
+/**
+ * Properties for the `tryTransformationBeforeUpdate` method.
+ */
+export type TryTransformationBeforeUpdateProps = {
+  /**
+   * Unique identifier of a transformation.
+   */
+  transformationID: string;
+  transformationTry: TransformationTry;
+};
+
 /**
  * Properties for the `updateAuthentication` method.
  */

diff --git a/packages/ingestion/model/transformation.ts b/packages/ingestion/model/transformation.ts
@@ -6,6 +6,11 @@ export type Transformation = {
    */
   transformationID: string;
 
+  /**
+   * The authentications associated for the current transformation.
+   */
+  authenticationIDs?: string[];
+
   /**
    * The source code of the transformation.
    */

diff --git a/packages/ingestion/model/transformationCreate.ts b/packages/ingestion/model/transformationCreate.ts
@@ -18,4 +18,9 @@ export type TransformationCreate = {
    * A descriptive name for your transformation of what it does.
    */
   description?: string;
+
+  /**
+   * The authentications associated for the current transformation.
+   */
+  authenticationIDs?: string[];
 };
diff --git a/packages/ingestion/model/transformationTry.ts b/packages/ingestion/model/transformationTry.ts
@@ -1,5 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { AuthenticationCreate } from './authenticationCreate';
+
 export type TransformationTry = {
   /**
    * The source code of the transformation.
@@ -10,4 +12,6 @@ export type TransformationTry = {
    * The record to apply the given code to.
    */
   sampleRecord: Record<string, any>;
+
+  authentications?: AuthenticationCreate[];
 };
diff --git a/packages/ingestion/src/ingestionClient.ts b/packages/ingestion/src/ingestionClient.ts
@@ -55,6 +55,7 @@ import type {
   RunTaskProps,
   RunTaskV1Props,
   TriggerDockerSourceDiscoverProps,
+  TryTransformationBeforeUpdateProps,
   UpdateAuthenticationProps,
   UpdateDestinationProps,
   UpdateSourceProps,
@@ -2455,7 +2456,7 @@ export function createIngestionClient({
     },
 
     /**
-     * Try a transformation.
+     * Try a transformation before creating it.
      *
      * Required API Key ACLs:
      * - addObject
@@ -2501,6 +2502,67 @@ export function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Try a transformation before updating it.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
+     * @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
+     * @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    tryTransformationBeforeUpdate(
+      {
+        transformationID,
+        transformationTry,
+      }: TryTransformationBeforeUpdateProps,
+      requestOptions?: RequestOptions
+    ): Promise<TransformationTryResponse> {
+      if (!transformationID) {
+        throw new Error(
+          'Parameter `transformationID` is required when calling `tryTransformationBeforeUpdate`.'
+        );
+      }
+
+      if (!transformationTry) {
+        throw new Error(
+          'Parameter `transformationTry` is required when calling `tryTransformationBeforeUpdate`.'
+        );
+      }
+
+      if (!transformationTry.code) {
+        throw new Error(
+          'Parameter `transformationTry.code` is required when calling `tryTransformationBeforeUpdate`.'
+        );
+      }
+      if (!transformationTry.sampleRecord) {
+        throw new Error(
+          'Parameter `transformationTry.sampleRecord` is required when calling `tryTransformationBeforeUpdate`.'
+        );
+      }
+
+      const requestPath = '/1/transformations/{transformationID}/try'.replace(
+        '{transformationID}',
+        encodeURIComponent(transformationID)
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: transformationTry,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * Updates an authentication resource.
      *