@algolia/ingestion 1.20.3 → 1.21.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.
Files changed (24) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +8 -5
  3. package/dist/builds/browser.js +5 -5
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +5 -5
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +5 -5
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +5 -5
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +5 -5
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +8 -5
  17. package/dist/node.d.cts +8 -5
  18. package/dist/node.d.ts +8 -5
  19. package/dist/src/ingestionClient.cjs +5 -5
  20. package/dist/src/ingestionClient.cjs.map +1 -1
  21. package/dist/src/ingestionClient.js +5 -5
  22. package/dist/src/ingestionClient.js.map +1 -1
  23. package/dist/worker.d.ts +8 -5
  24. package/package.json +10 -10
package/README.md CHANGED
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
41
41
  ### With a package manager
42
42
 
43
43
  ```bash
44
- yarn add @algolia/ingestion@1.20.3
44
+ yarn add @algolia/ingestion@1.21.0
45
45
  # or
46
- npm install @algolia/ingestion@1.20.3
46
+ npm install @algolia/ingestion@1.21.0
47
47
  # or
48
- pnpm add @algolia/ingestion@1.20.3
48
+ pnpm add @algolia/ingestion@1.21.0
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/ingestion@1.20.3
53
53
  Add the following JavaScript snippet to the <head> of your website:
54
54
 
55
55
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.20.3/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.21.0/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -865,6 +865,7 @@ type Task = {
865
865
  */
866
866
  failureThreshold?: number;
867
867
  action?: ActionType;
868
+ subscriptionAction?: ActionType;
868
869
  /**
869
870
  * Date of the last cursor in RFC 3339 format.
870
871
  */
@@ -1203,6 +1204,7 @@ type TaskCreate = {
1203
1204
  */
1204
1205
  destinationID: string;
1205
1206
  action: ActionType;
1207
+ subscriptionAction?: ActionType;
1206
1208
  /**
1207
1209
  * Cron expression for the task\'s schedule.
1208
1210
  */
@@ -1574,6 +1576,7 @@ type TaskUpdate = {
1574
1576
  * Whether the task is enabled.
1575
1577
  */
1576
1578
  enabled?: boolean;
1579
+ subscriptionAction?: ActionType;
1577
1580
  /**
1578
1581
  * Maximum accepted percentage of failures for a task run to finish successfully.
1579
1582
  */
@@ -2278,7 +2281,7 @@ type ValidateSourceBeforeUpdateProps = {
2278
2281
  sourceUpdate: SourceUpdate;
2279
2282
  };
2280
2283
 
2281
- declare const apiClientVersion = "1.20.3";
2284
+ declare const apiClientVersion = "1.21.0";
2282
2285
  declare const REGIONS: readonly ["eu", "us"];
2283
2286
  type Region = (typeof REGIONS)[number];
2284
2287
  type RegionOptions = {
@@ -2391,7 +2394,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2391
2394
  */
2392
2395
  createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
2393
2396
  /**
2394
- * This method allow you to send requests to the Algolia REST API.
2397
+ * This method lets you send requests to the Algolia REST API.
2395
2398
  * @param customDelete - The customDelete object.
2396
2399
  * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
2397
2400
  * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -2399,7 +2402,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2399
2402
  */
2400
2403
  customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2401
2404
  /**
2402
- * This method allow you to send requests to the Algolia REST API.
2405
+ * This method lets you send requests to the Algolia REST API.
2403
2406
  * @param customGet - The customGet object.
2404
2407
  * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
2405
2408
  * @param customGet.parameters - Query parameters to apply to the current query.
@@ -2407,7 +2410,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2407
2410
  */
2408
2411
  customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2409
2412
  /**
2410
- * This method allow you to send requests to the Algolia REST API.
2413
+ * This method lets you send requests to the Algolia REST API.
2411
2414
  * @param customPost - The customPost object.
2412
2415
  * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
2413
2416
  * @param customPost.parameters - Query parameters to apply to the current query.
@@ -2416,7 +2419,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2416
2419
  */
2417
2420
  customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2418
2421
  /**
2419
- * This method allow you to send requests to the Algolia REST API.
2422
+ * This method lets you send requests to the Algolia REST API.
2420
2423
  * @param customPut - The customPut object.
2421
2424
  * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
2422
2425
  * @param customPut.parameters - Query parameters to apply to the current query.
package/dist/builds/browser.js CHANGED
@@ -9,7 +9,7 @@ import {
9
9
 
10
10
  // src/ingestionClient.ts
11
11
  import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
12
- var apiClientVersion = "1.20.3";
12
+ var apiClientVersion = "1.21.0";
13
13
  var REGIONS = ["eu", "us"];
14
14
  function getDefaultHosts(region) {
15
15
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -288,7 +288,7 @@ function createIngestionClient({
288
288
  return transporter.request(request, requestOptions);
289
289
  },
290
290
  /**
291
- * This method allow you to send requests to the Algolia REST API.
291
+ * This method lets you send requests to the Algolia REST API.
292
292
  * @param customDelete - The customDelete object.
293
293
  * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
294
294
  * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -310,7 +310,7 @@ function createIngestionClient({
310
310
  return transporter.request(request, requestOptions);
311
311
  },
312
312
  /**
313
- * This method allow you to send requests to the Algolia REST API.
313
+ * This method lets you send requests to the Algolia REST API.
314
314
  * @param customGet - The customGet object.
315
315
  * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
316
316
  * @param customGet.parameters - Query parameters to apply to the current query.
@@ -332,7 +332,7 @@ function createIngestionClient({
332
332
  return transporter.request(request, requestOptions);
333
333
  },
334
334
  /**
335
- * This method allow you to send requests to the Algolia REST API.
335
+ * This method lets you send requests to the Algolia REST API.
336
336
  * @param customPost - The customPost object.
337
337
  * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
338
338
  * @param customPost.parameters - Query parameters to apply to the current query.
@@ -356,7 +356,7 @@ function createIngestionClient({
356
356
  return transporter.request(request, requestOptions);
357
357
  },
358
358
  /**
359
- * This method allow you to send requests to the Algolia REST API.
359
+ * This method lets you send requests to the Algolia REST API.
360
360
  * @param customPut - The customPut object.
361
361
  * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
362
362
  * @param customPut.parameters - Query parameters to apply to the current query.