@wix/workflows 1.0.25 → 1.0.27

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,733 @@
+interface Card$2 {
+    /** Card details. */
+    info?: CardInfo$2;
+}
+/** entity representing a card-info */
+interface CardInfo$2 {
+    /**
+     * 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$2;
+    /** Due date. */
+    dueDate?: Date;
+    /** Name of the app or service that created the contact. */
+    source?: string | null;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    createdAt?: Date;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    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;
+}
+interface Attachment$2 {
+    /**
+     * Attachment ID. For internal use.
+     * @readonly
+     */
+    attachmentId?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    value?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    attachmentType?: AttachmentType$2;
+    /** 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) */
+declare enum AttachmentType$2 {
+    ContactType = "ContactType"
+}
+interface PaginationResponse$2 {
+    /** 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;
+}
+interface ListCardsResponse {
+    /** List of cards. */
+    cards?: Card$2[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse$2;
+}
+interface CreateCardResponse {
+    /** ID of the newly created card. */
+    _id?: string | null;
+}
+interface ListCardsResponseNonNullableFields {
+    cards: {
+        info?: {
+            primaryAttachment?: {
+                attachmentId: string;
+                value: string;
+                attachmentType: AttachmentType$2;
+                contactId: string;
+            };
+        };
+    }[];
+    pagination?: {
+        offset: number;
+        total: number;
+        count: number;
+    };
+}
+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[];
+}
+interface CreateCardIdentifiers {
+    /** ID of the workflow to create the card in. */
+    workflowId: string;
+    /** ID of the phase to create the card in. */
+    phaseId: string;
+}
+interface CreateCardOptions {
+    /**
+     * 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;
+}
+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;
+}
+interface RestoreCardOptions {
+    /**
+     * Position of the restored card in the phase,
+     * where the first card is `0`.
+     */
+    newPosition?: number | null;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare function listCards$1(httpClient: HttpClient): (workflowId: string, options?: ListCardsOptions) => Promise<ListCardsResponse & ListCardsResponseNonNullableFields>;
+declare function getCard$1(httpClient: HttpClient): (_id: string) => Promise<Card$2 & {
+    info?: {
+        primaryAttachment?: {
+            attachmentId: string;
+            value: string;
+            attachmentType: AttachmentType$2;
+            contactId: string;
+        } | undefined;
+    } | undefined;
+}>;
+declare function updateCard$1(httpClient: HttpClient): (_id: string, cardInfo: CardInfo$2) => Promise<void>;
+declare function createCard$1(httpClient: HttpClient): (identifiers: CreateCardIdentifiers, card: CardInfo$2, options?: CreateCardOptions) => Promise<CreateCardResponse>;
+declare function deleteCard$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare function moveCard$1(httpClient: HttpClient): (_id: string, options?: MoveCardOptions) => Promise<void>;
+declare function restoreCard$1(httpClient: HttpClient): (_id: string, newPhaseId: string, options?: RestoreCardOptions) => Promise<void>;
+declare function archiveCard$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+
+declare const listCards: BuildRESTFunction<typeof listCards$1>;
+declare const getCard: BuildRESTFunction<typeof getCard$1>;
+declare const updateCard: BuildRESTFunction<typeof updateCard$1>;
+declare const createCard: BuildRESTFunction<typeof createCard$1>;
+declare const deleteCard: BuildRESTFunction<typeof deleteCard$1>;
+declare const moveCard: BuildRESTFunction<typeof moveCard$1>;
+declare const restoreCard: BuildRESTFunction<typeof restoreCard$1>;
+declare const archiveCard: BuildRESTFunction<typeof archiveCard$1>;
+
+declare const context$2_archiveCard: typeof archiveCard;
+declare const context$2_createCard: typeof createCard;
+declare const context$2_deleteCard: typeof deleteCard;
+declare const context$2_getCard: typeof getCard;
+declare const context$2_listCards: typeof listCards;
+declare const context$2_moveCard: typeof moveCard;
+declare const context$2_restoreCard: typeof restoreCard;
+declare const context$2_updateCard: typeof updateCard;
+declare namespace context$2 {
+  export { context$2_archiveCard as archiveCard, context$2_createCard as createCard, context$2_deleteCard as deleteCard, context$2_getCard as getCard, context$2_listCards as listCards, context$2_moveCard as moveCard, context$2_restoreCard as restoreCard, context$2_updateCard as updateCard };
+}
+
+interface Phase$1 {
+    /** Phase information. */
+    info?: PhaseInfo$1;
+    /** Cards contained in the phase. */
+    cardsList?: CardsList$1;
+}
+interface PhaseInfo$1 {
+    /**
+     * 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 */
+interface CardsList$1 {
+    /** 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$1[];
+}
+interface Card$1 {
+    /** Card details. */
+    info?: CardInfo$1;
+}
+/** entity representing a card-info */
+interface CardInfo$1 {
+    /**
+     * 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$1;
+    /** Due date. */
+    dueDate?: Date;
+    /** Name of the app or service that created the contact. */
+    source?: string | null;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    createdAt?: Date;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    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;
+}
+interface Attachment$1 {
+    /**
+     * Attachment ID. For internal use.
+     * @readonly
+     */
+    attachmentId?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    value?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    attachmentType?: AttachmentType$1;
+    /** 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) */
+declare enum AttachmentType$1 {
+    ContactType = "ContactType"
+}
+interface PaginationResponse$1 {
+    /** 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;
+}
+interface ListPhasesResponse {
+    /** List of phases. */
+    phases?: Phase$1[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse$1;
+}
+interface CreatePhaseResponse {
+    /** ID of the newly created phase. */
+    _id?: string | null;
+}
+interface ListPhasesResponseNonNullableFields {
+    phases: {
+        cardsList?: {
+            total: number;
+            cards: {
+                info?: {
+                    primaryAttachment?: {
+                        attachmentId: string;
+                        value: string;
+                        attachmentType: AttachmentType$1;
+                        contactId: string;
+                    };
+                };
+            }[];
+        };
+    }[];
+    pagination?: {
+        offset: number;
+        total: number;
+        count: number;
+    };
+}
+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[];
+}
+interface CreatePhaseOptions {
+    /**
+     * 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;
+}
+interface MovePhaseIdentifiers {
+    /** ID of the workflow that contains the phase to move. */
+    workflowId: string;
+    /** ID of the phase to move. */
+    _id: string;
+}
+
+declare function listPhases$1(httpClient: HttpClient): (workflowId: string, options?: ListPhasesOptions) => Promise<ListPhasesResponse & ListPhasesResponseNonNullableFields>;
+declare function getPhase$1(httpClient: HttpClient): (_id: string) => Promise<Phase$1 & {
+    cardsList?: {
+        total: number;
+        cards: {
+            info?: {
+                primaryAttachment?: {
+                    attachmentId: string;
+                    value: string;
+                    attachmentType: AttachmentType$1;
+                    contactId: string;
+                } | undefined;
+            } | undefined;
+        }[];
+    } | undefined;
+}>;
+declare function updatePhase$1(httpClient: HttpClient): (_id: string, phase: PhaseInfo$1) => Promise<void>;
+declare function createPhase$1(httpClient: HttpClient): (workflowId: string, phase: PhaseInfo$1, options?: CreatePhaseOptions) => Promise<CreatePhaseResponse>;
+declare function deletePhase$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare function movePhase$1(httpClient: HttpClient): (identifiers: MovePhaseIdentifiers, newPosition: number | null) => Promise<void>;
+
+declare const listPhases: BuildRESTFunction<typeof listPhases$1>;
+declare const getPhase: BuildRESTFunction<typeof getPhase$1>;
+declare const updatePhase: BuildRESTFunction<typeof updatePhase$1>;
+declare const createPhase: BuildRESTFunction<typeof createPhase$1>;
+declare const deletePhase: BuildRESTFunction<typeof deletePhase$1>;
+declare const movePhase: BuildRESTFunction<typeof movePhase$1>;
+
+declare const context$1_createPhase: typeof createPhase;
+declare const context$1_deletePhase: typeof deletePhase;
+declare const context$1_getPhase: typeof getPhase;
+declare const context$1_listPhases: typeof listPhases;
+declare const context$1_movePhase: typeof movePhase;
+declare const context$1_updatePhase: typeof updatePhase;
+declare namespace context$1 {
+  export { context$1_createPhase as createPhase, context$1_deletePhase as deletePhase, context$1_getPhase as getPhase, context$1_listPhases as listPhases, context$1_movePhase as movePhase, context$1_updatePhase as updatePhase };
+}
+
+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;
+}
+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;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    createdAt?: Date;
+    /**
+     * Indicates whether the workflow can be deleted.
+     * @readonly
+     * @deprecated
+     */
+    isDeletable?: boolean | null;
+    /**
+     * Date and time the workflow was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+}
+interface Phase {
+    /** Phase information. */
+    info?: PhaseInfo;
+    /** Cards contained in the phase. */
+    cardsList?: CardsList;
+}
+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 */
+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[];
+}
+interface Card {
+    /** Card details. */
+    info?: CardInfo;
+}
+/** entity representing a card-info */
+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;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    createdAt?: Date;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated
+     */
+    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;
+}
+interface Attachment {
+    /**
+     * Attachment ID. For internal use.
+     * @readonly
+     */
+    attachmentId?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    value?: string;
+    /**
+     * @internal
+     * @internal
+     * @deprecated
+     */
+    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) */
+declare enum AttachmentType {
+    ContactType = "ContactType"
+}
+/** a list of phases (a page) along with the total number */
+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[];
+}
+interface ListWorkflowsResponse {
+    /** Retrieved list of workflows. */
+    workflows?: WorkflowInfo[];
+    /** Metadata for the page of results. */
+    pagination?: PaginationResponse;
+}
+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;
+}
+interface CreateWorkflowResponse {
+    /** ID of the new workflow. */
+    _id?: string | null;
+}
+interface ListWorkflowsResponseNonNullableFields {
+    workflows: WorkflowInfo[];
+    pagination?: {
+        offset: number;
+        total: number;
+        count: number;
+    };
+}
+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[];
+}
+
+declare function listWorkflows$1(httpClient: HttpClient): (options?: ListWorkflowsOptions) => Promise<ListWorkflowsResponse & ListWorkflowsResponseNonNullableFields>;
+declare function getWorkflow$1(httpClient: HttpClient): (_id: string, cardsPerPhase: number | null) => Promise<Workflow & {
+    winPhase?: {
+        cardsList?: {
+            total: number;
+            cards: {
+                info?: {
+                    primaryAttachment?: {
+                        attachmentId: string;
+                        value: string;
+                        attachmentType: AttachmentType;
+                        contactId: string;
+                    } | undefined;
+                } | undefined;
+            }[];
+        } | undefined;
+    } | undefined;
+    phasesList?: {
+        total: number;
+        phases: {
+            cardsList?: {
+                total: number;
+                cards: {
+                    info?: {
+                        primaryAttachment?: {
+                            attachmentId: string;
+                            value: string;
+                            attachmentType: AttachmentType;
+                            contactId: string;
+                        } | undefined;
+                    } | undefined;
+                }[];
+            } | undefined;
+        }[];
+    } | undefined;
+}>;
+declare function updateWorkflow$1(httpClient: HttpClient): (_id: string, workflow: WorkflowInfo) => Promise<void>;
+declare function createWorkflow$1(httpClient: HttpClient): (workflow: WorkflowInfo) => Promise<CreateWorkflowResponse>;
+declare function deleteWorkflow$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+
+declare const listWorkflows: BuildRESTFunction<typeof listWorkflows$1>;
+declare const getWorkflow: BuildRESTFunction<typeof getWorkflow$1>;
+declare const updateWorkflow: BuildRESTFunction<typeof updateWorkflow$1>;
+declare const createWorkflow: BuildRESTFunction<typeof createWorkflow$1>;
+declare const deleteWorkflow: BuildRESTFunction<typeof deleteWorkflow$1>;
+
+declare const context_createWorkflow: typeof createWorkflow;
+declare const context_deleteWorkflow: typeof deleteWorkflow;
+declare const context_getWorkflow: typeof getWorkflow;
+declare const context_listWorkflows: typeof listWorkflows;
+declare const context_updateWorkflow: typeof updateWorkflow;
+declare namespace context {
+  export { context_createWorkflow as createWorkflow, context_deleteWorkflow as deleteWorkflow, context_getWorkflow as getWorkflow, context_listWorkflows as listWorkflows, context_updateWorkflow as updateWorkflow };
+}
+
+export { context$2 as cards, context$1 as phases, context as workflows };