@algolia/ingestion 1.0.0-alpha.8 → 1.0.0-alpha.80

package/dist/model/subscriptionTriggerType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A task which is triggered by an external subscription (e.g. Webhook).
+ */
+export type SubscriptionTriggerType = 'subscription';
+//# sourceMappingURL=subscriptionTriggerType.d.ts.map

package/dist/model/subscriptionTriggerType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptionTriggerType.d.ts","sourceRoot":"","sources":["../../model/subscriptionTriggerType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC"}

package/dist/model/task.d.ts

@@ -1,19 +1,37 @@
-import type { ActionType } from './actionType';
-import type { Trigger } from './trigger';
-export declare type Task = {
-    taskID: string;
-    sourceID: string;
-    destinationID: string;
-    trigger?: Trigger;
-    enabled: boolean;
-    action: ActionType;
-    /**
-     * Date of creation (RFC3339 format).
-     */
-    createdAt: string;
-    /**
-     * Date of last update (RFC3339 format).
-     */
-    updatedAt?: string;
-};
+import type { ActionType } from './actionType';
+import type { TaskInput } from './taskInput';
+import type { Trigger } from './trigger';
+export type Task = {
+    /**
+     * The task UUID.
+     */
+    taskID: string;
+    /**
+     * The source UUID.
+     */
+    sourceID: string;
+    /**
+     * The destination UUID.
+     */
+    destinationID: string;
+    trigger: Trigger;
+    input?: TaskInput;
+    /**
+     * Whether the task is enabled or not.
+     */
+    enabled: boolean;
+    /**
+     * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+     */
+    failureThreshold?: number;
+    action: ActionType;
+    /**
+     * Date of creation (RFC3339 format).
+     */
+    createdAt: string;
+    /**
+     * Date of last update (RFC3339 format).
+     */
+    updatedAt?: string;
+};
 //# sourceMappingURL=task.d.ts.map

