@wix/crm 1.0.73 → 1.0.74

package/build/cjs/src/crm-tasks-v1-task.types.d.ts

@@ -0,0 +1,269 @@
+export interface Task {
+    /**
+     * The id of the task. Should not be passed on creation
+     * @readonly
+     */
+    taskId?: string;
+    /** The id of the creator of the task. */
+    creator?: Creator;
+    /** Task's title. */
+    title?: string;
+    /** States if the task is completed */
+    isCompleted?: boolean;
+    /** Due Date fot the task. */
+    dueAt?: Date;
+    /** Assigned contactId to the task */
+    contactId?: string;
+    /** Task's version. Each change on the task will magnify it. */
+    version?: number;
+    /** Assigned wix user id to the task */
+    assigneeId?: string;
+    /** The labels assigned to the task */
+    labels?: Label[];
+}
+export interface Creator {
+    /**
+     * Creator id
+     * @readonly
+     */
+    id?: string;
+    /** Creator type */
+    creatorType?: CreatorType;
+}
+export declare enum CreatorType {
+    USER = "USER",
+    APP = "APP"
+}
+export interface Label {
+    /**
+     * The id of the label. Should not be passed on creation
+     * @readonly
+     */
+    labelId?: string;
+    /** Label's name. up to 50 characters */
+    name?: string;
+    /** Label's color. */
+    color?: string;
+}
+export interface GetTaskRequest {
+    /** Task id */
+    id: string;
+}
+export interface GetTaskResponse {
+    /** The Task object */
+    task?: Task;
+}
+export interface GetTasksListRequest {
+    /** Assigned contact id to the task - Optional. */
+    contactId?: string;
+    /** Sort key. */
+    key?: SortKey;
+}
+export declare enum SortKey {
+    /** Sort by position */
+    position = "position",
+    /** Sort by date created */
+    dateCreated = "dateCreated"
+}
+export interface GetTasksListResponse {
+    /** Array of the site's tasks */
+    tasks?: Task[];
+}
+export interface ListTasksRequest extends ListTasksRequestGetByOneOf {
+    /** List params */
+    params?: ListParams;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+/** @oneof */
+export interface ListTasksRequestGetByOneOf {
+    /** List params */
+    params?: ListParams;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+export interface ListParams {
+    /** Filter */
+    filter?: FilterBy;
+    /** Order */
+    order?: string[];
+    /** Limit */
+    limit?: number;
+    /** Offset */
+    offset?: number;
+}
+export interface FilterBy {
+    /** List of contact ids */
+    contactIds?: string[];
+    /** From due date */
+    fromDate?: Date;
+    /** To due date */
+    toDate?: Date;
+    /** Is completed status */
+    isCompleted?: boolean | null;
+    /** Assignee id */
+    assigneeId?: string | null;
+    /** Task title */
+    title?: string | null;
+    /** Task title contains substring */
+    subtitle?: string | null;
+    /** List of tasks ids */
+    tasksIds?: string[];
+    /** List of labels ids */
+    labelIds?: string[];
+}
+export interface ListTasksResponse {
+    /** Array of the site's tasks */
+    tasks?: Task[];
+    /** Pagination information */
+    pagination?: Pagination;
+}
+export interface Pagination {
+    /** Pagination offset */
+    offset?: number;
+    /** Pagination limit */
+    limit?: number;
+    /** Pagination total */
+    total?: number;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+export interface CountTasksRequest {
+    /** Group by field */
+    field?: GroupBy;
+    /** Where strings */
+    where?: string[];
+}
+export declare enum GroupBy {
+    total = "total",
+    contactId = "contactId"
+}
+export interface CountTasksResponse {
+    /** Tasks in site */
+    tasksInSite?: number;
+    /** Map by requested field */
+    byRequestedField?: Record<string, number>;
+}
+export interface CreateTaskRequest {
+    /** Task object with the creation data */
+    task?: TaskData;
+}
+export interface TaskData {
+    /** Task's title. up to 500 characters */
+    title?: string;
+    /** Due Date fot the task. */
+    dueAt?: Date;
+    /** Assigned contactId to the task */
+    contactId?: string;
+    /** Assigned assigneeId to the task */
+    assigneeId?: string;
+    /** The label ids assigned to the task */
+    labelIds?: string[];
+}
+export interface CreateTaskResponse {
+    /** Task id */
+    id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface TaskNotification {
+    /** InstanceId of the task in Tasks App */
+    instanceId?: string;
+    /** Task id */
+    taskId?: string;
+    /** The changed task */
+    task?: Task;
+    /** The action that was performed  on the task */
+    taskAction?: string;
+    /** Set of updated fields */
+    changes?: string[];
+}
+export interface UpdateTaskRequest {
+    /** Task id */
+    id: string;
+    /** Set of desired fields. */
+    fields?: string[];
+    /** Task object with the updated data */
+    task?: TaskData;
+}
+export interface UpdateTaskResponse {
+    /** Task id */
+    id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface CompleteTaskRequest {
+    /** Task id */
+    id: string;
+    /** Indication whether the task is completed */
+    isCompleted?: boolean | null;
+}
+export interface CompleteTaskResponse {
+    /** Task id */
+    id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface MoveTaskRequest {
+    /** Task id */
+    id?: string;
+    /** Task id of the task positioned before */
+    taskBeforeId?: string;
+}
+export interface MoveTaskResponse {
+    /** Task id */
+    id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface DeleteTaskRequest {
+    /** Task id */
+    id: string;
+}
+export interface DeleteTaskResponse {
+    /** Task id */
+    id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface DeleteCompletedRequest {
+}
+export interface DeleteCompletedResponse {
+    /** Array of deleted tasks ids */
+    ids?: string[];
+}
+export interface GetTaskResponseNonNullableFields {
+    task?: {
+        taskId: string;
+        creator?: {
+            id: string;
+            creatorType: CreatorType;
+        };
+        title: string;
+        isCompleted: boolean;
+        contactId: string;
+        version: number;
+        assigneeId: string;
+        labels: {
+            labelId: string;
+            name: string;
+            color: string;
+        }[];
+    };
+}
+export interface CreateTaskResponseNonNullableFields {
+    id: string;
+    version: number;
+}
+export interface UpdateTaskResponseNonNullableFields {
+    id: string;
+    version: number;
+}
+export interface CompleteTaskResponseNonNullableFields {
+    id: string;
+    version: number;
+}
+export interface DeleteTaskResponseNonNullableFields {
+    id: string;
+    version: number;
+}

package/build/cjs/src/crm-tasks-v1-task.types.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupBy = exports.SortKey = exports.CreatorType = void 0;
+var CreatorType;
+(function (CreatorType) {
+    CreatorType["USER"] = "USER";
+    CreatorType["APP"] = "APP";
+})(CreatorType = exports.CreatorType || (exports.CreatorType = {}));
+var SortKey;
+(function (SortKey) {
+    /** Sort by position */
+    SortKey["position"] = "position";
+    /** Sort by date created */
+    SortKey["dateCreated"] = "dateCreated";
+})(SortKey = exports.SortKey || (exports.SortKey = {}));
+var GroupBy;
+(function (GroupBy) {
+    GroupBy["total"] = "total";
+    GroupBy["contactId"] = "contactId";
+})(GroupBy = exports.GroupBy || (exports.GroupBy = {}));
+//# sourceMappingURL=crm-tasks-v1-task.types.js.map

package/build/cjs/src/crm-tasks-v1-task.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crm-tasks-v1-task.types.js","sourceRoot":"","sources":["../../../src/crm-tasks-v1-task.types.ts"],"names":[],"mappings":";;;AAkCA,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,0BAAW,CAAA;AACb,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA+BD,IAAY,OAKX;AALD,WAAY,OAAO;IACjB,uBAAuB;IACvB,gCAAqB,CAAA;IACrB,2BAA2B;IAC3B,sCAA2B,CAAA;AAC7B,CAAC,EALW,OAAO,GAAP,eAAO,KAAP,eAAO,QAKlB;AA+ED,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,kCAAuB,CAAA;AACzB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB"}

package/build/cjs/src/crm-tasks-v1-task.universal.d.ts

@@ -0,0 +1,350 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Task {
+    /**
+     * The ID of the task. Should not be populated in `createTask`.
+     * @readonly
+     */
+    taskId?: string;
+    /** The ID of the creator of the task. */
+    creator?: Creator;
+    /** The title of the task. */
+    title?: string;
+    /** Indicates if the task is completed. */
+    isCompleted?: boolean;
+    /** Expected due date for the task. */
+    dueAt?: Date;
+    /** Assigned contact ID for the task */
+    contactId?: string;
+    /** Task version. Incremented on each change. */
+    version?: number;
+    /** Assignee ID for the task. */
+    assigneeId?: string;
+    /** The labels assigned to the task */
+    labels?: Label[];
+}
+export interface Creator {
+    /**
+     * Creator ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Creator type */
+    creatorType?: CreatorType;
+}
+export declare enum CreatorType {
+    USER = "USER",
+    APP = "APP"
+}
+export interface Label {
+    /**
+     * The ID of the label. Should not be populated in `createTask`.
+     * @readonly
+     */
+    labelId?: string;
+    /**
+     * Label name.
+     *
+     * Max: 50 characters
+     */
+    name?: string;
+    /** Label's color. */
+    color?: string;
+}
+export interface GetTaskRequest {
+    /** Task ID. */
+    _id: string;
+}
+export interface GetTaskResponse {
+    /** Task information. */
+    task?: Task;
+}
+export interface GetTasksListRequest {
+    /** Assigned contact ID for the task. Optional. */
+    contactId?: string;
+    /** Sort key. */
+    key?: SortKey;
+}
+export declare enum SortKey {
+    /** Sort by position */
+    position = "position",
+    /** Sort by date created */
+    dateCreated = "dateCreated"
+}
+export interface GetTasksListResponse {
+    /** Array of the site's tasks */
+    tasks?: Task[];
+}
+export interface ListTasksRequest extends ListTasksRequestGetByOneOf {
+    /** List params */
+    params?: ListParams;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+/** @oneof */
+export interface ListTasksRequestGetByOneOf {
+    /** List params */
+    params?: ListParams;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+export interface ListParams {
+    /** Filter */
+    filter?: FilterBy;
+    /** Order */
+    order?: string[];
+    /** Limit */
+    limit?: number;
+    /** Offset */
+    offset?: number;
+}
+export interface FilterBy {
+    /** List of contact IDs. */
+    contactIds?: string[];
+    /** From due date */
+    fromDate?: Date;
+    /** To due date */
+    toDate?: Date;
+    /** Completed status. */
+    isCompleted?: boolean | null;
+    /** Assignee ID. */
+    assigneeId?: string | null;
+    /** The title of the task. */
+    title?: string | null;
+    /** Task title contains substring */
+    subtitle?: string | null;
+    /** List of tasks IDs. */
+    tasksIds?: string[];
+    /** List of labels IDs. */
+    labelIds?: string[];
+}
+export interface ListTasksResponse {
+    /** Array of the site's tasks */
+    tasks?: Task[];
+    /** Pagination information */
+    pagination?: Pagination;
+}
+export interface Pagination {
+    /** Pagination offset */
+    offset?: number;
+    /** Pagination limit */
+    limit?: number;
+    /** Pagination total */
+    total?: number;
+    /** Optional cursor */
+    cursor?: string | null;
+}
+export interface CountTasksRequest {
+    /** Group by field */
+    field?: GroupBy;
+    /** Where strings */
+    where?: string[];
+}
+export declare enum GroupBy {
+    total = "total",
+    contactId = "contactId"
+}
+export interface CountTasksResponse {
+    /** Tasks in site */
+    tasksInSite?: number;
+    /** Map by requested field */
+    byRequestedField?: Record<string, number>;
+}
+export interface CreateTaskRequest {
+    /** Task information. */
+    task?: TaskData;
+}
+export interface TaskData {
+    /**
+     * The title of the task.
+     *
+     * Max: 500 characters.
+     */
+    title?: string;
+    /** Expected due date for the task. */
+    dueAt?: Date;
+    /** Assigned contact ID for the task. */
+    contactId?: string;
+    /** Assignee ID for the task. */
+    assigneeId?: string;
+    /** The label IDs assigned to the task. */
+    labelIds?: string[];
+}
+export interface CreateTaskResponse {
+    /** Task ID. */
+    _id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface TaskNotification {
+    /** Instance ID of the task in Tasks App. */
+    instanceId?: string;
+    /** Task ID. */
+    taskId?: string;
+    /** The changed task */
+    task?: Task;
+    /** The action that was performed  on the task */
+    taskAction?: string;
+    /** Set of updated fields */
+    changes?: string[];
+}
+export interface UpdateTaskRequest {
+    /** Task ID. */
+    _id: string;
+    /** Required fields. */
+    fields?: string[];
+    /** Task information. */
+    task?: TaskData;
+}
+export interface UpdateTaskResponse {
+    /** Task ID. */
+    _id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface CompleteTaskRequest {
+    /** Task ID. */
+    _id: string;
+    /** Indicates whether the task is completed. */
+    isCompleted?: boolean | null;
+}
+export interface CompleteTaskResponse {
+    /** Task ID. */
+    _id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface MoveTaskRequest {
+    /** Task ID. */
+    _id?: string;
+    /** Task ID of the task positioned before. */
+    taskBeforeId?: string;
+}
+export interface MoveTaskResponse {
+    /** Task ID. */
+    _id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface DeleteTaskRequest {
+    /** Task ID. */
+    _id: string;
+}
+export interface DeleteTaskResponse {
+    /** Task ID. */
+    _id?: string;
+    /** The task version. Incremented on each change */
+    version?: number;
+}
+export interface DeleteCompletedRequest {
+}
+export interface DeleteCompletedResponse {
+    /** Array of deleted task IDs. */
+    ids?: string[];
+}
+export interface GetTaskResponseNonNullableFields {
+    task?: {
+        taskId: string;
+        creator?: {
+            _id: string;
+            creatorType: CreatorType;
+        };
+        title: string;
+        isCompleted: boolean;
+        contactId: string;
+        version: number;
+        assigneeId: string;
+        labels: {
+            labelId: string;
+            name: string;
+            color: string;
+        }[];
+    };
+}
+export interface CreateTaskResponseNonNullableFields {
+    _id: string;
+    version: number;
+}
+export interface UpdateTaskResponseNonNullableFields {
+    _id: string;
+    version: number;
+}
+export interface CompleteTaskResponseNonNullableFields {
+    _id: string;
+    version: number;
+}
+export interface DeleteTaskResponseNonNullableFields {
+    _id: string;
+    version: number;
+}
+/**
+ * Gets a task by ID.
+ *
+ *
+ * The `getTask()` function returns a Promise that resolves to the task with the given ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @param _id - Task ID.
+ */
+export declare function getTask(_id: string): Promise<GetTaskResponse & GetTaskResponseNonNullableFields>;
+/**
+ * Creates a new task.
+ *
+ *
+ * The `createTask()` function returns a Promise that resolves to the ID of the created task.
+ *
+ * When creating a new task, the specified `task` object must  contain a `title` value.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField task
+ * @param task - Task information.
+ */
+export declare function createTask(task: TaskData): Promise<CreateTaskResponse & CreateTaskResponseNonNullableFields>;
+/**
+ * Updates the specified fields of an existing task.
+ *
+ *
+ * The `updateTaskFields()` function returns a Promise that resolves to the ID of the updated task after it has been successfully updated.
+ *
+ * Only the properties in the `task` object are updated. All other properties remain the same.
+ *
+ * To remove a value from the task, pass its corresponding property with a value  of `null`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField fields
+ * @requiredField task
+ * @param _id - Task ID.
+ * @param task - Task information.
+ * @param fields - Required fields.
+ */
+export declare function updateTaskFields(_id: string, fields: string[], task: TaskData): Promise<UpdateTaskResponse & UpdateTaskResponseNonNullableFields>;
+/**
+ * Updates completed status of task.
+ *
+ *
+ * The `updateTaskStatus()` function returns a Promise that resolves to the ID of the task whose completed status was updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField isCompleted
+ * @param _id - Task ID.
+ * @param isCompleted - Indicates whether the task is completed.
+ */
+export declare function updateTaskStatus(_id: string, isCompleted: boolean | null): Promise<CompleteTaskResponse & CompleteTaskResponseNonNullableFields>;
+/**
+ * Removes an existing task.
+ *
+ *
+ * The `removeTask()` function returns a Promise that resolves to the ID of the removed task after it has been successfully removed.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @param _id - Task ID.
+ */
+export declare function removeTask(_id: string): Promise<DeleteTaskResponse & DeleteTaskResponseNonNullableFields>;