@algolia/ingestion 1.37.0 → 1.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/fetch.d.ts CHANGED
@@ -708,7 +708,7 @@ type ListSourcesResponse = {
708
708
  /**
709
709
  * Action to perform on the Algolia index.
710
710
  */
711
- type ActionType = 'replace' | 'save' | 'partial' | 'append';
711
+ type ActionType = 'replace' | 'save' | 'partial' | 'partialNoCreate' | 'append';
712
712
 
713
713
  type EmailNotifications = {
714
714
  /**
@@ -2255,6 +2255,10 @@ type ListTransformationsProps = {
2255
2255
  * Sort order of the response, ascending or descending.
2256
2256
  */
2257
2257
  order?: OrderKeys | undefined;
2258
+ /**
2259
+ * Whether to filter the list of transformations by the type of transformation.
2260
+ */
2261
+ type?: TransformationType | undefined;
2258
2262
  };
2259
2263
  /**
2260
2264
  * Properties for the `push` method.
@@ -2453,7 +2457,7 @@ type ChunkedPushOptions = {
2453
2457
  objects: Array<Record<string, unknown>>;
2454
2458
  };
2455
2459
 
2456
- declare const apiClientVersion = "1.37.0";
2460
+ declare const apiClientVersion = "1.39.0";
2457
2461
  declare const REGIONS: readonly ["eu", "us"];
2458
2462
  type Region = (typeof REGIONS)[number];
2459
2463
  type RegionOptions = {
@@ -2973,9 +2977,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2973
2977
  * @param listTransformations.page - Page number of the paginated API response.
2974
2978
  * @param listTransformations.sort - Property by which to sort the list of transformations.
2975
2979
  * @param listTransformations.order - Sort order of the response, ascending or descending.
2980
+ * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
2976
2981
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2977
2982
  */
2978
- listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2983
+ listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2979
2984
  /**
2980
2985
  * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
2981
2986
  *
@@ -2992,7 +2997,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2992
2997
  */
2993
2998
  push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
2994
2999
  /**
2995
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
3000
+ * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
2996
3001
  *
2997
3002
  * Required API Key ACLs:
2998
3003
  * - addObject
package/dist/node.d.cts CHANGED
@@ -708,7 +708,7 @@ type ListSourcesResponse = {
708
708
  /**
709
709
  * Action to perform on the Algolia index.
710
710
  */
711
- type ActionType = 'replace' | 'save' | 'partial' | 'append';
711
+ type ActionType = 'replace' | 'save' | 'partial' | 'partialNoCreate' | 'append';
712
712
 
713
713
  type EmailNotifications = {
714
714
  /**
@@ -2255,6 +2255,10 @@ type ListTransformationsProps = {
2255
2255
  * Sort order of the response, ascending or descending.
2256
2256
  */
2257
2257
  order?: OrderKeys | undefined;
2258
+ /**
2259
+ * Whether to filter the list of transformations by the type of transformation.
2260
+ */
2261
+ type?: TransformationType | undefined;
2258
2262
  };
2259
2263
  /**
2260
2264
  * Properties for the `push` method.
@@ -2453,7 +2457,7 @@ type ChunkedPushOptions = {
2453
2457
  objects: Array<Record<string, unknown>>;
2454
2458
  };
2455
2459
 
2456
- declare const apiClientVersion = "1.37.0";
2460
+ declare const apiClientVersion = "1.39.0";
2457
2461
  declare const REGIONS: readonly ["eu", "us"];
2458
2462
  type Region = (typeof REGIONS)[number];
2459
2463
  type RegionOptions = {
@@ -2973,9 +2977,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2973
2977
  * @param listTransformations.page - Page number of the paginated API response.
2974
2978
  * @param listTransformations.sort - Property by which to sort the list of transformations.
2975
2979
  * @param listTransformations.order - Sort order of the response, ascending or descending.
2980
+ * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
2976
2981
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2977
2982
  */
2978
- listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2983
+ listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2979
2984
  /**
2980
2985
  * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
2981
2986
  *
@@ -2992,7 +2997,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2992
2997
  */
2993
2998
  push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
2994
2999
  /**
2995
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
3000
+ * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
2996
3001
  *
2997
3002
  * Required API Key ACLs:
2998
3003
  * - addObject
package/dist/node.d.ts CHANGED
@@ -708,7 +708,7 @@ type ListSourcesResponse = {
708
708
  /**
709
709
  * Action to perform on the Algolia index.
710
710
  */
711
- type ActionType = 'replace' | 'save' | 'partial' | 'append';
711
+ type ActionType = 'replace' | 'save' | 'partial' | 'partialNoCreate' | 'append';
712
712
 
713
713
  type EmailNotifications = {
714
714
  /**
@@ -2255,6 +2255,10 @@ type ListTransformationsProps = {
2255
2255
  * Sort order of the response, ascending or descending.
2256
2256
  */
2257
2257
  order?: OrderKeys | undefined;
2258
+ /**
2259
+ * Whether to filter the list of transformations by the type of transformation.
2260
+ */
2261
+ type?: TransformationType | undefined;
2258
2262
  };
2259
2263
  /**
2260
2264
  * Properties for the `push` method.
@@ -2453,7 +2457,7 @@ type ChunkedPushOptions = {
2453
2457
  objects: Array<Record<string, unknown>>;
2454
2458
  };
2455
2459
 
2456
- declare const apiClientVersion = "1.37.0";
2460
+ declare const apiClientVersion = "1.39.0";
2457
2461
  declare const REGIONS: readonly ["eu", "us"];
2458
2462
  type Region = (typeof REGIONS)[number];
2459
2463
  type RegionOptions = {
@@ -2973,9 +2977,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2973
2977
  * @param listTransformations.page - Page number of the paginated API response.
2974
2978
  * @param listTransformations.sort - Property by which to sort the list of transformations.
2975
2979
  * @param listTransformations.order - Sort order of the response, ascending or descending.
2980
+ * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
2976
2981
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2977
2982
  */
2978
- listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2983
+ listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2979
2984
  /**
2980
2985
  * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
2981
2986
  *
@@ -2992,7 +2997,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2992
2997
  */
2993
2998
  push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
2994
2999
  /**
2995
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
3000
+ * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
2996
3001
  *
2997
3002
  * Required API Key ACLs:
2998
3003
  * - addObject
@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
29
29
  });
30
30
  module.exports = __toCommonJS(ingestionClient_exports);
31
31
  var import_client_common = require("@algolia/client-common");
32
- var apiClientVersion = "1.37.0";
32
+ var apiClientVersion = "1.39.0";
33
33
  var REGIONS = ["eu", "us"];
34
34
  function getDefaultHosts(region) {
35
35
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1355,9 +1355,10 @@ function createIngestionClient({
1355
1355
  * @param listTransformations.page - Page number of the paginated API response.
1356
1356
  * @param listTransformations.sort - Property by which to sort the list of transformations.
1357
1357
  * @param listTransformations.order - Sort order of the response, ascending or descending.
1358
+ * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
1358
1359
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1359
1360
  */
1360
- listTransformations({ itemsPerPage, page, sort, order } = {}, requestOptions = void 0) {
1361
+ listTransformations({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
1361
1362
  const requestPath = "/1/transformations";
1362
1363
  const headers = {};
1363
1364
  const queryParameters = {};
@@ -1373,6 +1374,9 @@ function createIngestionClient({
1373
1374
  if (order !== void 0) {
1374
1375
  queryParameters["order"] = order.toString();
1375
1376
  }
1377
+ if (type !== void 0) {
1378
+ queryParameters["type"] = type.toString();
1379
+ }
1376
1380
  const request = {
1377
1381
  method: "GET",
1378
1382
  path: requestPath,
@@ -1435,7 +1439,7 @@ function createIngestionClient({
1435
1439
  return transporter.request(request, requestOptions);
1436
1440
  },
1437
1441
  /**
1438
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
1442
+ * Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
1439
1443
  *
1440
1444
  * Required API Key ACLs:
1441
1445
  * - addObject