@wix/workflows 1.0.0

package/build/es/src/workflows-v1-phase.universal.d.ts

@@ -0,0 +1,388 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Phase {
+    /** Phase information. */
+    info?: PhaseInfo;
+    /** Cards contained in the phase. */
+    cardsList?: CardsList;
+}
+export interface PhaseInfo {
+    /**
+     * Phase ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Display name shown at the top of the phase. */
+    name?: string | null;
+}
+/** a list of cards (a page) along with the total number */
+export interface CardsList {
+    /** Total number of cards in the phase. */
+    total?: number;
+    /**
+     * List of cards in the phase.
+     * Sorted according to the card display order, from top to bottom.
+     */
+    cards?: Card[];
+}
+export interface Card {
+    /** Card details. */
+    info?: CardInfo;
+}
+/** entity representing a card-info */
+export interface CardInfo {
+    /**
+     * Card ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Display name shown at the top of the card. */
+    name?: string | null;
+    /** Card description. */
+    description?: string | null;
+    /** Details about the contact attached to the card. */
+    primaryAttachment?: Attachment;
+    /** Due date. */
+    dueDate?: Date;
+    /** Name of the app or service that created the contact. */
+    source?: string | null;
+    /**
+     * Deprecated. Use `createdDate` instead.
+     * @readonly
+     */
+    createdAt?: Date;
+    /**
+     * Deprecated. Use `updatedDate` instead.
+     * @readonly
+     */
+    updatedAt?: Date;
+    /**
+     * ID of the phase that currently holds the card.
+     * @readonly
+     */
+    phaseId?: string | null;
+    /**
+     * Date and time the card was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the card was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+export interface Attachment {
+    /**
+     * Attachment ID. For internal use.
+     * @readonly
+     */
+    attachmentId?: string;
+    /** Deprecated. Use `contactId` instead. */
+    value?: string;
+    /** Deprecated. For internal use. */
+    attachmentType?: AttachmentType;
+    /** ID of the contact attached to the card. */
+    contactId?: string;
+}
+/** describes the supported types of attachments (currently only supports Contact which is the default type) */
+export declare enum AttachmentType {
+    ContactType = "ContactType"
+}
+export interface QueryPhasesRequest {
+    /** Query, sort, and paging options. */
+    query?: Query;
+}
+export interface Query {
+    /**
+     * 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?: any;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** 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[];
+}
+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 QueryPhasesResponse {
+    /** List of phases that matched the query criteria. */
+    phases?: Phase[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse;
+}
+export interface PaginationResponse {
+    /** Number of items that were skipped in the current sort order. */
+    offset?: number;
+    /** Total number of items that matched the filter. */
+    total?: number;
+    /** Number of returned items. */
+    count?: number;
+}
+export interface ListPhasesRequest {
+    /** ID of the workflow whose phases will be listed. */
+    workflowId: string;
+    /** Number of items to return. */
+    limit?: number | null;
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     * Defaults to `0`.
+     */
+    offset?: number | null;
+    /**
+     * Supported fields:
+     * `id`, `name`
+     *
+     * List of fields to sort by.
+     * Formatted as `field:direction`,
+     * where field is the field name
+     * and direction is `asc` (ascending) or `desc` (descending).
+     *
+     * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
+     */
+    sort?: string[];
+}
+export interface ListPhasesResponse {
+    /** List of phases. */
+    phases?: Phase[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse;
+}
+export interface GetPhaseRequest {
+    /** ID of the phase to retrieve. */
+    _id: string;
+}
+export interface GetPhaseResponse {
+    /** Requested phase. */
+    phase?: Phase;
+}
+export interface UpdatePhaseRequest {
+    /** ID of the phase to update. */
+    _id: string;
+    /** Phase details to update. */
+    phase?: PhaseInfo;
+}
+export interface UpdatePhaseResponse {
+}
+export interface CreatePhaseRequest {
+    /** ID of the workflow to create the phase in. */
+    workflowId: string;
+    /** Phase details. */
+    phase?: PhaseInfo;
+    /**
+     * Phase position, where the first phase is `0`.
+     *
+     * If a phase already occupies the specified position,
+     * that phase and any subsequent phases
+     * are shifted to the right by 1.
+     *
+     * Defaults to the last position,
+     * which is displayed before the win phase.
+     */
+    position?: number | null;
+}
+export interface CreatePhaseResponse {
+    /** ID of the newly created phase. */
+    _id?: string | null;
+}
+export interface DeletePhaseRequest {
+    /** ID of the phase to delete. */
+    _id: string;
+}
+export interface DeletePhaseResponse {
+}
+export interface MovePhaseRequest {
+    /** ID of the workflow that contains the phase to move. */
+    workflowId: string;
+    /** ID of the phase to move. */
+    _id: string;
+    /**
+     * New phase position, where the first phase is `0`.
+     *
+     * If a phase already occupies the specified position,
+     * that phase and any subsequent phases
+     * are shifted to the right by 1.
+     */
+    newPosition: number | null;
+}
+export interface MovePhaseResponse {
+}
+/**
+ * Returns a list of phases according to:
+ * * paging: offset, limit
+ * * order: by some of the following fields: id, name, position
+ * * filter: by the following fields of PhaseInfo
+ * ** phaseInfo.id         - Guid
+ * ** phaseInfo.name       - Text
+ * ** phaseInfo.visibility - Text (Visible / Archived)
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryPhases(options?: QueryPhasesOptions): Promise<QueryPhasesResponse>;
+export interface QueryPhasesOptions {
+    /** Query, sort, and paging options. */
+    query?: Query;
+}
+/**
+ * Retrieves a list of active phases in the specified workflow.
+ *
+ * By default, the returned phases are sorted by their display order.
+ *
+ * The win phase is not an active phase
+ * and is therefore not returned with this endpoint.
+ * To get the win phase ID, use
+ * [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow?branch=workflows).
+ * @param workflowId - ID of the workflow whose phases will be listed.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflowId
+ */
+export declare function listPhases(workflowId: string, options?: ListPhasesOptions): Promise<ListPhasesResponse>;
+export interface ListPhasesOptions {
+    /** Number of items to return. */
+    limit?: number | null;
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     * Defaults to `0`.
+     */
+    offset?: number | null;
+    /**
+     * Supported fields:
+     * `id`, `name`
+     *
+     * List of fields to sort by.
+     * Formatted as `field:direction`,
+     * where field is the field name
+     * and direction is `asc` (ascending) or `desc` (descending).
+     *
+     * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
+     */
+    sort?: string[];
+}
+/**
+ * Retrieves a phase and its cards.
+ * @param _id - ID of the phase to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getPhase(_id: string): Promise<GetPhaseResponse>;
+/**
+ * Updates a phase's name.
+ *
+ * To reorder phases, use
+ * [Move Phase](https://dev.wix.com/api/rest/workflows/workflows/phases/move-phase).
+ * To reorder or rename cards, use the
+ * [Cards API](https://dev.wix.com/api/rest/workflows/workflows/cards).
+ * @param _id - ID of the phase to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function updatePhase(_id: string, options?: UpdatePhaseOptions): Promise<void>;
+export interface UpdatePhaseOptions {
+    /** Phase details to update. */
+    phase?: PhaseInfo;
+}
+/**
+ * Creates a new phase in the specified workflow.
+ *
+ * When creating a phase, you provide a `name` and an optional `position`.
+ *
+ * Phases are displayed according to their position from left to right,
+ * starting from `0` and incrementing by 1.
+ * If you create or move a phase to an existing position,
+ * the phase in that position and any subsequent phases
+ * are shifted to the right by 1.
+ *
+ * If `position` is not specified,
+ * the new phase is given the rightmost position.
+ * @param workflowId - ID of the workflow to create the phase in.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.phase.name
+ * @requiredField workflowId
+ */
+export declare function createPhase(workflowId: string, options?: CreatePhaseOptions): Promise<CreatePhaseResponse>;
+export interface CreatePhaseOptions {
+    /** Phase details. */
+    phase?: PhaseInfo;
+    /**
+     * Phase position, where the first phase is `0`.
+     *
+     * If a phase already occupies the specified position,
+     * that phase and any subsequent phases
+     * are shifted to the right by 1.
+     *
+     * Defaults to the last position,
+     * which is displayed before the win phase.
+     */
+    position?: number | null;
+}
+/**
+ * Deletes a phase and its cards.
+ * @param _id - ID of the phase to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deletePhase(_id: string): Promise<void>;
+/**
+ * Moves a phase to a new position in its workflow.
+ *
+ * Phases are displayed according to their position from left to right,
+ * starting from `0` and incrementing by 1.
+ * If you create or move a phase to an existing position,
+ * the phase in that position and any subsequent phases
+ * are shifted to the right by 1.
+ * @param newPosition - New phase position, where the first phase is `0`.
+ *
+ * If a phase already occupies the specified position,
+ * that phase and any subsequent phases
+ * are shifted to the right by 1.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.id
+ * @requiredField identifiers.workflowId
+ * @requiredField newPosition
+ */
+export declare function movePhase(identifiers: MovePhaseIdentifiers, newPosition: number | null): Promise<void>;
+export interface MovePhaseIdentifiers {
+    /** ID of the workflow that contains the phase to move. */
+    workflowId: string;
+    /** ID of the phase to move. */
+    _id: string;
+}