@wix/crm 1.0.13 → 1.0.14

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

@@ -1,404 +0,0 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
-export interface Task {
-    /**
-     * Task ID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Represents the current state of an item. For an update operation, pass the latest revision.
-     * @readonly
-     */
-    revision?: string | null;
-    /** The task title */
-    title?: string | null;
-    /** Description of the task. */
-    description?: string | null;
-    /**
-     * Represents the time this task was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Represents the time this task was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /** Due Date for the task. */
-    dueDate?: Date;
-    /** The status of the task. */
-    status?: TaskStatus;
-    /** Details about the task source. */
-    source?: TaskSource;
-    /** Id of a user assigned to this task. */
-    assigneeId?: string | null;
-    /** Details of a contact assigned to this task. */
-    contact?: ContactInfo;
-}
-/** Possible statuses in which the task may be. */
-export declare enum TaskStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    ACTION_NEEDED = "ACTION_NEEDED",
-    COMPLETED = "COMPLETED"
-}
-export interface TaskSource {
-    /**
-     * Type of task creator
-     * @readonly
-     */
-    sourceType?: SourceType;
-    /**
-     * App ID, if the task was created by an app.
-     * @readonly
-     */
-    appId?: string | null;
-    /**
-     * User ID, if the task was created by some user.
-     * @readonly
-     */
-    userId?: string | null;
-}
-/** Possible sources how can create task. */
-export declare enum SourceType {
-    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
-    APP = "APP",
-    USER = "USER"
-}
-export interface ContactInfo {
-    /** Id of a Contact this task is assigned to. */
-    _id?: string | null;
-    /**
-     * Contact first name.
-     * @readonly
-     */
-    firstName?: string | null;
-    /**
-     * Contact last name.
-     * @readonly
-     */
-    lastName?: string | null;
-    /**
-     * Contact image url
-     * @readonly
-     */
-    imageUrl?: string | null;
-}
-export interface RepositionTask {
-    /** The id of the last task that was re-positioned */
-    taskId?: string | null;
-    /** The position of the last task that was re-positioned */
-    position?: string | null;
-}
-export interface TaskWasOverdue {
-    /** The overdue task */
-    task?: Task;
-}
-export interface CreateTaskRequest {
-    /** Task to be created */
-    task: Task;
-}
-export interface CreateTaskResponse {
-    /** The created Task */
-    task?: Task;
-}
-export interface GetTaskRequest {
-    /** Id of the Task to retrieve */
-    taskId: string;
-}
-export interface GetTaskResponse {
-    /** The retrieved Task */
-    task?: Task;
-}
-export interface UpdateTaskRequest {
-    /** Task to be updated, may be partial */
-    task: Task;
-}
-export interface UpdateTaskResponse {
-    /** The updated Task */
-    task?: Task;
-}
-export interface DeleteTaskRequest {
-    /** Id of the Task to delete */
-    taskId: string;
-}
-export interface DeleteTaskResponse {
-}
-export interface QueryTasksRequest {
-    /** WQL expression */
-    query: QueryV2;
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** 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[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fieldsets?: string[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** 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;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface CursorPaging {
-    /** Number of items to load. */
-    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;
-}
-export interface QueryTasksResponse {
-    /** The retrieved Tasks */
-    tasks?: Task[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export 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;
-}
-export interface MoveTaskAfterRequest {
-    /** The Task id to move */
-    taskId: string;
-    /**
-     * The Task Id to be after
-     * If not provided, the task will be positions first
-     */
-    beforeTaskId?: string | null;
-}
-export interface MoveTaskAfterResponse {
-}
-export interface TaskNotFoundError {
-    /** The task id that was not found */
-    taskId?: string;
-}
-export interface Empty {
-}
-/**
- * Creates a new Task
- * If dueDate parameter is provided, it must be a future date.
- * @param task - Task to be created
- * @public
- * @documentationMaturity preview
- * @requiredField task
- * @returns The created Task
- */
-export declare function createTask(task: Task): Promise<Task>;
-/**
- * Get a Task.
- * @param taskId - Id of the Task to retrieve
- * @public
- * @documentationMaturity preview
- * @requiredField taskId
- * @returns The retrieved Task
- */
-export declare function getTask(taskId: string): Promise<Task>;
-/**
- * Update a Task, supports partial update
- * If dueDate parameter is provided, it must be a future date.
- * Each time the segment is updated,
- * `revision` increments by 1.
- * The existing `revision` must be included when updating the segment.
- * This ensures you're working with the latest segment
- * and prevents unintended overwrites.
- * @param _id - Task ID
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField task
- * @requiredField task.revision
- * @returns The updated Task
- */
-export declare function updateTask(_id: string | null, task: UpdateTask): Promise<Task>;
-export interface UpdateTask {
-    /**
-     * Task ID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Represents the current state of an item. For an update operation, pass the latest revision.
-     * @readonly
-     */
-    revision?: string | null;
-    /** The task title */
-    title?: string | null;
-    /** Description of the task. */
-    description?: string | null;
-    /**
-     * Represents the time this task was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Represents the time this task was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /** Due Date for the task. */
-    dueDate?: Date;
-    /** The status of the task. */
-    status?: TaskStatus;
-    /** Details about the task source. */
-    source?: TaskSource;
-    /** Id of a user assigned to this task. */
-    assigneeId?: string | null;
-    /** Details of a contact assigned to this task. */
-    contact?: ContactInfo;
-}
-/**
- * Deletes a Task
- * @param taskId - Id of the Task to delete
- * @public
- * @documentationMaturity preview
- * @requiredField taskId
- */
-export declare function deleteTask(taskId: string): Promise<void>;
-/**
- * Query Tasks using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
- * @public
- * @documentationMaturity preview
- */
-export declare function queryTasks(): TasksQueryBuilder;
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface TasksQueryResult extends QueryCursorResult {
-    items: Task[];
-    query: TasksQueryBuilder;
-    next: () => Promise<TasksQueryResult>;
-    prev: () => Promise<TasksQueryResult>;
-}
-export interface TasksQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'contact.id', value: any) => TasksQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'contact.id', value: any) => TasksQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => TasksQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => TasksQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
-     */
-    startsWith: (propertyName: '_id' | 'contact.id', value: string) => TasksQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     * @documentationMaturity preview
-     */
-    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'contact.id', value: any[]) => TasksQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'contact.id', value: any) => TasksQueryBuilder;
-    /** @documentationMaturity preview */
-    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'contact.id', value: boolean) => TasksQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate'>) => TasksQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate'>) => TasksQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
-    limit: (limit: number) => TasksQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
-    skipTo: (cursor: string) => TasksQueryBuilder;
-    /** @documentationMaturity preview */
-    find: () => Promise<TasksQueryResult>;
-}
-/**
- * Move a Task to be after another Task.
- * If beforeTaskId is not provided, the task will be positioned first.
- * @param taskId - The Task id to move
- * @public
- * @documentationMaturity preview
- * @requiredField taskId
- */
-export declare function moveTaskAfter(taskId: string, options?: MoveTaskAfterOptions): Promise<void>;
-export interface MoveTaskAfterOptions {
-    /**
-     * The Task Id to be after
-     * If not provided, the task will be positions first
-     */
-    beforeTaskId?: string | null;
-}
-export {};