@algolia/ingestion 1.3.1 → 1.4.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.3.1";
+var apiClientVersion = "1.4.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -56,25 +56,26 @@ function createIngestionClient({
   ...options
 }) {
   const auth = (0, import_client_common.createAuth)(appIdOption, apiKeyOption, authMode);
-  return {
-    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
-      }
+  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,
     /**
      * The `appId` currently in use.
      */
@@ -83,15 +84,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.
@@ -100,7 +99,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.
@@ -110,9 +109,9 @@ function createIngestionClient({
      */
     setClientApiKey({ apiKey }) {
       if (!authMode || authMode === "WithinHeaders") {
-        this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
       } else {
-        this.transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
       }
     },
     /**
@@ -149,7 +148,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -185,7 +184,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -218,7 +217,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -249,7 +248,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.
@@ -283,7 +282,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -311,7 +310,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.
@@ -334,7 +333,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.
@@ -357,7 +356,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.
@@ -382,7 +381,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.
@@ -407,7 +406,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.
@@ -437,7 +436,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.
@@ -467,7 +466,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.
@@ -494,7 +493,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -516,7 +515,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.
@@ -538,7 +537,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -563,7 +562,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -590,7 +589,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.
@@ -617,7 +616,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -644,7 +643,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.
@@ -671,7 +670,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.
@@ -710,7 +709,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -740,7 +739,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -770,7 +769,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.
@@ -801,7 +800,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -828,7 +827,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -855,7 +854,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -882,7 +881,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.
@@ -909,7 +908,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -939,7 +938,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -986,7 +985,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -1033,7 +1032,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.
@@ -1092,7 +1091,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1151,7 +1150,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1198,7 +1197,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1257,7 +1256,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.
@@ -1316,7 +1315,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1338,7 +1337,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1377,7 +1376,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.
@@ -1415,7 +1414,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.
@@ -1444,7 +1443,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.
@@ -1471,7 +1470,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.
@@ -1498,7 +1497,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1530,7 +1529,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1560,7 +1559,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1590,7 +1589,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1620,7 +1619,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.
@@ -1650,7 +1649,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1682,7 +1681,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`.
@@ -1709,7 +1708,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1742,7 +1741,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1785,7 +1784,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1820,7 +1819,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1855,7 +1854,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1887,7 +1886,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1914,7 +1913,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.
@@ -1941,7 +1940,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1977,7 +1976,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.
@@ -2001,7 +2000,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.
@@ -2033,7 +2032,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     }
   };
 }