@wix/workflows 1.0.0

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

@@ -0,0 +1,449 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+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 QueryCardsRequest {
+    /** 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 QueryCardsResponse {
+    /** List of cards that matched the query criteria. */
+    cards?: Card[];
+    /** 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 ListCardsRequest {
+    /** ID of the workflow whose cards will be listed. */
+    workflowId: string;
+    /** Filters for cards in the specified phase. */
+    phaseId?: string | null;
+    /**
+     * Number of items to return.
+     *
+     * Defaults to `50`.
+     */
+    limit?: number | null;
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     * Defaults to `0`.
+     */
+    offset?: number | null;
+    /** Filters for cards with the specified contact ID. */
+    attachmentValue?: string | null;
+    /**
+     * Filters for archived cards.
+     * If set to `true`,
+     * only archived cards are returned.
+     * If set to `false`,
+     * only cards that are not archived are returned.
+     *
+     * Defaults to `false`.
+     */
+    fetchArchived?: boolean | null;
+    /**
+     * Supported fields:
+     * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`
+     *
+     * 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 ListCardsResponse {
+    /** List of cards. */
+    cards?: Card[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse;
+}
+export interface GetCardRequest {
+    /** ID of the card to retrieve. */
+    _id: string;
+}
+export interface GetCardResponse {
+    /** Requested card. */
+    card?: Card;
+}
+export interface UpdateCardRequest {
+    /** ID of the card to update. */
+    _id: string;
+    /** Card details. */
+    cardInfo?: CardInfo;
+}
+export interface UpdateCardResponse {
+}
+export interface CreateCardRequest {
+    /** ID of the workflow to create the card in. */
+    workflowId: string;
+    /** ID of the phase to create the card in. */
+    phaseId: string;
+    /** Card details. */
+    card?: CardInfo;
+    /**
+     * Card position, where the first card is `0`.
+     *
+     * If a card already occupies the specified position,
+     * that card and any subsequent cards are shifted to the right by 1.
+     *
+     * Defaults to the last position.
+     */
+    position?: number | null;
+}
+export interface CreateCardResponse {
+    /** ID of the newly created card. */
+    _id?: string | null;
+}
+export interface DeleteCardRequest {
+    /** ID of the card to delete. */
+    _id: string;
+}
+export interface DeleteCardResponse {
+}
+export interface MoveCardRequest {
+    /** ID of the card to move. */
+    _id: string;
+    /** ID of the phase to move the card to. */
+    newPhaseId?: string | null;
+    /** Position of the card in the phase, where the first card is `0`. */
+    newPosition?: number | null;
+}
+export interface MoveCardResponse {
+}
+export interface RestoreCardRequest {
+    /** ID of the card to restore. */
+    _id: string;
+    /** ID of the phase to restore the card to. */
+    newPhaseId: string;
+    /**
+     * Position of the restored card in the phase,
+     * where the first card is `0`.
+     */
+    newPosition?: number | null;
+}
+export interface RestoreCardResponse {
+}
+export interface ArchiveCardRequest {
+    /** ID of the card to archive. */
+    _id?: string;
+}
+export interface ArchiveCardResponse {
+}
+/**
+ * Returns a list of cards according to:
+ * * paging: offset, limit
+ * * order: by some of the following fields: id, name, createdAt, updatedAt, position, phaseId
+ * * filter: by the following fields of CardInfo
+ * ** cardInfo.id                              - Guid
+ * ** cardInfo.name                            - Text
+ * ** cardInfo.source                          - Text
+ * ** cardInfo.position                        - Number
+ * ** cardInfo.createdAt                       - Date
+ * ** cardInfo.updatedAt                       - Date
+ * ** cardInfo.primaryAttachment.contactId     - Guid
+ * ** cardInfo.visibility                      - Text (Visible / Archived)
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryCards(options?: QueryCardsOptions): Promise<QueryCardsResponse>;
+export interface QueryCardsOptions {
+    /** Query, sort, and paging options. */
+    query?: Query;
+}
+/**
+ * Retrieves a list of cards in the specified workflow.
+ *
+ * By default, the returned cards are sorted by their display order.
+ * @param workflowId - ID of the workflow whose cards will be listed.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflowId
+ */
+export declare function listCards(workflowId: string, options?: ListCardsOptions): Promise<ListCardsResponse>;
+export interface ListCardsOptions {
+    /** Filters for cards in the specified phase. */
+    phaseId?: string | null;
+    /**
+     * Number of items to return.
+     *
+     * Defaults to `50`.
+     */
+    limit?: number | null;
+    /**
+     * Number of items to skip in the current sort order.
+     *
+     * Defaults to `0`.
+     */
+    offset?: number | null;
+    /** Filters for cards with the specified contact ID. */
+    attachmentValue?: string | null;
+    /**
+     * Filters for archived cards.
+     * If set to `true`,
+     * only archived cards are returned.
+     * If set to `false`,
+     * only cards that are not archived are returned.
+     *
+     * Defaults to `false`.
+     */
+    fetchArchived?: boolean | null;
+    /**
+     * Supported fields:
+     * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`
+     *
+     * 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 card.
+ *
+ * If the specified card is archived, an empty object is returned.
+ * You can restore the card with
+ * [Restore Card](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card).
+ * @param _id - ID of the card to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getCard(_id: string): Promise<GetCardResponse>;
+/**
+ * Updates a card's properties.
+ *
+ * To reorder cards, use
+ * [Move Card](https://dev.wix.com/api/rest/workflows/workflows/cards/move-card).
+ * To archive or restore a card, use
+ * [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
+ * or [Restore Card](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card),
+ * respectively.
+ * @param _id - ID of the card to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function updateCard(_id: string, options?: UpdateCardOptions): Promise<void>;
+export interface UpdateCardOptions {
+    /** Card details. */
+    cardInfo?: CardInfo;
+}
+/**
+ * Creates a new card in the specified phase and workflow.
+ *
+ * When creating a card, you provide a `name` and an optional `position`.
+ *
+ * Cards are displayed according to their position from top to bottom,
+ * starting from `0` and incrementing by 1.
+ * If you create or move a card to an existing position,
+ * the card in that position and any subsequent cards
+ * are shifted down by 1.
+ *
+ * If `position` is not specified,
+ * the new card is given the bottom position.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.phaseId
+ * @requiredField identifiers.workflowId
+ */
+export declare function createCard(identifiers: CreateCardIdentifiers, options?: CreateCardOptions): Promise<CreateCardResponse>;
+export interface CreateCardIdentifiers {
+    /** ID of the workflow to create the card in. */
+    workflowId: string;
+    /** ID of the phase to create the card in. */
+    phaseId: string;
+}
+export interface CreateCardOptions {
+    /** Card details. */
+    card?: CardInfo;
+    /**
+     * Card position, where the first card is `0`.
+     *
+     * If a card already occupies the specified position,
+     * that card and any subsequent cards are shifted to the right by 1.
+     *
+     * Defaults to the last position.
+     */
+    position?: number | null;
+}
+/**
+ * Deletes a card from a workflow.
+ *
+ * Deleted cards are removed from the workflow completely and can't be restored.
+ * To keep the card available for site contributors, use
+ * [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
+ * instead.
+ *
+ * After a card is deleted,
+ * its attached contact can be attached to another card in an active phase.
+ * @param _id - ID of the card to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteCard(_id: string): Promise<void>;
+/**
+ * Moves a card to another phase or a new position within the current phase.
+ *
+ * To move a card, the new phase ID must be provided.
+ * You can use
+ * [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
+ * to get IDs for all the phases in the workflow,
+ * including the win phase.
+ *
+ * If a card is moved to the win phase,
+ * its attached contact can be attached to another card in an active phase.
+ * @param _id - ID of the card to move.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function moveCard(_id: string, options?: MoveCardOptions): Promise<void>;
+export interface MoveCardOptions {
+    /** ID of the phase to move the card to. */
+    newPhaseId?: string | null;
+    /** Position of the card in the phase, where the first card is `0`. */
+    newPosition?: number | null;
+}
+/**
+ * Restores an archived card to the specified phase.
+ *
+ * To restore a card, the new phase ID must be provided.
+ * You can use
+ * [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
+ * to get IDs for all the phases in the workflow,
+ * including the win phase.
+ * @param _id - ID of the card to restore.
+ * @param newPhaseId - ID of the phase to restore the card to.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField newPhaseId
+ */
+export declare function restoreCard(_id: string, newPhaseId: string, options?: RestoreCardOptions): Promise<void>;
+export interface RestoreCardOptions {
+    /**
+     * Position of the restored card in the phase,
+     * where the first card is `0`.
+     */
+    newPosition?: number | null;
+}