@algolia/ingestion 1.2.5 → 1.3.0

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.2.5";
+var apiClientVersion = "1.3.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -34,26 +34,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.
      */
@@ -62,13 +61,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.
@@ -77,7 +78,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.
@@ -113,7 +123,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -149,7 +159,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -182,7 +192,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -213,7 +223,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.
@@ -247,7 +257,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -275,7 +285,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.
@@ -298,7 +308,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.
@@ -321,7 +331,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.
@@ -346,7 +356,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.
@@ -371,7 +381,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.
@@ -401,7 +411,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.
@@ -431,7 +441,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.
@@ -458,7 +468,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -480,7 +490,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.
@@ -502,7 +512,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -527,7 +537,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -554,7 +564,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.
@@ -581,7 +591,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -608,7 +618,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.
@@ -635,7 +645,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.
@@ -674,7 +684,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -704,7 +714,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -734,7 +744,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.
@@ -765,7 +775,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -792,7 +802,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -819,7 +829,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -846,7 +856,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.
@@ -873,7 +883,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -903,7 +913,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -950,7 +960,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -997,7 +1007,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.
@@ -1056,7 +1066,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1115,7 +1125,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1162,7 +1172,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1221,7 +1231,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.
@@ -1280,7 +1290,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1302,7 +1312,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1341,7 +1351,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.
@@ -1379,7 +1389,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.
@@ -1408,7 +1418,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.
@@ -1435,7 +1445,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.
@@ -1462,7 +1472,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1494,7 +1504,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1524,7 +1534,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1554,7 +1564,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1584,7 +1594,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.
@@ -1614,7 +1624,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1646,7 +1656,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`.
@@ -1673,7 +1683,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1706,7 +1716,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1749,7 +1759,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1784,7 +1794,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1819,7 +1829,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1851,7 +1861,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1878,7 +1888,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.
@@ -1905,7 +1915,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1941,7 +1951,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.
@@ -1965,7 +1975,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.
@@ -1997,7 +2007,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     }
   };
 }