@wix/workflows 1.0.0

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

@@ -0,0 +1,424 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+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 {
+}
+/**
+ * Retrieves a list of the site's workflows.
+ *
+ * By default,
+ * the returned workflows are sorted by `name` in ascending order.
+ * Sorting is applied lexicographically,
+ * so `"abc"` comes after `"XYZ"`.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listWorkflows(options?: ListWorkflowsOptions): Promise<ListWorkflowsResponse>;
+export interface ListWorkflowsOptions {
+    /**
+     * 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[];
+}
+/**
+ * Returns a list of workflows according to:
+ * * paging: offset, limit
+ * * order: by some of the following fields: id, name, createdAt
+ * * filter: by the following fields of WorkflowInfo
+ * ** workflowInfo.id                          - Guid
+ * ** workflowInfo.name                        - Text
+ * ** workflowInfo.createdAt                   - Date
+ * ** workflowInfo.visibility                  - Text (Visible / Archived)
+ * ** workflowInfo.winPhaseId                  - Guid
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryWorkflows(options?: QueryWorkflowsOptions): Promise<QueryWorkflowsResponse>;
+export interface QueryWorkflowsOptions {
+    /** Query options. */
+    query?: Query;
+}
+/**
+ * Retrieves a workflow by ID.
+ *
+ * Use this endpoint to list all phases and the first cards for each phase.
+ *
+ * The returned workflow object contains all the active phases and the win phase.
+ * The active phases are available in the `phasesList.phases` array,
+ * and the win phase is available at `winPhase`.
+ * Each phase's ID is in the phase object at `info.id`.
+ * The phase ID is needed when
+ * [moving](https://dev.wix.com/api/rest/workflows/workflows/cards/move-card)
+ * or [restoring](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card)
+ * a card.
+ *
+ * By default, the workflow is returned with up to 10 cards per phase.
+ * You can change the number of cards returned
+ * with the `cardsInitialPageSize` parameter.
+ * @param _id - ID of the workflow to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getWorkflow(_id: string, options?: GetWorkflowOptions): Promise<GetWorkflowResponse>;
+export interface GetWorkflowOptions {
+    /**
+     * 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;
+}
+/**
+ * Updates a workflow's name or description.
+ *
+ * To rename or reorder phases or cards, use the
+ * [Phases API](https://dev.wix.com/api/rest/workflows/workflows/phases)
+ * or the
+ * [Cards API](https://dev.wix.com/api/rest/workflows/workflows/cards),
+ * respectively.
+ * @param _id - ID of the workflow to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function updateWorkflow(_id: string, options?: UpdateWorkflowOptions): Promise<void>;
+export interface UpdateWorkflowOptions {
+    /** Workflow info. */
+    workflow?: WorkflowInfo;
+}
+/**
+ * Creates a new workflow.
+ *
+ * When creating a workflow, you provide a `name` and optional `description`,
+ * and the new workflow's `id` is returned.
+ * By default, the new workflow contains a `winPhase` named "Win".
+ * No other phases or cards are created.
+ *
+ * To continue building the workflow,
+ * use the returned workflow `id` to
+ * [create phases](https://dev.wix.com/api/rest/workflows/workflows/phases/create-phase)
+ * and [add cards](https://dev.wix.com/api/rest/drafts/workflows/cards/create-card)
+ * to the new phases.
+ *
+ * A site can have up to 30 workflows.
+ * When this limit is reached, calls to this endpoint result in a 403 error.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.workflow.name
+ */
+export declare function createWorkflow(options?: CreateWorkflowOptions): Promise<CreateWorkflowResponse>;
+export interface CreateWorkflowOptions {
+    /** Workflow details. */
+    workflow?: WorkflowInfo;
+}
+/**
+ * Deletes a workflow and its phases and cards.
+ * @param _id - ID of the workflow to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteWorkflow(_id: string): Promise<void>;
+/**
+ * Sets up the default workflow.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function setupWorkflow(): Promise<void>;