@algolia/ingestion 1.3.0 → 1.3.2

package/dist/builds/node.js

@@ -10,7 +10,7 @@ import { createHttpRequester } from "@algolia/requester-node-http";
 
 // src/ingestionClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.3.0";
+var apiClientVersion = "1.3.2";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -34,25 +34,26 @@ function createIngestionClient({
   ...options
 }) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  return {
-    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
-      }
+  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,
     /**
      * The `appId` currently in use.
      */
@@ -61,15 +62,13 @@ function createIngestionClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache() {
-      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
-        () => void 0
-      );
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
     },
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua() {
-      return this.transporter.algoliaAgent.value;
+      return transporter.algoliaAgent.value;
     },
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
@@ -78,7 +77,7 @@ function createIngestionClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment, version) {
-      this.transporter.algoliaAgent.add({ segment, version });
+      transporter.algoliaAgent.add({ segment, version });
     },
     /**
      * Helper method to switch the API key used to authenticate the requests.
@@ -87,7 +86,11 @@ function createIngestionClient({
      * @param params.apiKey - The new API Key to use.
      */
     setClientApiKey({ apiKey }) {
-      this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      if (!authMode || authMode === "WithinHeaders") {
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      } else {
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+      }
     },
     /**
      * Creates a new authentication resource.
@@ -123,7 +126,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -159,7 +162,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -192,7 +195,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -223,7 +226,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
@@ -257,7 +260,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -285,7 +288,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -308,7 +311,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -331,7 +334,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -356,7 +359,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -381,7 +384,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
@@ -411,7 +414,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
@@ -441,7 +444,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
@@ -468,7 +471,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -490,7 +493,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
@@ -512,7 +515,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -537,7 +540,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -564,7 +567,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Disables a task using the v1 endpoint, please use `disableTask` instead.
@@ -591,7 +594,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -618,7 +621,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Enables a task using the v1 endpoint, please use `enableTask` instead.
@@ -645,7 +648,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Generates code for the selected model based on the given prompt.
@@ -684,7 +687,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -714,7 +717,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -744,7 +747,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a single task run event by its ID.
@@ -775,7 +778,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -802,7 +805,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -829,7 +832,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -856,7 +859,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
@@ -883,7 +886,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -913,7 +916,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -960,7 +963,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -1007,7 +1010,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of events for a task run, identified by it\'s ID.
@@ -1066,7 +1069,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1125,7 +1128,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1172,7 +1175,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1231,7 +1234,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
@@ -1290,7 +1293,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1312,7 +1315,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1351,7 +1354,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
@@ -1389,7 +1392,7 @@ function createIngestionClient({
         headers,
         data: pushTaskPayload
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -1418,7 +1421,7 @@ function createIngestionClient({
         headers,
         data: runSourcePayload ? runSourcePayload : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Runs a task. You can check the status of task runs with the observability endpoints.
@@ -1445,7 +1448,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return 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.
@@ -1472,7 +1475,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1504,7 +1507,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1534,7 +1537,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1564,7 +1567,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1594,7 +1597,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
@@ -1624,7 +1627,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1656,7 +1659,7 @@ function createIngestionClient({
         headers,
         data: transformationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return 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`.
@@ -1683,7 +1686,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1716,7 +1719,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1759,7 +1762,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1794,7 +1797,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1829,7 +1832,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1861,7 +1864,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1888,7 +1891,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
@@ -1915,7 +1918,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1951,7 +1954,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -1975,7 +1978,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate ? sourceCreate : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return 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.
@@ -2007,7 +2010,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     }
   };
 }