@wix/auto_sdk_crm_pipelines 1.0.0 → 1.0.2

package/build/cjs/index.typings.d.ts

@@ -1,25 +1,1008 @@
-import { ai as CursorSearch, S as SearchCardsOptions, g as SearchCardsResponse } from './crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.js';
-export { bj as AccountInfo, bm as AccountInfoMetadata, be as ActionEvent, ak as Aggregation, ax as AggregationData, al as AggregationKindOneOf, aQ as AggregationResults, aR as AggregationResultsResultOneOf, aE as AggregationResultsScalarResult, F as AggregationType, bC as AggregationTypeWithLiterals, aX as ApplicationError, bk as BaseEventMetadata, aZ as BulkActionMetadata, aY as BulkCardResult, bq as BulkCreateCardsOptions, aU as BulkCreateCardsRequest, aV as BulkCreateCardsResponse, b2 as BulkDeleteCardsRequest, b3 as BulkDeleteCardsResponse, b4 as BulkDeleteCardsResponseBulkCardResult, aT as BulkSearchCardsResult, k as BulkUpdateCardTagsApplicationErrors, n as BulkUpdateCardTagsByFilterApplicationErrors, l as BulkUpdateCardTagsByFilterOptions, b7 as BulkUpdateCardTagsByFilterRequest, m as BulkUpdateCardTagsByFilterResponse, B as BulkUpdateCardTagsOptions, b5 as BulkUpdateCardTagsRequest, j as BulkUpdateCardTagsResponse, b6 as BulkUpdateCardTagsResult, br as BulkUpdateCardsOptions, a_ as BulkUpdateCardsRequest, b0 as BulkUpdateCardsResponse, b1 as BulkUpdateCardsResponseBulkCardResult, a as Card, Y as CardAssigned, o as CardAssignedEnvelope, p as CardCreatedEnvelope, q as CardDeletedEnvelope, X as CardMoved, r as CardMovedEnvelope, Z as CardOverdue, s as CardOverdueEnvelope, w as CardQuery, bo as CardQuerySpec, bp as CardSearchSpec, J as CardSource, _ as CardStale, t as CardStaleEnvelope, u as CardUpdatedEnvelope, v as CardsQueryBuilder, bn as CardsQueryResult, bG as CommonQueryWithEntityContext, bH as CommonSearchWithEntityContext, L as ContactInfo, a1 as ContactsNotFound, b as CreateCardApplicationErrors, C as CreateCardOptions, $ as CreateCardRequest, a0 as CreateCardResponse, ad as CursorPaging, af as CursorPagingMetadata, aa as CursorQuery, ab as CursorQueryPagingMethodOneOf, aj as CursorSearchPagingMethodOneOf, ag as Cursors, as as DateHistogramAggregation, aM as DateHistogramResult, aO as DateHistogramResults, a7 as DeleteCardRequest, a8 as DeleteCardResponse, b8 as DomainEvent, b9 as DomainEventBodyOneOf, bf as Empty, ba as EntityCreatedEvent, bd as EntityDeletedEvent, bc as EntityUpdatedEvent, bl as EventMetadata, R as ExtendedFields, a2 as GetCardRequest, a3 as GetCardResponse, aN as GroupByValueResults, bh as IdentificationData, bi as IdentificationDataIdOneOf, an as IncludeMissingValuesOptions, I as Interval, bB as IntervalWithLiterals, aW as ItemMetadata, Q as LinkedEntity, a$ as MaskedCard, bg as MessageEnvelope, D as MissingValues, by as MissingValuesWithLiterals, G as Mode, bD as ModeWithLiterals, K as Money, e as MoveCardApplicationErrors, M as MoveCardOptions, a6 as MoveCardRequest, d as MoveCardResponse, H as NameFormat, bE as NameFormatWithLiterals, av as NestedAggregation, at as NestedAggregationItem, au as NestedAggregationItemKindOneOf, aA as NestedAggregationResults, aB as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bA as NestedAggregationTypeWithLiterals, aJ as NestedResultValue, aK as NestedResultValueResultOneOf, aP as NestedResults, aF as NestedValueAggregationResult, O as Outcome, bu as OutcomeWithLiterals, P as Priority, bt as PriorityWithLiterals, T as PrivateTags, a9 as QueryCardsRequest, ae as QueryCardsResponse, aq as RangeAggregation, az as RangeAggregationResult, am as RangeBucket, aH as RangeResult, aD as RangeResults, bb as RestoreInfo, aL as Results, ar as ScalarAggregation, aI as ScalarResult, E as ScalarType, bz as ScalarTypeWithLiterals, h as SearchCardsByStageOptions, aS as SearchCardsByStageRequest, i as SearchCardsByStageResponse, ah as SearchCardsRequest, aw as SearchDetails, A as SortDirection, bx as SortDirectionWithLiterals, y as SortOrder, bv as SortOrderWithLiterals, z as SortType, bw as SortTypeWithLiterals, ac as Sorting, V as TagList, c as UpdateCardApplicationErrors, U as UpdateCardOptions, a4 as UpdateCardRequest, a5 as UpdateCardResponse, ao as ValueAggregation, ap as ValueAggregationOptionsOneOf, ay as ValueAggregationResult, aG as ValueResult, aC as ValueResults, W as WebhookIdentityType, bF as WebhookIdentityTypeWithLiterals, bW as bulkUpdateCardTags, bX as bulkUpdateCardTagsByFilter, bP as createCard, bT as deleteCard, bQ as getCard, bS as moveCard, bI as onCardAssigned, bJ as onCardCreated, bK as onCardDeleted, bL as onCardMoved, bM as onCardOverdue, bN as onCardStale, bO as onCardUpdated, bU as queryCards, bV as searchCardsByStage, x as typedQueryCards, bR as updateCard, bs as utils } from './crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.js';
-import '@wix/sdk-types';
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
-/** @hidden */
-type CardSearch = {};
 /**
- * Retrieves a list of cards given the provided free-text search expression, filtering, and sorting.
+ * A structured business process workflow consisting of multiple ordered stages and a final stage.
  *
- * By default, cards are sorted by `updatedDate` in descending order.
+ * Pipelines define the path that cards (deals, leads, projects, etc.) follow from start to completion.
+ * Each pipeline has a currency setting that applies to all monetary values within that pipeline.
+ * Pipeline stages can be configured with stale duration settings to identify workflow delays.
+ */
+interface Pipeline {
+    /**
+     * Pipeline ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pipeline is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the pipeline.
+     *
+     * Ignored when creating a pipeline.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pipeline was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the pipeline was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Pipeline name.
+     * @minLength 1
+     * @maxLength 60
+     */
+    name?: string | null;
+    /**
+     * Currency code for monetary values in this pipeline. Must be a valid ISO 4217 currency code. For example, `USD`.
+     *
+     * Default: Based on the site's currency settings.
+     * @format CURRENCY
+     * @immutable
+     */
+    currency?: string | null;
+    /**
+     * Pipeline stages in order.
+     * Cards move through these stages as they progress through the business process.
+     * @minSize 1
+     * @maxSize 30
+     */
+    stages?: Stage[];
+    /** The final pipeline stage where cards receive a final outcome. */
+    doneStage?: DoneStage;
+    /** Extended fields data. */
+    extendedFields?: ExtendedFields;
+    /** Tags for organizing and categorizing pipelines. */
+    tags?: PrivateTags;
+}
+interface Stage {
+    /**
+     * Stage ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Stage name.
+     * @minLength 1
+     * @maxLength 40
+     */
+    name?: string | null;
+    /**
+     * The duration (in hours) a card can remain in this stage before becoming stale.
+     * When a card exceeds this duration, it's marked as stale to indicate potential workflow delays.
+     * @min 1
+     * @max 100000
+     */
+    staleDurationInHours?: number | null;
+}
+interface DoneStage {
+    /**
+     * Done stage ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Done stage name.
+     * @minLength 1
+     * @maxLength 40
+     */
+    name?: string | null;
+    /**
+     * Outcomes that cards can have when moved to the done stage.
+     * @minSize 1
+     * @maxSize 3
+     */
+    allowedOutcomes?: OutcomeWithLiterals[];
+}
+declare enum Outcome {
+    /** No specific outcome. The process reached the final stage but has not been specified as successful or unsuccessful. */
+    NONE = "NONE",
+    /** Successful outcome. The process achieved its intended goal. */
+    WON = "WON",
+    /** Unsuccessful outcome. The process didn't achieve its intended goal. */
+    LOST = "LOST"
+}
+/** @enumType */
+type OutcomeWithLiterals = Outcome | 'NONE' | 'WON' | 'LOST';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface PrivateTags {
+    /** Tags that are exposed to anyone with access to the entity, including site members and visitors. */
+    privateTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface CreatePipelineRequest {
+    /** Pipeline to create. */
+    pipeline: Pipeline;
+}
+interface CreatePipelineResponse {
+    /** Created pipeline. */
+    pipeline?: Pipeline;
+}
+interface GetPipelineRequest {
+    /**
+     * Pipeline ID to retrieve.
+     * @format GUID
+     */
+    pipelineId: string;
+}
+interface GetPipelineResponse {
+    /** Retrieved pipeline. */
+    pipeline?: Pipeline;
+}
+interface UpdatePipelineRequest {
+    /** Pipeline to update, may be partial. */
+    pipeline: Pipeline;
+}
+interface UpdatePipelineResponse {
+    /** Updated pipeline. */
+    pipeline?: Pipeline;
+}
+interface DeletePipelineRequest {
+    /**
+     * Pipeline ID.
+     * @format GUID
+     */
+    pipelineId: string;
+}
+interface DeletePipelineResponse {
+}
+interface QueryPipelinesRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryPipelinesResponse {
+    /** Retrieved pipelines. */
+    pipelines?: Pipeline[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkUpdatePipelineTagsRequest {
+    /**
+     * List of pipeline IDs to update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    pipelineIds: string[];
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated pipelines in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdatePipelineTagsResponse {
+    /**
+     * Results for each updated pipeline.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePipelineTagsResult[];
+    /** Metadata about the bulk update. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdatePipelineTagsResult {
+    /** Metadata about the individual updated pipeline. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdatePipelineTagsByFilterRequest {
+    /** Filter to select which pipelines to update. */
+    filter: Record<string, any> | null;
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated pipelines in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdatePipelineTagsByFilterResponse {
+    /**
+     * Job ID for tracking the asynchronous tag updates.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type UpdatePipelineApplicationErrors = {
+    code?: 'CANNOT_CHANGE_DURATION_ON_STAGE_WITH_CARDS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_DELETE_STAGE_WITH_CARDS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_DELETE_PIPELINE_DONE_STAGE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INSUFFICIENT_PIPELINE_DATA';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'STAGE_IDS_MUST_BE_UNIQUE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type DeletePipelineApplicationErrors = {
+    code?: 'CANNOT_DELETE_NON_EMPTY_PIPELINE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdatePipelineTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdatePipelineTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface PipelineCreatedEnvelope {
+    entity: Pipeline;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a pipeline is created.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINES.PIPELINE_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.pipeline_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onPipelineCreated(handler: (event: PipelineCreatedEnvelope) => void | Promise<void>): void;
+interface PipelineDeletedEnvelope {
+    entity: Pipeline;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a pipeline is deleted.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINES.PIPELINE_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.pipeline_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onPipelineDeleted(handler: (event: PipelineDeletedEnvelope) => void | Promise<void>): void;
+interface PipelineUpdatedEnvelope {
+    entity: Pipeline;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a pipeline is updated.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINES.PIPELINE_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.pipeline_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onPipelineUpdated(handler: (event: PipelineUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a pipeline with defined stages and a final stage.
+ *
+ * Pipelines must have at least one stage in addition to the `doneStage`.
+ * You must specify allowed outcomes that cards can have when moved to the final stage.
+ * @param pipeline - Pipeline to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pipeline
+ * @requiredField pipeline.doneStage
+ * @requiredField pipeline.doneStage.allowedOutcomes
+ * @requiredField pipeline.doneStage.name
+ * @requiredField pipeline.name
+ * @requiredField pipeline.stages
+ * @requiredField pipeline.stages.name
+ * @permissionId PIPELINES.PIPELINE_CREATE
+ * @applicableIdentity APP
+ * @returns Created pipeline.
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.CreatePipeline
+ */
+declare function createPipeline(pipeline: NonNullablePaths<Pipeline, `doneStage` | `doneStage.allowedOutcomes` | `doneStage.name` | `name` | `stages` | `stages.${number}.name`, 4>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves a pipeline by ID.
+ * @param pipelineId - Pipeline ID to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pipelineId
+ * @permissionId PIPELINES.PIPELINE_READ
+ * @applicableIdentity APP
+ * @returns Retrieved pipeline.
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.GetPipeline
+ */
+declare function getPipeline(pipelineId: string): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Updates a pipeline.
+ *
+ * Each time the pipeline is updated, `revision` increments by 1. The current `revision` must be specified when updating the pipeline.  This ensures you're working with the latest pipeline and prevents unintended overwrites.
+ *
+ * >**Note:**
+ * > You can add and remove stages by calling this method. However, the done stage and any stages that contain cards can't be removed.
+ *
+ * </blockquote>
+ * @param _id - Pipeline ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField pipeline
+ * @requiredField pipeline.revision
+ * @permissionId PIPELINES.PIPELINE_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated pipeline.
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.UpdatePipeline
+ */
+declare function updatePipeline(_id: string, pipeline: NonNullablePaths<UpdatePipeline, `revision`, 2>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4> & {
+    __applicationErrorsType?: UpdatePipelineApplicationErrors;
+}>;
+interface UpdatePipeline {
+    /**
+     * Pipeline ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pipeline is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the pipeline.
+     *
+     * Ignored when creating a pipeline.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pipeline was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the pipeline was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Pipeline name.
+     * @minLength 1
+     * @maxLength 60
+     */
+    name?: string | null;
+    /**
+     * Currency code for monetary values in this pipeline. Must be a valid ISO 4217 currency code. For example, `USD`.
+     *
+     * Default: Based on the site's currency settings.
+     * @format CURRENCY
+     * @immutable
+     */
+    currency?: string | null;
+    /**
+     * Pipeline stages in order.
+     * Cards move through these stages as they progress through the business process.
+     * @minSize 1
+     * @maxSize 30
+     */
+    stages?: Stage[];
+    /** The final pipeline stage where cards receive a final outcome. */
+    doneStage?: DoneStage;
+    /** Extended fields data. */
+    extendedFields?: ExtendedFields;
+    /** Tags for organizing and categorizing pipelines. */
+    tags?: PrivateTags;
+}
+/**
+ * Deletes a pipeline.
+ *
+ * >**Notes:**
+ * > - You can't delete a pipeline that contains cards. Make sure to remove all cards in the pipeline before calling this method.
+ * > - Deleting a pipeline permanently removes it from a site.
+ * @param pipelineId - Pipeline ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pipelineId
+ * @permissionId PIPELINES.PIPELINE_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.DeletePipeline
+ */
+declare function deletePipeline(pipelineId: string): Promise<void & {
+    __applicationErrorsType?: DeletePipelineApplicationErrors;
+}>;
+/**
+ * Retrieves a list of up to 100 pipelines, given the provided paging, filtering, and sorting.
+ *
+ * By default, 50 pipelines are returned and sorted by `updatedDate` in descending order.
+ *
+ * For a detailed list of supported operations, see [Pipelines: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/supported-filters-and-sorting).
+ *
+ * To learn more about querying pipelines, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PIPELINES.PIPELINE_READ
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.QueryPipelines
+ */
+declare function queryPipelines(): PipelinesQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PipelinesQueryResult extends QueryCursorResult {
+    items: Pipeline[];
+    query: PipelinesQueryBuilder;
+    next: () => Promise<PipelinesQueryResult>;
+    prev: () => Promise<PipelinesQueryResult>;
+}
+interface PipelinesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PipelinesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'name', value: string) => PipelinesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'name', value: any) => PipelinesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | 'name'>) => PipelinesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_updatedDate'>) => PipelinesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PipelinesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PipelinesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PipelinesQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.QueryPipelines
+ * @requiredField query
+ */
+declare function typedQueryPipelines(query: PipelineQuery): Promise<NonNullablePaths<QueryPipelinesResponse, `pipelines`, 2>>;
+interface PipelineQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id'];
+            operators: ['$eq', '$in', '$ne', '$nin'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['_createdDate'];
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            sort: 'ASC';
+        },
+        {
+            fields: ['_updatedDate'];
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            sort: 'DESC';
+        },
+        {
+            fields: ['name'];
+            operators: ['$eq', '$in', '$ne', '$nin', '$startsWith'];
+            sort: 'ASC';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Pipeline, PipelineQuerySpec>;
+type PipelineQuery = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Pipeline, PipelineQuerySpec, PipelineQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Pipeline, PipelineQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<PipelineQuerySpec>;
+    };
+};
+/**
+ * Updates tags on multiple pipelines by specified pipeline IDs.
+ *
+ * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the pipelines.
+ * @param pipelineIds - List of pipeline IDs to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pipelineIds
+ * @permissionId PIPELINES.PIPELINE_UPDATE_TAGS
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.BulkUpdatePipelineTags
+ */
+declare function bulkUpdatePipelineTags(pipelineIds: string[], options?: BulkUpdatePipelineTagsOptions): Promise<NonNullablePaths<BulkUpdatePipelineTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+    __applicationErrorsType?: BulkUpdatePipelineTagsApplicationErrors;
+}>;
+interface BulkUpdatePipelineTagsOptions {
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated pipelines in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Updates tags on multiple pipelines, using a filter to select which pipelines to update.
  *
- * For a detailed list of supported filters, sorting options, and search capabilities, see [Cards: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/api-reference/crm/crm/pipelines-wip/card-v1/sort-filter-and-search).
+ * If you don't specify a filter, all pipelines on the site are updated.
+ * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the pipelines.
  *
- * To learn more about working with _Search_ methods, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
- * @param search - Search options.
+ * > **Note:**
+ * > This is an asynchronous method that returns a job ID for tracking progress.
+ * To get the status of the job, call [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
+ * @param filter - Filter to select which pipelines to update.
  * @public
  * @documentationMaturity preview
- * @requiredField search
- * @permissionId PIPELINE_CARDS.CARD_READ
+ * @requiredField filter
+ * @permissionId PIPELINES.PIPELINE_UPDATE_TAGS
  * @applicableIdentity APP
- * @fqn wix.crm.pipelines.cards.v1.Cards.SearchCards
+ * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.BulkUpdatePipelineTagsByFilter
  */
-declare function searchCards(search: CursorSearch, options: SearchCardsOptions): Promise<SearchCardsResponse>;
+declare function bulkUpdatePipelineTagsByFilter(filter: Record<string, any>, options?: BulkUpdatePipelineTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdatePipelineTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdatePipelineTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdatePipelineTagsByFilterOptions {
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated pipelines in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
 
-export { type CardSearch, CursorSearch, SearchCardsOptions, SearchCardsResponse, searchCards };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdatePipelineTagsApplicationErrors, type BulkUpdatePipelineTagsByFilterApplicationErrors, type BulkUpdatePipelineTagsByFilterOptions, type BulkUpdatePipelineTagsByFilterRequest, type BulkUpdatePipelineTagsByFilterResponse, type BulkUpdatePipelineTagsOptions, type BulkUpdatePipelineTagsRequest, type BulkUpdatePipelineTagsResponse, type BulkUpdatePipelineTagsResult, type CommonQueryWithEntityContext, type CreatePipelineRequest, type CreatePipelineResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeletePipelineApplicationErrors, type DeletePipelineRequest, type DeletePipelineResponse, type DomainEvent, type DomainEventBodyOneOf, type DoneStage, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetPipelineRequest, type GetPipelineResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, Outcome, type OutcomeWithLiterals, type Pipeline, type PipelineCreatedEnvelope, type PipelineDeletedEnvelope, type PipelineQuery, type PipelineQuerySpec, type PipelineUpdatedEnvelope, type PipelinesQueryBuilder, type PipelinesQueryResult, type PrivateTags, type QueryPipelinesRequest, type QueryPipelinesResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Stage, type TagList, type UpdatePipeline, type UpdatePipelineApplicationErrors, type UpdatePipelineRequest, type UpdatePipelineResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdatePipelineTags, bulkUpdatePipelineTagsByFilter, createPipeline, deletePipeline, getPipeline, onPipelineCreated, onPipelineDeleted, onPipelineUpdated, queryPipelines, typedQueryPipelines, updatePipeline, utils };