@wix/auto_sdk_crm_tasks 1.0.6 → 1.0.7

package/build/index.d.mts

@@ -0,0 +1,115 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { T as Task, U as UpdateTask, a as TasksQueryBuilder, C as CountTasksOptions, b as CountTasksResponse, M as MoveTaskAfterOptions } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.mjs';
+export { Y as ActionEvent, a4 as BaseEventMetadata, f as ContactInfo, l as ContactNotFoundError, x as CountTasksRequest, j as CreateTaskRequest, k as CreateTaskResponse, t as CursorPaging, v as CursorPagingMetadata, q as CursorQuery, r as CursorQueryPagingMethodOneOf, w as Cursors, a0 as DeleteCompletedTasksRequest, a1 as DeleteCompletedTasksResponse, D as DeleteTaskRequest, p as DeleteTaskResponse, K as DomainEvent, L as DomainEventBodyOneOf, J as Empty, N as EntityCreatedEvent, X as EntityDeletedEvent, V as EntityUpdatedEvent, a5 as EventMetadata, G as GetTaskRequest, m as GetTaskResponse, _ as IdentificationData, $ as IdentificationDataIdOneOf, Z as MessageEnvelope, F as MoveTaskAfterRequest, H as MoveTaskAfterResponse, P as Paging, E as PagingMetadataV2, y as QueryTasksInternalRequest, B as QueryTasksInternalResponse, Q as QueryTasksRequest, u as QueryTasksResponse, z as QueryV2, A as QueryV2PagingMethodOneOf, R as ReminderType, g as RepositionTask, O as RestoreInfo, a2 as SendTasksReminderRequest, a3 as SendTasksReminderResponse, d as SortOrder, s as Sorting, S as SourceType, i as TaskAssigned, a6 as TaskCreatedEnvelope, a7 as TaskDeletedEnvelope, I as TaskNotFoundError, h as TaskOverdue, a8 as TaskOverdueEnvelope, e as TaskSource, c as TaskStatus, a9 as TaskUpdatedEnvelope, aa as TasksQueryResult, n as UpdateTaskRequest, o as UpdateTaskResponse, W as WebhookIdentityType } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function createTask$1(httpClient: HttpClient): CreateTaskSignature;
+interface CreateTaskSignature {
+    /**
+     * Creates a new task.
+     * @param - Task to create.
+     * @returns The created task.
+     */
+    (task: Task): Promise<Task>;
+}
+declare function getTask$1(httpClient: HttpClient): GetTaskSignature;
+interface GetTaskSignature {
+    /**
+     * Retrieves a task by ID.
+     * @param - ID of the task to retrieve.
+     * @returns The retrieved task.
+     */
+    (taskId: string): Promise<Task>;
+}
+declare function updateTask$1(httpClient: HttpClient): UpdateTaskSignature;
+interface UpdateTaskSignature {
+    /**
+     * Updates a task.
+     *
+     * Each time the task is updated, `revision` increments by 1.
+     * The existing `revision` must be included when updating the task.
+     * This ensures you're working with the latest task
+     * and prevents unintended overwrites.
+     * @param - Task ID.
+     * @param - Task to update.
+     * @returns The updated task.
+     */
+    (_id: string, task: UpdateTask): Promise<Task>;
+}
+declare function deleteTask$1(httpClient: HttpClient): DeleteTaskSignature;
+interface DeleteTaskSignature {
+    /**
+     * Deletes a task by ID.
+     * @param - ID of the task to delete.
+     */
+    (taskId: string): Promise<void>;
+}
+declare function queryTasks$1(httpClient: HttpClient): QueryTasksSignature;
+interface QueryTasksSignature {
+    /**
+     * Creates a query to retrieve a list of tasks.
+     *
+     * The `queryTasks()` method builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.
+     *
+     * The returned object contains the query definition which is typically used to run the query using the `find()` method. You can refine the query by chaining `TasksQueryBuilder` methods onto the query. `TasksQueryBuilder` methods enable you to sort, filter, and control the results that `queryTasks()` returns.
+     *
+     * `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:
+     * - `limit(50)`
+     * - `descending('_createdDate')`
+     *
+     * The methods that are chained to `queryTasks()` are applied in the order they are called. For example, if you apply `ascending('_createdDate')` and then `descending('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
+     *
+     * The following `TasksQueryBuilder` methods are supported for `queryTasks()`. For a full description of the `task` object, see the object returned for the `items` property in `TasksQueryResult`.
+     */
+    (): TasksQueryBuilder;
+}
+declare function countTasks$1(httpClient: HttpClient): CountTasksSignature;
+interface CountTasksSignature {
+    /**
+     * Counts the number of tasks.
+     *
+     *
+     * This method returns the count of all tasks regardless of their `status`.
+     *
+     * Optionally, you can specify a filter to count only tasks that meet certain criteria.
+     * @param - Filtering options.
+     */
+    (options?: CountTasksOptions | undefined): Promise<CountTasksResponse>;
+}
+declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
+interface MoveTaskAfterSignature {
+    /**
+     * Moves a task specified by ID to be placed after another task in the task display.
+     *
+     * You can reposition a task to be first in the display by omitting `beforeTaskId`.
+     * @param - ID of the task to move.
+     * @param - Options for moving the task.
+     */
+    (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;
+}
+
+declare const createTask: MaybeContext<BuildRESTFunction<typeof createTask$1> & typeof createTask$1>;
+declare const getTask: MaybeContext<BuildRESTFunction<typeof getTask$1> & typeof getTask$1>;
+declare const updateTask: MaybeContext<BuildRESTFunction<typeof updateTask$1> & typeof updateTask$1>;
+declare const deleteTask: MaybeContext<BuildRESTFunction<typeof deleteTask$1> & typeof deleteTask$1>;
+declare const queryTasks: MaybeContext<BuildRESTFunction<typeof queryTasks$1> & typeof queryTasks$1>;
+declare const countTasks: MaybeContext<BuildRESTFunction<typeof countTasks$1> & typeof countTasks$1>;
+declare const moveTaskAfter: MaybeContext<BuildRESTFunction<typeof moveTaskAfter$1> & typeof moveTaskAfter$1>;
+/**
+ * Triggered when a task is created.
+ */
+declare const onTaskCreated: ReturnType<typeof createEventModule<typeof publicOnTaskCreated>>;
+/**
+ * Triggered when a task is deleted.
+ */
+declare const onTaskDeleted: ReturnType<typeof createEventModule<typeof publicOnTaskDeleted>>;
+/**
+ * Triggered when a task reaches its due date.
+ */
+declare const onTaskOverdue: ReturnType<typeof createEventModule<typeof publicOnTaskOverdue>>;
+/**
+ * Triggered when a task is updated.
+ */
+declare const onTaskUpdated: ReturnType<typeof createEventModule<typeof publicOnTaskUpdated>>;
+
+export { CountTasksOptions, CountTasksResponse, MoveTaskAfterOptions, Task, TasksQueryBuilder, UpdateTask, countTasks, createTask, deleteTask, getTask, moveTaskAfter, onTaskCreated, onTaskDeleted, onTaskOverdue, onTaskUpdated, queryTasks, updateTask };

package/build/index.d.ts

@@ -0,0 +1,115 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { T as Task, U as UpdateTask, a as TasksQueryBuilder, C as CountTasksOptions, b as CountTasksResponse, M as MoveTaskAfterOptions } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.js';
+export { Y as ActionEvent, a4 as BaseEventMetadata, f as ContactInfo, l as ContactNotFoundError, x as CountTasksRequest, j as CreateTaskRequest, k as CreateTaskResponse, t as CursorPaging, v as CursorPagingMetadata, q as CursorQuery, r as CursorQueryPagingMethodOneOf, w as Cursors, a0 as DeleteCompletedTasksRequest, a1 as DeleteCompletedTasksResponse, D as DeleteTaskRequest, p as DeleteTaskResponse, K as DomainEvent, L as DomainEventBodyOneOf, J as Empty, N as EntityCreatedEvent, X as EntityDeletedEvent, V as EntityUpdatedEvent, a5 as EventMetadata, G as GetTaskRequest, m as GetTaskResponse, _ as IdentificationData, $ as IdentificationDataIdOneOf, Z as MessageEnvelope, F as MoveTaskAfterRequest, H as MoveTaskAfterResponse, P as Paging, E as PagingMetadataV2, y as QueryTasksInternalRequest, B as QueryTasksInternalResponse, Q as QueryTasksRequest, u as QueryTasksResponse, z as QueryV2, A as QueryV2PagingMethodOneOf, R as ReminderType, g as RepositionTask, O as RestoreInfo, a2 as SendTasksReminderRequest, a3 as SendTasksReminderResponse, d as SortOrder, s as Sorting, S as SourceType, i as TaskAssigned, a6 as TaskCreatedEnvelope, a7 as TaskDeletedEnvelope, I as TaskNotFoundError, h as TaskOverdue, a8 as TaskOverdueEnvelope, e as TaskSource, c as TaskStatus, a9 as TaskUpdatedEnvelope, aa as TasksQueryResult, n as UpdateTaskRequest, o as UpdateTaskResponse, W as WebhookIdentityType } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function createTask$1(httpClient: HttpClient): CreateTaskSignature;
+interface CreateTaskSignature {
+    /**
+     * Creates a new task.
+     * @param - Task to create.
+     * @returns The created task.
+     */
+    (task: Task): Promise<Task>;
+}
+declare function getTask$1(httpClient: HttpClient): GetTaskSignature;
+interface GetTaskSignature {
+    /**
+     * Retrieves a task by ID.
+     * @param - ID of the task to retrieve.
+     * @returns The retrieved task.
+     */
+    (taskId: string): Promise<Task>;
+}
+declare function updateTask$1(httpClient: HttpClient): UpdateTaskSignature;
+interface UpdateTaskSignature {
+    /**
+     * Updates a task.
+     *
+     * Each time the task is updated, `revision` increments by 1.
+     * The existing `revision` must be included when updating the task.
+     * This ensures you're working with the latest task
+     * and prevents unintended overwrites.
+     * @param - Task ID.
+     * @param - Task to update.
+     * @returns The updated task.
+     */
+    (_id: string, task: UpdateTask): Promise<Task>;
+}
+declare function deleteTask$1(httpClient: HttpClient): DeleteTaskSignature;
+interface DeleteTaskSignature {
+    /**
+     * Deletes a task by ID.
+     * @param - ID of the task to delete.
+     */
+    (taskId: string): Promise<void>;
+}
+declare function queryTasks$1(httpClient: HttpClient): QueryTasksSignature;
+interface QueryTasksSignature {
+    /**
+     * Creates a query to retrieve a list of tasks.
+     *
+     * The `queryTasks()` method builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.
+     *
+     * The returned object contains the query definition which is typically used to run the query using the `find()` method. You can refine the query by chaining `TasksQueryBuilder` methods onto the query. `TasksQueryBuilder` methods enable you to sort, filter, and control the results that `queryTasks()` returns.
+     *
+     * `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:
+     * - `limit(50)`
+     * - `descending('_createdDate')`
+     *
+     * The methods that are chained to `queryTasks()` are applied in the order they are called. For example, if you apply `ascending('_createdDate')` and then `descending('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
+     *
+     * The following `TasksQueryBuilder` methods are supported for `queryTasks()`. For a full description of the `task` object, see the object returned for the `items` property in `TasksQueryResult`.
+     */
+    (): TasksQueryBuilder;
+}
+declare function countTasks$1(httpClient: HttpClient): CountTasksSignature;
+interface CountTasksSignature {
+    /**
+     * Counts the number of tasks.
+     *
+     *
+     * This method returns the count of all tasks regardless of their `status`.
+     *
+     * Optionally, you can specify a filter to count only tasks that meet certain criteria.
+     * @param - Filtering options.
+     */
+    (options?: CountTasksOptions | undefined): Promise<CountTasksResponse>;
+}
+declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
+interface MoveTaskAfterSignature {
+    /**
+     * Moves a task specified by ID to be placed after another task in the task display.
+     *
+     * You can reposition a task to be first in the display by omitting `beforeTaskId`.
+     * @param - ID of the task to move.
+     * @param - Options for moving the task.
+     */
+    (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;
+}
+
+declare const createTask: MaybeContext<BuildRESTFunction<typeof createTask$1> & typeof createTask$1>;
+declare const getTask: MaybeContext<BuildRESTFunction<typeof getTask$1> & typeof getTask$1>;
+declare const updateTask: MaybeContext<BuildRESTFunction<typeof updateTask$1> & typeof updateTask$1>;
+declare const deleteTask: MaybeContext<BuildRESTFunction<typeof deleteTask$1> & typeof deleteTask$1>;
+declare const queryTasks: MaybeContext<BuildRESTFunction<typeof queryTasks$1> & typeof queryTasks$1>;
+declare const countTasks: MaybeContext<BuildRESTFunction<typeof countTasks$1> & typeof countTasks$1>;
+declare const moveTaskAfter: MaybeContext<BuildRESTFunction<typeof moveTaskAfter$1> & typeof moveTaskAfter$1>;
+/**
+ * Triggered when a task is created.
+ */
+declare const onTaskCreated: ReturnType<typeof createEventModule<typeof publicOnTaskCreated>>;
+/**
+ * Triggered when a task is deleted.
+ */
+declare const onTaskDeleted: ReturnType<typeof createEventModule<typeof publicOnTaskDeleted>>;
+/**
+ * Triggered when a task reaches its due date.
+ */
+declare const onTaskOverdue: ReturnType<typeof createEventModule<typeof publicOnTaskOverdue>>;
+/**
+ * Triggered when a task is updated.
+ */
+declare const onTaskUpdated: ReturnType<typeof createEventModule<typeof publicOnTaskUpdated>>;
+
+export { CountTasksOptions, CountTasksResponse, MoveTaskAfterOptions, Task, TasksQueryBuilder, UpdateTask, countTasks, createTask, deleteTask, getTask, moveTaskAfter, onTaskCreated, onTaskDeleted, onTaskOverdue, onTaskUpdated, queryTasks, updateTask };