@algolia/ingestion 1.20.3 → 1.21.0

package/dist/fetch.d.ts

@@ -865,6 +865,7 @@ type Task = {
      */
     failureThreshold?: number;
     action?: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Date of the last cursor in RFC 3339 format.
      */
@@ -1203,6 +1204,7 @@ type TaskCreate = {
      */
     destinationID: string;
     action: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Cron expression for the task\'s schedule.
      */
@@ -1574,6 +1576,7 @@ type TaskUpdate = {
      * Whether the task is enabled.
      */
     enabled?: boolean;
+    subscriptionAction?: ActionType;
     /**
      * Maximum accepted percentage of failures for a task run to finish successfully.
      */
@@ -2278,7 +2281,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.20.3";
+declare const apiClientVersion = "1.21.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2391,7 +2394,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2399,7 +2402,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2407,7 +2410,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2416,7 +2419,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.

package/dist/node.d.cts

@@ -865,6 +865,7 @@ type Task = {
      */
     failureThreshold?: number;
     action?: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Date of the last cursor in RFC 3339 format.
      */
@@ -1203,6 +1204,7 @@ type TaskCreate = {
      */
     destinationID: string;
     action: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Cron expression for the task\'s schedule.
      */
@@ -1574,6 +1576,7 @@ type TaskUpdate = {
      * Whether the task is enabled.
      */
     enabled?: boolean;
+    subscriptionAction?: ActionType;
     /**
      * Maximum accepted percentage of failures for a task run to finish successfully.
      */
@@ -2278,7 +2281,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.20.3";
+declare const apiClientVersion = "1.21.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2391,7 +2394,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2399,7 +2402,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2407,7 +2410,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2416,7 +2419,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.

package/dist/node.d.ts

@@ -865,6 +865,7 @@ type Task = {
      */
     failureThreshold?: number;
     action?: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Date of the last cursor in RFC 3339 format.
      */
@@ -1203,6 +1204,7 @@ type TaskCreate = {
      */
     destinationID: string;
     action: ActionType;
+    subscriptionAction?: ActionType;
     /**
      * Cron expression for the task\'s schedule.
      */
@@ -1574,6 +1576,7 @@ type TaskUpdate = {
      * Whether the task is enabled.
      */
     enabled?: boolean;
+    subscriptionAction?: ActionType;
     /**
      * Maximum accepted percentage of failures for a task run to finish successfully.
      */
@@ -2278,7 +2281,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.20.3";
+declare const apiClientVersion = "1.21.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2391,7 +2394,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2399,7 +2402,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2407,7 +2410,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -2416,7 +2419,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.

package/dist/src/ingestionClient.cjs

@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
 });
 module.exports = __toCommonJS(ingestionClient_exports);
 var import_client_common = require("@algolia/client-common");
-var apiClientVersion = "1.20.3";
+var apiClientVersion = "1.21.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -308,7 +308,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -330,7 +330,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -352,7 +352,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.
@@ -376,7 +376,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * This method lets you 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.