@wix/workflows 1.0.19 → 1.0.21

package/build/cjs/src/workflows-v1-workflow.types.d.ts

@@ -1,319 +0,0 @@
-export interface Workflow {
-    /** Workflow information and metadata. */
-    info?: WorkflowInfo;
-    /**
-     * Final phase of the workflow.
-     * Cards in `winPhase` are treated as if they are not part of the workflow.
-     *
-     * Normally, a contact can be attached to only 1 card in the workflow.
-     * Moving a contact's card to `winPhase`
-     * frees up the contact to be attached to another card in the workflow.
-     */
-    winPhase?: Phase;
-    /** Phases that make up the workflow. */
-    phasesList?: PhasesList;
-}
-export interface WorkflowInfo {
-    /**
-     * Workflow ID.
-     * @readonly
-     */
-    id?: string | null;
-    /** Display name for the workflow. */
-    name?: string | null;
-    /**
-     * Workflow description,
-     * shown below the workflow's display name in the dashboard.
-     */
-    description?: string | null;
-    /**
-     * Deprecated. Use `createdDate` instead.
-     * @readonly
-     */
-    createdAt?: Date;
-    /**
-     * Indicates whether the workflow can be deleted.
-     * @readonly
-     */
-    isDeletable?: boolean | null;
-    /**
-     * Date and time the workflow was created.
-     * @readonly
-     */
-    createdDate?: Date;
-}
-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"
-}
-/** a list of phases (a page) along with the total number */
-export interface PhasesList {
-    /** Total number of phases in the workflow, excluding `winPhase`. */
-    total?: number;
-    /**
-     * List of phases in the workflow.
-     * Sorted according to the phase display order, from left to right.
-     */
-    phases?: Phase[];
-}
-export interface ListWorkflowsRequest {
-    /**
-     * Number of workflows to return.
-     * If omitted, all results are returned.
-     */
-    limit?: number | null;
-    /**
-     * Number of items to skip in the current sort order.
-     *
-     * Defaults to `0`.
-     */
-    offset?: number | null;
-    /**
-     * Supported fields:
-     * `id`, `name`, `description`, `createdDate`
-     *
-     * 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 ListWorkflowsResponse {
-    /** Retrieved list of workflows. */
-    workflows?: WorkflowInfo[];
-    /** 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 QueryWorkflowsRequest {
-    /** Query 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 QueryWorkflowsResponse {
-    /** List of workflows that matched the query. */
-    workflows?: Workflow[];
-    /** Metadata for the paginated results. */
-    pagination?: PaginationResponse;
-}
-export interface GetWorkflowRequest {
-    /** ID of the workflow to retrieve. */
-    id: string;
-    /**
-     * Maximum number of cards to return per phase.
-     * To retrieve additional pages of cards, use
-     * [List Cards](https://dev.wix.com/api/rest/workflows/workflows/cards/list-cards)
-     * (in the Cards API).
-     *
-     * Defaults to `10`.
-     */
-    cardsPerPhase?: number | null;
-}
-export interface GetWorkflowResponse {
-    /** Requested workflow. */
-    workflow?: Workflow;
-}
-export interface UpdateWorkflowRequest {
-    /** ID of the workflow to update. */
-    id: string;
-    /** Workflow info. */
-    workflow?: WorkflowInfo;
-}
-export interface UpdateWorkflowResponse {
-}
-export interface CreateWorkflowRequest {
-    /** Workflow details. */
-    workflow?: WorkflowInfo;
-}
-export interface CreateWorkflowResponse {
-    /** ID of the new workflow. */
-    id?: string | null;
-}
-export interface DeleteWorkflowRequest {
-    /** ID of the workflow to delete. */
-    id: string;
-}
-export interface DeleteWorkflowResponse {
-}
-export interface SetupWorkflowRequest {
-}
-export interface SetupWorkflowResponse {
-}
-export interface ListWorkflowsResponseNonNullableFields {
-    workflows: WorkflowInfo[];
-    pagination?: {
-        offset: number;
-        limit: number;
-        total: number;
-        count: number;
-    };
-}
-export interface GetWorkflowResponseNonNullableFields {
-    workflow?: {
-        winPhase?: {
-            cardsList?: {
-                total: number;
-                cards: {
-                    info?: {
-                        primaryAttachment?: {
-                            attachmentId: string;
-                            value: string;
-                            attachmentType: AttachmentType;
-                            contactId: string;
-                        };
-                    };
-                }[];
-            };
-        };
-        phasesList?: {
-            total: number;
-            phases: {
-                cardsList?: {
-                    total: number;
-                    cards: {
-                        info?: {
-                            primaryAttachment?: {
-                                attachmentId: string;
-                                value: string;
-                                attachmentType: AttachmentType;
-                                contactId: string;
-                            };
-                        };
-                    }[];
-                };
-            }[];
-        };
-    };
-}

package/build/cjs/src/workflows-v1-workflow.types.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SortOrder = exports.AttachmentType = void 0;
-/** describes the supported types of attachments (currently only supports Contact which is the default type) */
-var AttachmentType;
-(function (AttachmentType) {
-    AttachmentType["ContactType"] = "ContactType";
-})(AttachmentType || (exports.AttachmentType = AttachmentType = {}));
-var SortOrder;
-(function (SortOrder) {
-    SortOrder["ASC"] = "ASC";
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (exports.SortOrder = SortOrder = {}));
-//# sourceMappingURL=workflows-v1-workflow.types.js.map

package/build/cjs/src/workflows-v1-workflow.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflows-v1-workflow.types.js","sourceRoot":"","sources":["../../../src/workflows-v1-workflow.types.ts"],"names":[],"mappings":";;;AAyIA,+GAA+G;AAC/G,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6CAA2B,CAAA;AAC7B,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AA0FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}