@wix/auto_sdk_crm_tasks 1.0.6 → 1.0.7

package/build/meta.d.mts

@@ -0,0 +1,290 @@
+import { j as CreateTaskRequest$1, k as CreateTaskResponse$1, G as GetTaskRequest$1, m as GetTaskResponse$1, n as UpdateTaskRequest$1, o as UpdateTaskResponse$1, D as DeleteTaskRequest$1, p as DeleteTaskResponse$1, Q as QueryTasksRequest$1, u as QueryTasksResponse$1, x as CountTasksRequest$1, b as CountTasksResponse$1, F as MoveTaskAfterRequest$1, H as MoveTaskAfterResponse$1 } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.mjs';
+
+interface Task {
+    /**
+     * Task ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing `revision` must be used when updating a task.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Title of the task.
+     * @minLength 1
+     * @maxLength 250
+     */
+    title?: string | null;
+    /**
+     * Description of the task.
+     * @minLength 1
+     * @maxLength 500
+     */
+    description?: string | null;
+    /**
+     * Date and time the task was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the task was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Due date for the task. */
+    dueDate?: Date | null;
+    /**
+     * Status of the task.
+     *
+     * Default: `ACTION_NEEDED`
+     */
+    status?: TaskStatus;
+    /** Details about the task source. */
+    source?: TaskSource;
+    /** Information about the contact associated with the task. */
+    contact?: ContactInfo;
+}
+/** Possible statuses in which the task may be. */
+declare enum TaskStatus {
+    /** Action needed. */
+    ACTION_NEEDED = "ACTION_NEEDED",
+    /** Task completed. */
+    COMPLETED = "COMPLETED"
+}
+interface TaskSource {
+    /**
+     * How the task was created.
+     * @readonly
+     */
+    sourceType?: SourceType;
+    /**
+     * App ID, if the task was created by an app.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * User ID, if the task was created by a Wix user.
+     * @format GUID
+     * @readonly
+     */
+    userId?: string | null;
+}
+/** Possible sources that can create tasks. */
+declare enum SourceType {
+    /** Task was created by an app. */
+    APP = "APP",
+    /** Task was created by a Wix user. */
+    USER = "USER"
+}
+interface ContactInfo {
+    /**
+     * ID of the contact associated with the task.
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Contact's first name.
+     * @readonly
+     */
+    firstName?: string | null;
+    /**
+     * Contact's last name.
+     * @readonly
+     */
+    lastName?: string | null;
+    /**
+     * Contact's image URL.
+     * @readonly
+     */
+    imageUrl?: string | null;
+    /**
+     * Contact's primary email.
+     * @readonly
+     */
+    email?: string | null;
+    /**
+     * Contact's primary phone.
+     * @readonly
+     */
+    phone?: string | null;
+}
+interface CreateTaskRequest {
+    /** Task to create. */
+    task: Task;
+}
+interface CreateTaskResponse {
+    /** The created task. */
+    task?: Task;
+}
+interface GetTaskRequest {
+    /**
+     * ID of the task to retrieve.
+     * @format GUID
+     */
+    taskId: string;
+}
+interface GetTaskResponse {
+    /** The retrieved task. */
+    task?: Task;
+}
+interface UpdateTaskRequest {
+    /** Task to update. */
+    task: Task;
+}
+interface UpdateTaskResponse {
+    /** The updated task. */
+    task?: Task;
+}
+interface DeleteTaskRequest {
+    /**
+     * ID of the task to delete.
+     * @format GUID
+     */
+    taskId: string;
+}
+interface DeleteTaskResponse {
+}
+interface QueryTasksRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    /** Sort by ascending order. */
+    ASC = "ASC",
+    /** Sort by descending order. */
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryTasksResponse {
+    /** The retrieved tasks. */
+    tasks?: Task[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface CountTasksRequest {
+    /**
+     * Filter which tasks to count. See supported filters ([REST](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort)| [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/tasks/query-tasks)).
+     *
+     * Filter tasks in the following format:
+     *
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     *
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     */
+    filter?: Record<string, any> | null;
+}
+interface CountTasksResponse {
+    /** The number of tasks that match the specified filter. */
+    count?: number;
+}
+interface MoveTaskAfterRequest {
+    /**
+     * ID of the task to move.
+     * @format GUID
+     */
+    taskId: string;
+    /**
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
+     * @format GUID
+     */
+    beforeTaskId?: string | null;
+}
+interface MoveTaskAfterResponse {
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createTask(): __PublicMethodMetaInfo<'POST', {}, CreateTaskRequest$1, CreateTaskRequest, CreateTaskResponse$1, CreateTaskResponse>;
+declare function getTask(): __PublicMethodMetaInfo<'GET', {
+    taskId: string;
+}, GetTaskRequest$1, GetTaskRequest, GetTaskResponse$1, GetTaskResponse>;
+declare function updateTask(): __PublicMethodMetaInfo<'PATCH', {
+    taskId: string;
+}, UpdateTaskRequest$1, UpdateTaskRequest, UpdateTaskResponse$1, UpdateTaskResponse>;
+declare function deleteTask(): __PublicMethodMetaInfo<'DELETE', {
+    taskId: string;
+}, DeleteTaskRequest$1, DeleteTaskRequest, DeleteTaskResponse$1, DeleteTaskResponse>;
+declare function queryTasks(): __PublicMethodMetaInfo<'POST', {}, QueryTasksRequest$1, QueryTasksRequest, QueryTasksResponse$1, QueryTasksResponse>;
+declare function countTasks(): __PublicMethodMetaInfo<'POST', {}, CountTasksRequest$1, CountTasksRequest, CountTasksResponse$1, CountTasksResponse>;
+declare function moveTaskAfter(): __PublicMethodMetaInfo<'POST', {
+    taskId: string;
+}, MoveTaskAfterRequest$1, MoveTaskAfterRequest, MoveTaskAfterResponse$1, MoveTaskAfterResponse>;
+
+export { type __PublicMethodMetaInfo, countTasks, createTask, deleteTask, getTask, moveTaskAfter, queryTasks, updateTask };

package/build/meta.d.ts

@@ -0,0 +1,290 @@
+import { j as CreateTaskRequest$1, k as CreateTaskResponse$1, G as GetTaskRequest$1, m as GetTaskResponse$1, n as UpdateTaskRequest$1, o as UpdateTaskResponse$1, D as DeleteTaskRequest$1, p as DeleteTaskResponse$1, Q as QueryTasksRequest$1, u as QueryTasksResponse$1, x as CountTasksRequest$1, b as CountTasksResponse$1, F as MoveTaskAfterRequest$1, H as MoveTaskAfterResponse$1 } from './crm-tasks-v2-task-tasks.universal-DHOV27KP.js';
+
+interface Task {
+    /**
+     * Task ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing `revision` must be used when updating a task.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Title of the task.
+     * @minLength 1
+     * @maxLength 250
+     */
+    title?: string | null;
+    /**
+     * Description of the task.
+     * @minLength 1
+     * @maxLength 500
+     */
+    description?: string | null;
+    /**
+     * Date and time the task was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the task was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Due date for the task. */
+    dueDate?: Date | null;
+    /**
+     * Status of the task.
+     *
+     * Default: `ACTION_NEEDED`
+     */
+    status?: TaskStatus;
+    /** Details about the task source. */
+    source?: TaskSource;
+    /** Information about the contact associated with the task. */
+    contact?: ContactInfo;
+}
+/** Possible statuses in which the task may be. */
+declare enum TaskStatus {
+    /** Action needed. */
+    ACTION_NEEDED = "ACTION_NEEDED",
+    /** Task completed. */
+    COMPLETED = "COMPLETED"
+}
+interface TaskSource {
+    /**
+     * How the task was created.
+     * @readonly
+     */
+    sourceType?: SourceType;
+    /**
+     * App ID, if the task was created by an app.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * User ID, if the task was created by a Wix user.
+     * @format GUID
+     * @readonly
+     */
+    userId?: string | null;
+}
+/** Possible sources that can create tasks. */
+declare enum SourceType {
+    /** Task was created by an app. */
+    APP = "APP",
+    /** Task was created by a Wix user. */
+    USER = "USER"
+}
+interface ContactInfo {
+    /**
+     * ID of the contact associated with the task.
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Contact's first name.
+     * @readonly
+     */
+    firstName?: string | null;
+    /**
+     * Contact's last name.
+     * @readonly
+     */
+    lastName?: string | null;
+    /**
+     * Contact's image URL.
+     * @readonly
+     */
+    imageUrl?: string | null;
+    /**
+     * Contact's primary email.
+     * @readonly
+     */
+    email?: string | null;
+    /**
+     * Contact's primary phone.
+     * @readonly
+     */
+    phone?: string | null;
+}
+interface CreateTaskRequest {
+    /** Task to create. */
+    task: Task;
+}
+interface CreateTaskResponse {
+    /** The created task. */
+    task?: Task;
+}
+interface GetTaskRequest {
+    /**
+     * ID of the task to retrieve.
+     * @format GUID
+     */
+    taskId: string;
+}
+interface GetTaskResponse {
+    /** The retrieved task. */
+    task?: Task;
+}
+interface UpdateTaskRequest {
+    /** Task to update. */
+    task: Task;
+}
+interface UpdateTaskResponse {
+    /** The updated task. */
+    task?: Task;
+}
+interface DeleteTaskRequest {
+    /**
+     * ID of the task to delete.
+     * @format GUID
+     */
+    taskId: string;
+}
+interface DeleteTaskResponse {
+}
+interface QueryTasksRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    /** Sort by ascending order. */
+    ASC = "ASC",
+    /** Sort by descending order. */
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryTasksResponse {
+    /** The retrieved tasks. */
+    tasks?: Task[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface CountTasksRequest {
+    /**
+     * Filter which tasks to count. See supported filters ([REST](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort)| [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/tasks/query-tasks)).
+     *
+     * Filter tasks in the following format:
+     *
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     *
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     */
+    filter?: Record<string, any> | null;
+}
+interface CountTasksResponse {
+    /** The number of tasks that match the specified filter. */
+    count?: number;
+}
+interface MoveTaskAfterRequest {
+    /**
+     * ID of the task to move.
+     * @format GUID
+     */
+    taskId: string;
+    /**
+     * The ID of the task after which the moved task is positioned in the task display.
+     * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
+     * @format GUID
+     */
+    beforeTaskId?: string | null;
+}
+interface MoveTaskAfterResponse {
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createTask(): __PublicMethodMetaInfo<'POST', {}, CreateTaskRequest$1, CreateTaskRequest, CreateTaskResponse$1, CreateTaskResponse>;
+declare function getTask(): __PublicMethodMetaInfo<'GET', {
+    taskId: string;
+}, GetTaskRequest$1, GetTaskRequest, GetTaskResponse$1, GetTaskResponse>;
+declare function updateTask(): __PublicMethodMetaInfo<'PATCH', {
+    taskId: string;
+}, UpdateTaskRequest$1, UpdateTaskRequest, UpdateTaskResponse$1, UpdateTaskResponse>;
+declare function deleteTask(): __PublicMethodMetaInfo<'DELETE', {
+    taskId: string;
+}, DeleteTaskRequest$1, DeleteTaskRequest, DeleteTaskResponse$1, DeleteTaskResponse>;
+declare function queryTasks(): __PublicMethodMetaInfo<'POST', {}, QueryTasksRequest$1, QueryTasksRequest, QueryTasksResponse$1, QueryTasksResponse>;
+declare function countTasks(): __PublicMethodMetaInfo<'POST', {}, CountTasksRequest$1, CountTasksRequest, CountTasksResponse$1, CountTasksResponse>;
+declare function moveTaskAfter(): __PublicMethodMetaInfo<'POST', {
+    taskId: string;
+}, MoveTaskAfterRequest$1, MoveTaskAfterRequest, MoveTaskAfterResponse$1, MoveTaskAfterResponse>;
+
+export { type __PublicMethodMetaInfo, countTasks, createTask, deleteTask, getTask, moveTaskAfter, queryTasks, updateTask };