@algolia/ingestion 1.0.0-alpha.73 → 1.0.0-alpha.74

package/dist/ingestion.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '1.0.0-alpha.73';
+const apiClientVersion = '1.0.0-alpha.74';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'data.{region}.algolia.com'.replace('{region}', region);
@@ -91,7 +91,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Create a authentication.
          *
-         * @summary Create a authentication.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param authenticationCreate -.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -123,7 +127,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Create a destination.
          *
-         * @summary Create a destination.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param destinationCreate -.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -155,7 +163,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Create a source.
          *
-         * @summary Create a source.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param sourceCreate -.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -187,7 +199,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Create a task.
          *
-         * @summary Create a task.
          * @param taskCreate -.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -222,7 +233,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customDelete - The customDelete object.
          * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -246,7 +256,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customGet - The customGet object.
          * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customGet.parameters - Query parameters to apply to the current query.
@@ -270,7 +279,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPost - The customPost object.
          * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPost.parameters - Query parameters to apply to the current query.
@@ -296,7 +304,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPut - The customPut object.
          * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPut.parameters - Query parameters to apply to the current query.
@@ -322,7 +329,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Soft delete the authentication of the given authenticationID.
          *
-         * @summary Delete a authentication.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param deleteAuthentication - The deleteAuthentication object.
          * @param deleteAuthentication.authenticationID - The authentication UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -345,7 +356,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Soft delete the destination of the given destinationID.
          *
-         * @summary Delete a destination.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param deleteDestination - The deleteDestination object.
          * @param deleteDestination.destinationID - The destination UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -368,7 +383,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Soft delete the source of the given sourceID.
          *
-         * @summary Delete a source.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param deleteSource - The deleteSource object.
          * @param deleteSource.sourceID - The source UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -391,7 +410,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Soft delete the task of the given taskID.
          *
-         * @summary Delete a task.
          * @param deleteTask - The deleteTask object.
          * @param deleteTask.taskID - The task UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -414,7 +432,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Disable the task of the given taskID.
          *
-         * @summary Disable a task.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param disableTask - The disableTask object.
          * @param disableTask.taskID - The task UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -437,7 +459,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Enable the task of the given taskID.
          *
-         * @summary Enable a task.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param enableTask - The enableTask object.
          * @param enableTask.taskID - The task UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -460,7 +486,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get the authentication of the given authenticationID.
          *
-         * @summary Get a authentication.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getAuthentication - The getAuthentication object.
          * @param getAuthentication.authenticationID - The authentication UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -483,7 +513,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of authentications for the given query parameters, with pagination details.
          *
-         * @summary Get a list of authentications.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getAuthentications - The getAuthentications object.
          * @param getAuthentications.itemsPerPage - The number of items per page to return.
          * @param getAuthentications.page - The page number to fetch, starting at 1.
@@ -526,7 +560,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get the destination of the given destinationID.
          *
-         * @summary Get a destination.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getDestination - The getDestination object.
          * @param getDestination.destinationID - The destination UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -549,7 +587,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of destinations for the given query parameters, with pagination details.
          *
-         * @summary Get a list of destinations.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getDestinations - The getDestinations object.
          * @param getDestinations.itemsPerPage - The number of items per page to return.
          * @param getDestinations.page - The page number to fetch, starting at 1.
@@ -592,7 +634,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Retrieve a stream listing for a given Singer specification compatible docker type source ID.
          *
-         * @summary Retrieve a stream listing.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getDockerSourceStreams - The getDockerSourceStreams object.
          * @param getDockerSourceStreams.sourceID - The source UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -615,7 +661,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a single event for a specific runID.
          *
-         * @summary Get an event.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getEvent - The getEvent object.
          * @param getEvent.runID - The run UUID.
          * @param getEvent.eventID - The event UUID.
@@ -644,7 +694,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of events associated to the given runID, for the given query parameters.
          *
-         * @summary Get a list of events.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getEvents - The getEvents object.
          * @param getEvents.runID - The run UUID.
          * @param getEvents.itemsPerPage - The number of items per page to return.
@@ -699,7 +753,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a single run for the given ID.
          *
-         * @summary Get a run.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getRun - The getRun object.
          * @param getRun.runID - The run UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -722,7 +780,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of runs for the given query parameters, with pagination details.
          *
-         * @summary Get a list of runs.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getRuns - The getRuns object.
          * @param getRuns.itemsPerPage - The number of items per page to return.
          * @param getRuns.page - The page number to fetch, starting at 1.
@@ -773,7 +835,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get the source of the given sourceID.
          *
-         * @summary Get a source.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getSource - The getSource object.
          * @param getSource.sourceID - The source UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -796,7 +862,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of sources for the given query parameters, with pagination details.
          *
-         * @summary Get a list of sources.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getSources - The getSources object.
          * @param getSources.itemsPerPage - The number of items per page to return.
          * @param getSources.page - The page number to fetch, starting at 1.
@@ -839,7 +909,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get the task of the given taskID.
          *
-         * @summary Get a task.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getTask - The getTask object.
          * @param getTask.taskID - The task UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -862,7 +936,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Get a list of tasks for the given query parameters, with pagination details.
          *
-         * @summary Get a list of tasks.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param getTasks - The getTasks object.
          * @param getTasks.itemsPerPage - The number of items per page to return.
          * @param getTasks.page - The page number to fetch, starting at 1.
@@ -917,7 +995,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Run the task of the given taskID.
          *
-         * @summary Run a task.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param runTask - The runTask object.
          * @param runTask.taskID - The task UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -940,7 +1022,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Search among authentications with a defined set of parameters.
          *
-         * @summary Search among authentications.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param authenticationSearch - The authenticationSearch object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -966,7 +1052,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Search among destinations with a defined set of parameters.
          *
-         * @summary Search among destinations.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param destinationSearch - The destinationSearch object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -992,7 +1082,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Search among sources with a defined set of parameters.
          *
-         * @summary Search among sources.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param sourceSearch - The sourceSearch object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1018,7 +1112,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Search among tasks with a defined set of parameters.
          *
-         * @summary Search among tasks.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param taskSearch - The taskSearch object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1044,7 +1142,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Trigger a stream listing request for a Singer specification compatible docker type source.
          *
-         * @summary Trigger a stream listing request.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
          * @param triggerDockerSourceDiscover.sourceID - The source UUID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1067,7 +1169,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Update the authentication of the given authenticationID.
          *
-         * @summary Update a authentication.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param updateAuthentication - The updateAuthentication object.
          * @param updateAuthentication.authenticationID - The authentication UUID.
          * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
@@ -1095,7 +1201,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Update the destination of the given destinationID.
          *
-         * @summary Update a destination.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param updateDestination - The updateDestination object.
          * @param updateDestination.destinationID - The destination UUID.
          * @param updateDestination.destinationUpdate - The destinationUpdate object.
@@ -1123,7 +1233,11 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Update the source of the given sourceID.
          *
-         * @summary Update a source.
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
          * @param updateSource - The updateSource object.
          * @param updateSource.sourceID - The source UUID.
          * @param updateSource.sourceUpdate - The sourceUpdate object.
@@ -1151,7 +1265,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * Update the task of the given taskID.
          *
-         * @summary Update a task.
          * @param updateTask - The updateTask object.
          * @param updateTask.taskID - The task UUID.
          * @param updateTask.taskUpdate - The taskUpdate object.