@algolia/ingestion 1.2.5 → 1.3.0

package/dist/builds/node.cjs

@@ -32,7 +32,7 @@ var import_requester_node_http = require("@algolia/requester-node-http");
 
 // src/ingestionClient.ts
 var import_client_common = require("@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);
@@ -56,26 +56,25 @@ function createIngestionClient({
   ...options
 }) {
   const auth = (0, import_client_common.createAuth)(appIdOption, apiKeyOption, authMode);
-  const transporter = (0, import_client_common.createTransporter)({
-    hosts: getDefaultHosts(regionOption),
-    ...options,
-    algoliaAgent: (0, import_client_common.getAlgoliaAgent)({
-      algoliaAgents,
-      client: "Ingestion",
-      version: apiClientVersion
-    }),
-    baseHeaders: {
-      "content-type": "text/plain",
-      ...auth.headers(),
-      ...options.baseHeaders
-    },
-    baseQueryParameters: {
-      ...auth.queryParameters(),
-      ...options.baseQueryParameters
-    }
-  });
   return {
-    transporter,
+    transporter: (0, import_client_common.createTransporter)({
+      hosts: getDefaultHosts(regionOption),
+      ...options,
+      algoliaAgent: (0, import_client_common.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.
      */
@@ -84,13 +83,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.
@@ -99,7 +100,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.
@@ -135,7 +145,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -171,7 +181,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -204,7 +214,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -235,7 +245,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.
@@ -269,7 +279,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -297,7 +307,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.
@@ -320,7 +330,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.
@@ -343,7 +353,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.
@@ -368,7 +378,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.
@@ -393,7 +403,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.
@@ -423,7 +433,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.
@@ -453,7 +463,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.
@@ -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.
@@ -502,7 +512,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.
@@ -524,7 +534,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -549,7 +559,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -576,7 +586,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.
@@ -603,7 +613,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -630,7 +640,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.
@@ -657,7 +667,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.
@@ -696,7 +706,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -726,7 +736,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -756,7 +766,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.
@@ -787,7 +797,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -814,7 +824,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -841,7 +851,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -868,7 +878,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.
@@ -895,7 +905,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -925,7 +935,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -972,7 +982,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -1019,7 +1029,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.
@@ -1078,7 +1088,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1137,7 +1147,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1184,7 +1194,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1243,7 +1253,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.
@@ -1302,7 +1312,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1324,7 +1334,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1363,7 +1373,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.
@@ -1401,7 +1411,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.
@@ -1430,7 +1440,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.
@@ -1457,7 +1467,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.
@@ -1484,7 +1494,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1516,7 +1526,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1546,7 +1556,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1576,7 +1586,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1606,7 +1616,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.
@@ -1636,7 +1646,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1668,7 +1678,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`.
@@ -1695,7 +1705,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1728,7 +1738,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1771,7 +1781,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1806,7 +1816,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1841,7 +1851,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1873,7 +1883,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1900,7 +1910,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.
@@ -1927,7 +1937,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1963,7 +1973,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.
@@ -1987,7 +1997,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.
@@ -2019,7 +2029,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     }
   };
 }