@algolia/ingestion 1.41.0 → 1.42.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/worker.d.ts CHANGED
@@ -2486,7 +2486,7 @@ type ChunkedPushOptions = {
2486
2486
  objects: Array<Record<string, unknown>>;
2487
2487
  };
2488
2488
 
2489
- declare const apiClientVersion = "1.41.0";
2489
+ declare const apiClientVersion = "1.42.0";
2490
2490
  declare const REGIONS: readonly ["eu", "us"];
2491
2491
  type Region = (typeof REGIONS)[number];
2492
2492
  type RegionOptions = {
@@ -2596,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2596
2596
  createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
2597
2597
  /**
2598
2598
  * Creates a new task.
2599
+ *
2600
+ * Required API Key ACLs:
2601
+ * - addObject
2602
+ * - deleteIndex
2603
+ * - editSettings
2599
2604
  * @param taskCreate - Request body for creating a task.
2600
2605
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2601
2606
  */
@@ -2603,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2603
2608
  /**
2604
2609
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
2605
2610
  *
2611
+ * Required API Key ACLs:
2612
+ * - addObject
2613
+ * - deleteIndex
2614
+ * - editSettings
2615
+ *
2606
2616
  * @deprecated
2607
2617
  * @param taskCreate - Request body for creating a task.
2608
2618
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2610,6 +2620,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2610
2620
  createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2611
2621
  /**
2612
2622
  * Creates a new transformation.
2623
+ *
2624
+ * Required API Key ACLs:
2625
+ * - addObject
2626
+ * - deleteIndex
2627
+ * - editSettings
2613
2628
  * @param transformationCreate - Request body for creating a transformation.
2614
2629
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2615
2630
  */
@@ -2686,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2686
2701
  deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2687
2702
  /**
2688
2703
  * Deletes a task by its ID.
2704
+ *
2705
+ * Required API Key ACLs:
2706
+ * - addObject
2707
+ * - deleteIndex
2708
+ * - editSettings
2689
2709
  * @param deleteTask - The deleteTask object.
2690
2710
  * @param deleteTask.taskID - Unique identifier of a task.
2691
2711
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2694,6 +2714,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2694
2714
  /**
2695
2715
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
2696
2716
  *
2717
+ * Required API Key ACLs:
2718
+ * - addObject
2719
+ * - deleteIndex
2720
+ * - editSettings
2721
+ *
2697
2722
  * @deprecated
2698
2723
  * @param deleteTaskV1 - The deleteTaskV1 object.
2699
2724
  * @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -2702,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2702
2727
  deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2703
2728
  /**
2704
2729
  * Deletes a transformation by its ID.
2730
+ *
2731
+ * Required API Key ACLs:
2732
+ * - addObject
2733
+ * - deleteIndex
2734
+ * - editSettings
2705
2735
  * @param deleteTransformation - The deleteTransformation object.
2706
2736
  * @param deleteTransformation.transformationID - Unique identifier of a transformation.
2707
2737
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3041,6 +3071,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3041
3071
  pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
3042
3072
  /**
3043
3073
  * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
3074
+ *
3075
+ * Required API Key ACLs:
3076
+ * - addObject
3077
+ * - deleteIndex
3078
+ * - editSettings
3044
3079
  * @param replaceTask - The replaceTask object.
3045
3080
  * @param replaceTask.taskID - Unique identifier of a task.
3046
3081
  * @param replaceTask.taskReplace - The taskReplace object.
@@ -3233,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3233
3268
  updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
3234
3269
  /**
3235
3270
  * Partially updates a task by its ID.
3271
+ *
3272
+ * Required API Key ACLs:
3273
+ * - addObject
3274
+ * - deleteIndex
3275
+ * - editSettings
3236
3276
  * @param updateTask - The updateTask object.
3237
3277
  * @param updateTask.taskID - Unique identifier of a task.
3238
3278
  * @param updateTask.taskUpdate - The taskUpdate object.
@@ -3242,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3242
3282
  /**
3243
3283
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3244
3284
  *
3285
+ * Required API Key ACLs:
3286
+ * - addObject
3287
+ * - deleteIndex
3288
+ * - editSettings
3289
+ *
3245
3290
  * @deprecated
3246
3291
  * @param updateTaskV1 - The updateTaskV1 object.
3247
3292
  * @param updateTaskV1.taskID - Unique identifier of a task.
@@ -3251,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3251
3296
  updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3252
3297
  /**
3253
3298
  * Updates a transformation by its ID.
3299
+ *
3300
+ * Required API Key ACLs:
3301
+ * - addObject
3302
+ * - deleteIndex
3303
+ * - editSettings
3254
3304
  * @param updateTransformation - The updateTransformation object.
3255
3305
  * @param updateTransformation.transformationID - Unique identifier of a transformation.
3256
3306
  * @param updateTransformation.transformationCreate - The transformationCreate object.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.41.0",
2
+ "version": "1.42.0",
3
3
  "repository": {
4
4
  "type": "git",
5
5
  "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,14 +49,14 @@
49
49
  "index.d.ts"
50
50
  ],
51
51
  "dependencies": {
52
- "@algolia/client-common": "5.41.0",
53
- "@algolia/requester-browser-xhr": "5.41.0",
54
- "@algolia/requester-fetch": "5.41.0",
55
- "@algolia/requester-node-http": "5.41.0"
52
+ "@algolia/client-common": "5.42.0",
53
+ "@algolia/requester-browser-xhr": "5.42.0",
54
+ "@algolia/requester-fetch": "5.42.0",
55
+ "@algolia/requester-node-http": "5.42.0"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@arethetypeswrong/cli": "0.18.2",
59
- "@types/node": "22.18.11",
59
+ "@types/node": "22.18.12",
60
60
  "publint": "0.3.15",
61
61
  "rollup": "4.52.5",
62
62
  "tsup": "8.5.0",