@wix/auto_sdk_crm_pipelines 1.0.0

package/build/es/crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.d.mts

@@ -0,0 +1,2265 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A business entity representing a deal, lead, opportunity, or project that moves through pipeline stages.
+ *
+ * Cards contain comprehensive business information including contact details, monetary values,
+ * priorities, due dates, and outcomes. They progress through pipeline stages as work advances
+ * and can be assigned to team members for ownership and responsibility tracking.
+ */
+interface Card {
+    /**
+     * Card ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the card is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the card.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the card 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 card was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * ID of the pipeline containing this card.
+     * @format GUID
+     * @readonly
+     */
+    pipelineId?: string | null;
+    /**
+     * ID of the cards' current.
+     * @format GUID
+     */
+    stageId?: string | null;
+    /**
+     * Date and time when the card last moved between stagesin [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    stageUpdatedDate?: Date | null;
+    /**
+     * How the card was moved to its current stage.
+     * @readonly
+     */
+    stageUpdateSource?: CardSource;
+    /**
+     * The Card name.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * Card description.
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * Priority level of the card for task management.
+     *
+     * Default: `P3_MEDIUM`
+     */
+    priority?: PriorityWithLiterals;
+    /**
+     * ID of the Wix user assigned to manage the card.
+     * @format GUID
+     */
+    assigneeId?: string | null;
+    /**
+     * Date and time when the card is expected to moved to the done stage in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * If the card remains active past this date, it becomes overdue.
+     */
+    dueDate?: Date | null;
+    /**
+     * Date and time when the card becomes stale based on the stage's stale duration setting in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * This date is automatically calculated and updated when the card moves to a new stage.
+     * @readonly
+     */
+    staleDate?: Date | null;
+    /** Monetary value assigned to the card. */
+    value?: Money;
+    /**
+     * Final outcome of the card when moved to the done stage.
+     *
+     * Default: `NONE`
+     */
+    outcome?: OutcomeWithLiterals;
+    /** Primary contact associated with the card. */
+    mainContact?: ContactInfo;
+    /**
+     * Secondary contacts associated with the card.
+     * @maxSize 10
+     */
+    additionalContacts?: ContactInfo[];
+    /**
+     * Other entities linked to the card.
+     *
+     * For example, orders, invoices, activities, or other relevant entities.
+     * @maxSize 20
+     */
+    linkedEntities?: LinkedEntity[];
+    /** Extended fields data. */
+    extendedFields?: ExtendedFields;
+    /** Tags for organizing and categorizing the card. */
+    tags?: PrivateTags;
+}
+interface CardSource {
+    /**
+     * ID of the Wix user who last moved the card.
+     * @format GUID
+     * @readonly
+     */
+    userId?: string | null;
+    /**
+     * ID of the app that last moved the card.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+}
+declare enum Priority {
+    /** Urgent priority. Card requires immediate attention. */
+    P1_URGENT = "P1_URGENT",
+    /** High priority. Card is important and should be addressed promptly. */
+    P2_HIGH = "P2_HIGH",
+    /** Medium priority. Card should be completed within regular workflow timelines. */
+    P3_MEDIUM = "P3_MEDIUM",
+    /** Low priority. Card can be addressed when time and resources allow. */
+    P4_LOW = "P4_LOW"
+}
+/** @enumType */
+type PriorityWithLiterals = Priority | 'P1_URGENT' | 'P2_HIGH' | 'P3_MEDIUM' | 'P4_LOW';
+/**
+ * Monetary amount with currency information.
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+ */
+interface Money {
+    /**
+     * Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:2 }
+     */
+    value?: string;
+    /**
+     * Three-letter currency code in ISO-4217 format.
+     * Currency is the same as the pipeline currency and is immutable.
+     * @format CURRENCY
+     * @readonly
+     */
+    currency?: string;
+}
+declare enum Outcome {
+    /** No specific outcome. The card reached the final stage but hasn't been specified as successful or unsuccessful. */
+    NONE = "NONE",
+    /** Successful outcome. The card achieved its intended goal. */
+    WON = "WON",
+    /** Unsuccessful outcome. The card didn't achieve its intended goal. */
+    LOST = "LOST"
+}
+/** @enumType */
+type OutcomeWithLiterals = Outcome | 'NONE' | 'WON' | 'LOST';
+interface ContactInfo {
+    /**
+     * ID of the contact associated with the card.
+     * @format GUID
+     */
+    contactId?: string | null;
+    /**
+     * Contact's first name.
+     * @readonly
+     * @maxLength 50
+     */
+    firstName?: string | null;
+    /**
+     * Contact's last name.
+     * @readonly
+     * @maxLength 50
+     */
+    lastName?: string | null;
+    /**
+     * Contact's primary email.
+     * @format EMAIL
+     * @maxLength 320
+     * @readonly
+     */
+    email?: string | null;
+    /**
+     * Contact's primary phone.
+     * @minLength 1
+     * @maxLength 50
+     * @readonly
+     */
+    phone?: string | null;
+}
+interface LinkedEntity {
+    /**
+     * ID of the linked entity.
+     * @format GUID
+     */
+    entityId?: string;
+    /**
+     * Linked entity type.
+     *
+     * Identifies the type of entity associated with this card such as a contact submitted by a form, or an invoice sent to close a deal.
+     * You can store any value that helps identify the entity type.
+     * Use the item selection provider key to make the item selectable by the client.
+     * For example, an invoice uses "13ee94c1-b635-8505-3391-97919052c16f_InvoiceSelectionProvider".
+     * @minLength 1
+     * @maxLength 100
+     */
+    referencedEntity?: string;
+    /**
+     * Date and time the entity was linked to the card in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+     * @readonly
+     */
+    linkedDate?: Date | null;
+}
+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 CardMoved {
+    /** The card that moved. */
+    card?: Card;
+    /**
+     * The ID of the stage to which the card was moved.
+     * @format GUID
+     */
+    targetStageId?: string;
+    /**
+     * The ID of the stage from which the card was moved.
+     * @format GUID
+     */
+    sourceStageId?: string;
+}
+interface CardAssigned {
+    /** The card that is assigned. */
+    card?: Card;
+}
+interface CardOverdue {
+    /** The card that is overdue. */
+    card?: Card;
+}
+interface CardStale {
+    /** The card that is stale. */
+    card?: Card;
+}
+interface CreateCardRequest {
+    /** Card to create. */
+    card?: Card;
+}
+interface CreateCardResponse {
+    /** Created card. */
+    card?: Card;
+}
+interface ContactsNotFound {
+    /**
+     * The contact IDs that were not found.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 11
+     */
+    contactIds?: string[] | null;
+}
+interface GetCardRequest {
+    /**
+     * Card ID to retrieve.
+     * @format GUID
+     */
+    cardId: string;
+}
+interface GetCardResponse {
+    /** Retrieved card. */
+    card?: Card;
+}
+interface UpdateCardRequest {
+    /** Card to update, may be partial. */
+    card?: Card;
+}
+interface UpdateCardResponse {
+    /** Updated card. */
+    card?: Card;
+}
+interface MoveCardRequest {
+    /**
+     * Card ID to move.
+     * @format GUID
+     */
+    cardId: string;
+    /**
+     * ID of the stage to move the card to.
+     * @format GUID
+     */
+    stageId: string;
+    /** Revision of the card to move. Moving the card changes the `stageId` on the card and increases `revision` by 1. */
+    revision: string | null;
+    /** New card outcome. */
+    outcome?: OutcomeWithLiterals;
+}
+interface MoveCardResponse {
+    /** Updated card. */
+    card?: Card;
+}
+interface DeleteCardRequest {
+    /**
+     * Card ID to delete.
+     * @format GUID
+     */
+    cardId: string;
+}
+interface DeleteCardResponse {
+}
+interface QueryCardsRequest {
+    /** 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 the [filter section](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 the [sort section](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 in the results. Default is 50.
+     * @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 QueryCardsResponse {
+    /** List of cards. */
+    cards?: Card[];
+    /** 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 SearchCardsRequest {
+    /** Search options. */
+    search?: CursorSearch;
+    /**
+     * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
+     * By default, names are ordered by first name followed by last name.
+     * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
+     */
+    nameFormat?: NameFormatWithLiterals;
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * 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 the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /**
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+     * @maxSize 10
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+    /**
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome.
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * 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 Aggregation extends AggregationKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation. */
+    nested?: NestedAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, use dot notation to specify json path.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation. */
+    nested?: NestedAggregation;
+}
+interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
+    to?: number | null;
+}
+declare enum SortType {
+    /** Sort by number of matches. */
+    COUNT = "COUNT",
+    /** Sort by value of the field alphabetically. */
+    VALUE = "VALUE"
+}
+/** @enumType */
+type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
+declare enum SortDirection {
+    /** Sort in descending order. */
+    DESC = "DESC",
+    /** Sort in ascending order. */
+    ASC = "ASC"
+}
+/** @enumType */
+type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
+declare enum MissingValues {
+    /** Exclude missing values from the aggregation results. */
+    EXCLUDE = "EXCLUDE",
+    /** Include missing values in the aggregation results. */
+    INCLUDE = "INCLUDE"
+}
+/** @enumType */
+type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
+interface IncludeMissingValuesOptions {
+    /**
+     * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * @maxLength 20
+     */
+    addToBucket?: string;
+}
+declare enum ScalarType {
+    /** Count of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX"
+}
+/** @enumType */
+type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
+interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values. */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Whether to sort by number of matches or value of the field. */
+    sortType?: SortTypeWithLiterals;
+    /** Whether to sort in ascending or descending order. */
+    sortDirection?: SortDirectionWithLiterals;
+    /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
+    missingValues?: MissingValuesWithLiterals;
+}
+/** @oneof */
+interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values. */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+declare enum NestedAggregationType {
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+/** @enumType */
+type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
+interface RangeAggregation {
+    /**
+     * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
+     * @maxSize 50
+     */
+    buckets?: RangeBucket[];
+}
+interface ScalarAggregation {
+    /** Define the operator for the scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+}
+interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation. */
+    interval?: IntervalWithLiterals;
+}
+declare enum Interval {
+    /** Yearly interval */
+    YEAR = "YEAR",
+    /** Monthly interval */
+    MONTH = "MONTH",
+    /** Weekly interval */
+    WEEK = "WEEK",
+    /** Daily interval */
+    DAY = "DAY",
+    /** Hourly interval */
+    HOUR = "HOUR",
+    /** Minute interval */
+    MINUTE = "MINUTE",
+    /** Second interval */
+    SECOND = "SECOND"
+}
+/** @enumType */
+type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
+interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below. */
+    type?: NestedAggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, use dot notation to specify json path.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf {
+    /** Value aggregation. */
+    value?: ValueAggregation;
+    /** Range aggregation. */
+    range?: RangeAggregation;
+    /** Scalar aggregation. */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation. */
+    dateHistogram?: DateHistogramAggregation;
+}
+declare enum AggregationType {
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one. */
+    NESTED = "NESTED"
+}
+/** @enumType */
+type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
+interface NestedAggregation {
+    /**
+     * Flattened list of aggregations, where each next aggregation is nested within previous one.
+     * @minSize 2
+     * @maxSize 3
+     */
+    nestedAggregations?: NestedAggregationItem[];
+}
+interface SearchDetails {
+    /** Defines how separate search terms in `expression` are combined. */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** Any of the search terms must be present. */
+    OR = "OR",
+    /** All search terms must be present. */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+/** Name format types for sorting and searching. */
+declare enum NameFormat {
+    /** Names are ordered by first name followed by last name. */
+    BY_FIRST_NAME = "BY_FIRST_NAME",
+    /** Names are ordered by last name followed by first name. */
+    BY_LAST_NAME = "BY_LAST_NAME"
+}
+/** @enumType */
+type NameFormatWithLiterals = NameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
+interface SearchCardsResponse {
+    /** List of cards. */
+    cards?: Card[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data. */
+    aggregationData?: AggregationData;
+}
+interface AggregationData {
+    /**
+     * key = aggregation name (as derived from search request).
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number;
+}
+interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number;
+}
+interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /**
+     * User-defined name of aggregation, matches the one provided in request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that matches result. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, matches the one provided in request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+}
+interface ValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+interface RangeResults {
+    /**
+     * List of ranges returned in same order as requested.
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Nested aggregations. */
+    nestedResults?: NestedAggregationResults;
+}
+interface ValueResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number | null;
+}
+interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+interface Results {
+    /** List of nested aggregations. */
+    results?: Record<string, NestedResultValue>;
+}
+interface DateHistogramResult {
+    /**
+     * Date in ISO 8601 format.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of documents in the bucket. */
+    count?: number;
+}
+interface GroupByValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 1000
+     */
+    results?: NestedValueAggregationResult[];
+}
+interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations.
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults {
+    /**
+     * List of nested aggregations.
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /**
+     * User-defined name of aggregation as derived from search request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by as derived from search request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+}
+interface SearchCardsByStageRequest {
+    /**
+     * ID of the pipeline in which to look for cards.
+     * @format GUID
+     */
+    pipelineId: string | null;
+    /**
+     * Stage IDs to filter by.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 35
+     */
+    stageIds: string[];
+    /** Search options. `search.cursorPaging.cursor` is not supported in this request and is ignored. */
+    search?: CursorSearch;
+    /**
+     * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
+     * By default, names are ordered by first name followed by last name.
+     * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
+     */
+    nameFormat?: NameFormatWithLiterals;
+}
+interface SearchCardsByStageResponse {
+    /**
+     * List of card results matching the filter and search.
+     * @minSize 1
+     * @maxSize 30
+     */
+    results?: BulkSearchCardsResult[];
+}
+interface BulkSearchCardsResult {
+    /**
+     * ID of the pipeline containing the cards.
+     * @format GUID
+     */
+    pipelineId?: string | null;
+    /**
+     * ID of the stage containing the cards.
+     * @format GUID
+     */
+    stageId?: string | null;
+    /** List of cards. */
+    cards?: Card[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data. */
+    aggregationData?: AggregationData;
+}
+interface BulkCreateCardsRequest {
+    /**
+     * List of cards to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    cards: Card[];
+    /**
+     * Whether to return the created cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkCreateCardsResponse {
+    /**
+     * List of cards created by the bulk operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkCardResult[];
+    /** Bulk operation metadata. */
+    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 BulkCardResult {
+    /** Information about the card that was created. */
+    itemMetadata?: ItemMetadata;
+    /**
+     * Created card.
+     *
+     * Only returned if `returnEntity` was set to `true` in the request.
+     */
+    item?: Card;
+}
+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 BulkUpdateCardsRequest {
+    /**
+     * List of cards to update.
+     * @minSize 1
+     * @maxSize 100
+     * @readonly
+     */
+    cards: MaskedCard[];
+    /**
+     * Whether to return the updated cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface MaskedCard {
+    /**
+     * Card to update, may be partial.
+     * @readonly
+     */
+    card?: Card;
+}
+interface BulkUpdateCardsResponse {
+    /**
+     * List of cards updated by the bulk operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateCardsResponseBulkCardResult[];
+    /** Bulk operation metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateCardsResponseBulkCardResult {
+    /** Information about the card that was updated. */
+    itemMetadata?: ItemMetadata;
+    /**
+     * Updated card.
+     *
+     * Only returned if `returnEntity` was set to `true` in the request.
+     */
+    item?: Card;
+}
+interface BulkDeleteCardsRequest {
+    /**
+     * Card IDs to delete.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    cardIds: string[];
+}
+interface BulkDeleteCardsResponse {
+    /**
+     * List of cards deleted by the bulk operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteCardsResponseBulkCardResult[];
+    /** Bulk operation metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteCardsResponseBulkCardResult {
+    /** Information about the card that was deleted. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdateCardTagsRequest {
+    /**
+     * List of card IDs whose tags will be updated.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    cardIds: string[];
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdateCardTagsResponse {
+    /**
+     * List of cards whose tags were updated.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateCardTagsResult[];
+    /** Bulk operation metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateCardTagsResult {
+    /** Information about the card that was updated. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdateCardTagsByFilterRequest {
+    /** Filter object. */
+    filter: Record<string, any> | null;
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+}
+interface BulkUpdateCardTagsByFilterResponse {
+    /**
+     * Job ID.
+     * @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 Empty {
+}
+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 CreateCardApplicationErrors = {
+    code?: 'PIPELINE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'STAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ASSIGNEE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTACTS_NOT_FOUND';
+    description?: string;
+    data?: ContactsNotFound;
+} | {
+    code?: 'INVALID_OUTCOME';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ADDITIONAL_CONTACTS_WITHOUT_MAIN_CONTACT';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type UpdateCardApplicationErrors = {
+    code?: 'REVISION_MISSING';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'STAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_OUTCOME';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_REMOVE_NAME';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_ASSIGNEE_ID';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_CONTACT_ID';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_CHANGE_CURRENCY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INSUFFICIENT_CARD_DATA';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTACTS_NOT_FOUND';
+    description?: string;
+    data?: ContactsNotFound;
+} | {
+    code?: 'ADDITIONAL_CONTACTS_WITHOUT_MAIN_CONTACT';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type MoveCardApplicationErrors = {
+    code?: 'STAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_OUTCOME';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateCardTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateCardTagsByFilterApplicationErrors = {
+    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 CardAssignedEnvelope {
+    data: CardAssigned;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card is assigned.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_assigned
+ * @slug assigned
+ * @documentationMaturity preview
+ */
+declare function onCardAssigned(handler: (event: CardAssignedEnvelope) => void | Promise<void>): void;
+interface CardCreatedEnvelope {
+    entity: Card;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card is created.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onCardCreated(handler: (event: CardCreatedEnvelope) => void | Promise<void>): void;
+interface CardDeletedEnvelope {
+    entity: Card;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card is deleted.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onCardDeleted(handler: (event: CardDeletedEnvelope) => void | Promise<void>): void;
+interface CardMovedEnvelope {
+    data: CardMoved;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card is moved from one stage to another.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_moved
+ * @slug moved
+ * @documentationMaturity preview
+ */
+declare function onCardMoved(handler: (event: CardMovedEnvelope) => void | Promise<void>): void;
+interface CardOverdueEnvelope {
+    data: CardOverdue;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card's `dueDate` passes.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_overdue
+ * @slug overdue
+ * @documentationMaturity preview
+ */
+declare function onCardOverdue(handler: (event: CardOverdueEnvelope) => void | Promise<void>): void;
+interface CardStaleEnvelope {
+    data: CardStale;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a card's `staleDate` passes.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_stale
+ * @slug stale
+ * @documentationMaturity preview
+ */
+declare function onCardStale(handler: (event: CardStaleEnvelope) => void | Promise<void>): void;
+interface CardUpdatedEnvelope {
+    entity: Card;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a card is updated.
+ * @permissionScope Manage Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.MANAGE-PIPELINES
+ * @permissionScope Read Pipelines
+ * @permissionScopeId SCOPE.DC-CRM.READ-PIPELINES
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @webhook
+ * @eventType wix.crm.pipelines.v1.card_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onCardUpdated(handler: (event: CardUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a card in a specific pipeline stage.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.card.name
+ * @requiredField options.card.pipelineId
+ * @requiredField options.card.stageId
+ * @permissionId PIPELINE_CARDS.CARD_CREATE
+ * @applicableIdentity APP
+ * @returns Created card.
+ * @fqn wix.crm.pipelines.cards.v1.Cards.CreateCard
+ */
+declare function createCard(options?: NonNullablePaths<CreateCardOptions, `card.name` | `card.pipelineId` | `card.stageId`, 3>): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4> & {
+    __applicationErrorsType?: CreateCardApplicationErrors;
+}>;
+interface CreateCardOptions {
+    /** Card to create. */
+    card?: Card;
+}
+/**
+ * Retrieves a card by ID.
+ * @param cardId - Card ID to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField cardId
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @applicableIdentity APP
+ * @returns Retrieved card.
+ * @fqn wix.crm.pipelines.cards.v1.Cards.GetCard
+ */
+declare function getCard(cardId: string): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Updates a card by ID.
+ *
+ * Each time the card is updated, `revision` increments by 1. The current `revision` must be specified when updating the card. This ensures you're working with the latest card and prevents unintended overwrites.
+ *
+ * The card's `pipelineId` and `currency` fields can't be updated.
+ * @param _id - Card ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId PIPELINE_CARDS.CARD_UPDATE
+ * @permissionId PIPELINE_CARDS.CARD_UPDATE_WITHOUT_REVISION
+ * @applicableIdentity APP
+ * @returns Updated card.
+ * @fqn wix.crm.pipelines.cards.v1.Cards.UpdateCard
+ */
+declare function updateCard(_id: string, options?: UpdateCardOptions): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4> & {
+    __applicationErrorsType?: UpdateCardApplicationErrors;
+}>;
+interface UpdateCardOptions {
+    card: {
+        /**
+         * Card ID.
+         * @format GUID
+         * @readonly
+         */
+        _id?: string | null;
+        /**
+         * Revision number, which increments by 1 each time the card is updated.
+         * To prevent conflicting changes, the current revision must be passed when updating the card.
+         * @readonly
+         */
+        revision?: string | null;
+        /**
+         * Date and time the card 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 card was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+         * @readonly
+         */
+        _updatedDate?: Date | null;
+        /**
+         * ID of the pipeline containing this card.
+         * @format GUID
+         * @readonly
+         */
+        pipelineId?: string | null;
+        /**
+         * ID of the cards' current.
+         * @format GUID
+         */
+        stageId?: string | null;
+        /**
+         * Date and time when the card last moved between stagesin [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+         * @readonly
+         */
+        stageUpdatedDate?: Date | null;
+        /**
+         * How the card was moved to its current stage.
+         * @readonly
+         */
+        stageUpdateSource?: CardSource;
+        /**
+         * The Card name.
+         * @minLength 1
+         * @maxLength 100
+         */
+        name?: string | null;
+        /**
+         * Card description.
+         * @maxLength 1000
+         */
+        description?: string | null;
+        /**
+         * Priority level of the card for task management.
+         *
+         * Default: `P3_MEDIUM`
+         */
+        priority?: PriorityWithLiterals;
+        /**
+         * ID of the Wix user assigned to manage the card.
+         * @format GUID
+         */
+        assigneeId?: string | null;
+        /**
+         * Date and time when the card is expected to moved to the done stage in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+         * If the card remains active past this date, it becomes overdue.
+         */
+        dueDate?: Date | null;
+        /**
+         * Date and time when the card becomes stale based on the stage's stale duration setting in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
+         * This date is automatically calculated and updated when the card moves to a new stage.
+         * @readonly
+         */
+        staleDate?: Date | null;
+        /** Monetary value assigned to the card. */
+        value?: Money;
+        /**
+         * Final outcome of the card when moved to the done stage.
+         *
+         * Default: `NONE`
+         */
+        outcome?: OutcomeWithLiterals;
+        /** Primary contact associated with the card. */
+        mainContact?: ContactInfo;
+        /**
+         * Secondary contacts associated with the card.
+         * @maxSize 10
+         */
+        additionalContacts?: ContactInfo[];
+        /**
+         * Other entities linked to the card.
+         *
+         * For example, orders, invoices, activities, or other relevant entities.
+         * @maxSize 20
+         */
+        linkedEntities?: LinkedEntity[];
+        /** Extended fields data. */
+        extendedFields?: ExtendedFields;
+        /** Tags for organizing and categorizing the card. */
+        tags?: PrivateTags;
+    };
+}
+/**
+ * Moves a card to a different stage within the same pipeline.
+ *
+ * Cards can only be moved between stages within the same pipeline.
+ *
+ * Each time a card is moved, its `revision` increments by 1.
+ * @param cardId - Card ID to move.
+ * @param stageId - ID of the stage to move the card to.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField cardId
+ * @requiredField options.revision
+ * @requiredField stageId
+ * @permissionId PIPELINE_CARDS.CARD_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.MoveCard
+ */
+declare function moveCard(cardId: string, stageId: string, options?: NonNullablePaths<MoveCardOptions, `revision`, 2>): Promise<NonNullablePaths<MoveCardResponse, `card.priority` | `card.value.value` | `card.value.currency` | `card.outcome` | `card.additionalContacts` | `card.linkedEntities` | `card.linkedEntities.${number}.entityId` | `card.linkedEntities.${number}.referencedEntity` | `card.tags.privateTags.tagIds`, 5> & {
+    __applicationErrorsType?: MoveCardApplicationErrors;
+}>;
+interface MoveCardOptions {
+    /** Revision of the card to move. Moving the card changes the `stageId` on the card and increases `revision` by 1. */
+    revision: string | null;
+    /** New card outcome. */
+    outcome?: OutcomeWithLiterals;
+}
+/**
+ * Deletes a card.
+ *
+ * Deleting a card permanently removes it from a site.
+ * @param cardId - Card ID to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField cardId
+ * @permissionId PIPELINE_CARDS.CARD_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.DeleteCard
+ */
+declare function deleteCard(cardId: string): Promise<void>;
+/**
+ * Retrieves a list of up to 100 cards, given the provided paging, filtering, and sorting.
+ *
+ * By default, 50 cards are returned and sorted by `updatedDate` in descending order.
+ *
+ * For a detailed list of supported operations, see [Cards: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/crm/crm/pipelines/card-v1/supported-filters-sorting-and-search).
+ *
+ * To learn more about working with _Query_ 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).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.QueryCards
+ */
+declare function queryCards(): CardsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface CardsQueryResult extends QueryCursorResult {
+    items: Card[];
+    query: CardsQueryBuilder;
+    next: () => Promise<CardsQueryResult>;
+    prev: () => Promise<CardsQueryResult>;
+}
+interface CardsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'pipelineId' | 'stageId', value: any) => CardsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'pipelineId' | 'stageId', value: any) => CardsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => CardsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CardsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => CardsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CardsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'pipelineId' | 'stageId', value: any) => CardsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate'>) => CardsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_updatedDate'>) => CardsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => CardsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => CardsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<CardsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.crm.pipelines.cards.v1.Cards.QueryCards
+ * @requiredField query
+ */
+declare function typedQueryCards(query: CardQuery): Promise<NonNullablePaths<QueryCardsResponse, `cards` | `cards.${number}.priority` | `cards.${number}.value.value` | `cards.${number}.value.currency` | `cards.${number}.outcome`, 5>>;
+interface CardQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id', 'pipelineId', 'stageId'];
+            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';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Card, CardQuerySpec>;
+type CardQuery = {
+    /**
+    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 in the results. Default is 50.
+      @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 the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about the [sort section](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<Card, CardQuerySpec, CardQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Card, CardQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<CardQuerySpec>;
+    };
+    search: {
+        SearchBuilder: () => _wix_sdk_types.SearchBuilder<Card, CardSearchSpec, CardSearch>;
+        Filter: _wix_sdk_types.FilterFactory<Card, CardSearchSpec>;
+        Sort: _wix_sdk_types.SortFactory<CardSearchSpec>;
+        SearchParams: _wix_sdk_types.SearchParamsFactory<CardSearchSpec>;
+        Aggregation: _wix_sdk_types.AggregationFactory<CardSearchSpec>;
+    };
+};
+interface SearchCardsOptions {
+    /**
+     * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
+     * By default, names are ordered by first name followed by last name.
+     * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
+     */
+    nameFormat?: NameFormatWithLiterals;
+}
+interface CardSearchSpec extends SearchSpec {
+    searchable: [
+        'additionalContacts.email',
+        'additionalContacts.fullName',
+        'additionalContacts.phone',
+        'description',
+        'mainContact.email',
+        'mainContact.fullName',
+        'mainContact.phone',
+        'name'
+    ];
+    aggregatable: [
+        '_createdDate',
+        '_id',
+        '_updatedDate',
+        'additionalContacts',
+        'additionalContacts.contactId',
+        'assigneeId',
+        'description',
+        'dueDate',
+        'linkedEntities',
+        'linkedEntities.entityId',
+        'linkedEntities.referencedEntity',
+        'mainContact.contactId',
+        'name',
+        'outcome',
+        'pipelineId',
+        'priority',
+        'stageId',
+        'stageUpdatedDate',
+        'staleDate',
+        'tags.privateTags.tagIds',
+        'value.value'
+    ];
+    paging: 'cursor';
+    wql: [
+        {
+            operators: ['$eq', '$in', '$ne', '$nin'];
+            fields: ['_id', 'pipelineId', 'stageId'];
+            sort: 'ASC';
+        },
+        {
+            operators: ['$eq', '$exists', '$in', '$ne', '$nin'];
+            fields: ['assigneeId', 'mainContact.contactId'];
+            sort: 'ASC';
+        },
+        {
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            fields: ['_createdDate', '_updatedDate', 'stageUpdatedDate'];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$eq', '$exists', '$gt', '$gte', '$lt', '$lte'];
+            fields: ['dueDate', 'staleDate', 'value.value'];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$hasAll', '$hasSome', '$isEmpty'];
+            fields: ['tags.privateTags.tagIds'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$isEmpty', '$matchItems'];
+            fields: ['additionalContacts'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$matchItems'];
+            fields: ['linkedEntities'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$eq', '$exists', '$in', '$ne', '$nin', '$startsWith'];
+            fields: ['description'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$eq', '$in', '$ne', '$nin', '$startsWith'];
+            fields: ['mainContact.email', 'mainContact.phone', 'name'];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$eq', '$in', '$ne', '$nin'];
+            fields: ['outcome', 'priority'];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonSearchWithEntityContext = Search<Card, CardSearchSpec>;
+type CardSearch = {
+    /**
+    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 in the results. Default is 50.
+      @max: 100
+      */
+        limit?: NonNullable<CommonSearchWithEntityContext['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<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonSearchWithEntityContext['filter'] | null;
+    /**
+    List of sort objects.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
+    }[];
+    /**
+    Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+    @maxSize: 10
+    */
+    aggregations?: {
+        /**
+      Value aggregation.
+      */
+        value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
+        /**
+      Range aggregation.
+      */
+        range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
+        /**
+      Scalar aggregation.
+      */
+        scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
+        /**
+      Date histogram aggregation.
+      */
+        dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
+        /**
+      Nested aggregation.
+      */
+        nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
+        /**
+      User-defined name of aggregation, should be unique, will appear in aggregation results.
+      @maxLength: 100
+      */
+        name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
+        /**
+      Type of aggregation, client must provide matching aggregation field below.
+      */
+        type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
+        /**
+      Field to aggregate by, use dot notation to specify json path.
+      @maxLength: 200
+      */
+        fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
+    }[];
+    /**
+    Free text to match in searchable fields.
+    */
+    search?: {
+        /**
+      Defines how separate search terms in `expression` are combined.
+      */
+        mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
+        /**
+      Search term or expression.
+      @maxLength: 100
+      */
+        expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
+        /**
+      Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
+      @maxLength: 200,
+      @maxSize: 20
+      */
+        fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
+        /**
+      Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm).
+      */
+        fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
+    };
+    /**
+    UTC offset or IANA time zone. Valid values are
+    ISO 8601 UTC offsets, such as +02:00 or -06:00,
+    and IANA time zone IDs, such as Europe/Rome.
+  
+    Affects all filters and aggregations returned values.
+    You may override this behavior in a specific filter by providing
+    timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
+    @maxLength: 50
+    */
+    timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
+};
+/**
+ * Retrieves a list of cards by the pipeline's stage, given the provided free-text search expression, filtering, and sorting.
+ *
+ * By default, cards are sorted by `updatedDate` in descending order.
+ *
+ * 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).
+ *
+ * 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 pipelineId - ID of the pipeline in which to look for cards.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.stageIds
+ * @requiredField pipelineId
+ * @permissionId PIPELINE_CARDS.CARD_READ
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.SearchCardsByStage
+ */
+declare function searchCardsByStage(pipelineId: string, options?: NonNullablePaths<SearchCardsByStageOptions, `stageIds`, 2>): Promise<NonNullablePaths<SearchCardsByStageResponse, `results`, 2>>;
+interface SearchCardsByStageOptions {
+    /**
+     * Stage IDs to filter by.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 35
+     */
+    stageIds: string[];
+    /** Search options. `search.cursorPaging.cursor` is not supported in this request and is ignored. */
+    search?: CursorSearch;
+    /**
+     * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
+     * By default, names are ordered by first name followed by last name.
+     * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
+     */
+    nameFormat?: NameFormatWithLiterals;
+}
+interface BulkCreateCardsOptions {
+    /**
+     * Whether to return the created cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdateCardsOptions {
+    /**
+     * Whether to return the updated cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Updates tags on multiple cards by specified card IDs.
+ *
+ * If you specify a tag that in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
+ * @param cardIds - List of card IDs whose tags will be updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField cardIds
+ * @permissionId PIPELINE_CARDS.CARD_UPDATE_TAGS
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.BulkUpdateCardTags
+ */
+declare function bulkUpdateCardTags(cardIds: string[], options?: BulkUpdateCardTagsOptions): Promise<NonNullablePaths<BulkUpdateCardTagsResponse, `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?: BulkUpdateCardTagsApplicationErrors;
+}>;
+interface BulkUpdateCardTagsOptions {
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+    /**
+     * Whether to return the updated cards in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Asynchronously updates tags on multiple cards using a filter to specify which cards to update.
+ *
+ * An empty filter updates all cards in the pipeline.
+ *
+ * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
+ * @param filter - Filter object.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId PIPELINE_CARDS.CARD_UPDATE_TAGS
+ * @applicableIdentity APP
+ * @fqn wix.crm.pipelines.cards.v1.Cards.BulkUpdateCardTagsByFilter
+ */
+declare function bulkUpdateCardTagsByFilter(filter: Record<string, any>, options?: BulkUpdateCardTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateCardTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateCardTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateCardTagsByFilterOptions {
+    /** List of tags to assign. */
+    assignTags?: PrivateTags;
+    /** List of tags to unassign. */
+    unassignTags?: PrivateTags;
+}
+
+export { type CreateCardRequest as $, SortDirection as A, type BulkUpdateCardTagsOptions as B, type CreateCardOptions as C, MissingValues as D, ScalarType as E, AggregationType as F, Mode as G, NameFormat as H, Interval as I, type CardSource as J, type Money as K, type ContactInfo as L, type MoveCardOptions as M, NestedAggregationType as N, Outcome as O, Priority as P, type LinkedEntity as Q, type ExtendedFields as R, type SearchCardsOptions as S, type PrivateTags as T, type UpdateCardOptions as U, type TagList as V, WebhookIdentityType as W, type CardMoved as X, type CardAssigned as Y, type CardOverdue as Z, type CardStale as _, type Card as a, type MaskedCard as a$, type CreateCardResponse as a0, type ContactsNotFound as a1, type GetCardRequest as a2, type GetCardResponse as a3, type UpdateCardRequest as a4, type UpdateCardResponse as a5, type MoveCardRequest as a6, type DeleteCardRequest as a7, type DeleteCardResponse as a8, type QueryCardsRequest as a9, type NestedAggregationResults as aA, type NestedAggregationResultsResultOneOf as aB, type ValueResults as aC, type RangeResults as aD, type AggregationResultsScalarResult as aE, type NestedValueAggregationResult as aF, type ValueResult as aG, type RangeResult as aH, type ScalarResult as aI, type NestedResultValue as aJ, type NestedResultValueResultOneOf as aK, type Results as aL, type DateHistogramResult as aM, type GroupByValueResults as aN, type DateHistogramResults as aO, type NestedResults as aP, type AggregationResults as aQ, type AggregationResultsResultOneOf as aR, type SearchCardsByStageRequest as aS, type BulkSearchCardsResult as aT, type BulkCreateCardsRequest as aU, type BulkCreateCardsResponse as aV, type ItemMetadata as aW, type ApplicationError as aX, type BulkCardResult as aY, type BulkActionMetadata as aZ, type BulkUpdateCardsRequest as a_, type CursorQuery as aa, type CursorQueryPagingMethodOneOf as ab, type Sorting as ac, type CursorPaging as ad, type QueryCardsResponse as ae, type CursorPagingMetadata as af, type Cursors as ag, type SearchCardsRequest as ah, type CursorSearch as ai, type CursorSearchPagingMethodOneOf as aj, type Aggregation as ak, type AggregationKindOneOf as al, type RangeBucket as am, type IncludeMissingValuesOptions as an, type ValueAggregation as ao, type ValueAggregationOptionsOneOf as ap, type RangeAggregation as aq, type ScalarAggregation as ar, type DateHistogramAggregation as as, type NestedAggregationItem as at, type NestedAggregationItemKindOneOf as au, type NestedAggregation as av, type SearchDetails as aw, type AggregationData as ax, type ValueAggregationResult as ay, type RangeAggregationResult as az, type CreateCardApplicationErrors as b, type BulkUpdateCardsResponse as b0, type BulkUpdateCardsResponseBulkCardResult as b1, type BulkDeleteCardsRequest as b2, type BulkDeleteCardsResponse as b3, type BulkDeleteCardsResponseBulkCardResult as b4, type BulkUpdateCardTagsRequest as b5, type BulkUpdateCardTagsResult as b6, type BulkUpdateCardTagsByFilterRequest as b7, type DomainEvent as b8, type DomainEventBodyOneOf as b9, type NestedAggregationTypeWithLiterals as bA, type IntervalWithLiterals as bB, type AggregationTypeWithLiterals as bC, type ModeWithLiterals as bD, type NameFormatWithLiterals as bE, type WebhookIdentityTypeWithLiterals as bF, type CommonQueryWithEntityContext as bG, type CommonSearchWithEntityContext as bH, onCardAssigned as bI, onCardCreated as bJ, onCardDeleted as bK, onCardMoved as bL, onCardOverdue as bM, onCardStale as bN, onCardUpdated as bO, createCard as bP, getCard as bQ, updateCard as bR, moveCard as bS, deleteCard as bT, queryCards as bU, searchCardsByStage as bV, bulkUpdateCardTags as bW, bulkUpdateCardTagsByFilter as bX, type EntityCreatedEvent as ba, type RestoreInfo as bb, type EntityUpdatedEvent as bc, type EntityDeletedEvent as bd, type ActionEvent as be, type Empty as bf, type MessageEnvelope as bg, type IdentificationData as bh, type IdentificationDataIdOneOf as bi, type AccountInfo as bj, type BaseEventMetadata as bk, type EventMetadata as bl, type AccountInfoMetadata as bm, type CardsQueryResult as bn, type CardQuerySpec as bo, type CardSearchSpec as bp, type BulkCreateCardsOptions as bq, type BulkUpdateCardsOptions as br, utils as bs, type PriorityWithLiterals as bt, type OutcomeWithLiterals as bu, type SortOrderWithLiterals as bv, type SortTypeWithLiterals as bw, type SortDirectionWithLiterals as bx, type MissingValuesWithLiterals as by, type ScalarTypeWithLiterals as bz, type UpdateCardApplicationErrors as c, type MoveCardResponse as d, type MoveCardApplicationErrors as e, type CardSearch as f, type SearchCardsResponse as g, type SearchCardsByStageOptions as h, type SearchCardsByStageResponse as i, type BulkUpdateCardTagsResponse as j, type BulkUpdateCardTagsApplicationErrors as k, type BulkUpdateCardTagsByFilterOptions as l, type BulkUpdateCardTagsByFilterResponse as m, type BulkUpdateCardTagsByFilterApplicationErrors as n, type CardAssignedEnvelope as o, type CardCreatedEnvelope as p, type CardDeletedEnvelope as q, type CardMovedEnvelope as r, type CardOverdueEnvelope as s, type CardStaleEnvelope as t, type CardUpdatedEnvelope as u, type CardsQueryBuilder as v, type CardQuery as w, typedQueryCards as x, SortOrder as y, SortType as z };