@algolia/ingestion 1.2.5 → 1.3.0

package/dist/src/ingestionClient.js

@@ -1,6 +1,6 @@
 // src/ingestionClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.2.5";
+var apiClientVersion = "1.3.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -24,26 +24,25 @@ function createIngestionClient({
   ...options
 }) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  const transporter = createTransporter({
-    hosts: getDefaultHosts(regionOption),
-    ...options,
-    algoliaAgent: getAlgoliaAgent({
-      algoliaAgents,
-      client: "Ingestion",
-      version: apiClientVersion
-    }),
-    baseHeaders: {
-      "content-type": "text/plain",
-      ...auth.headers(),
-      ...options.baseHeaders
-    },
-    baseQueryParameters: {
-      ...auth.queryParameters(),
-      ...options.baseQueryParameters
-    }
-  });
   return {
-    transporter,
+    transporter: createTransporter({
+      hosts: getDefaultHosts(regionOption),
+      ...options,
+      algoliaAgent: getAlgoliaAgent({
+        algoliaAgents,
+        client: "Ingestion",
+        version: apiClientVersion
+      }),
+      baseHeaders: {
+        "content-type": "text/plain",
+        ...auth.headers(),
+        ...options.baseHeaders
+      },
+      baseQueryParameters: {
+        ...auth.queryParameters(),
+        ...options.baseQueryParameters
+      }
+    }),
     /**
      * The `appId` currently in use.
      */
@@ -52,13 +51,15 @@ function createIngestionClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache() {
-      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
+        () => void 0
+      );
     },
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua() {
-      return transporter.algoliaAgent.value;
+      return this.transporter.algoliaAgent.value;
     },
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
@@ -67,7 +68,16 @@ function createIngestionClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment, version) {
-      transporter.algoliaAgent.add({ segment, version });
+      this.transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }) {
+      this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
     },
     /**
      * Creates a new authentication resource.
@@ -103,7 +113,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -139,7 +149,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -172,7 +182,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -203,7 +213,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
@@ -237,7 +247,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -265,7 +275,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -288,7 +298,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -311,7 +321,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -336,7 +346,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -361,7 +371,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
@@ -391,7 +401,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
@@ -421,7 +431,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
@@ -448,7 +458,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -470,7 +480,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
@@ -492,7 +502,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -517,7 +527,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -544,7 +554,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task using the v1 endpoint, please use `disableTask` instead.
@@ -571,7 +581,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -598,7 +608,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task using the v1 endpoint, please use `enableTask` instead.
@@ -625,7 +635,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Generates code for the selected model based on the given prompt.
@@ -664,7 +674,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -694,7 +704,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -724,7 +734,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a single task run event by its ID.
@@ -755,7 +765,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -782,7 +792,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -809,7 +819,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -836,7 +846,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
@@ -863,7 +873,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -893,7 +903,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -940,7 +950,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -987,7 +997,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of events for a task run, identified by it\'s ID.
@@ -1046,7 +1056,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1105,7 +1115,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1152,7 +1162,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1211,7 +1221,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
@@ -1270,7 +1280,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1292,7 +1302,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1331,7 +1341,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
@@ -1369,7 +1379,7 @@ function createIngestionClient({
         headers,
         data: pushTaskPayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -1398,7 +1408,7 @@ function createIngestionClient({
         headers,
         data: runSourcePayload ? runSourcePayload : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Runs a task. You can check the status of task runs with the observability endpoints.
@@ -1425,7 +1435,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
@@ -1452,7 +1462,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1484,7 +1494,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1514,7 +1524,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1544,7 +1554,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1574,7 +1584,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
@@ -1604,7 +1614,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1636,7 +1646,7 @@ function createIngestionClient({
         headers,
         data: transformationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
@@ -1663,7 +1673,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1696,7 +1706,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1739,7 +1749,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1774,7 +1784,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1809,7 +1819,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1841,7 +1851,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1868,7 +1878,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
@@ -1895,7 +1905,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1931,7 +1941,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -1955,7 +1965,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate ? sourceCreate : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -1987,7 +1997,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     }
   };
 }