@algolia/ingestion 1.0.0-beta.4 → 1.0.0-beta.5

package/dist/ingestion.esm.browser.js

@@ -271,8 +271,7 @@ function serializeUrl(host, path, queryParameters) {
   return url;
 }
 function serializeQueryParameters(parameters) {
-  const isObjectOrArray = value => Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
-  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]).replaceAll('+', '%20')}`).join('&');
+  return Object.keys(parameters).filter(key => parameters[key] !== undefined).sort().map(key => `${key}=${encodeURIComponent(Object.prototype.toString.call(parameters[key]) === '[object Array]' ? parameters[key].join(',') : parameters[key]).replaceAll('+', '%20')}`).join('&');
 }
 function serializeData(request, requestOptions) {
   if (request.method === 'GET' || request.data === undefined && requestOptions.data === undefined) {
@@ -677,7 +676,7 @@ function createXhrRequester() {
 }
 
 // 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-beta.4';
+const apiClientVersion = '1.0.0-beta.5';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'data.{region}.algolia.com'.replace('{region}', region);
@@ -903,6 +902,37 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Creates a new transformation.
+         *
+         * @param transformationCreate - Request body for creating a transformation.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        createTransformation(transformationCreate, requestOptions) {
+            if (!transformationCreate) {
+                throw new Error('Parameter `transformationCreate` is required when calling `createTransformation`.');
+            }
+            if (!transformationCreate.code) {
+                throw new Error('Parameter `transformationCreate.code` is required when calling `createTransformation`.');
+            }
+            if (!transformationCreate.name) {
+                throw new Error('Parameter `transformationCreate.name` is required when calling `createTransformation`.');
+            }
+            if (!transformationCreate.description) {
+                throw new Error('Parameter `transformationCreate.description` is required when calling `createTransformation`.');
+            }
+            const requestPath = '/1/transformations';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: transformationCreate,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
@@ -1102,6 +1132,28 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Deletes a transformation by its ID.
+         *
+         * @param deleteTransformation - The deleteTransformation object.
+         * @param deleteTransformation.transformationID - Unique identifier of a transformation.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteTransformation({ transformationID }, requestOptions) {
+            if (!transformationID) {
+                throw new Error('Parameter `transformationID` is required when calling `deleteTransformation`.');
+            }
+            const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Disables a task.
          *
@@ -1304,33 +1356,6 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
-        /**
-         * Retrieves a stream listing for a source.  Listing streams only works with sources with `type: docker` and `imageType: singer`.
-         *
-         * Required API Key ACLs:
-         * - addObject
-         * - deleteIndex
-         * - editSettings.
-         *
-         * @param getDockerSourceStreams - The getDockerSourceStreams object.
-         * @param getDockerSourceStreams.sourceID - Unique identifier of a source.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getDockerSourceStreams({ sourceID }, requestOptions) {
-            if (!sourceID) {
-                throw new Error('Parameter `sourceID` is required when calling `getDockerSourceStreams`.');
-            }
-            const requestPath = '/1/sources/{sourceID}/discover'.replace('{sourceID}', encodeURIComponent(sourceID));
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
         /**
          * Retrieves a single task run event by its ID.
          *
@@ -1380,8 +1405,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getEvents.type - Event type for filtering the list of task runs.
          * @param getEvents.sort - Property by which to sort the list of task run events.
          * @param getEvents.order - Sort order of the response, ascending or descending.
-         * @param getEvents.startDate - Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
-         * @param getEvents.endDate - Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
+         * @param getEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
+         * @param getEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }, requestOptions) {
@@ -1465,8 +1490,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getRuns.taskID - Task ID for filtering the list of task runs.
          * @param getRuns.sort - Property by which to sort the list of task runs.
          * @param getRuns.order - Sort order of the response, ascending or descending.
-         * @param getRuns.startDate - Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
-         * @param getRuns.endDate - Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
+         * @param getRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
+         * @param getRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, } = {}, requestOptions = undefined) {
@@ -1665,6 +1690,64 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Retrieves a transformation by its ID.
+         *
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
+         * @param getTransformation - The getTransformation object.
+         * @param getTransformation.transformationID - Unique identifier of a transformation.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTransformation({ transformationID }, requestOptions) {
+            if (!transformationID) {
+                throw new Error('Parameter `transformationID` is required when calling `getTransformation`.');
+            }
+            const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves a list of transformations.
+         *
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
+         * @param getTransformations - The getTransformations object.
+         * @param getTransformations.sort - Property by which to sort the list.
+         * @param getTransformations.order - Sort order of the response, ascending or descending.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTransformations({ sort, order } = {}, requestOptions = undefined) {
+            const requestPath = '/1/transformations';
+            const headers = {};
+            const queryParameters = {};
+            if (sort !== undefined) {
+                queryParameters.sort = sort.toString();
+            }
+            if (order !== undefined) {
+                queryParameters.order = order.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Runs a task. You can check the status of task runs with the observability endpoints.
          *
@@ -1812,6 +1895,36 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Searches for transformations.
+         *
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
+         * @param transformationSearch - The transformationSearch object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchTransformations(transformationSearch, requestOptions) {
+            if (!transformationSearch) {
+                throw new Error('Parameter `transformationSearch` is required when calling `searchTransformations`.');
+            }
+            if (!transformationSearch.transformationsIDs) {
+                throw new Error('Parameter `transformationSearch.transformationsIDs` is required when calling `searchTransformations`.');
+            }
+            const requestPath = '/1/transformations/search';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: transformationSearch,
+            };
+            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`.
          *
