npm - @algolia/ingestion - Versions diffs - 1.48.0 → 1.48.1 - Mend

@algolia/ingestion 1.48.0 → 1.48.1

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

package/README.md +4 -4
package/dist/browser.d.ts +54 -54
package/dist/builds/browser.js +12 -12
package/dist/builds/browser.js.map +1 -1
package/dist/builds/browser.min.js +1 -1
package/dist/builds/browser.min.js.map +1 -1
package/dist/builds/browser.umd.js +1 -1
package/dist/builds/fetch.js +12 -12
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +12 -12
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +12 -12
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +12 -12
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +54 -54
package/dist/node.d.cts +54 -54
package/dist/node.d.ts +54 -54
package/dist/src/ingestionClient.cjs +12 -12
package/dist/src/ingestionClient.cjs.map +1 -1
package/dist/src/ingestionClient.js +12 -12
package/dist/src/ingestionClient.js.map +1 -1
package/dist/worker.d.ts +54 -54
package/package.json +6 -6

package/README.md CHANGED Viewed

@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/ingestion@1.48.0
+yarn add @algolia/ingestion@1.48.1
 # or
-npm install @algolia/ingestion@1.48.0
+npm install @algolia/ingestion@1.48.1
 # or
-pnpm add @algolia/ingestion@1.48.0
+pnpm add @algolia/ingestion@1.48.1
 ```
 ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/ingestion@1.48.0
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.48.0/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.48.1/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -127,11 +127,11 @@ type Authentication = {
     owner?: string | null | undefined;
     input: AuthInputPartial;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -258,7 +258,7 @@ type AuthenticationCreateResponse = {
      */
     name: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -283,14 +283,14 @@ type AuthenticationUpdateResponse = {
      */
     name: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
 type DeleteResponse = {
     /**
-     * Date of deletion in RFC 3339 format.
+     * Date and time when the resource was deleted, in RFC 3339 format.
      */
     deletedAt: string;
 };
@@ -336,11 +336,11 @@ type Destination = {
     owner?: string | null | undefined;
     input: DestinationInput;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
     /**
@@ -380,7 +380,7 @@ type DestinationCreateResponse = {
      */
     name: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -405,7 +405,7 @@ type DestinationUpdateResponse = {
      */
     name: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -436,7 +436,7 @@ type Event = {
         [key: string]: any;
     } | null | undefined;
     /**
-     * Date of publish RFC 3339 format.
+     * Date and time when the resource was published, in RFC 3339 format.
      */
     publishedAt: string;
 };
@@ -478,11 +478,11 @@ type ListDestinationsResponse = {
  */
 type Window = {
     /**
-     * Date in RFC 3339 format representing the oldest data in the time window.
+     * Date and time representing the oldest data in the time window, in RFC 3339 format.
      */
     startDate: string;
     /**
-     * Date in RFC 3339 format representing the newest data in the time window.
+     * Date and time representing the newest data in the time window, in RFC 3339 format.
      */
     endDate: string;
 };
@@ -727,11 +727,11 @@ type Source = {
      */
     authenticationID?: string | undefined;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -921,17 +921,17 @@ type Task = {
     action?: ActionType | undefined;
     subscriptionAction?: ActionType | undefined;
     /**
-     * Date of the last cursor in RFC 3339 format.
+     * Date and time when the last cursor was created, in RFC 3339 format.
      */
     cursor?: string | undefined;
     notifications?: Notifications | undefined;
     policies?: Policies | undefined;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1014,7 +1014,7 @@ type SubscriptionTrigger = {
 type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger | StreamingTrigger;
 /**
- * The V1 task object, please use methods and types that don\'t contain the V1 suffix.
+ * The V1 task object. Use methods and types that don\'t contain the V1 suffix.
  */
 type TaskV1 = {
     /**
@@ -1041,17 +1041,17 @@ type TaskV1 = {
     failureThreshold?: number | undefined;
     action?: ActionType | undefined;
     /**
-     * Date of the last cursor in RFC 3339 format.
+     * Date and time when the last cursor was created, in RFC 3339 format.
      */
     cursor?: string | undefined;
     notifications?: Notifications | undefined;
     policies?: Policies | undefined;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1119,11 +1119,11 @@ type Transformation = {
      */
     owner?: string | null | undefined;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1185,15 +1185,15 @@ type Run = {
     reasonCode?: RunReasonCode | undefined;
     type: RunType;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
     /**
-     * Date of start in RFC 3339 format.
+     * Date and time when the task started, in RFC 3339 format.
      */
     startedAt?: string | undefined;
     /**
-     * Date of finish in RFC 3339 format.
+     * Date and time when the task finished, in RFC 3339 format.
      */
     finishedAt?: string | undefined;
 };
@@ -1213,7 +1213,7 @@ type RunResponse = {
      */
     runID: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -1226,7 +1226,7 @@ type RunSourceResponse = {
         [key: string]: string;
     };
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -1254,7 +1254,7 @@ type SourceCreateResponse = {
      */
     name: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -1273,7 +1273,7 @@ type SourceUpdateResponse = {
      */
     name: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1306,7 +1306,7 @@ type TaskCreate = {
     failureThreshold?: number | undefined;
     input?: TaskInput | undefined;
     /**
-     * Date of the last cursor in RFC 3339 format.
+     * Date and time when the last cursor was created, in RFC 3339 format.
      */
     cursor?: string | undefined;
     notifications?: Notifications | undefined;
@@ -1322,7 +1322,7 @@ type TaskCreateResponse = {
      */
     taskID: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -1348,7 +1348,7 @@ type ScheduleTriggerInput = {
 type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | SubscriptionTrigger | StreamingTrigger;
 /**
- * API request body for creating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
+ * API request body for creating a task using the V1 shape. Use methods and types that don\'t contain the V1 suffix.
  */
 type TaskCreateV1 = {
     /**
@@ -1371,7 +1371,7 @@ type TaskCreateV1 = {
     failureThreshold?: number | undefined;
     input?: TaskInput | undefined;
     /**
-     * Date of the last cursor in RFC 3339 format.
+     * Date and time when the last cursor was created, in RFC 3339 format.
      */
     cursor?: string | undefined;
 };
@@ -1389,7 +1389,7 @@ type TaskUpdateResponse = {
      */
     taskID: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1427,7 +1427,7 @@ type TransformationCreateResponse = {
      */
     transformationID: string;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt: string;
 };
@@ -1481,7 +1481,7 @@ type TransformationUpdateResponse = {
      */
     transformationID: string;
     /**
-     * Date of last update in RFC 3339 format.
+     * Date and time when the resource was last updated, in RFC 3339 format.
      */
     updatedAt: string;
 };
@@ -1508,7 +1508,7 @@ type WatchResponse = {
      */
     message?: string | undefined;
     /**
-     * Date of creation in RFC 3339 format.
+     * Date and time when the resource was created, in RFC 3339 format.
      */
     createdAt?: string | undefined;
 };
@@ -1704,7 +1704,7 @@ type TaskReplace = {
     failureThreshold?: number | undefined;
     input?: TaskInput | undefined;
     /**
-     * Date of the last cursor in RFC 3339 format.
+     * Date and time when the last cursor was created, in RFC 3339 format.
      */
     cursor?: string | undefined;
     notifications?: Notifications | undefined;
@@ -1753,7 +1753,7 @@ type TriggerUpdateInput = {
 };
 /**
- * API request body for updating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
+ * API request body for updating a task using the V1 shape. Use methods and types that don\'t contain the V1 suffix.
  */
 type TaskUpdateV1 = {
     /**
@@ -2152,11 +2152,11 @@ type ListRunsProps = {
      */
     order?: OrderKeys | undefined;
     /**
-     * Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
+     * Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
      */
     startDate?: string | undefined;
     /**
-     * Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
+     * Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
      */
     endDate?: string | undefined;
 };
@@ -2501,7 +2501,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
-declare const apiClientVersion = "1.48.0";
+declare const apiClientVersion = "1.48.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2621,7 +2621,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
-     * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     * Creates a new task using the v1 endpoint. Use `createTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2727,7 +2727,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
-     * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2765,7 +2765,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
-     * Disables a task using the v1 endpoint, please use `disableTask` instead.
+     * Disables a task using the v1 endpoint. Use `disableTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2791,7 +2791,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
-     * Enables a task using the v1 endpoint, please use `enableTask` instead.
+     * Enables a task using the v1 endpoint. Use `enableTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2878,7 +2878,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
     /**
-     * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
+     * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2973,8 +2973,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listRuns.taskID - Task ID for filtering the list of task runs.
      * @param listRuns.sort - Property by which to sort the list of task runs.
      * @param listRuns.order - Sort order of the response, ascending or descending.
-     * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
-     * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
+     * @param listRuns.startDate - Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
+     * @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. 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.
      */
     listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