package/dist/model/task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../../model/task.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,oBAAY,IAAI,GAAG;IACjB,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IAEjB,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,EAAE,OAAO,CAAC;IAEjB,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}
+{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../../model/task.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/model/taskCreate.d.ts

@@ -1,10 +1,28 @@
-import type { ActionType } from './actionType';
-import type { TriggerInput } from './triggerInput';
-export declare type TaskCreate = {
-    sourceID: string;
-    destinationID: string;
-    trigger: TriggerInput;
-    action: ActionType;
-    enabled?: boolean;
-};
+import type { ActionType } from './actionType';
+import type { TaskCreateTrigger } from './taskCreateTrigger';
+import type { TaskInput } from './taskInput';
+/**
+ * The payload for a task creation.
+ */
+export type TaskCreate = {
+    /**
+     * The source UUID.
+     */
+    sourceID: string;
+    /**
+     * The destination UUID.
+     */
+    destinationID: string;
+    trigger: TaskCreateTrigger;
+    action: ActionType;
+    /**
+     * Whether the task is enabled or not.
+     */
+    enabled?: boolean;
+    /**
+     * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+     */
+    failureThreshold?: number;
+    input?: TaskInput;
+};
 //# sourceMappingURL=taskCreate.d.ts.map

package/dist/model/taskCreate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskCreate.d.ts","sourceRoot":"","sources":["../../model/taskCreate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAC;IAEjB,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,YAAY,CAAC;IAEtB,MAAM,EAAE,UAAU,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
+{"version":3,"file":"taskCreate.d.ts","sourceRoot":"","sources":["../../model/taskCreate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,iBAAiB,CAAC;IAE3B,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC"}

package/dist/model/taskCreateResponse.d.ts

@@ -1,8 +1,14 @@
-export declare type TaskCreateResponse = {
-    taskID: string;
-    /**
-     * Date of creation (RFC3339 format).
-     */
-    createdAt: string;
-};
+/**
+ * The response from the API after a task creation.
+ */
+export type TaskCreateResponse = {
+    /**
+     * The task UUID.
+     */
+    taskID: string;
+    /**
+     * Date of creation (RFC3339 format).
+     */
+    createdAt: string;
+};
 //# sourceMappingURL=taskCreateResponse.d.ts.map

package/dist/model/taskCreateResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskCreateResponse.d.ts","sourceRoot":"","sources":["../../model/taskCreateResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"taskCreateResponse.d.ts","sourceRoot":"","sources":["../../model/taskCreateResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/taskCreateTrigger.d.ts

@@ -0,0 +1,5 @@
+import type { OnDemandTriggerInput } from './onDemandTriggerInput';
+import type { ScheduleTriggerInput } from './scheduleTriggerInput';
+import type { SubscriptionTrigger } from './subscriptionTrigger';
+export type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | SubscriptionTrigger;
+//# sourceMappingURL=taskCreateTrigger.d.ts.map

package/dist/model/taskCreateTrigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskCreateTrigger.d.ts","sourceRoot":"","sources":["../../model/taskCreateTrigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,CAAC"}

package/dist/model/taskInput.d.ts

@@ -0,0 +1,4 @@
+import type { OnDemandDateUtilsInput } from './onDemandDateUtilsInput';
+import type { ScheduleDateUtilsInput } from './scheduleDateUtilsInput';
+export type TaskInput = OnDemandDateUtilsInput | ScheduleDateUtilsInput;
+//# sourceMappingURL=taskInput.d.ts.map

package/dist/model/taskInput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskInput.d.ts","sourceRoot":"","sources":["../../model/taskInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,SAAS,GAAG,sBAAsB,GAAG,sBAAsB,CAAC"}

package/dist/model/taskSearch.d.ts

@@ -0,0 +1,4 @@
+export type TaskSearch = {
+    taskIDs: string[];
+};
+//# sourceMappingURL=taskSearch.d.ts.map

package/dist/model/taskSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskSearch.d.ts","sourceRoot":"","sources":["../../model/taskSearch.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/model/taskSortKeys.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Used to sort the Task list endpoint.
+ */
+export type TaskSortKeys = 'action' | 'createdAt' | 'enabled' | 'triggerType' | 'updatedAt';
+//# sourceMappingURL=taskSortKeys.d.ts.map

package/dist/model/taskSortKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskSortKeys.d.ts","sourceRoot":"","sources":["../../model/taskSortKeys.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,WAAW,GACX,SAAS,GACT,aAAa,GACb,WAAW,CAAC"}

package/dist/model/taskUpdate.d.ts

@@ -1,7 +1,22 @@
-import type { TriggerInput } from './triggerInput';
-export declare type TaskUpdate = {
-    destinationID?: string;
-    trigger?: TriggerInput;
-    enabled?: boolean;
-};
+import type { TaskInput } from './taskInput';
+import type { TriggerUpdateInput } from './triggerUpdateInput';
+/**
+ * The payload for a task update.
+ */
+export type TaskUpdate = {
+    /**
+     * The destination UUID.
+     */
+    destinationID?: string;
+    trigger?: TriggerUpdateInput;
+    input?: TaskInput;
+    /**
+     * Whether the task is enabled or not.
+     */
+    enabled?: boolean;
+    /**
+     * A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
+     */
+    failureThreshold?: number;
+};
 //# sourceMappingURL=taskUpdate.d.ts.map

package/dist/model/taskUpdate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskUpdate.d.ts","sourceRoot":"","sources":["../../model/taskUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,UAAU,GAAG;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
+{"version":3,"file":"taskUpdate.d.ts","sourceRoot":"","sources":["../../model/taskUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/model/taskUpdateResponse.d.ts

@@ -1,8 +1,14 @@
-export declare type TaskUpdateResponse = {
-    taskID: string;
-    /**
-     * Date of last update (RFC3339 format).
-     */
-    updatedAt: string;
-};
+/**
+ * The response from the API after a task update.
+ */
+export type TaskUpdateResponse = {
+    /**
+     * The task UUID.
+     */
+    taskID: string;
+    /**
+     * Date of last update (RFC3339 format).
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=taskUpdateResponse.d.ts.map

package/dist/model/taskUpdateResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskUpdateResponse.d.ts","sourceRoot":"","sources":["../../model/taskUpdateResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"taskUpdateResponse.d.ts","sourceRoot":"","sources":["../../model/taskUpdateResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/trigger.d.ts

@@ -1,14 +1,5 @@
-import type { TriggerType } from './triggerType';
-export declare type Trigger = {
-    type: TriggerType;
-    cron?: string;
-    /**
-     * The last time the task ran (`scheduled` or `on-demand`).
-     */
-    lastRun?: string;
-    /**
-     * The next scheduled run for the task (`scheduled`).
-     */
-    nextRun?: string;
-};
+import type { OnDemandTrigger } from './onDemandTrigger';
+import type { ScheduleTrigger } from './scheduleTrigger';
+import type { SubscriptionTrigger } from './subscriptionTrigger';
+export type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger;
 //# sourceMappingURL=trigger.d.ts.map

package/dist/model/trigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../model/trigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,oBAAY,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../model/trigger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,eAAe,GAAG,mBAAmB,CAAC"}

package/dist/model/triggerType.d.ts

@@ -1,2 +1,5 @@
-export declare type TriggerType = 'on_demand' | 'schedule' | 'subscription';
+/**
+ * The type of the task reflect how it can be used:   - onDemand: a task that runs manually   - schedule: a task that runs regularly, following a given cron expression   - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook).
+ */
+export type TriggerType = 'onDemand' | 'schedule' | 'subscription';
 //# sourceMappingURL=triggerType.d.ts.map

package/dist/model/triggerType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"triggerType.d.ts","sourceRoot":"","sources":["../../model/triggerType.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,cAAc,CAAC"}
+{"version":3,"file":"triggerType.d.ts","sourceRoot":"","sources":["../../model/triggerType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,CAAC"}

package/dist/model/triggerUpdateInput.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The trigger input for a task update.
+ */
+export type TriggerUpdateInput = {
+    /**
+     * A cron expression that represent at which regularity the task should run.
+     */
+    cron: string;
+};
+//# sourceMappingURL=triggerUpdateInput.d.ts.map

package/dist/model/triggerUpdateInput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"triggerUpdateInput.d.ts","sourceRoot":"","sources":["../../model/triggerUpdateInput.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/model/window.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
+ */
+export type Window = {
+    /**
+     * A date in format RFC3339 representing the oldest possible data in query window.
+     */
+    startDate: string;
+    /**
+     * A date in format RFC3339 representing the newest possible data in query window.
+     */
+    endDate: string;
+};
+//# sourceMappingURL=window.d.ts.map

package/dist/model/window.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"window.d.ts","sourceRoot":"","sources":["../../model/window.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}