@@ -1839,6 +1952,39 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Searches for transformations.
+         *
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
+         * @param transformationTry - The transformationTry object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        tryTransformations(transformationTry, requestOptions) {
+            if (!transformationTry) {
+                throw new Error('Parameter `transformationTry` is required when calling `tryTransformations`.');
+            }
+            if (!transformationTry.code) {
+                throw new Error('Parameter `transformationTry.code` is required when calling `tryTransformations`.');
+            }
+            if (!transformationTry.sampleRecord) {
+                throw new Error('Parameter `transformationTry.sampleRecord` is required when calling `tryTransformations`.');
+            }
+            const requestPath = '/1/transformations/try';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: transformationTry,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Updates an authentication resource.
          *
@@ -1962,6 +2108,98 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Updates a transformation by its ID.
+         *
+         * @param updateTransformation - The updateTransformation object.
+         * @param updateTransformation.transformationID - Unique identifier of a transformation.
+         * @param updateTransformation.transformationCreate - The transformationCreate object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        updateTransformation({ transformationID, transformationCreate }, requestOptions) {
+            if (!transformationID) {
+                throw new Error('Parameter `transformationID` is required when calling `updateTransformation`.');
+            }
+            if (!transformationCreate) {
+                throw new Error('Parameter `transformationCreate` is required when calling `updateTransformation`.');
+            }
+            if (!transformationCreate.code) {
+                throw new Error('Parameter `transformationCreate.code` is required when calling `updateTransformation`.');
+            }
+            if (!transformationCreate.name) {
+                throw new Error('Parameter `transformationCreate.name` is required when calling `updateTransformation`.');
+            }
+            if (!transformationCreate.description) {
+                throw new Error('Parameter `transformationCreate.description` is required when calling `updateTransformation`.');
+            }
+            const requestPath = '/1/transformations/{transformationID}'.replace('{transformationID}', encodeURIComponent(transformationID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: transformationCreate,
+            };
+            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.
+         *
+         * 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.
+         */
+        validateSource(sourceCreate, requestOptions = undefined) {
+            const requestPath = '/1/sources/validate';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: sourceCreate ? sourceCreate : {},
+            };
+            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.
+         *
+         * Required API Key ACLs:
+         * - addObject
+         * - deleteIndex
+         * - editSettings.
+         *
+         * @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
+         * @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
+         * @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        validateSourceBeforeUpdate({ sourceID, sourceUpdate }, requestOptions) {
+            if (!sourceID) {
+                throw new Error('Parameter `sourceID` is required when calling `validateSourceBeforeUpdate`.');
+            }
+            if (!sourceUpdate) {
+                throw new Error('Parameter `sourceUpdate` is required when calling `validateSourceBeforeUpdate`.');
+            }
+            const requestPath = '/1/sources/{sourceID}/validate'.replace('{sourceID}', encodeURIComponent(sourceID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: sourceUpdate,
+            };
+            return transporter.request(request, requestOptions);
+        },
     };
 }