@@ -3018,7 +3018,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, withEmailNotifications, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
     /**
-     * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
+     * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -3124,7 +3124,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     runTask({ taskID, runTaskPayload }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
     /**
-     * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
+     * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -3183,7 +3183,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<Task>>;
     /**
-     * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
+     * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -3295,7 +3295,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
-     * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject

package/dist/builds/browser.js CHANGED Viewed

@@ -9,7 +9,7 @@ import { createXhrRequester } from "@algolia/requester-browser-xhr";
 // src/ingestionClient.ts
 import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.48.0";
+var apiClientVersion = "1.48.1";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -299,7 +299,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     * Creates a new task using the v1 endpoint. Use `createTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -570,7 +570,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -653,7 +653,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Disables a task using the v1 endpoint, please use `disableTask` instead.
+     * Disables a task using the v1 endpoint. Use `disableTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -707,7 +707,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Enables a task using the v1 endpoint, please use `enableTask` instead.
+     * Enables a task using the v1 endpoint. Use `enableTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -901,7 +901,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
+     * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -1126,8 +1126,8 @@ function createIngestionClient({
      * @param listRuns.taskID - Task ID for filtering the list of task runs.
      * @param listRuns.sort - Property by which to sort the list of task runs.
      * @param listRuns.order - Sort order of the response, ascending or descending.
-     * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
-     * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
+     * @param listRuns.startDate - Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
+     * @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. 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.
      */
     listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
@@ -1294,7 +1294,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
+     * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -1591,7 +1591,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
+     * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -1739,7 +1739,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
+     * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2033,7 +2033,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
      *
      * Required API Key ACLs:
      *  - addObject